Documentación de la API

API REST para acceso a las colecciones de autoliquidaciones: valor, rc, nif y c60.

Base URL: https://api.tributec.es

Ejemplos Interactivos

Haz clic en cualquier ejemplo para ver la respuesta real de la API en tiempo real. No necesitas configurar nada, todos los ejemplos usan un token de demostración.

Autenticación

Todos los endpoints requieren un token de API que debe incluirse en el header Authorization:

Authorization: Bearer YOUR_API_TOKEN

Para obtener un token de API, contacta con el administrador o accede al panel de administración.

Endpoints Disponibles

Colección: Valor

GET /api/valor

Lista de valores con filtros y paginación

Filtros: status, clave.aaaa, clave.concepto, sujetoPasivo.nif, sujetoPasivo.nombre, periodo.ejercicio, periodo.periodo, importe

GET /api/valor/[id]

Detalle de un valor por ID

Colección: RC

GET /api/rc

Lista de RCs con filtros y paginación

Filtros: status, sujetoPasivo.nif, sujetoPasivo.nombre, tipoRC, numero, total

GET /api/rc/[id]

Detalle de un RC por ID

Colección: NIF

GET /api/nif

Lista de NIFs con filtros y paginación

Filtros: nif, nombre, userType, contacto.email

GET /api/nif/[id]

Detalle de un NIF por ID

Colección: C60

GET /api/c60

Lista de registros C60 con filtros y paginación

Filtros: status, registros, importe, totalImporte

GET /api/c60/[id]

Detalle de un registro C60 por ID

Referencia

GET /api/referencia/[referencia+dc]

Devuelve la RC y su único valor asociado a partir de la referencia completa

Parámetros de Consulta

page- Número de página (default: 1)
limit- Elementos por página (default: 50, max: 100)
sort- Campo para ordenar (default: _id)
order- Orden: asc o desc (default: desc)

Ejemplo de Uso con cURL

# Obtener lista de valores filtrados por status
curl -H "Authorization: Bearer YOUR_TOKEN" \
  "http://localhost:3000/api/valor?status=pagado&page=1&limit=10"

# Obtener detalle de un valor específico
curl -H "Authorization: Bearer YOUR_TOKEN" \
  "http://localhost:3000/api/valor/668e5590645a42ac111fd0b5"

# Buscar NIFs por nombre
curl -H "Authorization: Bearer YOUR_TOKEN" \
  "http://localhost:3000/api/nif?nombre=ORANGE&limit=5"

# Obtener RC y valor asociados a partir de referencia completa
curl -H "Authorization: Bearer YOUR_TOKEN" \
  "http://localhost:3000/api/referencia/1234567801"

Formato de Respuestas

Las respuestas de lista incluyen paginación:

{
  "success": true,
  "data": [...],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 806,
    "totalPages": 17
  }
}