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 40: Línea 40:
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
−
! Parámetro !! Descripción !! Tipo !! Obligatorio !! API
+
! Parámetro !! Descripción !! Tipo !! Obligatorio  
 
|-
 
|-
−
| provider || Datos del proveedor  || objeto || SI || v1.0
+
| provider || Datos del proveedor  || objeto || SI  
 
|-
 
|-
−
| provider->name || Nombre del proveedor || cadena || SI || v1.0
+
| provider->name || Nombre del proveedor || cadena || SI  
 
|-
 
|-
−
| provider->id || Número de documento del proveedor || cadena || SI || v1.0
+
| provider->id || Número de documento del proveedor || cadena || SI  
 
|-
 
|-
−
| provider->telephone || Número de teléfono del proveedor || cadena || SI || v1.0
+
| provider->telephone || Número de teléfono del proveedor || cadena || SI  
 
|-
 
|-
−
| provider->email || Correo del provvedor || cadena || SI || v1.0
+
| provider->email || Correo del provvedor || cadena || SI  
 
|-
 
|-
−
| totals || Valores totales reportados en el documento<br/><b>Los datos aque presentados, son los que sean encontrados en el document enviado por el proveedor</b> || objeto|| SI || v1.0
+
| totals || Valores totales reportados en el documento<br/><b>Los datos aquí presentados, son los que sean encontrados en el documento enviado por el proveedor</b> || objeto|| SI  
 
|-
 
|-
−
| general || Datos propios del documento recibido || objeto || SI || v1.0
+
| general || Datos propios del documento recibido || objeto || SI  
 
|-
 
|-
−
| general->type ||Tipo de documento:<br/><small>fc->Factura, nc->Nota Crédito, nd->Nota Débito</small>|| cadena || SI || v1.0
+
| general->type ||Tipo de documento:<br/><small>fc->Factura, nc->Nota Crédito, nd->Nota Débito</small>|| cadena || SI  
 
|-
 
|-
−
| general->mode || Modo de ambiente de generación del documento<br/><small>1 -> Ambiente de producción<br/>2 -> Ambiente de pruebas</small> || cadena || En producción solo aparecerán tipo 1 || v1.0
+
| general->mode || Modo de ambiente de generación del documento recibido<br/><small>1 -> Ambiente de producción<br/>2 -> Ambiente de pruebas</small> || cadena || En producción solo aparecerán tipo 1  
 
|-
 
|-
−
| general->num || Número del documento recibido || cadena || SI || v1.0
+
| general->num || Número del documento recibido || cadena || SI  
 
|-
 
|-
−
| general->cufe || Número de identificacion del documento en la DIAN || cadena || SI || v1.0
+
| general->cufe || Número de identificacion del documento en la DIAN || cadena || SI
 
|-
 
|-
−
| general->json || Cádena que contiene un json convertido a string con toda la información encontrada en el XML recibido || cadena || SI/NO || v1.0
+
| general->json || Cádena que contiene un json convertido a string con toda la información encontrada en el XML recibido || cadena || SI
 
|}
 
|}

Revisión del 18:58 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 En producción solo aparecerán tipo 1
general->num Número del documento recibido cadena SI
general->cufe Número de identificacion del documento en la DIAN cadena SI
general->json Cádena que contiene un json convertido a string con toda la información encontrada en el XML recibido cadena SI
Obtenido de «https://wiki.lafactura.co/index.php?title=API_LaFactura.co:WebHook_Document&oldid=2209»