{ "openapi": "3.1.2", "info": { "title": "Fichacora", "version": "0.0.1-draft", "description": "Referencia preliminar de lectura. API cerrada, sin acceso ni sandbox público. Contrato sujeto a cambios antes del piloto. Código a61f5e3, 11/11/2026." }, "servers": [ { "url": "https://sandbox.example.invalid/api/v1/integraciones", "description": "Marcador inoperativo: no existe un sandbox público" } ], "tags": [ { "name": "Integración", "description": "Consultas de lectura de la API preliminar." }, { "name": "Empleados", "description": "Consultas de lectura de la API preliminar." }, { "name": "Sedes", "description": "Consultas de lectura de la API preliminar." }, { "name": "Fichajes", "description": "Consultas de lectura de la API preliminar." } ], "security": [ { "http": [] } ], "paths": { "/me": { "get": { "operationId": "v1.integraciones.me", "summary": "Consultar integración y empresa", "tags": [ "Integración" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "integration": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "scopes": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" }, "minItems": 0, "maxItems": 0 } ] }, "expires_at": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "scopes", "expires_at" ] }, "tenant": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "slug", "name" ] } }, "required": [ "integration", "tenant" ] } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" } } }, "401": { "description": "unauthenticated", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" }, "WWW-Authenticate": { "schema": { "type": "string" }, "description": "Bearer" } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" } } }, "404": { "description": "not_found", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" } } }, "405": { "description": "method_not_allowed", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" }, "Allow": { "schema": { "type": "string" } } } }, "422": { "description": "validation_failed", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" } } }, "429": { "description": "rate_limit_exceeded", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" }, "Retry-After": { "schema": { "type": "integer" }, "description": "Segundos antes de reintentar" } } }, "500": { "description": "internal_error", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" } } }, "503": { "description": "service_unavailable", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" } } } }, "description": "Identidad de la integración y empresa asociada a la credencial. El cliente no selecciona el tenant. Scope requerido: context:read.", "x-required-scope": "context:read" } }, "/employees": { "get": { "operationId": "v1.integraciones.employees.index", "summary": "Listar empleados activos", "tags": [ "Empleados" ], "parameters": [ { "name": "per_page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "page", "in": "query", "description": "Página desde 1; sin snapshot estable.", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "first_name": { "type": "string" }, "last_name": { "type": "string" } }, "required": [ "id", "first_name", "last_name" ] } }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": "integer" } }, "required": [ "current_page", "per_page", "total", "last_page" ] } }, "required": [ "data", "meta" ] } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" } } }, "422": { "description": "validation_failed", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" } } }, "401": { "description": "unauthenticated", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" }, "WWW-Authenticate": { "schema": { "type": "string" }, "description": "Bearer" } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" } } }, "404": { "description": "not_found", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" } } }, "405": { "description": "method_not_allowed", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" }, "Allow": { "schema": { "type": "string" } } } }, "429": { "description": "rate_limit_exceeded", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" }, "Retry-After": { "schema": { "type": "integer" }, "description": "Segundos antes de reintentar" } } }, "500": { "description": "internal_error", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" } } }, "503": { "description": "service_unavailable", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" } } } }, "description": "Solo empleados activos, ordenados por apellidos y nombre. No devuelve PIN, iCard ni datos de contacto. Scope requerido: employees:read.", "x-required-scope": "employees:read" } }, "/employee-schedules": { "get": { "operationId": "v1.integraciones.employee-schedules.index", "summary": "Consultar horarios de empleados", "tags": [ "Empleados" ], "parameters": [ { "name": "employee_id", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "date", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "page", "in": "query", "description": "Página desde 1; sin snapshot estable.", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "employee_id": { "type": "integer" }, "horario": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "color": { "type": [ "string", "null" ] }, "days": { "type": "string" } }, "required": [ "id", "name", "color", "days" ] } }, "required": [ "employee_id", "horario" ] } }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": "integer" } }, "required": [ "current_page", "per_page", "total", "last_page" ] } }, "required": [ "date", "data", "meta" ] } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" } } }, "422": { "description": "validation_failed", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" } } }, "401": { "description": "unauthenticated", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" }, "WWW-Authenticate": { "schema": { "type": "string" }, "description": "Bearer" } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" } } }, "404": { "description": "not_found", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" } } }, "405": { "description": "method_not_allowed", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" }, "Allow": { "schema": { "type": "string" } } } }, "429": { "description": "rate_limit_exceeded", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" }, "Retry-After": { "schema": { "type": "integer" }, "description": "Segundos antes de reintentar" } } }, "500": { "description": "internal_error", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" } } }, "503": { "description": "service_unavailable", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" } } } }, "description": "Horario asignado para date; por defecto, hoy según la aplicación. horario puede ser null. days contiene horas, minutos de descanso y día laborable. No es el calendario efectivo: no aplica por sí solo ausencias, festivos ni períodos de actividad. Scope requerido: employees:read.", "x-required-scope": "employees:read" } }, "/locations": { "get": { "operationId": "v1.integraciones.locations.index", "summary": "Listar sedes de empresa", "tags": [ "Sedes" ], "parameters": [ { "name": "per_page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "page", "in": "query", "description": "Página desde 1; sin snapshot estable.", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "address": { "type": "string" } }, "required": [ "id", "name", "address" ] } }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": "integer" } }, "required": [ "current_page", "per_page", "total", "last_page" ] } }, "required": [ "data", "meta" ] } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" } } }, "422": { "description": "validation_failed", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" } } }, "401": { "description": "unauthenticated", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" }, "WWW-Authenticate": { "schema": { "type": "string" }, "description": "Bearer" } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" } } }, "404": { "description": "not_found", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" } } }, "405": { "description": "method_not_allowed", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" }, "Allow": { "schema": { "type": "string" } } } }, "429": { "description": "rate_limit_exceeded", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" }, "Retry-After": { "schema": { "type": "integer" }, "description": "Segundos antes de reintentar" } } }, "500": { "description": "internal_error", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" } } }, "503": { "description": "service_unavailable", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" } } } }, "description": "Sedes de empresa, ordenadas por nombre. Devuelve id, name y address. Scope requerido: locations:read.", "x-required-scope": "locations:read" } }, "/time-entries": { "get": { "operationId": "v1.integraciones.time-entries.index", "summary": "Consultar jornadas de trabajo", "tags": [ "Fichajes" ], "parameters": [ { "name": "employee_id", "in": "query", "schema": { "type": "integer", "minimum": 1 } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "page", "in": "query", "description": "Página desde 1; sin snapshot estable.", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "employee_id": { "type": "integer" }, "entrada": { "type": [ "string", "null" ] }, "entrada_location_id": { "type": [ "integer", "null" ] }, "salida": { "type": [ "string", "null" ] }, "salida_location_id": { "type": [ "integer", "null" ] } }, "required": [ "id", "employee_id", "entrada", "entrada_location_id", "salida", "salida_location_id" ] } }, "meta": { "type": "object", "properties": { "current_page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": "integer" } }, "required": [ "current_page", "per_page", "total", "last_page" ] } }, "required": [ "data", "meta" ] } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" } } }, "422": { "description": "validation_failed", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" } } }, "401": { "description": "unauthenticated", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" }, "WWW-Authenticate": { "schema": { "type": "string" }, "description": "Bearer" } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" } } }, "404": { "description": "not_found", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" } } }, "405": { "description": "method_not_allowed", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" }, "Allow": { "schema": { "type": "string" } } } }, "429": { "description": "rate_limit_exceeded", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" }, "Retry-After": { "schema": { "type": "integer" }, "description": "Segundos antes de reintentar" } } }, "500": { "description": "internal_error", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" } } }, "503": { "description": "service_unavailable", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" } } } }, "description": "Jornadas ordenadas por entrada descendente y después id. from y to filtran la fecha de entrada de forma inclusiva, según la zona horaria de la aplicación; no seleccionan por solapamiento. Si se indican ambas, from no puede superar to. salida puede ser null. Entrada menos salida no representa horas efectivas: no se desglosan pausas ni se calculan nóminas. Scope requerido: time-entries:read.", "x-required-scope": "time-entries:read" } }, "/break-types": { "get": { "operationId": "v1.integraciones.break-types.index", "summary": "Listar tipos de descanso disponibles", "tags": [ "Fichajes" ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "string" } } }, "required": [ "data" ] } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" } } }, "401": { "description": "unauthenticated", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" }, "WWW-Authenticate": { "schema": { "type": "string" }, "description": "Bearer" } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" } } }, "404": { "description": "not_found", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" } } }, "405": { "description": "method_not_allowed", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" }, "Allow": { "schema": { "type": "string" } } } }, "422": { "description": "validation_failed", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" } } }, "429": { "description": "rate_limit_exceeded", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" }, "Retry-After": { "schema": { "type": "integer" }, "description": "Segundos antes de reintentar" } } }, "500": { "description": "internal_error", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" } } }, "503": { "description": "service_unavailable", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string", "format": "uuid" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } } }, "headers": { "X-Request-ID": { "schema": { "type": "string", "format": "uuid" } }, "Cache-Control": { "schema": { "type": "string" }, "description": "Incluye no-store" } } } }, "description": "Tipos de descanso activos, ordenados por nombre. Devuelve id, name, description e is_paid. No paginado. No inicia ni finaliza descansos. Scope requerido: time-entries:read.", "x-required-scope": "time-entries:read" } } }, "components": { "securitySchemes": { "http": { "type": "http", "scheme": "bearer" } }, "responses": { "ValidationException": { "description": "Validation error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "description": "Errors overview." }, "errors": { "type": "object", "description": "A detailed description of each field that failed validation.", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "required": [ "message", "errors" ] } } } } } } }