Diferencia entre revisiones de «API LaFactura.co:InvoiceResult»
Línea 104: | Línea 104: | ||
| ATTACHED || Dirección para descarga del XML del xml enviado al cliente<br/><small>Esta opción se agrega para ayudar a algunos sistemas.<br/>Recomendamos almacenar el resultado de <b>URL<b></small> || cadena || Solo si está Aceptado por la DIAN<br/><small>(Solo para documentos generados desde Enero 10 - 2021)</small> || v2.0 / v3.0 | | ATTACHED || Dirección para descarga del XML del xml enviado al cliente<br/><small>Esta opción se agrega para ayudar a algunos sistemas.<br/>Recomendamos almacenar el resultado de <b>URL<b></small> || cadena || Solo si está Aceptado por la DIAN<br/><small>(Solo para documentos generados desde Enero 10 - 2021)</small> || v2.0 / v3.0 | ||
|} | |} | ||
+ | |||
+ | ===prefix / prefix=== | ||
+ | Información referente al rango utilizado en la operación: <b>En beta para los usuarios que usan el elemento "prefix" en lugar de "rangeKey"</b> | ||
+ | ---- | ||
+ | |||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! Parámetro !! Descripción !! Tipo !! Obligatorio !! API | ||
+ | |- | ||
+ | | prefix || Prefijo utilizado para la elaboración de este documento || cadena || SI || v3.0 | ||
+ | |- | ||
+ | | from || Primero numero del rango en uso || cadena || SI || v3.0 | ||
+ | |- | ||
+ | | to || Último número del rango en uso|| cadena || SI || v3.0 | ||
+ | |- | ||
+ | | last || Último número utilizado|| cadena || SI || v3.0 | ||
+ | |- | ||
+ | | remaining || Cantidad de documentos disponibles || cadena || SI || v3.0 | ||
+ | |- | ||
+ | | firstDate || Fecha inicial de la resolución en uso || cadena || En facturas || v3.0 | ||
+ | |- | ||
+ | | lastDate || Fecha final de la resolución en uso || cadena || Para Notas Débito y Credito || v3.0 | ||
+ | |- | ||
+ | | descriptuon || Discripción libre del rango || cadena || Para Documento Soporte || v3.0 | ||
+ | |- | ||
+ | | DIANKey || Clave técnica del rango en la DIAN || cadena || SI || v3.0 | ||
+ | |- | ||
+ | | auth || Número de resolución de la DIAN|| cadena || SI || v3.0 | ||
+ | |} | ||
+ | |||
<span style="color:#009999"><b>Notas para migrantes de API v2.0 a v3.0:</b></span> | <span style="color:#009999"><b>Notas para migrantes de API v2.0 a v3.0:</b></span> |
Revisión del 14:25 16 nov 2023
Sumario
Objeto: invoiceResult/radianResult
Entrega la información básica correspondiente a un documento en el sistema. Es el resultado ante cualquier operacion relacionada con facturación, tales como Generar, Verificar o Anular documentos.
Ejemplo
Es el resultado ante los eventos de Generar, Anular o Verificar Factura
{ "invoiceResult":{ "status":{ "code": 200, "text":"Operación realizada con exito", }, "document":{ "type":"Factura", "mode":"Creation", "tascode":"fc-54984309jtr903840932480", "intID":"1", "document":"FACT-2092092", "CUFE":"0092183901238098123092109383403298409328490348903483094", "process":"1", "retries":"0", "customer":"0", "enhancedInfo":null }, "prefix":{ "prefix":"SETP", "from":"990000000", "to":"995000000", "last":"990000102", "remaining":"4999898", "firstDate":"20200223", "lastDate":"20210223", "description":"", "DIANKey":"0934092940390932093292309023", "auth":"18760000001" } } }
Explicacion
- El resultado fue exitoso (200)
- En texto: Operación realizada con exito
- Se trata de una factura
- El resultado fue en la operacion de creacion de factura
- El codigo interno del documento es: fc-54984309jtr903840932480
- El documento generado es: FACT-2091092
- El CUFE del documento: 0092183901238098123092109383403298409328490348903483094
- El estado actual del documento es: "Enviando"
- El numero de reintentos es 0
status
Entrega la información referente a la operacioón realizada en los siguientes campos:
Parámetro | Descripción | Tipo | Obligatorio | API |
---|---|---|---|---|
code | valor correspondiente al estado: 200 -> OK consultar tabla |
numérico | SI | v2.0 / v3.0 |
text | texto explicativo del error | cadena | SI | v2.0 / v3.0 |
documento / document
Información referente al documento al que se hace relación:
Parámetro | Descripción | Tipo | Obligatorio | API |
---|---|---|---|---|
type | Tipo de documento: "Factura" / ¨Factura Transporte" / "Factura Salud" / "Nota Credito" / "Nota Débito" / "Documento Soporte" / "Documento Ajuste Soporte" | cadena | SI | v3.0 |
mode | Resultado por "Creation"->Creación / "Verify"->Verificación | cadena | SI | v3.0 |
tascode | Código interno del documento generado (Requerido para posteriores acciones) | cadena | SI | v3.0 |
intID | Código interno del documento en tu base de datos | cadena | SI | v3.0 |
document | Número del documento generado segun consecutivo DIAN | cadena | SI | v3.0 |
CUFE | Código único de la factura DIAN | cadena | En facturas | v3.0 |
CUDE | Código único de documento electrónico DIAN | cadena | Para Notas Débito y Credito | v3.0 |
CUDS | Código único de documento electrónico DIAN | cadena | Para Documento Soporte | v3.0 |
process | Estado de proceso: 0 -> Enviando 1 -> Verificando 2 -> Aceptado DIAN 78 -> Reintentando DIAN (API v3.0) Mayor que 90 -> Rechazado DIAN |
cadena | SI | v3.0 |
retries | Reintentos de envio a la DIAN | cadena | SI | v3.0 |
customer | Estado de aceptacion del documento por el cliente final 0->Desconocido, 1->Aceptado, 2->Rechazado (Nuevo campo en API v3.0) |
cadena | SI | v3.0 |
enhancedInfo | Información ampliada de estados de Error y notificación DIAN | cadena | SI | v3.0 |
URL | Dirección para descarga del Documento aceptado por la DIAN (formato ZIP) Contiene PDF (Representación gráfica del Documento) Contiene XML (Attached Document DIAN del Documento) |
cadena | Solo si está Aceptado por la DIAN | v3.0 |
Dirección para descarga del PDF de la factura generada Esta opción se agrega para ayudar a algunos sistemas. Recomendamos almacenar el resultado de URL |
cadena | Solo si está Aceptado por la DIAN (Solo para documentos generados desde Enero 10 - 2021) |
v3.0 | |
ATTACHED | Dirección para descarga del XML del xml enviado al cliente Esta opción se agrega para ayudar a algunos sistemas. Recomendamos almacenar el resultado de URL |
cadena | Solo si está Aceptado por la DIAN (Solo para documentos generados desde Enero 10 - 2021) |
v2.0 / v3.0 |
prefix / prefix
Información referente al rango utilizado en la operación: En beta para los usuarios que usan el elemento "prefix" en lugar de "rangeKey"
Parámetro | Descripción | Tipo | Obligatorio | API |
---|---|---|---|---|
prefix | Prefijo utilizado para la elaboración de este documento | cadena | SI | v3.0 |
from | Primero numero del rango en uso | cadena | SI | v3.0 |
to | Último número del rango en uso | cadena | SI | v3.0 |
last | Último número utilizado | cadena | SI | v3.0 |
remaining | Cantidad de documentos disponibles | cadena | SI | v3.0 |
firstDate | Fecha inicial de la resolución en uso | cadena | En facturas | v3.0 |
lastDate | Fecha final de la resolución en uso | cadena | Para Notas Débito y Credito | v3.0 |
descriptuon | Discripción libre del rango | cadena | Para Documento Soporte | v3.0 |
DIANKey | Clave técnica del rango en la DIAN | cadena | SI | v3.0 |
auth | Número de resolución de la DIAN | cadena | SI | v3.0 |
Notas para migrantes de API v2.0 a v3.0:
- Se agregó retries, el cual permite conocer el numero de reintentos de envio de un documento a la DIAN
- Se agredó customer para conocer el estado de aceptacion o rechazo de un documento por pargte del cliente final
- Se eliminó accepted
- Se eliminó referal
A tener presente
- Puede tener objetos adicionales en su respuesta (Verifica el recurso usado para su llamado)
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.