Referencia · Catálogos
Listar locales
POST
/localesListadoListado de locales de la empresa. No requiere body.
Solicitud
Sección titulada «Solicitud»La ruta POST /localesListado se agrega a la URL base del ambiente.
Enviá los headers x-api-key y x-api-secret. Cómo obtenerlos está en Credenciales.
No lleva cuerpo.
Este endpoint no recibe campos.
Respuesta 200
Sección titulada «Respuesta 200»Listado de locales de la empresa
Si la operación sale bien, codigoError es "0".
| Campo | Tipo | Obligatorio | Descripción | Ejemplo |
|---|---|---|---|---|
descripcion |
string | Sí | — | — |
codigoError |
string | Sí | — | — |
locales |
array de objetos | No | Ver locales. | — |
Respuesta locales
Sección titulada «Respuesta locales»| Campo | Tipo | Obligatorio | Descripción | Ejemplo |
|---|---|---|---|---|
id |
string | Sí | Identificador del local. Es el valor que podés enviar en local al emitir. |
— |
nombreComercial |
string | Sí | Nombre comercial del local. | — |
nombre |
string | Sí | Nombre interno del local. | — |
direccion |
string | Sí | Dirección del local. | — |
localidad |
string | Sí | Localidad del local. | — |
departamento |
string | Sí | Departamento del local. | — |
codigoDgi |
number | Sí | Código de sucursal informado a DGI. | — |
activo |
boolean | Sí | El listado solo incluye locales activos. | — |
Errores
Sección titulada «Errores»Una respuesta de error trae codigoError y descripcion. El mismo código puede significar cosas distintas según el endpoint. El índice completo está en Códigos de error.
Si fallan las credenciales o el formato del body, aplican los códigos comunes: A01 a A06, V01 y V02.
| Código | Significado |
|---|---|
| E02 | Empresa no encontrada |
HTTP 500
Sección titulada «HTTP 500»Error al obtener catálogo
{ "descripcion": "Empresa no encontrada", "codigoError": "E02"}Ejemplos
Sección titulada «Ejemplos»Este endpoint no lleva cuerpo.