Diferencia entre revisiones de «API LaFactura.co:Invoice»
(→Campos) |
(→Campos) |
||
(No se muestran 153 ediciones intermedias del mismo usuario) | |||
Línea 1: | Línea 1: | ||
==Objeto:invoice== | ==Objeto:invoice== | ||
− | Es el objeto raiz, del sistema de envio de facturas de nuestra '''API''', es importante respetar todos los elementos aquí contemplados. | + | Es el objeto raiz, del sistema de envio de <b>facturas, documentos soporte, POS electrónico y Peajes</b> de nuestra '''API''', es importante respetar todos los elementos aquí contemplados.<br/> |
+ | <br><br> | ||
+ | Ingreso: | ||
+ | <nowiki>https://***.tas-la.com/facturacion.v30/invoice/</nowiki> | ||
+ | |||
+ | <b>Solicita tu usuario y contraseña +57-601-7466664</b> | ||
+ | No cobramos por el proceso de pruebas o desarrollo | ||
+ | Y puedes empezar inmediatamente (sin certificados o papeleos) | ||
+ | <br> | ||
+ | <small> | ||
+ | * Los "Documentos Soporte", Solo están presentes en el API v3.0 | ||
+ | </small> | ||
+ | |||
=====Ejemplo===== | =====Ejemplo===== | ||
Línea 6: | Línea 18: | ||
"invoice": | "invoice": | ||
{ | { | ||
− | " | + | "prefix":"SETP", |
"intID":"1", | "intID":"1", | ||
"issueDate":"20200317", | "issueDate":"20200317", | ||
"issueTime":"100521", | "issueTime":"100521", | ||
− | |||
"paymentType" : "2", | "paymentType" : "2", | ||
"paymentCode" : "1", | "paymentCode" : "1", | ||
Línea 18: | Línea 29: | ||
"additionalAccountID":"1", | "additionalAccountID":"1", | ||
"name":"Pepito Perez y Compania S.A.", | "name":"Pepito Perez y Compania S.A.", | ||
− | |||
− | |||
"city":"Bogotá D.C.", | "city":"Bogotá D.C.", | ||
− | |||
"countrySubentity":"11001", | "countrySubentity":"11001", | ||
"addressLine":"Av 25 No. 8-47", | "addressLine":"Av 25 No. 8-47", | ||
Línea 27: | Línea 35: | ||
"documentType":"31", | "documentType":"31", | ||
"telephone":"3112196952", | "telephone":"3112196952", | ||
− | "email":"[email protected] | + | "email":"[email protected]" |
− | |||
}, | }, | ||
"amounts":{ | "amounts":{ | ||
"totalAmount":"120000.00", | "totalAmount":"120000.00", | ||
"discountAmount":"4000.00", | "discountAmount":"4000.00", | ||
− | |||
"taxAmount":"18240.00", | "taxAmount":"18240.00", | ||
"payAmount":"134240.00" | "payAmount":"134240.00" | ||
Línea 45: | Línea 51: | ||
"brand":"LF", | "brand":"LF", | ||
"model":"Soporte", | "model":"Soporte", | ||
− | |||
− | |||
"code": "1000", | "code": "1000", | ||
"allowance":[ | "allowance":[ | ||
Línea 54: | Línea 58: | ||
"description":"Es un super descuento por hoy", | "description":"Es un super descuento por hoy", | ||
"baseAmount":"100000.00", | "baseAmount":"100000.00", | ||
− | "amount":"4000 | + | "amount":"4000.00" |
− | |||
} | } | ||
], | ], | ||
Línea 73: | Línea 76: | ||
"brand":"LF", | "brand":"LF", | ||
"model":"Serv1", | "model":"Serv1", | ||
− | |||
− | |||
"code": "1001" | "code": "1001" | ||
} | } | ||
− | + | ] | |
− | + | } | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
} | } | ||
Línea 113: | Línea 107: | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
− | ! Parámetro !! Descripción !! Tipo !! Obligatorio !! | + | ! Parámetro !! Descripción !! Tipo !! Obligatorio !! <small>Factura (F)<br/>Documento Soporte (DS)<br/>Documento Equivalente (DE)</small> |
+ | |- | ||
+ | | prefix || Prefijo del rango a ser utilizado<br/><small>Los prefijos disponibles los puedes obtener usando el servicio de [[API_LaFactura.co:Rangos_Facturacion|getRanges]]|| cadena || SI || F/DS/DE | ||
|- | |- | ||
− | | | + | | intID || Identificador único, de este documento en tu base de datos<br><small>Esta valor se utiliza como control para evitar repetir documentos en el sistema (Alfanumerico)</small>|| cadena || SI|| F/DS/DE |
|- | |- | ||
− | | | + | | issueDate || Fecha del documento<br><small>(YYYYMMDD) Ejemplo: 20200321<br/>No puede ser: <b>Menor de 8 dias a la fecha actual o mayor al dia de hoy</b><br/>|| cadena || SI || F/DS/DE |
|- | |- | ||
− | | | + | | issueTime || Hora del documento<br><small>(HHMMSS) Ejemplo: 175430</small> La Hora debe ser GMT -5 || cadena || SI || F/DS/DE |
|- | |- | ||
− | | | + | | dueDate || Fecha de vencimiento<br><small>(YYYYMMDD) Ejemplo: 20200421<br/><b>En caso de no enviarse, se utilizará el mismo issueDate</b><br/>Nunca deberá ser menor a la fecha de la factura</small> || cadena || NO || F/DS/DE |
|- | |- | ||
− | | | + | | paymentType || Tipo de pago<br><small>Contado->1 / Credito->2</small> || cadena || SI || F/DS/DE |
|- | |- | ||
− | | | + | | paymentCode || Medio de pago<br/><small><br/>[[API_LaFactura.co:Tabla_Tipos_Medios_Pago|consultar tabla]]</small> || cadena || SI || F/DS/DE |
|- | |- | ||
− | | | + | | note1 || Valor del documento en letras<br/><small>Esto se hace para ayudar a tener una representación gráfica de alta calidad para el cliente final</small> || cadena || SI || F/DS/DE |
|- | |- | ||
− | | | + | | note2 || Nota para ser agregada en el documento<br/><small>Aparece en el PDF</small>|| cadena || NO || F/DS/DE |
|- | |- | ||
− | | | + | | note3 || Nota para ser agregada en el documento<br/><small>Aparece en el PDF</small> || cadena || NO || F/DS/DE |
|- | |- | ||
− | | | + | | note4 || Nota para ser agregada en el documento<br/><small>Aparece en el PDF</small> || cadena || NO || F/DS/DE |
|- | |- | ||
− | | | + | | order || Datos correspondientes a la orden de compra del cliente<br/><small>(Solo en facturas)<br/>Ir a: [[API_laFactura.co:order|order]]</small> || objeto || NO || F/DE |
|- | |- | ||
− | | | + | | additionalOrder || Datos correspondientes a la orden de compra del cliente<br/><small>(Solo en facturas)<br/>Ir a: [[API_laFactura.co:order|order]]</small> || objeto || NO || F/DE |
|- | |- | ||
− | | | + | | period || Periodo de facturación<br/><small>(Solo en facturas)<br/>Grupo adicional para informar un Periodo de facturación<br><b>Importante: debe ir incluido si se usa el objeto "salud"</b><br>Ir a: [[API_laFactura.co:period|period]]</small> || objeto || NO || F |
|- | |- | ||
− | | | + | | prepaid || Pagos anticipados<br/><small>Grupo adicional para informar un Pago Anticipado<br>Ir a: [[API_laFactura.co:prePaid|prepaid]]</small> || objeto || NO || F/DE |
|- | |- | ||
− | | | + | | delivery || Datos de envío<br/><small>Grupo adicional para informar Datos y terminos de envío<br>Ir a: [[API_laFactura.co:delivery|delivery]]</small> || objeto || NO || F |
|- | |- | ||
− | | | + | | exchangeRate || Tasas de cambio<small><br>Solo se requiere cuando se trata de un documento generado a una empresa extranjera<br/>Si se envía y es el documentType <> 42 es rechazado<br>Ir a: [[API_laFactura.co:exchangeRate|exchangeRate]]</small> || objeto || NO || F/DS/DE |
|- | |- | ||
− | | | + | | AIU || Facturas de tipo AIU<br/><small>Grupo adicional para informar facturas de AIU (Administración / Imprevistos / Utilidad)<br>* No se envia en conjuncion con supplier, salud o equivalente<br/>Ir a: [[API_laFactura.co:AIU|AIU]]</small> || objeto || NO || F |
|- | |- | ||
− | | additional || Objeto con elementos complementarios<small><br>Relaciona elementos específicos para algunos clientes especiales<br/><b>Objetos:</b><br/>[[API_LaFactura.co: | + | | equivalente || <b>Documentos equivalentes</b><br/><b>POS Electrónico, Peajes y demás complementarios</b><br/><small>Información complementara requerida para generar documentos equivalentes<br/>La resolución de la DIAN definitiva del documento técnico v1.9 <b>Salió en noviembre de 2.023</b>. <br/>* No se envia en conjunción con AIU, supplier o salud<br>Ir a: [[API_laFactura.co:equivalente|equivalente]]</small> || objeto || NO || DE |
+ | |- | ||
+ | | poa || <b>(PowerOfAttorney) Datos del mandatario</b><br><small>* Se envia únicamente cuando se trata de factura por mandato</br>Ir a: [[API_laFactura.co:mandato|mandato]]<br/></small> || objeto / cadena || <small>SI/NO</small>||F/DE | ||
+ | |- | ||
+ | | customer || <b>Datos del cliente (Para generar facturas)</b><br><small>* Se envia únicamente cuando se trata de factura<br/>* NO se envia cuando se trata de documento soporte.</br>Ir a: [[API_laFactura.co:customer|customer]]<br/><b>=============================<br/>En lugar de un objeto, también se puede enviar una cadena "consumidor final"<br/> y nuestro sistema la convertirá en un objeto estándard de customer con los valores por defecto para consumidor final<br/>=============================<br/></b></small> || objeto / cadena || <small>SI/NO</small>||F/DE | ||
+ | |- | ||
+ | | supplier || <b>Datos del proveedor (Para generar documento soporte)</b><br><small>* Se envia únicamente cuando se trata de documento soporte<br/>* NO se envia cuando se trata de factura.</br>Ir a: [[API_laFactura.co:supplier|supplier]]</small> || objeto || <small>SI/NO</small> ||DS | ||
+ | |- | ||
+ | | whTaxes || Retenciones efectuadas al documento (para NO autoretenedores)<br><small>Ir a: [[API_laFactura.co:whTaxes|whTaxes]]</small> || objeto || NO || F/DS/DE | ||
+ | |- | ||
+ | | amounts || Totales del documento<br><small>Ir a: [[API_laFactura.co:amounts|amounts]]</small> || objeto || SI || F/DS/DE | ||
+ | |- | ||
+ | | items || Líneas del documento<br><small>(Debe existir almenos una)<br>Ir a: [[API_LaFactura.co:items|items]]</small> || objeto || <small>SI/NO<br/>Algunos casos no lo requieren: (AIU)</small> || F/DS/DE | ||
+ | |- | ||
+ | | salud || <b>Manejo de informacion complementaria (Facturas del sector salud)</b><br/><small>(Solo en facturas)<br/>Conjunto de informacion requerida para emisión de facturas del sector salud<br/>* No se envia en conjunción con AIU o supplier<br/><small>Ir a: [[API_laFactura.co:salud|salud]]</small> || objeto || NO || F | ||
+ | |- | ||
+ | | additional || Objeto con elementos complementarios<small><br>Relaciona elementos específicos para algunos clientes especiales<br/><b>Objetos:</b><br/>[[API_LaFactura.co:documento.gn|documento_gn]] <b>(Requerido para usuarios que manejan su consecutivo de facturación)</b><br/>[[API_LaFactura.co:email|email]] <b>(Para utilizar un formato completamente personalizado de correo electrónico -Requiere autorizacion-)</b></small>|| objeto || NO || F/DS | ||
|} | |} | ||
+ | |||
+ | <br/> | ||
=====Resultados===== | =====Resultados===== | ||
Línea 163: | Línea 177: | ||
"text":"Operación realizada con exito" | "text":"Operación realizada con exito" | ||
}, | }, | ||
− | " | + | "document":{ |
"type":"Factura", | "type":"Factura", | ||
"mode":"Creation", | "mode":"Creation", | ||
− | "tascode":"fc- | + | "tascode":"fc-16fc1cfdd2d42f27492691ba30cee903382f2-v301", |
"intID":"1", | "intID":"1", | ||
− | "document":" | + | "document":"SETP-2092092", |
"CUFE":"43059843095203948093248093483048039248093403298409328490348903483094", | "CUFE":"43059843095203948093248093483048039248093403298409328490348903483094", | ||
− | "process":0 | + | "process":"0", |
− | } | + | "retries":"0" |
+ | }, | ||
+ | "prefix":{ | ||
+ | "prefix":"SETP", | ||
+ | "from":"990000000", | ||
+ | "to":"995000000", | ||
+ | "last":"990000102", | ||
+ | "remaining":"4999898", | ||
+ | "firstDate":"20200223", | ||
+ | "lastDate":"20210223", | ||
+ | "description":"", | ||
+ | "DIANKey":"0934092940390932093292309023", | ||
+ | "auth":"18760000001" | ||
+ | } | ||
} | } | ||
} | } |
Revisión actual del 16:12 3 dic 2024
Sumario
Objeto:invoice
Es el objeto raiz, del sistema de envio de facturas, documentos soporte, POS electrónico y Peajes de nuestra API, es importante respetar todos los elementos aquí contemplados.
Ingreso: https://***.tas-la.com/facturacion.v30/invoice/ Solicita tu usuario y contraseña +57-601-7466664 No cobramos por el proceso de pruebas o desarrollo Y puedes empezar inmediatamente (sin certificados o papeleos)
- Los "Documentos Soporte", Solo están presentes en el API v3.0
Ejemplo
{ "invoice": { "prefix":"SETP", "intID":"1", "issueDate":"20200317", "issueTime":"100521", "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.", "city":"Bogotá D.C.", "countrySubentity":"11001", "addressLine":"Av 25 No. 8-47", "documentNumber":"900900651", "documentType":"31", "telephone":"3112196952", "email":"[email protected]" }, "amounts":{ "totalAmount":"120000.00", "discountAmount":"4000.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", "code": "1000", "allowance":[ { "charge":"false", "reasonCode":"11", "description":"Es un super descuento por hoy", "baseAmount":"100000.00", "amount":"4000.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", "code": "1001" } ] } }
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 | Factura (F) Documento Soporte (DS) Documento Equivalente (DE) |
---|---|---|---|---|
prefix | Prefijo del rango a ser utilizado Los prefijos disponibles los puedes obtener usando el servicio de getRanges |
cadena | SI | F/DS/DE |
intID | Identificador único, de este documento en tu base de datos Esta valor se utiliza como control para evitar repetir documentos en el sistema (Alfanumerico) |
cadena | SI | F/DS/DE |
issueDate | Fecha del documento (YYYYMMDD) Ejemplo: 20200321 No puede ser: Menor de 8 dias a la fecha actual o mayor al dia de hoy |
cadena | SI | F/DS/DE |
issueTime | Hora del documento (HHMMSS) Ejemplo: 175430 La Hora debe ser GMT -5 |
cadena | SI | F/DS/DE |
dueDate | Fecha de vencimiento (YYYYMMDD) Ejemplo: 20200421 En caso de no enviarse, se utilizará el mismo issueDate Nunca deberá ser menor a la fecha de la factura |
cadena | NO | F/DS/DE |
paymentType | Tipo de pago Contado->1 / Credito->2 |
cadena | SI | F/DS/DE |
paymentCode | Medio de pago consultar tabla |
cadena | SI | F/DS/DE |
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 | F/DS/DE |
note2 | Nota para ser agregada en el documento Aparece en el PDF |
cadena | NO | F/DS/DE |
note3 | Nota para ser agregada en el documento Aparece en el PDF |
cadena | NO | F/DS/DE |
note4 | Nota para ser agregada en el documento Aparece en el PDF |
cadena | NO | F/DS/DE |
order | Datos correspondientes a la orden de compra del cliente (Solo en facturas) Ir a: order |
objeto | NO | F/DE |
additionalOrder | Datos correspondientes a la orden de compra del cliente (Solo en facturas) Ir a: order |
objeto | NO | F/DE |
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 "salud" Ir a: period |
objeto | NO | F |
prepaid | Pagos anticipados Grupo adicional para informar un Pago Anticipado Ir a: prepaid |
objeto | NO | F/DE |
delivery | Datos de envío Grupo adicional para informar Datos y terminos de envío Ir a: delivery |
objeto | NO | F |
exchangeRate | Tasas de cambio Solo se requiere cuando se trata de un documento generado a una empresa extranjera Si se envía y es el documentType <> 42 es rechazado Ir a: exchangeRate |
objeto | NO | F/DS/DE |
AIU | Facturas de tipo AIU Grupo adicional para informar facturas de AIU (Administración / Imprevistos / Utilidad) * No se envia en conjuncion con supplier, salud o equivalente Ir a: AIU |
objeto | NO | F |
equivalente | Documentos equivalentes POS Electrónico, Peajes y demás complementarios Información complementara requerida para generar documentos equivalentes La resolución de la DIAN definitiva del documento técnico v1.9 Salió en noviembre de 2.023. * No se envia en conjunción con AIU, supplier o salud Ir a: equivalente |
objeto | NO | DE |
poa | (PowerOfAttorney) Datos del mandatario * Se envia únicamente cuando se trata de factura por mandato Ir a: mandato |
objeto / cadena | SI/NO | F/DE |
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 ============================= En lugar de un objeto, también se puede enviar una cadena "consumidor final" y nuestro sistema la convertirá en un objeto estándard de customer con los valores por defecto para consumidor final ============================= |
objeto / cadena | SI/NO | F/DE |
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 | DS |
whTaxes | Retenciones efectuadas al documento (para NO autoretenedores) Ir a: whTaxes |
objeto | NO | F/DS/DE |
amounts | Totales del documento Ir a: amounts |
objeto | SI | F/DS/DE |
items | Líneas del documento (Debe existir almenos una) Ir a: items |
objeto | SI/NO Algunos casos no lo requieren: (AIU) |
F/DS/DE |
salud | Manejo de informacion complementaria (Facturas del sector salud) (Solo en facturas) Conjunto de informacion requerida para emisión de facturas del sector salud * No se envia en conjunción con AIU o supplier Ir a: salud |
objeto | NO | F |
additional | Objeto con elementos complementarios Relaciona elementos específicos para algunos clientes especiales Objetos: documento_gn (Requerido para usuarios que manejan su consecutivo de facturación) email (Para utilizar un formato completamente personalizado de correo electrónico -Requiere autorizacion-) |
objeto | NO | F/DS |
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" }, "document":{ "type":"Factura", "mode":"Creation", "tascode":"fc-16fc1cfdd2d42f27492691ba30cee903382f2-v301", "intID":"1", "document":"SETP-2092092", "CUFE":"43059843095203948093248093483048039248093403298409328490348903483094", "process":"0", "retries":"0" }, "prefix":{ "prefix":"SETP", "from":"990000000", "to":"995000000", "last":"990000102", "remaining":"4999898", "firstDate":"20200223", "lastDate":"20210223", "description":"", "DIANKey":"0934092940390932093292309023", "auth":"18760000001" } } }
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
- exchangeRate (Tasas - Para ventas en Dólares)
- customer (Cliente)
- amounts (Montos)
- items (Lineas de la factura)
Usado por
Los siguientes recursos:
Temas complementarios
Enlaces
- LaFactura.co: https://lafactura.co
- GitHub: https://github.com/FacturacionElectronicaColombia/lafactura.co
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.