Read the payroll escrituração records included in a window

Reads the rail’s consultar-escrituracoes-remuneracoes (Manual 005 v1.13 §3.3): every escrituração record included in the inclusion window, each carrying its OWN competência and Dataprev’s pre-computed analise verdict, relayed verbatim. The window is mandatory and capped at 30 days by the rail (code GR); this gateway refuses a wider window locally. The read writes nothing: the reconciliation job’s per-record done-keys are untouched, so a record read here is still delivered as a fact by the job.

GET /v1/consignado/reconciliation/escrituracoes

Read the payroll escrituração records included in a window

cURL

curl --request GET \
  --url https://br-consignado-gw.sandbox.lerian.net/v1/consignado/reconciliation/escrituracoes \
  --header 'Authorization: Bearer <token>'

200

{
  "escrituracoes": [
    {
      "analise": {
        "dados_correspondentes": true,
        "existe_numero_contrato_escriturado": true,
        "existe_trabalhador_escriturado": true,
        "instituicao_financeira_correta": true,
        "valor_parcela_correta": true,
        "vinculo_correto": true
      },
      "competencia": "202607",
      "cpf": "99971699990",
      "matricula": "MATCEN716",
      "numero_contrato": "199971600000",
      "tipo_evento_esocial": {
        "codigo": 0,
        "descricao": "Periódico"
      },
      "valor_parcela": "1116.31"
    }
  ]
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Parámetros de consulta

data_hora_inicio · string<date-time> · requerido

Inclusion window start, RFC 3339 (rail dataHoraInicio, Obrigatório Sim — Manual 005 v1.13 §3.3.1 p.20 / §3.4.1 p.26).

Ejemplo:

"2026-07-01T00:00:00Z"

data_hora_fim · string<date-time> · requerido

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.

Ejemplo:

"2026-07-30T00:00:00Z"

Respuesta

200

application/json

OK

escrituracoes · object[] | null · requerido

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.

Show child attributes