Skip to main content
POST
Suspend one or more competências by early payment

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency
string
required

Client-chosen idempotency key. REQUIRED: an absent key is 422, never a generated default.

Example:

"idem-antecipacao-incluir-0001"

Path Parameters

numero_contrato
string
required

Rail contract number of an averbação belonging to the authenticated tenant.

Required string length: 2 - 15
Example:

"1997123478"

Body

application/json
listaCompetencias
string[] | null
required

Competências to suspend by early payment, each yyyyMM. Must be non-empty, well-formed and free of duplicates; the rail's own UA additionally refuses any competência that is not strictly greater than its current payroll competência, or that falls outside the contract's programmed discount window.

Minimum array length: 1
Pattern: ^[0-9]{6}$
Example:

Response

OK

contrato
string
required

The contract number the rail confirmed the operation against.

Example:

"1997123478"

mensagem
string
required

The rail's own message.

Example:

"Antecipacao de parcela realizada com sucesso"