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 15 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:
 
Entrega la información referente a la operacioón realizada en los siguientes campos:
  
Línea 52: Línea 42:
 
| code || valor correspondiente al estado: 200 -> OK<br><small>[[API_LaFactura.co:Tabla_invoiceResult|consultar tabla]]</small> || numérico || SI
 
| 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
+
| text || texto explicativo del error || cadena || SI
 
|}
 
|}
  
=====ranges=====
+
=====otros objetos=====
Información referente a los rangos solicitados (Es un arreglo):
+
* Puede enviar en el resultado objetos adicionales (consulta el recurso que realizó la solicitud)
 
 
{| class="wikitable"
 
|-
 
! Parámetro !! Descripción !! Tipo !! Obligatorio
 
|-
 
| RANGEKEY || Llave del rango<br><small>Es requerido para enviar una factura</small> || cadena || SI
 
|-
 
| type || Tipo de rango<br><small>invoice -> Factura<br>debitNote -> Nota Debito<br>creditNote -> Nota Credito</small> || cadena || SI
 
|-
 
| prefix || Prefijo de facturacion || cadena || SI
 
|-
 
| from || Primer numero del rango || cadena || SI
 
|-
 
| to || Ultimo numero del rango || cadena || SI
 
|-
 
| last || Ultimo numero usado || cadena || SI
 
|}
 
 
 
=====A tener presente=====
 
* RANGEKEY es la llave requerida para enviar solicitud de una factura al sistema
 
  
 
==Usado por==
 
==Usado por==
 
Los siguientes recursos:
 
Los siguientes recursos:
 +
* [[API_LaFactura.co:Enviar_Correo|Enviar correo al cliente]]
 
* [[API_LaFactura.co:Rangos_Facturacion|Obtener Rangos de Facturacion]]
 
* [[API_LaFactura.co:Rangos_Facturacion|Obtener Rangos de Facturacion]]
  
Línea 88: Línea 59:
 
*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.