Skip to content
GitLab

API Sector Privado · Changes

Page history
Update API Sector Privado authored by Nicolas Goldberg's avatar Nicolas Goldberg
Show whitespace changes
Inline Side-by-side
API-Sector-Privado.md
View page @ c75f20b2
## Rutas ## Rutas sector privado
### ARTICULOS ### CUENTAS CORRIENTES
<details open> <details open>
**<summary>Listado de articulos</summary>** **<summary>Listado cuenta corrientes</summary>**
<br/> <br/>
`Endpoint` `Endpoint`
``` ```
[GET] /articulos [POST] /cta_cte
``` ```
`Request` `Request`
```JSON ```JSON
{ {
"id": "string", "cantidad": number,
"q": "string", "offset": number,
"titulo_pagina_id": "string (1234) | comma separated array (1234,1236)", "matricula": "string",
"rubro_pagina_id": "string (1234) | comma separated array (1234,1236)", "desde": "string",
"clase_pagina_id": "string (1234) | comma separated array (1234,1236)", "hasta": "string",
"marca_pagina_id": "string (1234) | comma separated array (1234,1236)", "tipo": "H" | "A"
}
```
`Response`
```JSON
{
"resultado": "OK" | "ERROR"
"mensaje": "string", -> opcional cuando ERROR
"resultados": [
{
"fecha": "string",
"tipo_mov": "string",
"num_mov": "string",
"descrip": "string",
"debe": number,
"haber": number,
"saldo": number,
"ordeno": number,
}
]
}
```
</details>
<details open>
**<summary>Archivo extracto cuenta corriente</summary>**
<br/>
`Endpoint`
```
[POST] /cta_cte/resumen
```
`Request`
```JSON
{
"matricula": "string",
"desde": "string",
"hasta": "string",
"tipo": "H" | "A"
"formato": "PDF" | "CSV" | "EXCEL" -> depende cual acepte
}
```
`Response`
```JSON
{
"resultado": "OK" | "ERROR"
"mensaje": "string", -> opcional cuando ERROR
"archivo": "string", -> url al archivo
}
```
</details>
### LIQUIDACIONES
<details open>
**<summary>Listado liquidaciones</summary>**
<br/>
"limit": "number", `Endpoint`
"page": "number",
```
[POST] /liquidaciones/listado
```
`Request`
```JSON
{
"cantidad": number,
"offset": number,
"matricula": "string",
"desde": "string",
"hasta": "string",
} }
``` ```
...@@ -34,80 +117,262 @@ ...@@ -34,80 +117,262 @@
```JSON ```JSON
{ {
"response": { "resultado": "OK" | "ERROR"
"total": 1, "mensaje": "string", -> opcional cuando ERROR
"results": 1, "resultados": [
"paging": {
"complete": true,
"end": true,
"page": 1,
"pages": 1
},
"limit": 20,
"offset": 0
},
"results": [
{ {
"id": "0025337", "fecha": "string",
"ean13": "", "descrip": "string",
"ean132": "", "numero": number,
"descripcion": "ABRAZAD ACE CREM 23A29x12 mm", "prestaciones": number,
"cantidad_por_etiquetas": 0, "retenciones": number,
"cantidad_bultos": 1, "total": number,
"peso_total": 0, "id": "string",
"peso_neto": 0.025, "ordeno": number,
"cantidad_unidad": 0,
"cantidad_fraccion": 1,
"reemplazo": "",
"codigo_proveedor": "0000000000000ABRA009",
"cola": "ABRAZAD ACE CREM 23A29x12 mm",
"miniatura": null,
"imagen": null,
"stock": 7,
"titulo_pagina_id": 1234,
"rubro_pagina_id": 123,
"clase_pagina_id": 1,
"marca_pagina_id": 448,
"descripcion_pagina": "Descripción pagina",
"precio_web": 1000,
[...]
} }
], ]
"filters": { }
[...] ```
},
"order": {
"field": "descripcion", </details>
"sort": "ASC"
<details open>
**<summary>Archivo listado liquidaciones</summary>**
<br/>
`Endpoint`
```
[POST] /liquidaciones/listado/resumen
```
`Request`
```JSON
{
"matricula": "string",
"desde": "string",
"hasta": "string",
"formato": "PDF" | "CSV" | "EXCEL" -> depende cual acepte
}
```
`Response`
```JSON
{
"resultado": "OK" | "ERROR"
"mensaje": "string", -> opcional cuando ERROR
"archivo": "string", -> url al archivo
}
```
</details>
<details open>
**<summary>Archivo caratula</summary>**
<br/>
`Endpoint`
```
[POST] /liquidaciones/caratula
```
`Request`
```JSON
{
"id": "string",
}
```
`Response`
```JSON
{
"resultado": "OK" | "ERROR"
"mensaje": "string", -> opcional cuando ERROR
"archivo": "string", -> url al archivo
}
```
</details>
<details open>
**<summary>Archivo detalle liquidacion</summary>**
<br/>
`Endpoint`
```
[POST] /liquidaciones/detalle
```
`Request`
```JSON
{
"id": "string",
}
```
`Response`
```JSON
{
"resultado": "OK" | "ERROR"
"mensaje": "string", -> opcional cuando ERROR
"archivo": "string", -> url al archivo
}
```
</details>
### LIQUIDACIONES PENDIENTES
<details open>
**<summary>Listado liquidaciones pendientes</summary>**
<br/>
`Endpoint`
```
[POST] /liquidaciones/pendientes/listado
```
`Request`
```JSON
{
"cantidad": number,
"offset": number,
"matricula": "string",
"pend_tipo": "P"
}
```
`Response`
```JSON
{
"resultado": "OK" | "ERROR"
"mensaje": "string", -> opcional cuando ERROR
"resultados": [
{
"fecha": "string",
"descrip": "string",
"numero": number,
"prestaciones": number,
"retenciones": number,
"total": number,
"id": "string",
"ordeno": number,
} }
]
}
```
</details>
<details open>
**<summary>Archivo liquidaciones pendientes</summary>**
<br/>
`Endpoint`
```
[POST] /liquidaciones/pendientes/resumen
```
`Request`
```JSON
{
"matricula": "string",
"pend_tipo": "P"
}
```
`Response`
```JSON
{
"resultado": "OK" | "ERROR"
"mensaje": "string", -> opcional cuando ERROR
"archivo": "string", -> url al archivo
} }
``` ```
Ejemplo </details>
<details open>
**<summary>Archivo deuda consolidada</summary>**
<br/>
`Endpoint`
``` ```
CURL api.hogarshops.com/articulos?rubro_pagina_id=1234&limit=10&page=4 [POST] /liquidaciones/pendientes/deuda
```
`Request`
```JSON
{
"matricula": "string",
}
```
`Response`
```JSON
{
"resultado": "OK" | "ERROR"
"mensaje": "string", -> opcional cuando ERROR
"archivo": "string", -> url al archivo
}
``` ```
</details> </details>
### FACTURAS
<details open> <details open>
**<summary>Listado de articulos</summary>** **<summary>Listado de facturas</summary>**
<br/> <br/>
`Endpoint` `Endpoint`
``` ```
[GET] /articulos/:articulo [POST] /facturas/listado
``` ```
`Request` `Request`
```JSON ```JSON
{ {
"details": "imagenes|atributos|descripciones|contenidos", "cantidad": number,
"offset": number,
"matricula": "string",
"desde": "string",
"hasta": "string",
} }
``` ```
...@@ -115,36 +380,134 @@ CURL api.hogarshops.com/articulos?rubro_pagina_id=1234&limit=10&page=4 ...@@ -115,36 +380,134 @@ CURL api.hogarshops.com/articulos?rubro_pagina_id=1234&limit=10&page=4
```JSON ```JSON
{ {
"id": "0025337", "resultado": "OK" | "ERROR"
"ean13": "", "mensaje": "string", -> opcional cuando ERROR
"ean132": "", "resultados": [
"descripcion": "ABRAZAD ACE CREM 23A29x12 mm", {
"cantidad_por_etiquetas": 0, "fecha_prest": "string",
"cantidad_bultos": 1, "tipo": "string",
"peso_total": 0, "planilla": "string",
"peso_neto": 0.025, "matricula": "string",
"cantidad_unidad": 0, "nro_aut": "string",
"cantidad_fraccion": 1, "ooss": "string",
"reemplazo": "", "nro_fact_intern": "string",
"codigo_proveedor": "0000000000000ABRA009", "fecha": "string",
"cola": "ABRAZAD ACE CREM 23A29x12 mm", "porcentaje": "string",
"miniatura": null, "codigos": "string",[] <- array de codigos
"imagen": null, }
"stock": 7, ]
"titulo_pagina_id": 1234,
"rubro_pagina_id": 123,
"clase_pagina_id": 1,
"marca_pagina_id": 448,
"descripcion_pagina": "Descripción pagina",
"precio_web": 1000,
[...]
} }
``` ```
Ejemplo </details>
<details open>
**<summary>Archivo de facturas (CSV)</summary>**
<br/>
`Endpoint`
``` ```
CURL api.hogarshops.com/articulos/0025337?details=descripciones [POST] /facturas/resumen
```
`Request`
```JSON
{
"matricula": "string",
"desde": "string",
"hasta": "string",
}
```
`Response`
```JSON
{
"resultado": "OK" | "ERROR"
"mensaje": "string", -> opcional cuando ERROR
"archivo": "string", -> url al archivo
}
``` ```
</details> </details>
### FACTURAS PENDIENTES
<details open>
**<summary>Listado facturas no presentadas</summary>**
<br/>
`Endpoint`
```
[POST] /facturas/pendientes/listado
```
`Request`
```JSON
{
"cantidad": number,
"offset": number,
"matricula": "string",
}
```
`Response`
```JSON
{
"resultado": "OK" | "ERROR"
"mensaje": "string", -> opcional cuando ERROR
"resultados": [
{
"fecha": "string",
"hon_gravados": number,
"hon_exentos": number,
"gas_gravados": number,
"gas_exentos": number,
"iva": number,
"total": number,
}
]
}
```
</details>
<details open>
**<summary>Archivo de resumen facturas no presentadas</summary>**
<br/>
`Endpoint`
```
[POST] /facturas/pendientes/resumen
```
`Request`
```JSON
{
"matricula": "string",
"formato": "PDF" | "CSV" | "EXCEL" -> depende cual acepte
}
```
`Response`
```JSON
{
"resultado": "OK" | "ERROR"
"mensaje": "string", -> opcional cuando ERROR
"archivo": "string", -> url al archivo
}
```