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

De API LaFactura.co
Ir a la navegación Ir a la búsqueda
(Página creada con «==Objeto: resultadoNomina== Entrega la información básica correspondiente a un documento en el sistema. Es el resultado ante cualquier operacion relacionada con nomina.…»)
 
Línea 61: Línea 61:
 
! Parámetro !! Descripción !! Tipo !! Obligatorio !! API
 
! Parámetro !! Descripción !! Tipo !! Obligatorio !! API
 
|-
 
|-
−
| type || Tipo de documento: "Factura" / "Factura Salud" / "Nota Credito" / "Documento Soporte" || cadena || SI || v2.0 / v3.0
+
| type || Tipo de documento: "nominaIndividual" / "nominaIndividualAjuste" || cadena || SI || v1.0
 
|-
 
|-
−
| mode || Resultado por "Creation"->Creación / "Verify"->Verificación || cadena || SI || v2.0 / v3.0
+
| mode || Resultado por "Creation"->Creación / "Verify"->Verificación || cadena || SI || v1.0
 
|-
 
|-
−
| tascode || Código interno del documento generado (Requerido para posteriores acciones)|| cadena || SI || v2.0 / v3.0
+
| tascode || Código interno del documento generado (Requerido para posteriores acciones)|| cadena || SI || v1.0
 
|-
 
|-
−
| intID || Código interno del documento en tu base de datos|| cadena || SI || v2.0 / v3.0
+
| intID || Código interno del documento en tu base de datos|| cadena || SI || v1.0
 
|-
 
|-
−
| referal || Código de documento enlazado (Una nota crédito o factura a este documento)<br/><small>Eliminado de API v3.0</small> || cadena || NO || v2.0
+
| document || Número del documento || cadena || SI || v1.0
 
|-
 
|-
−
| document || Número del documento || cadena || SI || v2.0 / v3.0
+
| CUNE || Código único del documento de nomina || cadena || SI || v1.0
 
|-
 
|-
−
| CUFE || Código único de la factura DIAN || cadena || En facturas || v2.0 / v3.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
−
|-
 
−
| CUDE || Código único de documento electrónico DIAN || cadena || Para cualquier  documento diferente a factura || v2.0 / v3.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 || v2.0 / v3.0
 
 
|-
 
|-
 
| retries || Reintentos de envio a la DIAN|| cadena || SI || v3.0
 
| retries || Reintentos de envio a la DIAN|| cadena || SI || v3.0
 
|-
 
|-
−
| accepted || Estado de aceptacion del documento por el cliente final<br/><small>Desconocida / Aceptada / Rechazada<br/>(Campo retirado en API v3.0)</small>|| cadena || SI || v2.0
+
| customer || Estado de aceptacion del documento por el empleado<br/><small>0->Desconocido, 1->Aceptado, 2->Rechazado</small>|| cadena || SI || v1.0
−
|-
 
−
| customer || Estado de aceptacion del documento por el cliente final<br/><small>0->Desconocido, 1->Aceptado, 2->Rechazado<br/>(Nuevo campo en API v3.0)</small>|| cadena || SI || v3.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 || v2.0 / v3.0
 
 
|-
 
|-
−
| CHECK || Dirección para descarga de los resultados del documento en la DIAN (formato ZIP)<br/><small>Contiene XXXXXXXXX-DE.xml (Documento firmado enviado a la DIAN)<br/> Contiene XXXXXXXXX-R(1/2).xml (Resultado puro de la transacción en la DIAN)</small> || cadena || Solo si está Aceptado por la DIAN || v2.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
 
|-
 
|-
−
| PDF || Dirección para descarga del PDF de la factura generada<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/><small>(Solo para documentos generados desde Enero 10 - 2021)</small> || v2.0 / v3.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
 
|-
 
|-
−
| ATTACHED || Dirección para descarga del XML del xml enviado al cliente<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/><small>(Solo para documentos generados desde Enero 10 - 2021)</small> || v2.0 / v3.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
 
|}
 
|}
−
 
−
<span style="color:#009999"><b>Notas para migrantes de API v2.0 a v3.0:</b></span>
 
−
----
 
−
* Se agregó retries, el cual permite conocer el numero de reintentos de envio de un documento a la DIAN<br/>
 
−
* Se agredó customer para conocer el estado de aceptacion o rechazo de un documento por pargte del cliente final<br/>
 
−
* Se eliminó accepted
 
−
* Se eliminó referal
 
−
<br/>
 
  
 
==A tener presente==
 
==A tener presente==

Revisión del 12:30 20 ago 2021

Objeto: resultadoNomina

Entrega la información básica correspondiente a un documento en el sistema. Es el resultado ante cualquier operacion relacionada con nomina.

Ejemplo

Es el resultado ante los eventos de Generar, Anular o Verificar nomina 

 {
   "resultadoNomina":{
       "status":{
           "code":200,
           "text":"Operación realizada con exito"
        },"
        documento":{
           "type":"nominaIndividual",
           "mode":"Creation",
           "tascode":"ni-969527772dbe01117b63a3ef6aec715a-v300",
           "intID":"ni-20210820121642",
           "document":"NOM156",
           "CUNE":"b84b1889239498d4b1f34a63bec5290589a3aa880a9eaa5ab36a6837ae66bf649325130500dec0cbacc0b4c513f00df6",
           "process":"0",
           "retries":"0",
           "customer":"0"
         }
     }
  }


Explicacion

  • El resultado fue exitoso (200)
  • En texto: Operación realizada con exito
  • Se trata de un comprobante de nomina
  • El resultado fue en la operacion de creacion de nomina
  • El codigo interno del documento es: ni-969527772dbe01117b63a3ef6aec715a-v300
  • El documento generado es: NOM156
  • El CUNE del documento: b84b1889239498d4b1f34a63bec5290589a3aa880a9eaa5ab36a6837ae66bf649325130500dec0cbacc0b4c513f00df6
  • El estado actual del documento es: "Enviando"
  • El numero de reintentos es 0

status

Entrega la información referente a la operacioón realizada en los siguientes campos:

Parámetro Descripción Tipo Obligatorio API
code valor correspondiente al estado: 200 -> OK
consultar tabla		 numérico SI v2.0 / v3.0
text texto explicativo del error cadena SI v2.0 / v3.0

documento

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


Parámetro Descripción Tipo Obligatorio API
type Tipo de documento: "nominaIndividual" / "nominaIndividualAjuste" cadena SI v1.0
mode Resultado por "Creation"->Creación / "Verify"->Verificación cadena SI v1.0
tascode Código interno del documento generado (Requerido para posteriores acciones) cadena SI v1.0
intID Código interno del documento en tu base de datos cadena SI v1.0
document Número del documento cadena SI v1.0
CUNE Código único del documento de nomina cadena SI v1.0
process Estado de proceso:
0 -> Enviando
1 -> Verificando
2 -> Aceptado DIAN
78 -> Reintentando DIAN (API v3.0)
Mayor que 90 -> Rechazado DIAN		 cadena SI v1.0
retries Reintentos de envio a la DIAN cadena SI v3.0
customer Estado de aceptacion del documento por el empleado
0->Desconocido, 1->Aceptado, 2->Rechazado		 cadena SI v1.0
URL Dirección para descarga del Documento aceptado por la DIAN (formato ZIP)
Contiene PDF (Representación gráfica del Documento)
Contiene XML (Attached Document DIAN del Documento)		 cadena Solo si está Aceptado por la DIAN v1.0
PDF Dirección para descarga del PDF del documento generado
Esta opción se agrega para ayudar a algunos sistemas.
Recomendamos almacenar el resultado de URL		 cadena Solo si está Aceptado por la DIAN v1.0
ATTACHED Dirección para descarga del XML del xml enviado al empleado
Esta opción se agrega para ayudar a algunos sistemas.
Recomendamos almacenar el resultado de URL		 cadena Solo si está Aceptado por la DIAN
 v1.0

A tener presente

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

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:ResultadoNomina&oldid=1849»