Skip to main content
GET
Read the rail's operational-calendar competência window

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Query Parameters

competencia
string

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.

Pattern: ^[0-9]{6}$
Example:

"202410"

Response

OK

competencia_atual
string
required

The rail's own current competência, yyyyMM (Número). It can differ from competencia_consulta on ANY call.

Example:

"202603"

competencia_consulta
string
required

The competência this read resolved to: your competencia filter, or the rail's current competência when you omitted it.

Example:

"202410"

data_fim_competencia
string
required

End date of competencia_consulta (yyyy-MM-dd).

Example:

"2024-09-20"

data_inicio_competencia
string
required

Start date of competencia_consulta (yyyy-MM-dd).

Example:

"2024-08-21"