Diferencia entre revisiones de «API LaFactura.co:Webhook»
Ir a la navegación
Ir a la búsqueda
| Línea 2: | Línea 2: | ||
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 los documentos. | 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 los documentos. | ||
| − | == | + | ==Objeto:event== |
| + | El objeto event lleva el resultado del evento ocurrido | ||
| + | |||
| + | { | ||
| + | "event":{ | ||
| + | "tascode":"fc-ioeri98499843yuyw97397329382", | ||
| + | "date":"20210125102005", | ||
| + | "text":"Documento aprobado por la DIAN", | ||
| + | "process":{ | ||
| + | "change":true, | ||
| + | "newValue":2 | ||
| + | } | ||
| + | } | ||
| + | } | ||
| + | |||
| + | =====Explicacion===== | ||
| + | |||
| + | Se recibió un evento: | ||
| + | |||
| + | *Documento relacionado: fc-ioeri98499843yuyw97397329382 | ||
| + | *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) | ||
| + | |||
| + | =====Campos===== | ||
| + | {| class="wikitable" | ||
| + | |- | ||
| + | ! Parámetro !! Descripción !! Tipo !! Obligatorio | ||
| + | |- | ||
| + | | tascode || Identificador único, del documento del evento|| cadena || SI | ||
| + | |- | ||
| + | | date || Fecha del evento<br><small>(YYYYMMDDHHMMSS) Ejemplo: 20210125102005</small> || cadena || SI | ||
| + | |- | ||
| + | | text || Información del evento en texto || cadena || SI | ||
| + | |- | ||
| + | | process || Información del proceso || objeto || 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></small> || numerico || SI/NO | ||
| + | |} | ||
Revisión del 14:51 5 ago 2020
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 los documentos.
Objeto:event
El objeto event lleva el resultado del evento ocurrido
{
"event":{
"tascode":"fc-ioeri98499843yuyw97397329382",
"date":"20210125102005",
"text":"Documento aprobado por la DIAN",
"process":{
"change":true,
"newValue":2
}
}
}
Explicacion
Se recibió un evento:
- Documento relacionado: fc-ioeri98499843yuyw97397329382
- 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)
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 |
| process | Información del proceso | objeto | SI |
| process->change | Si cambió el estado del documento (true/false) | boolean | SI |
| process->newValue | El nuevo estado del documento (Solo si change=true) |
numerico | SI/NO |
