Diferencia entre revisiones de «API LaFactura.co:WebRecepcion»

De API LaFactura.co
Ir a la navegación Ir a la búsqueda
(Página creada con «==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 doc…»)
 
Línea 100: Línea 100:
 
! Parámetro !! Descripción !! Tipo !! Obligatorio
 
! Parámetro !! Descripción !! Tipo !! Obligatorio
 
|-
 
|-
−
| tascode || Identificador único, del documento del evento|| cadena || SI
+
| type || Tiene el método por el cual nuestro sistema recibió el documento || cadena || SI
 
|-
 
|-
−
| date || Fecha del evento<br><small>(YYYYMMDDHHMMSS) Ejemplo: 20210125102005</small> || cadena || SI
+
| status || Estado del documento<br><small>2 - > Aceptado<br/>98 -> Rechazado</small> || cadena || SI
 
|-
 
|-
−
| text || Información del evento en texto || cadena || SI
+
| tascode || Código único del documento en nuestro sistema</small> || cadena || SI
 
|-
 
|-
−
| alert || Alerta generada || cadena || SI
+
| msg || Mensajes de error y/o advertencias encontradas por nuestro sistema || cadena || SI
 
|-
 
|-
−
| process || Información del proceso<br/><small>Solo aparece cuando se trata de un cambio de estado del documento</small>  || objeto || NO
+
| email->from || Correo recibido de este buzón || cadena || SI
 
|-
 
|-
−
| process->change || Si cambió el estado del documento  (true/false) || boolean || SI
+
| email->to || Buzón que recibió el correo || cadena || 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/78 -> Reintentando<br/>Mayor que 90 -> Rechazado DIAN</small> || numerico || SI/NO
+
| email->subject || Asunto enviado al correo || cadena || SI
 
|-
 
|-
−
| email|| información de correo || cadena || NO
+
| email->date || Fecha del recepción<br><small>(YYYYMMDDHHMMSS) Ejemplo: 20210125102005</small> || cadena || SI
 
|-
 
|-
−
| email->email || correo electronico del evento || cadena || SI<br/><small>Solo si el evento es relacionado con correos</small>
+
| email->spam || Contiene si el correo es considerado spam "false"/"true" || cadena || SI
 
|-
 
|-
−
| 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>
+
| email->virus || Contiene si el correo contienes virus "false"/"true"  || cadena || SI
 
|-
 
|-
−
| 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>
+
| document || Si el documento fué aceptado por nuestro sistema, contiene la información más relevante del documento recibido || objeto || NO/SI</small>
 
|}
 
|}

Revisión del 17:35 29 jun 2022

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
document Si el documento fué aceptado por nuestro sistema, contiene la información más relevante del documento recibido objeto NO/SI
Obtenido de «https://wiki.lafactura.co/index.php?title=API_LaFactura.co:WebRecepcion&oldid=2199»