Diferencia entre revisiones de «API LaFactura.co:UNSPSC»
(→Clases) |
|||
| Línea 117: | Línea 117: | ||
==== Clases ==== | ==== Clases ==== | ||
| − | + | ----- | |
Método Clases: Devuelve todas las clases pertenecientes a una familia | Método Clases: Devuelve todas las clases pertenecientes a una familia | ||
Revisión del 20:46 27 jul 2020
UNSPSC
Es el estándard internacional de clasificación de productos creado por las Nacciones Unidas y utilizado por gran cantidad de países entre los que se encuentra Colombia. Este servicio consta de varios tipos de consulta por el método GET
Segmentos
Método Segmentos: Devulve el conjunto completo de segmentos del standard
{
"UNSPSC":{
"version":"v14.0.80",
"getSegments": {
"lang":"es"
}
}
}
Objeto
| Parámetro | Descripción | Tipo | Obligatorio |
|---|---|---|---|
| version | Versión de UNSPSC a ser utilizada .. debe contener: v14.0.80 | cadena | SI |
| getSegments | Objeto para obtener segmentos | objeto | SI |
| lang | Idioma de la respuesta (en->Inglés, es->Español, all->Todos los idiomas disponibles) | cadena | SI |
Resultados
{
"generalResult":{
"status":{
"code":200,
"text":"Operación realizada con exito"
},
"data":[
{
"code":"10000000",
"es":"Material Vivo Vegetal y Animal, Accesorios y Suministros"
},
{
"code":"11000000",
"es":"Material Mineral, Textil y Vegetal y Animal No Comestible"
},
.
.
.
{
"code":"95000000",
"es":"Terrenos, Edificios, Estructuras y Vías"
}
]
}
}
Familias
Método Familias: Devuelve todas las familias pertenecientes a un segmento
{
"UNSPSC":{
"version":"v14.0.80",
"getFamilies": {
"lang":"es",
"segment":"10"
}
}
}
Objeto
| Parámetro | Descripción | Tipo | Obligatorio |
|---|---|---|---|
| version | Versión de UNSPSC a ser utilizada .. debe contener: v14.0.80 | cadena | SI |
| getFamilies | Objeto para obtener familias | objeto | SI |
| lang | Idioma de la respuesta (en->Inglés, es->Español, all->Todos los idiomas disponibles) | cadena | SI |
| segment | Segmento del cual se desean las familias (2 dígitos) | cadena | SI |
Resultados
{
"generalResult":{
"status":{
"code":200,
"text":"Operación realizada con exito"
},
"data":[
{
"code":"10100000",
"es":"Animales vivos"
},
{
"code":"10110000",
"es":"Productos para animales domésticos"
},
{
"code":"10120000",
"es":"Comida de animales"
},
.
.
.
{
"code":"10500000",
"es":"Follaje cortado fresco"
}
]
}
Clases
Método Clases: Devuelve todas las clases pertenecientes a una familia
{
"UNSPSC":{
"version":"v14.0.80",
"getClasses": {
"lang":"es",
"family":"1050"
}
}
}
Objeto
| Parámetro | Descripción | Tipo | Obligatorio |
|---|---|---|---|
| version | Versión de UNSPSC a ser utilizada .. debe contener: v14.0.80 | cadena | SI |
| getClasses | Objeto para obtener clases | objeto | SI |
| lang | Idioma de la respuesta (en->Inglés, es->Español, all->Todos los idiomas disponibles) | cadena | SI |
| family | Familia del cual se desean todas las clases (4 dígitos) | cadena | SI |
Productos
Método Productos: Devuelve todos los productos pertenecientes a una clase
{
"UNSPSC":{
"version":"v14.0.80",
"getProducts": {
"lang":"es",
"class":"105016"
}
}
}
Objeto
| Parámetro | Descripción | Tipo | Obligatorio |
|---|---|---|---|
| version | Versión de UNSPSC a ser utilizada .. debe contener: v14.0.80 | cadena | SI |
| getProducts | Objeto para obtener productos | objeto | SI |
| lang | Idioma de la respuesta (en->Inglés, es->Español, all->Todos los idiomas disponibles) | cadena | SI |
| class | clase del cual se desean obtener los productos (6 dígitos) | cadena | SI |
Producto por código
Método por código: Devuelve toda la información referente a un código UNSPSC.
{
"UNSPSC":{
"version":"v14.0.80",
"getProductByCode": {
"lang":"es",
"code":"10501601"
}
}
}
Objeto
| Parámetro | Descripción | Tipo | Obligatorio |
|---|---|---|---|
| version | Versión de UNSPSC a ser utilizada .. debe contener: v14.0.80 | cadena | SI |
| getProductByCode | Objeto para obtener información de un producto | objeto | SI |
| lang | Idioma de la respuesta (en->Inglés, es->Español, all->Todos los idiomas disponibles) | cadena | SI |
| code | Código del producto (8 dígitos) | cadena | SI |
Producto por texto
Método de búsqueda por texto: Devuelve todos los códigos que en su texto contengan el "texto", entre un segmento dado.
{
"UNSPSC":{
"version":"v14.0.80",
"getProductByText": {
"lang":"es",
"segment":"10",
"text":"chile"
}
}
}
Objeto
| Parámetro | Descripción | Tipo | Obligatorio |
|---|---|---|---|
| version | Versión de UNSPSC a ser utilizada .. debe contener: v14.0.80 | cadena | SI |
| getProductByText | Busca productos por texto | objeto | SI |
| lang | Idioma de la respuesta (en->Inglés, es->Español, all->Todos los idiomas disponibles) | cadena | SI |
| segment | Segmento en el que se desea buscar (2 dígitos) | cadena | SI |
| text | Texto que se desea buscar | cadena | SI |
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"
},
{
"rangeKey":"rk-009e51a3986e10aad892275fb1e72594a",
"type":"creditNote",
"prefix":"NCR",
"from":"0",
"to":"999999999",
"last":"17"
},
{
"rangeKey":"rk-ad664ee282763d4f89870b653ac5b90e8",
"type":"debitNote",
"prefix":"NDE",
"from":"0",
"to":"999999999",
"last":"11"
}
]
}
}
ranges
Información referente a los rangos solicitados (Es un arreglo):
| Parámetro | Descripción | Tipo | Obligatorio |
|---|---|---|---|
| rangeKey | Llave del rango Es requerido para enviar una factura |
cadena | SI |
| type | Tipo de rango invoice -> Factura debitNote -> Nota Debito creditNote -> Nota Credito |
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
- 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.