Diferencia entre revisiones de «API LaFactura.co:Webhook»
Ir a la navegación
Ir a la búsqueda
(→Campos) |
(→Campos) |
||
Línea 113: | Línea 113: | ||
| 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:<br/>0 -> En cola <br/>1 -> En proceso DIAN<br/>2 -> Aceptado DIAN<br/>77 -> Reintentando<br/>Mayor que 90 -> Rechazado DIAN</small> || numerico || SI/NO | + | | 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 |
|- | |- | ||
| email|| información de correo || cadena || NO | | email|| información de correo || cadena || NO |
Revisión del 22:22 20 oct 2021
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 } } }
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)
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" } }
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
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 |
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 |