Diferencia entre revisiones de «API LaFactura.co:Amounts»

De API LaFactura.co
Ir a la navegación Ir a la búsqueda
(Página creada con «==Objeto:amounts== Es un objeto usado en invoice. Permite enviar al sistema, los datos referentes al cliente. Su uso es obligatorio para la generación de cualquier factur…»)
 
 
(No se muestran 53 ediciones intermedias del mismo usuario)
Línea 5: Línea 5:
 
=====Ejemplo=====
 
=====Ejemplo=====
  
−
       "customer":{
+
       "amounts":{
−
           "additionalAccountID":"1",
+
           "totalAmount":"116000.00",
−
           "name":"Pepito Perez y Compania S.A.",
+
           "discountAmount":"4000.00",
−
           "countryName":"Colombia",
+
           "extraAmount":"0.00",
−
           "countryCode":"CO",
+
           "taxAmount":"18240.00",
−
          "city":"Bogotá D.C.",
+
           "prepaidAmount":"0.00",
−
          "countryEntity":"11",
+
           "payAmount":"134240.00"
−
          "countrySubentity":"11001",
 
−
           "addressLine":"Av 25 No. 8-47",
 
−
          "documentNumber":"900900651",
 
−
          "documentType":"31",
 
−
          "telephone":"3112196952",
 
−
           "email":"este@ejemplo.com"
 
 
       }
 
       }
 +
 +
=====Explicacion=====
 +
 +
Representa los totales de la siguiente manera:
 +
 +
*Subtotal: $116000.00
 +
*Descuentos: $4000.00 (Antes de impuestos)
 +
*Cargos: $0.00 (Antes de impuestos)
 +
*Impuestos totales: $18240.00
 +
*Pagos Anticipados: $0.00
 +
*Total a pagar: $134240.00<br/><br/>
  
 
=====Campos=====
 
=====Campos=====
−
 
+
----
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
−
! Parámetro !! Descripción !! Tipo !! Obligatorio
+
! Parámetro !! Descripción !! Tipo !! Obligatorio !! API
−
|-
 
−
| additionalAccountID || Tipo de cliente -> "1" es persona jurídica, "2" es persona natural || cadena || SI
 
−
|-
 
−
| name || Nombre de la empresa o persona || cadena || SI
 
−
|-
 
−
| countryName || Nombre completo del pais de compra (Por omisión "Colombia") || cadena || NO
 
 
|-
 
|-
−
| countryCode || Código ISO de dos letras del país de compra (Por omisión "CO") .. en mayúsculas || cadena || NO
+
| totalAmount || Total de la factura antes de impuestos<br><small>(con dos decimales)</small>|| cadena || SI|| v2.0 / v3.0
 
|-
 
|-
−
| city || Ciudad del cliente que compra || cadena || SI
+
| discountAmount || Total de descuentos realizados (Antes impuestos)<br/><small>En API 3.0 si no es enviado, se asume "0.00"<br>(con dos decimales)</small>|| cadena || <small>SI -> para API v2.0<br/>NO -> para API v3.0</small> || v2.0 / v3.0
 
|-
 
|-
−
| countryEntity || Código del departamento según DIAN<br><small>(Si es al extranjero no es necesario)<br>[[API_LaFactura.co:Tabla_Departamentos|consultar tabla]]</small> || cadena || SI/NO
+
| extraAmount || Total de cargos adicionales cobrados (Antes impuestos)<br/><small>En API 3.0 si no es enviado, se asume "0.00"<br><small>(con dos decimales)</small>|| cadena || <small>SI -> para API v2.0<br/>NO -> para API v3.0</small> || v2.0 / v3.0
 
|-
 
|-
−
| countrySubentity || Código del municipio según tabla DIAN<br><small>(Si es al extranjero no es necesario)<br>[[API_LaFactura.co:Tabla_Municipios|consultar tabla]]</small> || cadena || SI/NO
+
| taxAmount || Total de impuestos cobrados<br><small>En API 3.0 si no es enviado, se asume "0.00"<br/>(con dos decimales)</small>|| cadena || <small>SI -> para API v2.0<br/>NO -> para API v3.0</small> || v2.0 / v3.0
 
|-
 
|-
−
| addressLine || Dirección en la ciudad || cadena || SI
+
| whTaxAmount || Total de retenciones aplicadas en whTaxes<br/><small>si no es enviado, se asume "0.00"<br/>Este paramétro no va en creditNote o debitNote<br/>(con dos decimales) -> No incluir en el calculo de payAmount</small> || cadena || NO || v3.0
 
|-
 
|-
−
| documentNumber || Identificación tributaria del cliente (En caso de NIT, NO colocar puntos, rayas o dígito de verificación) || cadena || SI
+
| prepaidAmount || Total de pagos anticipados<br><small>En API 3.0 si no es enviado, se asume "0.00"<br/>(con dos decimales)</small>|| cadena || <small>SI -> para API v2.0<br/>NO -> para API v3.0</small> || v2.0 / v3.0
 
|-
 
|-
−
| documentType || Tipo de documento según la DIAN<br><small>[[API_LaFactura.co:Tabla_Tipos_Documento|consultar tabla]]</small>|| cadena || SI
+
| globalDiscount || Descuento global aplicado <b>después de impuestos</b><br><small>Si no es enviado, se asume "0.00"<br/>Esta campo no es validado contra otra información recibida y solo se acepta en facturas<br/>(con dos decimales)</small>|| cadena || <small>NO</small> || v3.0
 
|-
 
|-
−
| telephone || Número telefónico del cliente || cadena || SI
+
| payAmount || Total a pagar<br><small>payAmount=totalAmount-discountAmount+extraAmount+taxAmount-prepaidAmount-globalDiscount<br/>(con dos decimales) - NO incluir whTaxAmount -</small>|| cadena || SI || v2.0 / v3.0
−
|-
 
−
| email || correo electronico del cliente || cadena || SI
 
 
|}
 
|}
 +
 +
<span style="color:#009999"><b>Notas para migrantes de API v2.0 a v3.0:</b></span>
 +
----
 +
Ahora, si no se envia: discountAmount / extraAmount / taxAmount / prepaidAmount / whTaxes se asume "0.00"<br/>
 +
Antes dichos campos eran obligatorios (inclusive en ceros)
 +
<br/>
 +
 +
=====A tener Presente=====
 +
----
 +
* Todos los campos deben estar presentes a excepción de prepaidAmount
 +
* Si no tiene valor, debe ir con: 0.00
 +
* discountAmount, extraAmount y taxAmount deben ser las sumas de los descuentos, cargos e impuestos totales cobrados a nivel de items
 +
* prepaidAmount es la suma de todos los anticipos en el documento
  
 
==Usado por==
 
==Usado por==
 
Los siguientes recursos:
 
Los siguientes recursos:
 
* [[API_LaFactura.co:Generar_Factura|Generar Factura]]
 
* [[API_LaFactura.co:Generar_Factura|Generar Factura]]
 +
* [[API_LaFactura.co:Generar_Nota_Credito|Generar Nota Crédito]]
 +
 
Los siguientes objetos:
 
Los siguientes objetos:
−
* [[API_laFactura.co:invoice|invoice]]
+
* [[API_laFactura.co:invoice|invoice]] (Factura)
 +
* [[API_laFactura.co:creditNote|creditNote]] (Nota Crédito)
  
 
==Temas complementarios==
 
==Temas complementarios==
 
* [[API_LaFactura.co:Facturacion|Facturación]]
 
* [[API_LaFactura.co:Facturacion|Facturación]]
 +
* [[API_LaFactura.co:NotaCredito|Nota Crédito]]
 +
 +
==Enlaces==
 +
*LaFactura.co: https://lafactura.co
 +
*GitHub: https://github.com/FacturacionElectronicaColombia/lafactura.co

Revisión actual del 15:45 9 ene 2024

Objeto:amounts

Es un objeto usado en invoice. Permite enviar al sistema, los datos referentes al cliente. Su uso es obligatorio para la generación de cualquier factura.

Ejemplo
     "amounts":{
          "totalAmount":"116000.00",
          "discountAmount":"4000.00",
          "extraAmount":"0.00",
          "taxAmount":"18240.00",
          "prepaidAmount":"0.00",
          "payAmount":"134240.00"
     }
Explicacion

Representa los totales de la siguiente manera:

  • Subtotal: $116000.00
  • Descuentos: $4000.00 (Antes de impuestos)
  • Cargos: $0.00 (Antes de impuestos)
  • Impuestos totales: $18240.00
  • Pagos Anticipados: $0.00
  • Total a pagar: $134240.00

Campos
Parámetro Descripción Tipo Obligatorio API
totalAmount Total de la factura antes de impuestos
(con dos decimales)		 cadena SI v2.0 / v3.0
discountAmount Total de descuentos realizados (Antes impuestos)
En API 3.0 si no es enviado, se asume "0.00"
(con dos decimales)		 cadena SI -> para API v2.0
NO -> para API v3.0		 v2.0 / v3.0
extraAmount Total de cargos adicionales cobrados (Antes impuestos)
En API 3.0 si no es enviado, se asume "0.00"
(con dos decimales)		 cadena SI -> para API v2.0
NO -> para API v3.0		 v2.0 / v3.0
taxAmount Total de impuestos cobrados
En API 3.0 si no es enviado, se asume "0.00"
(con dos decimales)		 cadena SI -> para API v2.0
NO -> para API v3.0		 v2.0 / v3.0
whTaxAmount Total de retenciones aplicadas en whTaxes
si no es enviado, se asume "0.00"
Este paramétro no va en creditNote o debitNote
(con dos decimales) -> No incluir en el calculo de payAmount		 cadena NO v3.0
prepaidAmount Total de pagos anticipados
En API 3.0 si no es enviado, se asume "0.00"
(con dos decimales)		 cadena SI -> para API v2.0
NO -> para API v3.0		 v2.0 / v3.0
globalDiscount Descuento global aplicado después de impuestos
Si no es enviado, se asume "0.00"
Esta campo no es validado contra otra información recibida y solo se acepta en facturas
(con dos decimales)		 cadena NO v3.0
payAmount Total a pagar
payAmount=totalAmount-discountAmount+extraAmount+taxAmount-prepaidAmount-globalDiscount
(con dos decimales) - NO incluir whTaxAmount -		 cadena SI v2.0 / v3.0

Notas para migrantes de API v2.0 a v3.0:

Ahora, si no se envia: discountAmount / extraAmount / taxAmount / prepaidAmount / whTaxes se asume "0.00"
Antes dichos campos eran obligatorios (inclusive en ceros)

A tener Presente
  • Todos los campos deben estar presentes a excepción de prepaidAmount
  • Si no tiene valor, debe ir con: 0.00
  • discountAmount, extraAmount y taxAmount deben ser las sumas de los descuentos, cargos e impuestos totales cobrados a nivel de items
  • prepaidAmount es la suma de todos los anticipos en el documento

Usado por

Los siguientes recursos:

Los siguientes objetos:

Temas complementarios

Enlaces

Obtenido de «https://wiki.lafactura.co/index.php?title=API_LaFactura.co:Amounts&oldid=2650»