Skip to main content
GET
Read the payroll escrituração records included in a window

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Query Parameters

data_hora_inicio
string<date-time>
required

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

Example:

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

data_hora_fim
string<date-time>
required

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.

Example:

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

Response

OK

escrituracoes
object[] | null
required

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.