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

De API LaFactura.co
Ir a la navegación Ir a la búsqueda
 
(No se muestran 11 ediciones intermedias del mismo usuario)
Línea 11: Línea 11:
 
                     "id": "900900900",
 
                     "id": "900900900",
 
                     "telephone": "212121",
 
                     "telephone": "212121",
−
                     "email": "nicolas.pena@on2design.com"
+
                     "email": "xxx@test.com"
 
                 },
 
                 },
 
                 "totals": {
 
                 "totals": {
Línea 33: Línea 33:
 
       }
 
       }
  
−
 
+
===document===
−
===documento===
 
 
Información referente al documento al que se hace relación:
 
Información referente al documento al que se hace relación:
 
----
 
----
Línea 41: Línea 40:
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
−
! Parámetro !! Descripción !! Tipo !! Obligatorio !! API
+
! Parámetro !! Descripción !! Tipo !! Obligatorio  
 
|-
 
|-
−
| type || Tipo de documento: "nominaIndividual" / "nominaIndividualAjuste" || cadena || SI || v1.0
+
| provider || Datos del proveedor || objeto || SI  
 
|-
 
|-
−
| mode || Resultado por "Creation"->Creación / "Verify"->Verificación || cadena || SI || v1.0
+
| provider->name || Nombre del proveedor || cadena || SI  
 
|-
 
|-
−
| 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  
 
|-
 
|-
−
| 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  
 
|-
 
|-
−
| document || Número del documento || cadena || SI || v1.0
+
| provider->email || Correo del provvedor || cadena || SI  
 
|-
 
|-
−
| CUNE || Código único del documento de nomina || cadena || 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  
 
|-
 
|-
−
| 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  
 
|-
 
|-
−
| 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  
 
|-
 
|-
−
| 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 recibido<br/><small>1 -> Ambiente de producción<br/>2 -> Ambiente de pruebas</small> || cadena || SI
 
|-
 
|-
−
| 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
 
|-
 
|-
−
| 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
 
|-
 
|-
−
| 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 || json convertido a string con toda la información encontrada en el XML recibido || cadena || SI
 
|}
 
|}
−
 
−
==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==
 
−
* [[API_LaFactura.co:Nomina|Nomina]]
 
−
 
−
==Enlaces==
 
−
*LaFactura.co: https://lafactura.co
 
−
*GitHub: https://github.com/FacturacionElectronicaColombia/lafactura.co
 
−
 
−
==Importante==
 
−
Recuerda que nosotros no te cobramos absolutamente nada por que pruebes nuestra plataforma.<br>
 
−
'''Si deseas tener un usuario y contraseña , comunícate con nosotros.'''
 

Revisión actual del 20:44 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
Obtenido de «https://wiki.lafactura.co/index.php?title=API_LaFactura.co:WebHook_Document&oldid=2235»