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 34: Línea 34:
  
  
−
===documento===
+
===document===
 
Información referente al documento al que se hace relación:
 
Información referente al documento al que se hace relación:
 
----
 
----
Línea 43: Línea 43:
 
! Parámetro !! Descripción !! Tipo !! Obligatorio !! API
 
! Parámetro !! Descripción !! Tipo !! Obligatorio !! API
 
|-
 
|-
−
| type || Tipo de documento: "nominaIndividual" / "nominaIndividualAjuste" || cadena || SI || v1.0
+
| provider || Datos del proveedor || objeto || SI || v1.0
 
|-
 
|-
−
| mode || Resultado por "Creation"->Creación / "Verify"->Verificación || cadena || SI || v1.0
+
| provider->name || Nombre del proveedor || cadena || SI || v1.0
 
|-
 
|-
−
| tascode || Código interno del documento generado (Requerido para posteriores acciones)|| cadena || SI || v1.0
+
| provider->id || Número de documento del proveedor || cadena || SI || v1.0
 
|-
 
|-
−
| intID || Código interno del documento en tu base de datos|| cadena || SI || v1.0
+
| provider->telephone || Número de teléfono del proveedor || cadena || SI || v1.0
 
|-
 
|-
−
| document || Número del documento || cadena || SI || v1.0
+
| provider->email || Correo del provvedor || cadena || SI || v1.0
 
|-
 
|-
−
| CUNE || Código único del documento de nomina || cadena || SI || v1.0
+
| 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
 
|-
 
|-
−
| process || Estado de proceso:<small><br/>0 -> Enviando<br/>1 -> Verificando<br/>2 -> Aceptado DIAN<br/>78 -> Reintentando DIAN (API v3.0)<br/>Mayor que 90 -> Rechazado DIAN</small>|| cadena || SI || v1.0
+
| general || Datos propios del documento recibido || objeto || SI || v1.0
 
|-
 
|-
−
| retries || Reintentos de envio a la DIAN|| cadena || SI || v1.0
+
| general->type ||Tipo de documento:<br/><small>fc->Factura, nc->Nota Crédito, nd->Nota Débito</small>|| cadena || SI || v1.0
 
|-
 
|-
−
| customer || Estado de aceptacion del documento por el empleado<br/><small>0->Desconocido, 1->Aceptado, 2->Rechazado</small>|| cadena || SI || v1.0
+
| 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
 
|-
 
|-
−
| URL || Dirección para descarga del Documento aceptado por la DIAN (formato ZIP)<br/><small>Contiene PDF (Representación gráfica del Documento)<br/>Contiene XML (Attached Document DIAN del Documento)</small> || cadena || Solo si está Aceptado por la DIAN || v1.0
+
| general->num || Número del documento recibido || cadena || SI || v1.0
 
|-
 
|-
−
| PDF || Dirección para descarga del PDF del documento generado<br/><small>Esta opción se agrega para ayudar a algunos sistemas.<br/>Recomendamos almacenar el resultado de <b>URL<b></small> || cadena || Solo si está Aceptado por la DIAN|| v1.0
+
| general->cufe || Número de identificacion del documento en la DIAN || cadena || SI || v1.0
 
|-
 
|-
−
| ATTACHED || Dirección para descarga del XML del xml enviado al empleado<br/><small>Esta opción se agrega para ayudar a algunos sistemas.<br/>Recomendamos almacenar el resultado de <b>URL<b></small> || cadena || Solo si está Aceptado por la DIAN<br/> || v1.0
+
| general->json || Cádena que contiene un json convertido a string con toda la información encontrada en el XML recibido || || v1.0
 
|}
 
|}
  

Revisión del 17:52 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 API
provider Datos del proveedor objeto SI v1.0
provider->name Nombre del proveedor cadena SI v1.0
provider->id Número de documento del proveedor cadena SI v1.0
provider->telephone Número de teléfono del proveedor cadena SI v1.0
provider->email Correo del provvedor cadena SI v1.0
totals Valores totales reportados en el documento
Los datos aque presentados, son los que sean encontrados en el document enviado por el proveedor		 objeto SI v1.0
general Datos propios del documento recibido objeto SI v1.0
general->type Tipo de documento:
fc->Factura, nc->Nota Crédito, nd->Nota Débito		 cadena SI v1.0
general->mode Modo de ambiente de generación del documento
1 -> Ambiente de producción
2 -> Ambiente de pruebas		 cadena En producción solo aparecerán tipo 1 v1.0
general->num Número del documento recibido cadena SI v1.0
general->cufe Número de identificacion del documento en la DIAN cadena SI v1.0
general->json Cádena que contiene un json convertido a string con toda la información encontrada en el XML recibido v1.0

A tener presente

  • Puede tener objetos adicionales en su respuesta (Verifica el recurso usado para su llamado)

Objetos empleados

Usado por

Los siguientes recursos:

Temas complementarios

Enlaces

Importante

Recuerda que nosotros no te cobramos absolutamente nada por que pruebes nuestra plataforma.
Si deseas tener un usuario y contraseña , comunícate con nosotros.

Obtenido de «https://wiki.lafactura.co/index.php?title=API_LaFactura.co:WebHook_Document&oldid=2204»