Diferencia entre revisiones de «API LaFactura.co:Webhook»
Ir a la navegación
Ir a la búsqueda
(→Campos) |
|||
| (No se muestran 40 ediciones intermedias del mismo usuario) | |||
| Línea 6: | Línea 6: | ||
El objeto '''event''' lleva el resultado del evento ocurrido | El objeto '''event''' lleva el resultado del evento ocurrido | ||
| − | ====Ejemplo 1==== | + | |
| + | ====Ejemplo 1 (Estado de proceso del documento)==== | ||
---- | ---- | ||
{ | { | ||
"event":{ | "event":{ | ||
"tascode":"fc-ioeri98499843yuyw97397329382", | "tascode":"fc-ioeri98499843yuyw97397329382", | ||
| + | "intID":"212121", | ||
"date":"20210125102005", | "date":"20210125102005", | ||
"text":"Documento aprobado por la DIAN", | "text":"Documento aprobado por la DIAN", | ||
"process":{ | "process":{ | ||
"change":true, | "change":true, | ||
| − | "newValue":2 | + | "newValue":2, |
| + | "pdf"="https://***.tas-la.com/facturacion.v30/fc-34908349839483984938493848.pdf", | ||
| + | "url"="https://***.tas-la.com/facturacion.v30/fc-34908349839483984938493848.zip", | ||
| + | "attached"="https://***.tas-la.com/facturacion.v30/fc-34908349839483984938493848.xml" | ||
} | } | ||
} | } | ||
| Línea 25: | Línea 30: | ||
*Documento relacionado: fc-ioeri98499843yuyw97397329382 | *Documento relacionado: fc-ioeri98499843yuyw97397329382 | ||
| + | *El ID en tu sistema es 212121 | ||
*Fecha del evento: 2021-01-25 10:20:05 | *Fecha del evento: 2021-01-25 10:20:05 | ||
*Texto del evento: Documento aprobado por la DIAN | *Texto del evento: Documento aprobado por la DIAN | ||
*El evento informa que cambió el estado del documento (change: true) | *El evento informa que cambió el estado del documento (change: true) | ||
*El nuevo estado del documento es 2 (Aprobado por la DIAN) | *El nuevo estado del documento es 2 (Aprobado por la DIAN) | ||
| + | - como es un evento aprobado, adicionalmente trae los enlaces para descargar pdf, zip y xml | ||
| − | ====Ejemplo 2==== | + | ====Ejemplo 2 (Evento relacionado con correo)==== |
---- | ---- | ||
{ | { | ||
| Línea 37: | Línea 44: | ||
"date":"20210125102005", | "date":"20210125102005", | ||
"text":"El correo fué recibido por el buzón de [email protected]", | "text":"El correo fué recibido por el buzón de [email protected]", | ||
| − | |||
| − | |||
| − | |||
"email":{ | "email":{ | ||
"email":"[email protected]", | "email":"[email protected]", | ||
| − | " | + | "status":1 |
} | } | ||
} | } | ||
| Línea 54: | Línea 58: | ||
*Fecha del evento: 2021-01-25 10:20:05 | *Fecha del evento: 2021-01-25 10:20:05 | ||
*Texto del evento: El correo fué recibido por el buzón de [email protected] | *Texto del evento: El correo fué recibido por el buzón de [email protected] | ||
| − | *El evento | + | *El correo fué recibido efectivamente por el buzon status = (1) |
| − | *El | + | |
| + | |||
| + | ====Ejemplo 3 (Alerta general)==== | ||
| + | ---- | ||
| + | { | ||
| + | "event":{ | ||
| + | "date":"20210125102005", | ||
| + | "alert":"Al rango de facturas le queda disponible el 5% [0093493049]. Por favor renuevalo antes del vencimiento" | ||
| + | } | ||
| + | } | ||
| + | |||
| + | =====Explicacion===== | ||
| + | |||
| + | Se recibió un evento: | ||
| + | |||
| + | *Es una alerta: Al rango de facturas le queda disponible el 5% [0093493049]. Por favor renuevalo antes del vencimiento | ||
| + | *EL numero de la resolucion es: 0093493049 | ||
| + | *Fecha del evento: 2021-01-25 10:20:05 | ||
| + | |||
| + | |||
| + | ====Ejemplo 4 (Alerta en un documento)==== | ||
| + | ---- | ||
| + | { | ||
| + | "event":{ | ||
| + | "tascode":"fc-i98439839489834", | ||
| + | "date":"20210125102005", | ||
| + | "alert":"El cliente rechazó el documento", | ||
| + | "accept":2 | ||
| + | } | ||
| + | } | ||
| + | |||
| + | =====Explicacion===== | ||
| + | |||
| + | Se recibió un evento: | ||
| + | |||
| + | *Es una alerta: A un documento específico | ||
| + | *EL numero del tascode es: fc-i98439839489834 | ||
| + | *Fecha del evento: 2021-01-25 10:20:05 | ||
| + | |||
| + | |||
| + | ====Ejemplo 5 (Validación Errores asincronicos RADIAN)==== | ||
| + | ---- | ||
| + | { | ||
| + | "radianError":{ | ||
| + | "tascode":"rx-i98439839489834", | ||
| + | "intID":"09239023a12", | ||
| + | "date":"20250125102005", | ||
| + | "radianType":"031", | ||
| + | "radianError":1, | ||
| + | "radianMsg":"El documento ya contaba con un evento 031", | ||
| + | "CUFE":"0980980980989023840923840932840923840923840932840932489032849023849032843902820938" | ||
| + | } | ||
| + | } | ||
| + | |||
| + | =====Explicacion===== | ||
| + | |||
| + | Se encontró un error en un envio a RADIAN: | ||
| + | *EL numero del tascode es: rx-i98439839489834 | ||
| + | *Fecha del evento: 2025-01-25 10:20:05 | ||
| + | *El tipo de evento es: 031 | ||
| + | *El error fué: El documento ya contaba con un evento 031 | ||
| + | *El CUFE/CUDE del documento original es: 0980980980989023840923840932840923840923840932840932489032849023849032843902820938 | ||
| + | |||
=====Campos===== | =====Campos===== | ||
| + | ---- | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
| Línea 68: | Línea 135: | ||
| text || Información del evento en texto || cadena || SI | | text || Información del evento en texto || cadena || SI | ||
|- | |- | ||
| − | | process || Información del proceso || objeto || | + | | alert || Alerta generada || cadena || SI |
| + | |- | ||
| + | | process || Información del proceso<br/><small>Solo aparece cuando se trata de un cambio de estado del documento</small> || objeto || NO | ||
|- | |- | ||
| process->change || Si cambió el estado del documento (true/false) || boolean || SI | | process->change || Si cambió el estado del documento (true/false) || boolean || SI | ||
|- | |- | ||
| − | | process->newValue || El nuevo estado del documento (Solo si change=true)<br/><small>Estado de proceso 0 -> | + | | process->newValue || El nuevo estado del documento (Solo si change=true)<br/><small>Estado de proceso:<br/>0 -> En cola <br/>1 -> En proceso DIAN<br/>2 -> Aceptado DIAN<br/>77/78 -> Reintentando<br/>Mayor que 90 -> Rechazado DIAN</small> || numerico || SI/NO |
| + | |- | ||
| + | | process->pdf/zip/xml || Solo si newValue = 2, los enlaces para la descarga de los documentos generados|| cadena || SI/NO | ||
| + | |- | ||
| + | | email|| información de correo || cadena || NO | ||
| + | |- | ||
| + | | email->email || correo electronico del evento || cadena || SI<br/><small>Solo si el evento es relacionado con correos</small> | ||
| + | |- | ||
| + | | email->status || Estado de transporte de correos<br/><small>0 -> Correo enviado<br/>1->correo recibido<br/>2->correo rechazado<br>97-> dominio bloqueado por inexistente o estar en lista negra<br/>98-> correo en lista negra || numerico || SI<br/><small>Solo si el evento es relacionado con correos</small> | ||
| + | |- | ||
| + | | accept || Estado de aceptacion de un documento por un cliente<br/><small>1 -> Aceptado<br/>2->Rechazado || numerico || SI<br/><small>Solo si el evento es relacionado con aceptacion o rechazo de documentos</small> | ||
| + | |- | ||
| + | | radianType || Tipo de documento de RADIAN || cadena || SI<br/><small>Solo en eventos RADIAN</small> | ||
| + | |- | ||
| + | | radianError || Tipo de error de RADIAN<br/><small>1-> Evento reportado previamente<br/>2-> Documento inexistente en la DIAN<br/>3-> Tipo de documento no acepta eventos<br/>4-> No se puede enviar aceptacion tácita sobre un documento ajeno<br/>5-> No se puede enviar 030,031,032,033 sobre un documento propio<br/>6-> Faltan eventos previos para poder realizar el solicitado<br/>7-> Evento enviado fuera de la fecha máxima de aceptación</small> || numerico || SI<br/><small>Solo en eventos RADIAN</small> | ||
| + | |- | ||
| + | | radianMsg || Mensaje claro en español || cadena || SI<br/><small>Solo en eventos RADIAN</small> | ||
| + | |- | ||
| + | | CUFE || CUFE/CUDE del documento relacionado || cadena || SI<br/><small>Solo en eventos RADIAN</small> | ||
| + | |- | ||
| + | | intID || Código del documento en tu sistema || cadena || SI<br/><small>Solo en eventos RADIAN</small> | ||
|} | |} | ||
Revisión actual del 19:09 10 oct 2025
Sumario
Webhook
Por nuestro sistema de interconexión, podemos enviarte a una URL tuya, una respuesta de tipo automática cada vez que suceda un cambio de estado o un evento en tus documentos.
IMPORTANTE: Para recibir estas notificaciones, debes enviarnos por correo la url específica a la cual quieras que te enviemos los eventos. (La url debe en todo caso ser https)
Objeto:event
El objeto event lleva el resultado del evento ocurrido
Ejemplo 1 (Estado de proceso del documento)
{
"event":{
"tascode":"fc-ioeri98499843yuyw97397329382",
"intID":"212121",
"date":"20210125102005",
"text":"Documento aprobado por la DIAN",
"process":{
"change":true,
"newValue":2,
"pdf"="https://***.tas-la.com/facturacion.v30/fc-34908349839483984938493848.pdf",
"url"="https://***.tas-la.com/facturacion.v30/fc-34908349839483984938493848.zip",
"attached"="https://***.tas-la.com/facturacion.v30/fc-34908349839483984938493848.xml"
}
}
}
Explicacion
Se recibió un evento:
- Documento relacionado: fc-ioeri98499843yuyw97397329382
- El ID en tu sistema es 212121
- Fecha del evento: 2021-01-25 10:20:05
- Texto del evento: Documento aprobado por la DIAN
- El evento informa que cambió el estado del documento (change: true)
- El nuevo estado del documento es 2 (Aprobado por la DIAN)
- como es un evento aprobado, adicionalmente trae los enlaces para descargar pdf, zip y xml
Ejemplo 2 (Evento relacionado con correo)
{
"event":{
"tascode":"fc-ioeri98499843yuyw97397329382",
"date":"20210125102005",
"text":"El correo fué recibido por el buzón de [email protected]",
"email":{
"email":"[email protected]",
"status":1
}
}
}
Explicacion
Se recibió un evento:
- Documento relacionado: fc-ioeri98499843yuyw97397329382
- Fecha del evento: 2021-01-25 10:20:05
- Texto del evento: El correo fué recibido por el buzón de [email protected]
- El correo fué recibido efectivamente por el buzon status = (1)
Ejemplo 3 (Alerta general)
{
"event":{
"date":"20210125102005",
"alert":"Al rango de facturas le queda disponible el 5% [0093493049]. Por favor renuevalo antes del vencimiento"
}
}
Explicacion
Se recibió un evento:
- Es una alerta: Al rango de facturas le queda disponible el 5% [0093493049]. Por favor renuevalo antes del vencimiento
- EL numero de la resolucion es: 0093493049
- Fecha del evento: 2021-01-25 10:20:05
Ejemplo 4 (Alerta en un documento)
{
"event":{
"tascode":"fc-i98439839489834",
"date":"20210125102005",
"alert":"El cliente rechazó el documento",
"accept":2
}
}
Explicacion
Se recibió un evento:
- Es una alerta: A un documento específico
- EL numero del tascode es: fc-i98439839489834
- Fecha del evento: 2021-01-25 10:20:05
Ejemplo 5 (Validación Errores asincronicos RADIAN)
{
"radianError":{
"tascode":"rx-i98439839489834",
"intID":"09239023a12",
"date":"20250125102005",
"radianType":"031",
"radianError":1,
"radianMsg":"El documento ya contaba con un evento 031",
"CUFE":"0980980980989023840923840932840923840923840932840932489032849023849032843902820938"
}
}
Explicacion
Se encontró un error en un envio a RADIAN:
- EL numero del tascode es: rx-i98439839489834
- Fecha del evento: 2025-01-25 10:20:05
- El tipo de evento es: 031
- El error fué: El documento ya contaba con un evento 031
- El CUFE/CUDE del documento original es: 0980980980989023840923840932840923840923840932840932489032849023849032843902820938
Campos
| Parámetro | Descripción | Tipo | Obligatorio |
|---|---|---|---|
| tascode | Identificador único, del documento del evento | cadena | SI |
| date | Fecha del evento (YYYYMMDDHHMMSS) Ejemplo: 20210125102005 |
cadena | SI |
| text | Información del evento en texto | cadena | SI |
| alert | Alerta generada | cadena | SI |
| process | Información del proceso Solo aparece cuando se trata de un cambio de estado del documento |
objeto | NO |
| process->change | Si cambió el estado del documento (true/false) | boolean | SI |
| process->newValue | El nuevo estado del documento (Solo si change=true) Estado de proceso: 0 -> En cola 1 -> En proceso DIAN 2 -> Aceptado DIAN 77/78 -> Reintentando Mayor que 90 -> Rechazado DIAN |
numerico | SI/NO |
| process->pdf/zip/xml | Solo si newValue = 2, los enlaces para la descarga de los documentos generados | cadena | SI/NO |
| información de correo | cadena | NO | |
| email->email | correo electronico del evento | cadena | SI Solo si el evento es relacionado con correos |
| email->status | Estado de transporte de correos 0 -> Correo enviado 1->correo recibido 2->correo rechazado 97-> dominio bloqueado por inexistente o estar en lista negra 98-> correo en lista negra |
numerico | SI Solo si el evento es relacionado con correos |
| accept | Estado de aceptacion de un documento por un cliente 1 -> Aceptado 2->Rechazado |
numerico | SI Solo si el evento es relacionado con aceptacion o rechazo de documentos |
| radianType | Tipo de documento de RADIAN | cadena | SI Solo en eventos RADIAN |
| radianError | Tipo de error de RADIAN 1-> Evento reportado previamente 2-> Documento inexistente en la DIAN 3-> Tipo de documento no acepta eventos 4-> No se puede enviar aceptacion tácita sobre un documento ajeno 5-> No se puede enviar 030,031,032,033 sobre un documento propio 6-> Faltan eventos previos para poder realizar el solicitado 7-> Evento enviado fuera de la fecha máxima de aceptación |
numerico | SI Solo en eventos RADIAN |
| radianMsg | Mensaje claro en español | cadena | SI Solo en eventos RADIAN |
| CUFE | CUFE/CUDE del documento relacionado | cadena | SI Solo en eventos RADIAN |
| intID | Código del documento en tu sistema | cadena | SI Solo en eventos RADIAN |