Saltar al contenido principal

Endpoints de Datos Maestros

Esta sección documenta los endpoints de consulta de los ficheros maestros y tablas auxiliares.

Regla de Permisos

Este módulo está disponible siempre. No requiere un módulo específico de licencia de datos maestros; cualquier API Key activa con permisos en algún módulo del sistema tiene acceso concedido a todos los endpoints que figuran en esta página.

Parámetros Comunes en Listados​

Todos los endpoints de listado (GET /api/masterdata/{recurso}) admiten los siguientes parámetros por query string:

ParámetroTipoPredeterminadoRango / Descripción
pageinteger1Número de página (mínimo 1).
pageSizeinteger50Registros por página (entre 1 y 100).
searchstringnullBúsqueda parcial por texto (evalúa coincidencias tanto en el código como en la descripción).

Estructura de Respuesta Paginada​

{
  "items": [
    {
      "code": "01",
      "description": "Descripción del registro"
    }
  ],
  "totalCount": 142,
  "page": 1,
  "pageSize": 50,
  "totalPages": 3,
  "hasPreviousPage": false,
  "hasNextPage": true
}

1. Países (countries)​

Consulta los países configurados a nivel general en BaseGes.

Listado Paginado​

GET /api/masterdata/countries?page=1&pageSize=20&search=ES HTTP/1.1
X-Company-Id: 001
X-Api-Key: tu-api-key

Detalle por Código​

GET /api/masterdata/countries/ES HTTP/1.1
X-Company-Id: 001
X-Api-Key: tu-api-key

Respuesta Detalle (200 OK):

{
  "code": "ES",
  "name": "España"
}

2. Formas de Pago (payment-methods)​

Consulta los métodos y condiciones de pago y cobro.

Listado Paginado​

GET /api/masterdata/payment-methods?page=1&pageSize=50 HTTP/1.1
X-Company-Id: 001
X-Api-Key: tu-api-key

Detalle por Código​

GET /api/masterdata/payment-methods/01 HTTP/1.1
X-Company-Id: 001
X-Api-Key: tu-api-key

Respuesta Detalle (200 OK):

{
  "code": "01",
  "name": "Transferencia bancaria a 30 días"
}

3. Rutas de Reparto (delivery-routes)​

Consulta las rutas logísticas de entrega asociadas a la empresa activa.

Listado Paginado​

GET /api/masterdata/delivery-routes?page=1&pageSize=50 HTTP/1.1
X-Company-Id: 001
X-Api-Key: tu-api-key

Detalle por Código​

GET /api/masterdata/delivery-routes/R01 HTTP/1.1
X-Company-Id: 001
X-Api-Key: tu-api-key

Respuesta Detalle (200 OK):

{
  "code": "R01",
  "name": "Ruta Nord / Maresme"
}

4. Vehículos (vehicles)​

Consulta la flota de vehículos registrada en la empresa.

Listado Paginado​

GET /api/masterdata/vehicles?page=1&pageSize=50 HTTP/1.1
X-Company-Id: 001
X-Api-Key: tu-api-key

Detalle por Código​

GET /api/masterdata/vehicles/V01 HTTP/1.1
X-Company-Id: 001
X-Api-Key: tu-api-key

Respuesta Detalle (200 OK):

{
  "code": "V01",
  "registration": "1234BBB"
}

5. Zonas (zones)​

Consulta las zonas geográficas y sus tarifas de transporte y kilometraje.

Listado Paginado​

GET /api/masterdata/zones?page=1&pageSize=50 HTTP/1.1
X-Company-Id: 001
X-Api-Key: tu-api-key

Detalle por Código​

GET /api/masterdata/zones/Z01 HTTP/1.1
X-Company-Id: 001
X-Api-Key: tu-api-key

Respuesta Detalle (200 OK):

{
  "code": "Z01",
  "name": "Área Metropolitana",
  "distance": 25.00,
  "offerCode": "TAR-01",
  "travelTime": 40.00
}

6. Conceptos de Retención (retention-concepts)​

Consulta las tipologías de retención fiscal (IRPF, arrendamientos, profesionales).

Listado Paginado​

GET /api/masterdata/retention-concepts?page=1&pageSize=50 HTTP/1.1
X-Company-Id: 001
X-Api-Key: tu-api-key

Detalle por Código​

GET /api/masterdata/retention-concepts/01 HTTP/1.1
X-Company-Id: 001
X-Api-Key: tu-api-key

Respuesta Detalle (200 OK):

{
  "code": "01",
  "name": "Arrendamiento de inmuebles urbanos",
  "percent": 19.00,
  "accountCode": "475100001",
  "applyToTaxableBase": true,
  "applyToCustomAmount": false,
  "applyToTotalInvoice": false
}

7. Impuestos Soportados (input-taxes)​

Consulta los tipos de IVA soportado para documentos y facturas de compra y proveedores.

Listado Paginado​

GET /api/masterdata/input-taxes?page=1&pageSize=50 HTTP/1.1
X-Company-Id: 001
X-Api-Key: tu-api-key

Detalle por Código​

GET /api/masterdata/input-taxes/01 HTTP/1.1
X-Company-Id: 001
X-Api-Key: tu-api-key

Respuesta Detalle (200 OK):

{
  "code": "01",
  "name": "IVA General 21%",
  "percent": 21.00,
  "accountCode": "472000021",
  "equivalenceSurchargePercent": 5.20,
  "equivalenceSurchargeAccountCode": "472000052"
}

8. Impuestos Repercutidos (output-taxes)​

Consulta los tipos de IVA repercutido aplicables a clientes y facturación de venta.

Listado Paginado​

GET /api/masterdata/output-taxes?page=1&pageSize=50 HTTP/1.1
X-Company-Id: 001
X-Api-Key: tu-api-key

Detalle por Código​

GET /api/masterdata/output-taxes/01 HTTP/1.1
X-Company-Id: 001
X-Api-Key: tu-api-key

Respuesta Detalle (200 OK):

{
  "code": "01",
  "name": "IVA General 21%",
  "percent": 21.00,
  "accountCode": "477000021",
  "equivalenceSurchargePercent": 5.20,
  "equivalenceSurchargeAccountCode": "477000052"
}

Códigos de Estado HTTP​

CódigoSignificadoCausa
200 OKPetición exitosaDevuelve el listado paginado o el detalle del registro.
400 Bad RequestParámetros inválidosParámetro page < 1, pageSize < 1 o pageSize > 100, o código vacío.
401 UnauthorizedAutenticación ausenteCabeceras X-Api-Key o Authorization no proporcionadas o inválidas.
403 ForbiddenAcceso denegadoLa API Key está caducada, suspendida o carece de permisos en todos los módulos.
404 Not FoundNo encontradoEl código del registro maestro solicitado en la URL no existe en el sistema.
500 Internal Server ErrorError de servidorIncidencia interna en base de datos.