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

De API LaFactura.co
Ir a la navegación Ir a la búsqueda
 
(No se muestran 29 ediciones intermedias del mismo usuario)
Línea 26: Línea 26:
  
 
=====Campos=====
 
=====Campos=====
−
 
+
----
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
 
! Parámetro !! Descripción !! Tipo !! Obligatorio !! API
 
! Parámetro !! Descripción !! Tipo !! Obligatorio !! API
 
|-
 
|-
−
| totalAmount || Total de la factura antes de impuestos<br><small>(con dos decimales)</small>|| cadena || SI -> para API v2.0 / NO -> para API v3.0|| v2.0 y 3.0
+
| totalAmount || Total de la factura antes de impuestos<br><small>(con dos decimales)</small>|| cadena || SI|| v2.0 / v3.0
 
|-
 
|-
−
| discountAmount || Total de descuentos realizados (Antes impuestos)<br/>En API 3.0 si no es enviado, se asume "0.00"<br><small>(con dos decimales)</small>|| cadena || SI || v2.0 y 3.0
+
| discountAmount || Total de descuentos realizados (Antes impuestos) que corresponde a la suma de descuentos aplicados a nivel de items<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
 
|-
 
|-
−
| extraAmount || Total de cargos adicionaless cobrados (Antes impuestos)<br/>En API 3.0 si no es enviado, se asume "0.00"<br><small>(con dos decimales)</small>|| cadena || SI || v2.0 y 3.0
+
| extraAmount || Total de cargos adicionales cobrados (Antes impuestos) que corresponde a la suma de cargos aplicados a nivel de items<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
 
|-
 
|-
−
| taxAmount || Total de impuestos cobrados<br><br/>En API 3.0 si no es enviado, se asume "0.00"<small>(con dos decimales)</small>|| cadena || SI || v2.0 y 3.0
+
| 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
 
|-
 
|-
−
| prepaidAmount || Total de pagos anticipados<br><br/>En API 3.0 si no es enviado, se asume "0.00"<small>Solo requerido si se usa el objeto "prepaid"<br/>(con dos decimales)</small>|| cadena || SI/NO || v2.0 y 3.0
+
| 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
 
|-
 
|-
−
| payAmount || Total a pagar<br><small>(con dos decimales)</small>|| cadena || SI || v2.0 y 3.0
+
| 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
 +
|-
 +
| 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
 +
|-
 +
| globalCharge || Cargo 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
 +
|-
 +
| 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
 
|}
 
|}
 +
 +
<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=====
 
=====A tener Presente=====
 +
----
 
* Todos los campos deben estar presentes a excepción de prepaidAmount
 
* Todos los campos deben estar presentes a excepción de prepaidAmount
 
* Si no tiene valor, debe ir con: 0.00
 
* Si no tiene valor, debe ir con: 0.00

Revisión actual del 16:20 14 jul 2025

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) que corresponde a la suma de descuentos aplicados a nivel de items
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) que corresponde a la suma de cargos aplicados a nivel de items
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
globalCharge Cargo 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=2847»