Diferencia entre revisiones de «API LaFactura.co:WebHook Document»

De API LaFactura.co
Ir a la navegación Ir a la búsqueda
Línea 65: Línea 65:
 
|-
 
|-
 
| general->json || json convertido a string con toda la información encontrada en el XML recibido || cadena || SI
 
| general->json || json convertido a string con toda la información encontrada en el XML recibido || cadena || SI
−
|-
 
−
| * dian || Datos de la DIAN  || objeto || SI
 
−
|-
 
−
| * dian->mode || Modo de operacion de la DIAN || cadena || SI
 
−
|-
 
−
| * dian->num || Numero del documento en el comprobante DIAN || cadena || SI
 
−
|-
 
−
| * dian->cufe || Numero del cufe del documento en el comprobante DIAN || cadena || SI
 
−
|-
 
−
| * dian->msg || json convertido a string .. contiene arreglo con los errores y advertencias mostrados por la DIAN || cadena || SI
 
−
|-
 
−
| * dian->approved || estado de aprobación o rechazo de la DIAN al documento "true"/"false" || cadena || SI
 
−
|-
 
−
| * customer || Los datos tuyos reportados en el documento  || objeto || SI
 
−
|-
 
−
| * customer->name || Tu nombre reportado en el documento || cadena || SI
 
−
|-
 
−
| * customer->id || Tu número de documento reportado en el documento|| cadena || SI
 
−
|-
 
−
| * customer->telephone || Número de teléfono reportado en el documento || cadena || SI
 
−
|-
 
−
| * customer->email || Correo reportado en el documento || cadena || SI
 
 
|}
 
|}
  
 
* Estos campos solo aparecen reportados cuando se obtiene este objeto como parte de la respuesta a getDocumentInfo
 
* Estos campos solo aparecen reportados cuando se obtiene este objeto como parte de la respuesta a getDocumentInfo

Revisión del 20:43 29 jun 2022

Objeto: document

Entrega la información básica correspondiente a un documento recibido en el sistema.

Ejemplo

Llega en los resultados de recepción de documentos por el hook 

 {
         "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\":{.........}}}"
               }
            }
         }
     }

document

Información referente al documento al que se hace relación:


Parámetro Descripción Tipo Obligatorio
provider Datos del proveedor objeto SI
provider->name Nombre del proveedor cadena SI
provider->id Número de documento del proveedor cadena SI
provider->telephone Número de teléfono del proveedor cadena SI
provider->email Correo del provvedor cadena SI
totals Valores totales reportados en el documento
Los datos aquí presentados, son los que sean encontrados en el documento enviado por el proveedor		 objeto SI
general Datos propios del documento recibido objeto SI
general->type Tipo de documento:
fc->Factura, nc->Nota Crédito, nd->Nota Débito		 cadena SI
general->mode Modo de ambiente de generación del documento recibido
1 -> Ambiente de producción
2 -> Ambiente de pruebas		 cadena SI
general->num Número del documento recibido cadena SI
general->cufe Número de identificacion del documento en la DIAN cadena SI
general->json json convertido a string con toda la información encontrada en el XML recibido cadena SI
  • Estos campos solo aparecen reportados cuando se obtiene este objeto como parte de la respuesta a getDocumentInfo
Obtenido de «https://wiki.lafactura.co/index.php?title=API_LaFactura.co:WebHook_Document&oldid=2234»