Diferencia entre revisiones de «API LaFactura.co:WebRecepcion»
Ir a la navegación
Ir a la búsqueda
(→Campos) |
|||
Línea 119: | Línea 119: | ||
|- | |- | ||
| email->virus || Contiene si el correo contienes virus "false"/"true" || cadena || SI | | email->virus || Contiene si el correo contienes virus "false"/"true" || cadena || SI | ||
+ | |- | ||
+ | | URL || URL dispuesta para descargar copia de los documentos recibidos en formato zip || cadena || SI | ||
|- | |- | ||
| document || Si el documento fué aceptado por nuestro sistema, contiene la información más relevante del documento recibido<br/>Verifica el objeto [[API_laFactura.co:WebHook_Document|webhook document]] || objeto || NO/SI</small> | | document || Si el documento fué aceptado por nuestro sistema, contiene la información más relevante del documento recibido<br/>Verifica el objeto [[API_laFactura.co:WebHook_Document|webhook document]] || objeto || NO/SI</small> | ||
|} | |} |
Revisión del 19:53 29 jun 2022
Sumario
Webhook Recepción de Documentos
Por nuestro sistema de interconexión, podemos enviarte a una URL tuya, una respuesta de tipo automática cada vez que se reciba un documento electronico en nuestra plataforma.
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:incoming
El objeto incoming lleva el resultado del documento recibido
Ejemplo 1 (Documento recibido pero rechazado por nuestra plataforma)
{ "incoming":{ "type":"email", "status": "98", "tascode": "in-86ba3c44coetireoriterotiebdc042febbbbbf31bd0083-v300", "msg": "Att: firma en modo estricto -2-;Att: No tiene Documentos adjuntos", "email": { "from": "[email protected]", "to": "[email protected]", "subject": "Asunto del correo", "date": "20220629114359", "spam": "false", "virus": "false" } } }
Explicacion
Se recibió un correo en la plataforma:
- Su estado es: Rechazado (98)
- el ID de recepcion del documento en nuestro sistema es: in-86ba3c44coetireoriterotiebdc042febbbbbf31bd0083-v300
- Contiene las siguientes notas acerca del rechazo: Att: firma en modo estricto -2-;Att: No tiene Documentos adjuntos
- Fué enviado por [email protected] al correo [email protected].
- Fue recibido el 2022.06.29 a las 11:43:59
- No es considerado spam o virus
Ejemplo 2 (Documento recibido de manera positiva)
{ "incoming": { "type": "email", "status": "2", "tascode": "em-86ba3cewrowerpoweor44casasebdc042febbbbbf31bd0083-v300", "msg": "Att: firma en modo estricto -2-", "email": { "from": "[email protected]", "to": "[email protected]", "subject": "Fwd: El asunto", "date": "20220629114359", "spam": "false", "virus": "false" }, "document": { "provider": { "name": "XXXX SAS", "id": "900900900", "telephone": "212121", "email": "[email protected]" }, "totals": { "LineExtensionAmount": "45608043.00", "TaxExclusiveAmount": "45608043.00", "TaxInclusiveAmount": "54273571.17", "AllowanceTotalAmount": "0.00", "ChargeTotalAmount": "0.00", "PrepaidAmount": "0.00", "PayableAmount": "54273571.17" }, "general": { "type": "fc", "mode": "1", "num": "FE958", "cufe": "0c35d06916434833335ddddeabf88152b60084be595bfd648329a516568bd8004cea56a7823eba7c1ead7f569662a5a0e9cf88e57", "json": "{\"Invoice\":{.........}}}" } } } }
Explicacion
Se recibió un correo en la plataforma:
- Su estado es: Aprobado (2)
- el ID de recepcion del documento en nuestro sistema es: em-86ba3cewrowerpoweor44casasebdc042febbbbbf31bd0083-v300
- Contiene las siguientes notas acerca del rechazo: Att: firma en modo estricto -2-
- Fué enviado por [email protected] al correo [email protected].
- Fue recibido el 2022.06.29 a las 11:43:59
- No es considerado spam o virus
- Los detalles del documento están incluidos en "Documento"
Campos
Parámetro | Descripción | Tipo | Obligatorio |
---|---|---|---|
type | Tiene el método por el cual nuestro sistema recibió el documento | cadena | SI |
status | Estado del documento 2 - > Aceptado 98 -> Rechazado |
cadena | SI |
tascode | Código único del documento en nuestro sistema | cadena | SI |
msg | Mensajes de error y/o advertencias encontradas por nuestro sistema | cadena | SI |
email->from | Correo recibido de este buzón | cadena | SI |
email->to | Buzón que recibió el correo | cadena | SI |
email->subject | Asunto enviado al correo | cadena | SI |
email->date | Fecha del recepción (YYYYMMDDHHMMSS) Ejemplo: 20210125102005 |
cadena | SI |
email->spam | Contiene si el correo es considerado spam "false"/"true" | cadena | SI |
email->virus | Contiene si el correo contienes virus "false"/"true" | cadena | SI |
URL | URL dispuesta para descargar copia de los documentos recibidos en formato zip | cadena | SI |
document | Si el documento fué aceptado por nuestro sistema, contiene la información más relevante del documento recibido Verifica el objeto webhook document |
objeto | NO/SI |