Saltar al contenido principal

Módulo de Datos Maestros (MasterData)

El módulo MasterData proporciona endpoints centralizados para la consulta de ficheros maestros y tablas auxiliares de referencia de BaseGes ERP.

Está concebido para alimentar desplegables, combos de selección, validaciones y sincronizaciones de datos maestros transversales que utilizan el resto de módulos del sistema (ventas, compras, contabilidad, etc.).

Disponibilidad Universal y Permisos

Este módulo está siempre disponible para cualquier tipo de configuración de permisos.

No requiere contratar ni licenciar un módulo específico de datos maestros. Cualquier integración autenticada mediante una API Key activa con permisos sobre al menos un módulo del ERP (o mediante JWT) tiene acceso garantizado de lectura a todas las consultas de este módulo.


Estrategia de Consulta Unificada​

El módulo implementa un patrón común con dos niveles de detalle:

  1. Listado Paginado (GET /api/masterdata/{recurso}):

    • Proyección ligera y optimizada de dos campos: code (código) y description (nombre o descripción).
    • Soporta búsqueda parcial (search) evaluada directamente en la base de dades SQL (coincidencia en código o descripción).
    • Paginación mediante page y pageSize.
    • Ideal para autocompletes, selectores UI y listados rápidos.
  2. Detalle Completo (GET /api/masterdata/{recurso}/{code}):

    • Retorna todos los datos y columnas del registro maestro (datos extendidos como porcentajes, recargos, distancias, tiempos de desplazamiento, cuentas contables asociadas, etc.).
    • Retorna 200 OK si existe o 404 Not Found si el código no está registrado.

Ficheros Maestros Disponibles​

A continuación se detallan las tablas y recursos actualmente disponibles:

Recurso (Endpoint)DescripciónEntorno BDDatos en Detalle
/api/masterdata/countriesPaíses del sistemaCompartida (SharedDb)Código, Nombre
/api/masterdata/payment-methodsFormas de pago y cobroCompartida (SharedDb)Código, Nombre
/api/masterdata/delivery-routesRutas de repartoEmpresa (TenantDb)Código, Nombre
/api/masterdata/vehiclesFlota de vehículosEmpresa (TenantDb)Código, Matrícula
/api/masterdata/zonesZonas y tarifas de transporteCompartida (SharedDb)Código, Nombre, Distancia, Oferta, Tiempo
/api/masterdata/retention-conceptsConceptos de retención IRPFCompartida (SharedDb)Código, Nombre, Porcentaje, Cuenta contable, Reglas de base
/api/masterdata/input-taxesTipos de IVA soportado (compras)Compartida (SharedDb)Código, Nombre, %, Cuenta, % Recargo, Cuenta recargo
/api/masterdata/output-taxesTipos de IVA repercutido (ventas)Compartida (SharedDb)Código, Nombre, %, Cuenta, % Recargo, Cuenta recargo

Autenticación y Cabeceras​

Todas las peticiones requieren las cabeceras estándar de la API:

X-Company-Id: 001
X-Api-Key: tu-api-key
Accept: application/json

O bien mediante token Bearer JWT:

Authorization: Bearer eyJhbGciOi...
X-Company-Id: 001
Accept: application/json