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

De API LaFactura.co
Ir a la navegación Ir a la búsqueda
 
(No se muestran 24 ediciones intermedias del mismo usuario)
Línea 5: Línea 5:
 
Es el resultado ante el evento de solicitar rangos de facturacion  
 
Es el resultado ante el evento de solicitar rangos de facturacion  
 
    
 
    
−
    {
+
      {
 
           "generalResult":{
 
           "generalResult":{
 
               "status":{
 
               "status":{
 
                 "code":200,
 
                 "code":200,
−
                 "error":"Operación realizada con exito"
+
                 "text":"Operación realizada con exito"
 
               },
 
               },
 
               "ranges":[
 
               "ranges":[
 
                   {
 
                   {
−
                     "RANGEKEY":"c1cbededb62c3546c19a0676cca4cb85",
+
                     "rangeKey":"rk-98349384983849384984",
 
                     "type":"invoice",
 
                     "type":"invoice",
 +
                    "mode":"active",
 
                     "prefix":"SETP",
 
                     "prefix":"SETP",
 
                     "from":"990000000",
 
                     "from":"990000000",
 
                     "to":"995000000",
 
                     "to":"995000000",
−
                     "last":"990000102"
+
                     "last":"990000102",
−
                  },
+
                     "remaining":"4999898",
−
                  {
+
                     "firstDate":"20200223",
−
                     "RANGEKEY":"009e51a3986e10aa892275fb1e72594a",
+
                     "lastDate":"20210223",
−
                     "type":"creditNote",
+
                     "description":"Prueba",
−
                     "prefix":"NCR",
+
                     "DIANKey":"opwqpo0-23912-03921-03912309"
−
                     "from":"0",
+
                   }
−
                     "to":"999999999",
 
−
                    "last":"17"
 
−
                   },
 
−
                  {
 
−
                    "RANGEKEY":"a664ee282763d4f89870b653ac5b90e8",
 
−
                    "type":"debitNote",
 
−
                    "prefix":"NDE",
 
−
                    "from":"0",
 
−
                    "to":"999999999",
 
−
                    "last":"11"
 
−
                  }
 
 
               ]
 
               ]
 
           }
 
           }
Línea 43: Línea 33:
 
contiene los siguientes objetos en su resultado:
 
contiene los siguientes objetos en su resultado:
  
−
=====status=====
+
=====Objeto:status=====
−
Entrega la información referente a la operacioón realizada en los siguientes campos:
 
−
 
 
−
{| class="wikitable"
 
−
|-
 
−
! Parámetro !! Descripción !! Tipo !! Obligatorio
 
−
|-
 
−
| code || valor correspondiente al estado: 200 -> OK<br><small>[[API_LaFactura.co:Tabla_invoiceResult|consultar tabla]]</small> || numérico || SI
 
−
|-
 
−
| error || texto explicativo del error || cadena || SI
 
−
|}
 
−
 
 
−
=====ranges=====
 
−
Información referente a los rangos solicitados (Es un arreglo):
 
−
 
 
−
{| class="wikitable"
 
−
|-
 
−
! Parámetro !! Descripción !! Tipo !! Obligatorio
 
−
|-
 
−
| type || Tipo de documento: "Factura" ó "Nota Credito" || cadena || SI
 
−
|-
 
−
| mode || Resultado por "Creation"->Creación / "Verify"->Verificación || cadena || SI
 
−
|-
 
−
| tascode || Código interno del documento generado (Requerido para posteriores acciones)|| cadena || SI
 
−
|-
 
−
| referal || Código de documento enlazado (Una nota crédito o factura a este documento) || cadena || NO
 
−
|-
 
−
| document || Número de la Factura o Nota Credito || cadena || SI
 
−
|-
 
−
| CUFE || Código único de la factura DIAN || cadena || Solo en facturas
 
−
|-
 
−
| CUDE || Código único de documento electrónico DIAN || cadena || Solo en Notas Crédito
 
−
|-
 
−
| process || Estado de proceso 0 -> Enviando / 1 -> Verificando / 2 -> Aceptado DIAN // Mayor que 90 -> Rechazado DIAN || cadena || SI
 
−
|-
 
−
| URL || Dirección para descarga de la factura aceptada por la DIAN (formato ZIP) || cadena || Solo si está Aceptado por la DIAN
 
−
|-
 
−
| CHECK || Dirección para descarga de los resultados del documento en la DIAN (formato ZIP) || cadena || Solo si está aceptado por la DIAN
 
−
|}
 
−
 
 
−
=====A tener presente=====
 
−
* No se debe considerar un documento como válido por la DIAN, hasta que el resultado de una verificación del documento, muestre a process con: '''2'''
 
−
 
 
−
===Ejemplo 2===
 
−
Es el resultado de la solicitud de Eventos del Documento
 
−
 
 
−
  {
 
−
  "invoiceResult":{
 
−
      "status":{
 
−
          "code": 200,
 
−
          "text":"Operación realizada con exito",
 
−
      },
 
−
      "invoiceLog":[
 
−
          {"fecha":"20200127111116","proceso":"Documento Anulado \/ NCR000000011"},
 
−
          {"fecha":"20200127110005","proceso":"Documento enviado al correo [email protected]"},
 
−
          {"fecha":"20200127110004","proceso":"Documento aprobado por DIAN"},
 
−
          {"fecha":"20200127110003","proceso":"Documento en Verificación DIAN"},
 
−
          {"fecha":"20200127110003","proceso":"Verificando documento en la DIAN"},
 
−
          {"fecha":"20200127105826","proceso":"Documento en Cola"}
 
−
      ]
 
−
    }
 
−
  }
 
−
 
 
−
=====status=====
 
 
Entrega la información referente a la operacioón realizada en los siguientes campos:
 
Entrega la información referente a la operacioón realizada en los siguientes campos:
  
Línea 118: Línea 45:
 
|}
 
|}
  
−
=====invoiceLog=====
+
=====otros objetos=====
−
Contiene la relacion completa de eventos sucedidos con un documento (Cuando se hace una peticion getLog). El mismo es un arreglo, en el cual contiene siempre los siguientes campos:
+
* Puede enviar en el resultado objetos adicionales (consulta el recurso que realizó la solicitud)
−
 
 
−
{| class="wikitable"
 
−
|-
 
−
! Parámetro !! Descripción !! Tipo !! Obligatorio
 
−
|-
 
−
| fecha|| Fecha en la que sucedió el evento (AAAAMMDDHHMMSS) Año.Mes.Dia.Horas.Minutos.Segundos || cadena || SI
 
−
|-
 
−
| proceso || Tarea realizada || cadena || SI
 
−
|}
 
−
=====A tener presente=====
 
−
* La fecha y hora presentada, está en la zona horaria propia de America/Bogota (GMT -5)
 
  
 
==Usado por==
 
==Usado por==
 
Los siguientes recursos:
 
Los siguientes recursos:
−
* [[API_LaFactura.co:Generar_Factura|Generar Factura]]
+
* [[API_LaFactura.co:Enviar_Correo|Enviar correo al cliente]]
−
* [[API_LaFactura.co:Verificar_Factura|Verificar Factura]]
+
* [[API_LaFactura.co:Rangos_Facturacion|Obtener Rangos de Facturacion]]
−
* [[API_LaFactura.co:Anular_Factura|Anular Factura]]
 
−
* [[API_LaFactura.co:Eventos_Documento|Eventos Documento]]
 
  
 
==Temas complementarios==
 
==Temas complementarios==
−
* [[API_LaFactura.co:Facturacion|Facturación]]
+
* [[API_LaFactura.co:General|Procesos Generales]]
  
 
==Enlaces==
 
==Enlaces==
 
*LaFactura.co: https://lafactura.co
 
*LaFactura.co: https://lafactura.co
 
*GitHub: https://github.com/FacturacionElectronicaColombia/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 13:32 13 may 2022

Objeto: generalResult

Entrega la información básica correspondiente a un proceso general en el sistema.

Ejemplo

Es el resultado ante el evento de solicitar rangos de facturacion 

     {
         "generalResult":{
             "status":{
                "code":200,
                "text":"Operación realizada con exito"
              },
              "ranges":[
                 {
                   "rangeKey":"rk-98349384983849384984",
                   "type":"invoice",
                   "mode":"active",
                   "prefix":"SETP",
                   "from":"990000000",
                   "to":"995000000",
                   "last":"990000102",
                   "remaining":"4999898",
                   "firstDate":"20200223",
                   "lastDate":"20210223",
                   "description":"Prueba",
                   "DIANKey":"opwqpo0-23912-03921-03912309"
                 }
             ]
         }
      }


contiene los siguientes objetos en su resultado:

Objeto:status

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

Parámetro Descripción Tipo Obligatorio
code valor correspondiente al estado: 200 -> OK
consultar tabla		 numérico SI
text texto explicativo del error cadena SI
otros objetos
  • Puede enviar en el resultado objetos adicionales (consulta el recurso que realizó la solicitud)

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:GeneralResult&oldid=2192»