> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # Leer la ventana de competencia del calendario operativo de la red > Esta operación actúa como proxy de consultar-calendario-trabalhador (Manual 005 v1.13 §3.1): las fechas de inicio/fin de una competencia de nómina más la noción propia de la red de la competencia REAL. Responde a una competencia SOLAMENTE UNA VENTANA: el Manual 005 §3.1 no tiene apariciones de "feriado" y no publica ningún campo de día hábil, por lo que esta ruta nunca afirma que una fecha es o no un día hábil. Almacenado en caché por hasta una hora por (tenant, competencia), porque la lectura gasta la cuota de solicitudes de la red en cada llamada; un caché responde sin ningún viaje de ida y vuelta en la red. ## OpenAPI ````yaml es/openapi/v3-current/consignado.yaml get /v1/consignado/calendar openapi: 3.1.0 info: contact: email: contact@lerian.studio name: Lerian Studio url: https://lerian.studio description: >- Superficie OpenAPI 3.1 para Lerian Consignado — Dataprev. API cubre las credenciales y la configuración de red de tenant, el margen de los trabajadores, las subastas y ofertas de préstamos, el registro y el ciclo de vida de los contratos, la confirmación de desembolsos, la portabilidad, la refinanciación, la renegociación, las garantías de FGTS, la conciliación, los fondos, las asignaciones, el uso, el rendimiento y las suscripciones a eventos. El material secreto se escribe en el almacén secreto tenant y ninguna operación lo devuelve nunca. license: name: Lerian Studio General License title: Lerian Consignado API version: v1.0.0 servers: - url: https://consignado.sandbox.lerian.net security: - BearerAuth: [] tags: - description: >- Custodia de credenciales de Dataprev y configuración pública del rail por tenant (carga, estado, rotación, revocación, código del solicitante y URL base del portal del trabajador) name: Credentials - description: >- Uso de la gateway del consignado en el ámbito del tenant: agregación de unidades facturables con precio por competencia name: Consignado Usage - description: >- Plano de control de suscripción al hub de streaming per-tenant (enumerar, crear, obtener, rotar, revocar y probar la entrega) name: Subscriptions - description: >- Superficie de rail de nómina Dataprev: lecturas de saldo y autorización FGTS, ejecución de garantía FGTS, suspensión de contrato, reactivación y cambios de términos, documentos de contrato propios de la red y lecturas bajo demanda de leilão solicitações, escriturações, repasses y terminaciones de empleo. name: Consignado Rail - description: >- Superficie de comando de red síncrona: las operaciones de un bancarizador sin que el prestamista conduzca sobre HTTP. Cada uno comparte su implementación de comando con el activador de evento de prestamista equivalente. name: Consignado Rail Commands - description: >- Confirmación de desembolso propiedad de la gateway: un banco cliente que registra el dinero que ya pagó a un trabajador. No cruza ninguna frontera gubernamental y no representa ninguna operación Dataprev. name: Consignado Disbursement - description: > Rendimiento de red Dataprev saliente de autoservicio per-tenant: lea y configure el requests-per-second propio de este tenant, incluida una pausa deliberada en cero name: Consignado Throughput paths: /v1/consignado/calendar: get: tags: - Consignado Rail summary: Leer la ventana de competencia del calendario operativo de la red description: >- Esta operación actúa como proxy de consultar-calendario-trabalhador (Manual 005 v1.13 §3.1): las fechas de inicio/fin de una competencia de nómina más la noción propia de la red de la competencia REAL. Responde a una competencia SOLAMENTE UNA VENTANA: el Manual 005 §3.1 no tiene apariciones de "feriado" y no publica ningún campo de día hábil, por lo que esta ruta nunca afirma que una fecha es o no un día hábil. Almacenado en caché por hasta una hora por (tenant, competencia), porque la lectura gasta la cuota de solicitudes de la red en cada llamada; un caché responde sin ningún viaje de ida y vuelta en la red. operationId: getConsignadoCalendar parameters: - description: >- OPTIONAL payroll competência to query, yyyyMM (Manual 005 v1.13 §3.1.1, código CT). Omit it and the rail answers for its own current competência. explode: false in: query name: competencia schema: description: >- OPTIONAL payroll competência to query, yyyyMM (Manual 005 v1.13 §3.1.1, código CT). Omit it and the rail answers for its own current competência. examples: - '202410' pattern: ^[0-9]{6}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetCalendarResponse' description: OK default: content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Error security: - BearerAuth: [] components: schemas: GetCalendarResponse: additionalProperties: false properties: competencia_atual: description: >- The rail's own current competência, yyyyMM (Número). It can differ from competencia_consulta on ANY call. examples: - '202603' type: string competencia_consulta: description: >- The competência this read resolved to: your competencia filter, or the rail's current competência when you omitted it. examples: - '202410' type: string data_fim_competencia: description: End date of competencia_consulta (yyyy-MM-dd). examples: - '2024-09-20' type: string data_inicio_competencia: description: Start date of competencia_consulta (yyyy-MM-dd). examples: - '2024-08-21' type: string required: - competencia_atual - competencia_consulta - data_inicio_competencia - data_fim_competencia type: object Detail: additionalProperties: false properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). examples: - ERR-0001 type: string detail: description: >- A human-readable explanation specific to this occurrence of the problem. examples: - Property foo is required but is missing. type: string errors: description: Optional list of individual error details items: $ref: '#/components/schemas/ErrorDetail' type: - array - 'null' instance: description: >- A URI reference that identifies the specific occurrence of the problem. examples: - https://example.com/error-log/abc123 format: uri type: string status: description: HTTP status code examples: - 400 format: int64 type: integer title: description: >- A short, human-readable summary of the problem type. This value should not change between occurrences of the error. examples: - Bad Request type: string type: default: about:blank description: A URI reference to human-readable documentation for the error. examples: - https://example.com/errors/example format: uri type: string upstream: $ref: '#/components/schemas/Upstream' description: >- RFC 9457 extension member: the error a proxied third-party provider reported. Absent unless the emitting service explicitly surfaced one. type: object ErrorDetail: additionalProperties: false properties: location: description: >- Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id' type: string message: description: Error message text type: string value: description: The value at the given location type: object Upstream: additionalProperties: false properties: code: description: The upstream provider's own error code, verbatim. examples: - E4001 type: string message: description: >- The upstream provider's own error message, verbatim (bounded, never its raw response body). examples: - account not found at provider type: string type: object securitySchemes: BearerAuth: bearerFormat: JWT description: JWT bearer token issued by the identity provider. scheme: bearer type: http ````