API LaFactura.co:Invoice

De API LaFactura.co
Ir a la navegación Ir a la búsqueda

Objeto:invoice

Es el objeto raiz, del sistema de envio de facturas y documentos soporte de nuestra API, es importante respetar todos los elementos aquí contemplados.

  • Los "Documentos Soporte", Solo están presentes en el API v3.0

Ejemplo
 {
   "invoice":
   {
     "rangeKey":"219832728",
     "intID":"1",
     "issueDate":"20200317",
     "issueTime":"100521",
     "dueDate" : "20200417",
     "paymentType" : "2",
     "paymentCode"  : "1",
     "note1" : "CIENTO TREINTA Y CUATRO MIL DOSCIENTOS CUARENTA PESOS",
     "note2" : "Esta es una nota en la factura",
     "customer" : {
          "additionalAccountID":"1",
          "name":"Pepito Perez y Compania S.A.",
          "countryName":"Colombia",
          "countryCode":"CO",
          "city":"Bogotá D.C.",
          "countryEntity":"11",
          "countrySubentity":"11001",
          "addressLine":"Av 25 No. 8-47",
          "documentNumber":"900900651",
          "documentType":"31",
          "telephone":"3112196952",
          "email":"[email protected]",
          "emailStyle":"0"
     },
     "amounts":{
          "totalAmount":"120000.00",
          "discountAmount":"4000.00",
          "extraAmount":"0.00",
          "taxAmount":"18240.00",
          "payAmount":"134240.00"
     },
     "items":[
         {
           "quantity":"5.00",
           "unitPrice":"20000.00",
           "total":"96000.00",
           "description":"Horas de soporte remoto",
           "brand":"LF",
           "model":"Soporte",
           "standard": "999",
           "agency": "990",
           "code": "1000",
           "allowance":[
                {
                  "charge":"false",
                  "reasonCode":"11",
                  "description":"Es un super descuento por hoy",
                  "baseAmount":"100000.00",
                  "amount":"4000.00",
                  "percent":"4.00"
                }                    
           ],
           "taxes":[
                {
                  "ID":"01",
                  "taxAmount":"18240.00",
                  "percent":"19.00"
                }
            ]
         },
         {
           "quantity":"1.00",
           "unitPrice":"20000.00",
           "total":"20000.00",
           "description":"Servicio sin IVA",
           "brand":"LF",
           "model":"Serv1",
           "standard": "999",
           "agency": "990",
           "code": "1001"
         }
   ],
   "additional":{
        "payment":{
            "link":"https://linkdepago.com/id=1",
            "message":"PAGAR",
            "color":"#496591"
         }
    }
  }
}
Explicacion

Se está solicitando la creación de una factura por un total de $134.240 Pesos, para el cliente Pepito Perez y Compañía SA, con:

Item 1:

  • 5 Horas de soporte remoto con un costo unitario de $20.000, para un total de $100.000
  • A estas 5 horas se les hizo un descuento del 4% ($4.000), para un total de $96.000
  • Se le aplicó el IVA al valor de la línea ($18.240)

Item 2:

  • 1 Hora de servicio sin IVA por un valor de $20.000

Totales:

  • El total antes de impuestos es de $116.000
  • Los impuestos son: $ 18.240
  • El total en factura en: $ 134.240

Adicionalmente en el correo enviado al cliente va un boton de "PAGAR", que lleva a un link. (Esta opción NO está disponible para todos los clientes)

Campos
Parámetro Descripción Tipo Obligatorio Notas API
rangeKey Identificador único, del rango de facturación/Documento-soporte a ser usado
Esta valor es el resultado del servicio: Obtener Rangos		 cadena SI v2.0 / v3.0
intID Identificador único, de este documento en tu base de datos
Esta valor se utiliza como control para evitar repetir documentos en el sistema		 cadena SI v2.0 / v3.0
issueDate Fecha del documento
(YYYYMMDD) Ejemplo: 20200321
No puede ser -/+ 5 Dias de la fecha actual		 cadena SI v2.0 / v3.0
issueTime Hora del documento
(HHMMSS) Ejemplo: 175430		 cadena SI v2.0 / v3.0
dueDate Fecha de vencimiento
(YYYYMMDD) Ejemplo: 20200421
Nunca deberá ser menor a la fecha de la factura		 cadena SI v2.0 / v3.0
paymentType Tipo de pago
Contado->1 / Credito->2
Por omisión el sistema supone Credito -> "2"		 cadena NO v2.0 / v3.0
paymentCode Medio de pago
Por omisión supone Instrumento No Definido -> "1"
consultar tabla		 cadena NO v2.0 / v3.0
note1 Valor del documento en letras
Esto se hace para ayudar a tener una representación gráfica de alta calidad para el cliente final		 cadena SI v2.0 / v3.0
note2 Nota para ser agregada en el documento
Aparece en el PDF		 cadena NO v2.0 / v3.0
note3 Nota para ser agregada en el documento
Aparece en el PDF		 cadena NO v2.0 / v3.0
note4 Nota para ser agregada en el documento
Aparece en el PDF		 cadena NO v2.0 / v3.0
order
additionalOrder		 Datos correspondientes a la orden de compra del cliente
(Solo en facturas)
Ir a: order		 objeto NO v3.0
period Periodo de facturación
(Solo en facturas)
Grupo adicional para informar un Periodo de facturación
Importante: debe ir incluido si se usa el objeto "minsalud" -> API v3.0
Ir a: period		 objeto NO v2.0 / v3.0
prepaid Pagos anticipados
Grupo adicional para informar un Pago Anticipado
Ir a: prepaid		 objeto NO v2.0 / v3.0
exchangeRate Tasas de cambio
Solo se requiere cuando se trata de un documento generado a un extranjero (Empresa o Persona)
Si se envía y el cliente es Colombiano, es rechazado
Ir a: exchangeRate		 objeto NO v2.0 / v3.0
customer Datos del cliente (Para generar facturas)
* Se envia únicamente cuando se trata de factura
* NO se envia cuando se trata de documento soporte.
Ir a: customer		 objeto SI -> para v2.0
SI/NO -> para v3.0		 v2.0 / v3.0
supplier Datos del proveedor (Para generar documento soporte)
* Se envia únicamente cuando se trata de documento soporte
* NO se envia cuando se trata de factura.
Ir a: supplier		 objeto SI/NO -> para v3.0 v3.0
whTaxes Retenciones efectuadas al documento (para NO autoretenedores)
Ir a: whTaxes		 objeto NO v3.0
amounts Totales del documento
Ir a: amounts		 objeto SI v2.0 / v3.0
items Líneas del documento
(Debe existir almenos una)
Ir a: items		 objeto SI v2.0 / v3.0
minsalud Manejo de informacion para el sector salud
(Solo en facturas)
Conjunto de informacion requerida para emisión de facturas del sector salud
Ir a: minsalud		 objeto NO v3.0
additional Objeto con elementos complementarios
Relaciona elementos específicos para algunos clientes especiales
Objetos:
usuarios.ms (Sector Salud) -> Solo API v2.0 (ahora obsoleto)
documento.gn (Requerido para usuarios que manejan su consecutivo de facturación) -> Solo API v3.0		 objeto NO v2.0 / v3.0

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

  • Se agregó el objeto order para enviar datos referente a un numero de orden emitida por el cliente
  • Se agregó un nuevo objeto para el sector salud "minsalud"
  • Se eliminó el objeto usuarios.ms (El cual pasó a ser parte del objeto "minsalud")
  • Se agregó el objeto documento.gn, para aquellos usuarios que administran su propio consecutivo.


Importante:

  • Este objeto sirve ahora para generar Facturas y Documentos de soporte
  • Para diferenciar fácilmente el uno del otro, las Facturas llevan el objeto "customer" y los documentos equivalentes el objeto "supplier"
  • Si colocas el objeto "supplier", no se aceptan: "order", "period", "exchangeRate", "minsalud"


Resultados

Devuelve un objeto invoiceResult con el resultado de la operación
Importante: Verifica toda la informacion que invoiceResult devuelve ingresando al objeto. 

 {
   "invoiceResult":{
       "status":{
          "code":200,
          "text":"Operación realizada con exito"
       },
       "documento":{
          "type":"Factura",
          "mode":"Creation",
          "tascode":"fc-54984309jtr0ret90jjrg",
          "intID":"1",
          "document":"FC-2092092",
          "CUFE":"43059843095203948093248093483048039248093403298409328490348903483094",
          "process":"0",
          "retries":"0"
       }
   }
 }
A tener presente
  • El resultado incluye el campo "tascode", que es el codigo único interno en nuestro sistema e identifica el documento. Es requerido para cualquier acción posterior sobre este documento. (Es importante conservarlo)
  • No se debe considerar un documento como válido por la DIAN, hasta que el resultado de una verificación del documento, muestre a process con: 2

Objetos empleados

Usado por

Los siguientes recursos:

Temas complementarios

Enlaces

Importante

Recuerda que nosotros no te cobramos absolutamente nada por que pruebes nuestra plataforma.
Si deseas tener un usuario y contraseña , comunícate con nosotros.

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