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 @ d6b99596
## Rutas sector privado ## Rutas
### CUENTAS CORRIENTES ### ARTICULOS
<details open> <details open>
**<summary>Listado cuenta corrientes</summary>** **<summary>Listado de articulos</summary>**
<br/> <br/>
`Endpoint` `Endpoint`
``` ```
[POST] /cta_cte [GET] /articulos
``` ```
`Request` `Request`
```JSON ```JSON
{ {
"cantidad": number,
"offset": number,
"matricula": "string",
"desde": "string",
"hasta": "string",
"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/>
`Endpoint`
```
[POST] /liquidaciones/listado
```
`Request`
```JSON
{
"cantidad": number,
"offset": number,
"matricula": "string",
"desde": "string",
"hasta": "string",
}
```
`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", "id": "string",
"ordeno": number, "q": "string",
} "titulo_pagina_id": "string (1234) | comma separated array (1234,1236)",
] "rubro_pagina_id": "string (1234) | comma separated array (1234,1236)",
} "clase_pagina_id": "string (1234) | comma separated array (1234,1236)",
``` "marca_pagina_id": "string (1234) | comma separated array (1234,1236)",
</details>
<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` "limit": "number",
"page": "number",
```
[POST] /liquidaciones/pendientes/listado
```
`Request`
```JSON
{
"cantidad": number,
"offset": number,
"matricula": "string",
"pend_tipo": "P"
} }
``` ```
...@@ -266,196 +34,80 @@ ...@@ -266,196 +34,80 @@
```JSON ```JSON
{ {
"resultado": "OK" | "ERROR" "response": {
"mensaje": "string", -> opcional cuando ERROR "total": 1,
"resultados": [ "results": 1,
"paging": {
"complete": true,
"end": true,
"page": 1,
"pages": 1
},
"limit": 20,
"offset": 0
},
"results": [
{ {
"fecha": "string", "id": "0025337",
"descrip": "string", "ean13": "",
"numero": number, "ean132": "",
"prestaciones": number, "descripcion": "ABRAZAD ACE CREM 23A29x12 mm",
"retenciones": number, "cantidad_por_etiquetas": 0,
"total": number, "cantidad_bultos": 1,
"id": "string", "peso_total": 0,
"ordeno": number, "peso_neto": 0.025,
"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": {
``` [...]
},
</details> "order": {
"field": "descripcion",
<details open> "sort": "ASC"
**<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
}
```
</details>
<details open>
**<summary>Archivo deuda consolidada</summary>**
<br/>
`Endpoint`
```
[POST] /liquidaciones/pendientes/deuda
```
`Request`
```JSON
{
"matricula": "string",
}
```
`Response`
```JSON
{
"resultado": "OK" | "ERROR"
"mensaje": "string", -> opcional cuando ERROR
"archivo": "string", -> url al archivo
}
```
</details>
### FACTURAS
<details open>
**<summary>Listado de facturas</summary>**
<br/>
`Endpoint`
```
[POST] /facturas/listado
```
`Request`
```JSON
{
"cantidad": number,
"offset": number,
"matricula": "string",
"desde": "string",
"hasta": "string",
}
```
`Response`
```JSON
{
"resultado": "OK" | "ERROR"
"mensaje": "string", -> opcional cuando ERROR
"resultados": [
{
"fecha_prest": "string",
"tipo": "string",
"planilla": "string",
"matricula": "string",
"nro_aut": "string",
"ooss": "string",
"nro_fact_intern": "string",
"fecha": "string",
"porcentaje": "string",
"codigos": "string",[] <- array de codigos
} }
]
} }
``` ```
</details> Ejemplo
<details open>
**<summary>Archivo de facturas (CSV)</summary>**
<br/>
`Endpoint`
``` ```
[POST] /facturas/resumen CURL api.hogarshops.com/articulos?rubro_pagina_id=1234&limit=10&page=4
```
`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> <details open>
**<summary>Listado facturas no presentadas</summary>** **<summary>Listado de articulos</summary>**
<br/> <br/>
`Endpoint` `Endpoint`
``` ```
[POST] /facturas/pendientes/listado [GET] /articulos/:articulo
``` ```
`Request` `Request`
```JSON ```JSON
{ {
"cantidad": number, "details": "imagenes|atributos|descripciones|contenidos",
"offset": number,
"matricula": "string",
} }
``` ```
...@@ -463,51 +115,36 @@ ...@@ -463,51 +115,36 @@
```JSON ```JSON
{ {
"resultado": "OK" | "ERROR" "id": "0025337",
"mensaje": "string", -> opcional cuando ERROR "ean13": "",
"resultados": [ "ean132": "",
{ "descripcion": "ABRAZAD ACE CREM 23A29x12 mm",
"fecha": "string", "cantidad_por_etiquetas": 0,
"hon_gravados": number, "cantidad_bultos": 1,
"hon_exentos": number, "peso_total": 0,
"gas_gravados": number, "peso_neto": 0.025,
"gas_exentos": number, "cantidad_unidad": 0,
"iva": number, "cantidad_fraccion": 1,
"total": number, "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,
[...]
} }
``` ```
</details> Ejemplo
<details open>
**<summary>Archivo de resumen facturas no presentadas</summary>**
<br/>
`Endpoint`
```
[POST] /facturas/pendientes/resumen
``` ```
CURL api.hogarshops.com/articulos/0025337?details=descripciones
`Request`
```JSON
{
"matricula": "string",
"formato": "PDF" | "CSV" | "EXCEL" -> depende cual acepte
}
``` ```
`Response` </details>
```JSON
{
"resultado": "OK" | "ERROR"
"mensaje": "string", -> opcional cuando ERROR
"archivo": "string", -> url al archivo
}
```