Diferencia entre revisiones de «API LaFactura.co:Rangos Facturacion»
Ir a la navegación
Ir a la búsqueda
(→Objeto) |
|||
Línea 73: | Línea 73: | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
− | ! Parámetro !! Descripción !! Tipo !! Obligatorio | + | ! Parámetro !! Descripción !! Tipo !! Obligatorio !! API |
|- | |- | ||
− | | rangeKey || Llave del rango<br><small>Es requerido para enviar una factura</small> || cadena || SI | + | | rangeKey || Llave del rango<br><small>Es requerido para enviar una factura</small> || cadena || SI || v2.0 / v3.0 |
|- | |- | ||
− | | type || Tipo de rango<br><small>invoice -> Factura<br>debitNote -> Nota Debito<br>creditNote -> Nota Credito</small> || cadena || SI | + | | type || Tipo de rango<br><small>invoice -> Factura<br>debitNote -> Nota Debito<br>creditNote -> Nota Credito</small> || cadena || SI || v2.0 / v3.0 |
|- | |- | ||
− | | prefix || Prefijo de facturacion || cadena || SI | + | | prefix || Prefijo de facturacion || cadena || SI || v2.0 / v3.0 |
|- | |- | ||
− | | from || Primer numero del rango || cadena || SI | + | | from || Primer numero del rango || cadena || SI || v2.0 / v3.0 |
|- | |- | ||
− | | to || Ultimo numero del rango || cadena || SI | + | | to || Ultimo numero del rango || cadena || SI || v2.0 / v3.0 |
|- | |- | ||
− | | last || Ultimo numero usado || cadena || SI | + | | last || Ultimo numero usado || cadena || SI || v2.0 / v3.0 |
|- | |- | ||
− | | remaining || Documentos disponibles || cadena || SI | + | | remaining || Documentos disponibles || cadena || SI || v2.0 / v3.0 |
|- | |- | ||
− | | description || Campo informativo<br/><small>Descripcion en base de datos solicitada por algunos usuarios</small>|| cadena || SI | + | | description || Campo informativo<br/><small>Descripcion en base de datos solicitada por algunos usuarios</small>|| cadena || SI || v2.0 / v3.0 |
|- | |- | ||
− | | DIANKey || Clave técnica DIAN<br/><small>Requerido por usuarios que llevan su propio control de consecutivo de facturacion<br/>No está disponible para todos los clientes</small>|| cadena || SI | + | | DIANKey || Clave técnica DIAN<br/><small>Requerido por usuarios que llevan su propio control de consecutivo de facturacion<br/>No está disponible para todos los clientes</small>|| cadena || SI || v3.0 |
|} | |} | ||
======A tener presente====== | ======A tener presente====== |
Revisión del 13:00 5 abr 2021
Sumario
Objeto:getRanges (Rangos de facturación)
Se utiliza para conocer los rangos de facturacion en el sistema, saber los que estan activos asi como las llaves para ser usadas en peticiones de generar factura. Este servicio es por el método GET
{ "getRanges":{ "mode":"active", "type":"all" } }
Objeto
Envía la información referente al documento a anular:
Parámetro | Descripción | Tipo | Obligatorio | API |
---|---|---|---|---|
mode | Que rangos deseo consultar: active ->Activos inactive-> Inactivos reserved-> Reservados |
cadena | SI | v2.0 / v3.0 |
type | Que tipo de rangos deseo: all -> Todos invoice -> Facturas creditNote -> Nota Credito debitNote -> Nota Debito |
cadena | SI | v2.0 / v3.0 |
Resultados
Devuelve un objeto generalResult con el resultado de la operación y la información referente a los rangos
{ "generalResult":{ "status":{ "code":200, "text":"Operación realizada con exito" }, "ranges":[ { "rangeKey":"rk-c1cbededb62c3546c19ad0676cca4cb85", "type":"invoice", "prefix":"SETP", "from":"990000000", "to":"995000000", "last":"990000102", "remaining":"4999898", "description":"", "DIANKey":"03942832094839043829409238409382409324908" }, { "rangeKey":"rk-009e51a3986e10aad892275fb1e72594a", "type":"creditNote", "prefix":"NCR", "from":"0", "to":"999999999", "last":"17", "remaining":"999999982", "description":"", "DIANKey":"" }, { "rangeKey":"rk-ad664ee282763d4f89870b653ac5b90e8", "type":"debitNote", "prefix":"NDE", "from":"0", "to":"999999999", "last":"999999999", "remaining":"0", "description":"", "DIANKey":"" } ] } }
Objeto:ranges
Información referente a los rangos solicitados (Es un arreglo de Objetos):
Parámetro | Descripción | Tipo | Obligatorio | API |
---|---|---|---|---|
rangeKey | Llave del rango Es requerido para enviar una factura |
cadena | SI | v2.0 / v3.0 |
type | Tipo de rango invoice -> Factura debitNote -> Nota Debito creditNote -> Nota Credito |
cadena | SI | v2.0 / v3.0 |
prefix | Prefijo de facturacion | cadena | SI | v2.0 / v3.0 |
from | Primer numero del rango | cadena | SI | v2.0 / v3.0 |
to | Ultimo numero del rango | cadena | SI | v2.0 / v3.0 |
last | Ultimo numero usado | cadena | SI | v2.0 / v3.0 |
remaining | Documentos disponibles | cadena | SI | v2.0 / v3.0 |
description | Campo informativo Descripcion en base de datos solicitada por algunos usuarios |
cadena | SI | v2.0 / v3.0 |
DIANKey | Clave técnica DIAN Requerido por usuarios que llevan su propio control de consecutivo de facturacion No está disponible para todos los clientes |
cadena | SI | v3.0 |
A tener presente
- rangeKey es la llave requerida para enviar solicitud de una factura al sistema
- Si se solicitan los rangos activos, solamente aparecerá un rango por cada tipo de documento generable
Objetos Empleados
- generalResult: Resultado General
Temas complementarios
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.
Si deseas tener un usuario y contraseña , comunícate con nosotros.