Diferencia entre revisiones de «API LaFactura.co:Rangos Facturacion»
(→Objeto) |
|||
(No se muestran 22 ediciones intermedias del mismo usuario) | |||
Línea 9: | Línea 9: | ||
Y puedes empezar inmediatamente (sin certificados o papeleos) | Y puedes empezar inmediatamente (sin certificados o papeleos) | ||
<br> | <br> | ||
+ | =====Ejemplo para todos los activos===== | ||
{ | { | ||
"getRanges":{ | "getRanges":{ | ||
Línea 15: | Línea 16: | ||
} | } | ||
} | } | ||
+ | |||
+ | Este ejemplo trae todos los rangos activos de todos los tipos | ||
+ | <br> | ||
+ | |||
+ | =====Ejemplo para los de un prefijo específico===== | ||
+ | { | ||
+ | "getRanges":{ | ||
+ | "prefix":"POSA" | ||
+ | } | ||
+ | } | ||
+ | |||
+ | Este ejemplo trae el prefijo de facturas POSA que se encuentre activo<br/> | ||
+ | Es facturas, ya que si no se envia el tipo se asume facturas<br/> | ||
+ | Es el activo, ya que si no se envia el modo se asume activo | ||
=====Objeto===== | =====Objeto===== | ||
Línea 23: | Línea 38: | ||
! Parámetro !! Descripción !! Tipo !! Obligatorio !! API | ! Parámetro !! Descripción !! Tipo !! Obligatorio !! API | ||
|- | |- | ||
− | | mode || Que rangos deseo consultar:<br><small>active ->Activos<br>inactive-> Inactivos<br/>reserved-> Reservados</small>|| cadena || | + | | mode || Que rangos deseo consultar:<br><small>active ->Activos (Aquellos en uso)<br>inactive-> Inactivos (Aquellos vencidos por resolución o fecha)<br/>reserved-> Reservados (Aún no utilizados en el sistema)<br/>blocked -> bloqueados (Bloqueados por haber sido eliminados de 'Facturando Electrónicamente' en la DIAN)<br/><b>Por omision asumimos "active"</b></small>|| cadena || NO || v3.0 |
|- | |- | ||
− | | type || Que tipo de rangos deseo:<br><small>all -> Todos<br>invoice -> Factura<br>debitNote -> Nota Debito<br>creditNote -> Nota Credito<br/>CO.documentoSoporte -> documento soporte<br/>CO.ajusteDocumentoSoporte -> Ajuste a documento soporte<br/>CO.RADIAN -> Documentos Radian<br/>CO.documentoEquivalente -> Documento equivalente (POS/SPD/-etc-)<br/></small> || cadena || | + | | type || Que tipo de rangos deseo:<br><small>all -> Todos<br>invoice -> Factura<br>debitNote -> Nota Debito<br>creditNote -> Nota Credito<br/>CO.documentoSoporte -> documento soporte<br/>CO.ajusteDocumentoSoporte -> Ajuste a documento soporte<br/>CO.RADIAN -> Documentos Radian<br/>CO.documentoEquivalente -> Documento equivalente (POS/SPD/-etc-)<br/><b>Por omision asumimos "invoice"</b></small> || cadena || NO || v3.0 |
+ | |- | ||
+ | | prefix || Prefijo que busco <small><br/><b>El type no puede ser "all" cuando se busca por prefijo</b></small>|| cadena || NO || v3.0 | ||
|} | |} | ||
Línea 50: | Línea 67: | ||
"lastDate":"20210223", | "lastDate":"20210223", | ||
"description":"", | "description":"", | ||
− | "DIANKey":"0934092940390932093292309023" | + | "DIANKey":"0934092940390932093292309023", |
+ | "auth":"18760000001" | ||
}, | }, | ||
{ | { | ||
Línea 65: | Línea 83: | ||
"description":"" | "description":"" | ||
"DIANKey":"none" | "DIANKey":"none" | ||
+ | "auth":"0" | ||
}, | }, | ||
{ | { | ||
Línea 79: | Línea 98: | ||
"description":"" | "description":"" | ||
"DIANKey":"none" | "DIANKey":"none" | ||
+ | "auth":"0" | ||
} | } | ||
] | ] | ||
Línea 96: | Línea 116: | ||
| type || Tipo de rango<br><small>invoice -> Factura<br>debitNote -> Nota Debito<br>creditNote -> Nota Credito<br/>CO.documentoSoporte -> documento soporte<br/>CO.ajusteDocumentoSoporte -> Ajuste a documento soporte<br/>CO.RADIAN -> Documentos Radian<br/>CO.documentoEquivalente -> Documento equivalente (POS/SPD/-etc-)<br/></small> || cadena || SI || v2.0 / v3.0 | | type || Tipo de rango<br><small>invoice -> Factura<br>debitNote -> Nota Debito<br>creditNote -> Nota Credito<br/>CO.documentoSoporte -> documento soporte<br/>CO.ajusteDocumentoSoporte -> Ajuste a documento soporte<br/>CO.RADIAN -> Documentos Radian<br/>CO.documentoEquivalente -> Documento equivalente (POS/SPD/-etc-)<br/></small> || cadena || SI || v2.0 / v3.0 | ||
|- | |- | ||
− | | mode || Estado del rango<br><small>active ->Activos<br>inactive-> Inactivos<br/>reserved-> Reservados</small>|| cadena || SI || v3.0 | + | | mode || Estado del rango<br><small>active ->Activos<br>inactive-> Inactivos<br/>reserved-> Reservados<br/>blocked - inactive -> Bloqueado inactivo<br/>blocked - active -> Bloqueado activo<br/>blocked - reserved -> Bloqueado reservado</small>|| cadena || SI || v3.0 |
|- | |- | ||
| prefix || Prefijo de facturacion || cadena || SI || v2.0 / v3.0 | | prefix || Prefijo de facturacion || cadena || SI || v2.0 / v3.0 | ||
Línea 114: | Línea 134: | ||
| description || Campo informativo<br/><small>Descripcion en base de datos solicitada por algunos usuarios</small>|| cadena || SI || v2.0 / v3.0 | | 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 | + | | DIANKey || Clave técnica DIAN<br/><small>Requerido para calcular el CUFE/CUDE.<br/>En caso de no poseerlo retornará "none"</small>|| cadena || SI || v3.0 |
+ | |- | ||
+ | | auth || Resolución DIAN<br/><small>En caso de ser un rango controlado por la DIAN, contiene el número de la resolucón.<br/>En caso de no poseerlo retornará "0"</small>|| cadena || SI || v3.0 | ||
+ | |||
|} | |} | ||
<span style="color:#009999"><b>Notas para migrantes de API v2.0 a v3.0:</b></span> | <span style="color:#009999"><b>Notas para migrantes de API v2.0 a v3.0:</b></span> | ||
Línea 120: | Línea 143: | ||
* Se agregó el tipo de documento supportDoc para Documento Soporte DIAN<br/> | * Se agregó el tipo de documento supportDoc para Documento Soporte DIAN<br/> | ||
* Se agregaron los campos firstDate, lastDate, para tener las fechas iniciales y finales de validez de un rango<br/> | * Se agregaron los campos firstDate, lastDate, para tener las fechas iniciales y finales de validez de un rango<br/> | ||
− | * El objeto DIANKey, contiene la clave tecnica del rango de facturacion, para aquellos | + | * El objeto DIANKey, contiene la clave tecnica del rango de facturacion, para aquellos rangos que lo posseen en la DIAN CUFE/CUDE |
<br/> | <br/> | ||
Revisión actual del 19:42 9 may 2024
Sumario
Objeto:getRanges (Rangos de Documentos Facturacion)
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 POST
Ingreso: https://***.tas-la.com/facturacion.v30/general/ Solicita tu usuario y contraseña +57-601-7466664 No cobramos por el proceso de pruebas o desarrollo Y puedes empezar inmediatamente (sin certificados o papeleos)
Ejemplo para todos los activos
{ "getRanges":{ "mode":"active", "type":"all" } }
Este ejemplo trae todos los rangos activos de todos los tipos
Ejemplo para los de un prefijo específico
{ "getRanges":{ "prefix":"POSA" } }
Este ejemplo trae el prefijo de facturas POSA que se encuentre activo
Es facturas, ya que si no se envia el tipo se asume facturas
Es el activo, ya que si no se envia el modo se asume activo
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 (Aquellos en uso) inactive-> Inactivos (Aquellos vencidos por resolución o fecha) reserved-> Reservados (Aún no utilizados en el sistema) blocked -> bloqueados (Bloqueados por haber sido eliminados de 'Facturando Electrónicamente' en la DIAN) Por omision asumimos "active" |
cadena | NO | v3.0 |
type | Que tipo de rangos deseo: all -> Todos invoice -> Factura debitNote -> Nota Debito creditNote -> Nota Credito CO.documentoSoporte -> documento soporte CO.ajusteDocumentoSoporte -> Ajuste a documento soporte CO.RADIAN -> Documentos Radian CO.documentoEquivalente -> Documento equivalente (POS/SPD/-etc-) Por omision asumimos "invoice" |
cadena | NO | v3.0 |
prefix | Prefijo que busco El type no puede ser "all" cuando se busca por prefijo |
cadena | NO | 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-c1acbededb62c3546c19a0676cca4cb85", "type":"invoice", "mode":"active", "prefix":"SETP", "from":"990000000", "to":"995000000", "last":"990000102", "remaining":"4999898", "firstDate":"20200223", "lastDate":"20210223", "description":"", "DIANKey":"0934092940390932093292309023", "auth":"18760000001" }, { "rangeKey":"rk-a009e51a3986e10aa892275fb1e72594a", "type":"creditNote", "mode":"active", "prefix":"NCR", "from":"0", "to":"999999999", "last":"17", "remaining":"999999982", "firstDate":"20000101", "lastDate":"29990101", "description":"" "DIANKey":"none" "auth":"0" }, { "rangeKey":"rk-a66a4ee282763d4f89870b653ac5b90e8", "type":"debitNote", "mode":"active", "prefix":"NDE", "from":"0", "to":"999999999", "last":"11", "remaining":"999999988", "firstDate":"20000101", "lastDate":"29990101", "description":"" "DIANKey":"none" "auth":"0" } ] } }
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 CO.documentoSoporte -> documento soporte CO.ajusteDocumentoSoporte -> Ajuste a documento soporte CO.RADIAN -> Documentos Radian CO.documentoEquivalente -> Documento equivalente (POS/SPD/-etc-) |
cadena | SI | v2.0 / v3.0 |
mode | Estado del rango active ->Activos inactive-> Inactivos reserved-> Reservados blocked - inactive -> Bloqueado inactivo blocked - active -> Bloqueado activo blocked - reserved -> Bloqueado reservado |
cadena | SI | 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 |
firstDate | Fecha apartir de la cual el rango puede ser utilizado | cadena | SI | v3.0 |
lastDate | Fecha hasta la cual el rango puede ser utilizado | cadena | SI | 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 para calcular el CUFE/CUDE. En caso de no poseerlo retornará "none" |
cadena | SI | v3.0 |
auth | Resolución DIAN En caso de ser un rango controlado por la DIAN, contiene el número de la resolucón. En caso de no poseerlo retornará "0" |
cadena | SI | v3.0 |
Notas para migrantes de API v2.0 a v3.0:
- Se agregó el tipo de documento supportDoc para Documento Soporte DIAN
- Se agregaron los campos firstDate, lastDate, para tener las fechas iniciales y finales de validez de un rango
- El objeto DIANKey, contiene la clave tecnica del rango de facturacion, para aquellos rangos que lo posseen en la DIAN CUFE/CUDE
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.