> ## 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 los registros de escrituração de nómina incluidos en una ventana > Lee el consultar-escrituracoes-remuneracoes de la red (Manual 005 v1.13 §3.3): cada registro de escrituração incluido en la ventana de inclusión, cada uno con su competencia propio y el veredicto de análisis precalculado de Dataprev, transmitido textualmente. La ventana es obligatoria y está limitada a 30 días por la red (código gr); esta gateway rechaza una ventana más amplia a nivel local. La lectura no escribe nada: las teclas de finalización por registro del trabajo de conciliación no se modifican, por lo que el trabajo aún entrega un registro leído aquí como un hecho. ## OpenAPI ````yaml es/openapi/v3-current/consignado.yaml get /v1/consignado/reconciliation/escrituracoes 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/reconciliation/escrituracoes: get: tags: - Consignado Rail summary: Leer los registros de escrituração de nómina incluidos en una ventana description: >- Lee el consultar-escrituracoes-remuneracoes de la red (Manual 005 v1.13 §3.3): cada registro de escrituração incluido en la ventana de inclusión, cada uno con su competencia propio y el veredicto de análisis precalculado de Dataprev, transmitido textualmente. La ventana es obligatoria y está limitada a 30 días por la red (código gr); esta gateway rechaza una ventana más amplia a nivel local. La lectura no escribe nada: las teclas de finalización por registro del trabajo de conciliación no se modifican, por lo que el trabajo aún entrega un registro leído aquí como un hecho. operationId: listConsignadoEscrituracoes parameters: - description: >- Inclusion window start, RFC 3339 (rail dataHoraInicio, Obrigatório Sim — Manual 005 v1.13 §3.3.1 p.20 / §3.4.1 p.26). explode: false in: query name: data_hora_inicio required: true schema: description: >- Inclusion window start, RFC 3339 (rail dataHoraInicio, Obrigatório Sim — Manual 005 v1.13 §3.3.1 p.20 / §3.4.1 p.26). examples: - '2026-07-01T00:00:00Z' format: date-time type: string - description: >- Inclusion window end, RFC 3339 (rail dataHoraFim, Obrigatório Sim). The span must not exceed 30 days — the rail answers code GR above that (Manual 005 v1.13 §4.1 p.29), and this gateway refuses 422 locally so the attempt costs no rail quota. explode: false in: query name: data_hora_fim required: true schema: description: >- Inclusion window end, RFC 3339 (rail dataHoraFim, Obrigatório Sim). The span must not exceed 30 days — the rail answers code GR above that (Manual 005 v1.13 §4.1 p.29), and this gateway refuses 422 locally so the attempt costs no rail quota. examples: - '2026-07-30T00:00:00Z' format: date-time type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/DataprevEscrituracoesResponse' description: OK default: content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Error security: - BearerAuth: [] components: schemas: DataprevEscrituracoesResponse: additionalProperties: false properties: escrituracoes: description: >- The escrituração records included in the window. Each carries its OWN competência — there is no envelope-level competência because one window routinely spans two payroll months. An empty list is the rail's answer, not an error. items: $ref: '#/components/schemas/DataprevEscrituracao' type: - array - 'null' required: - escrituracoes 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 DataprevEscrituracao: additionalProperties: false properties: analise: $ref: '#/components/schemas/DataprevEscrituracaoAnalise' description: >- Dataprev's OWN pre-computed reconciliation verdict for this record, relayed verbatim. The gateway does not re-derive it. competencia: description: >- The record's OWN payroll competência, yyyyMM, from the wire's periodoReferencia (Manual 005 §3.3.2 p.21, Número). It is the record's attribution key: one query window routinely spans two payroll months, so never attribute a record to the competência you queried. examples: - '202607' type: string cpf: description: >- The worker the record belongs to, 11 digits. Re-padded from the rail's JSON Número. examples: - '99971699990' type: string matricula: description: >- The worker's payroll registration on the bond the discount was taken from (Manual 005 §3.3.2 p.21, Texto). With cpf it names the employment bond — which is precisely what this record's own vinculo_correto verdict is about. Empty when the rail did not publish it. examples: - MATCEN716 type: string numero_contrato: description: The contract the escrituração record belongs to. examples: - '199971600000' type: string tipo_evento_esocial: $ref: '#/components/schemas/DataprevTipoEventoESocial' description: >- The eSocial event-kind block. It is a SIBLING of analise on the wire (Manual 005 §3.3.2), not a field inside it. valor_parcela: description: >- The instalment amount actually DISCOUNTED from payroll (decimal string, BRL). Its source wire field is valorParcelaDesconto (Manual 005 §3.3.2) — NOT the contract's emprestimo.valorParcela, which is what the contract expected. examples: - '1116.31' type: string required: - numero_contrato - cpf - matricula - competencia - valor_parcela - analise - tipo_evento_esocial 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 DataprevEscrituracaoAnalise: additionalProperties: false properties: dados_correspondentes: description: >- The rail's AGGREGATE verdict that the escriturated data corresponds to the averbado contract. examples: - true type: boolean existe_numero_contrato_escriturado: description: The rail's verdict that the contract number was found escriturado. examples: - true type: boolean existe_trabalhador_escriturado: description: >- The rail's verdict that the worker was found escriturado for the competência. examples: - true type: boolean instituicao_financeira_correta: description: The rail's verdict that the lending institution matches. examples: - true type: boolean valor_parcela_correta: description: >- The rail's verdict that the escriturated instalment matches the averbado contract. false is the reconciliation signal that payroll discounted an amount other than the contracted one. examples: - true type: boolean vinculo_correto: description: The rail's verdict that the employment vínculo matches. examples: - true type: boolean required: - existe_trabalhador_escriturado - existe_numero_contrato_escriturado - vinculo_correto - instituicao_financeira_correta - valor_parcela_correta - dados_correspondentes type: object DataprevTipoEventoESocial: additionalProperties: false properties: codigo: description: >- The eSocial event kind: 0 = periódico, 1 = não-periódico (desligamento/rescisório). examples: - 0 format: int64 type: integer descricao: description: The rail's own label for the event kind. examples: - Periódico type: string required: - codigo - descricao type: object securitySchemes: BearerAuth: bearerFormat: JWT description: JWT bearer token issued by the identity provider. scheme: bearer type: http ````