Skip to main content
POST
Suspender una o más competencias por pago anticipado

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Idempotency
string
requerido

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

Ejemplo:

"idem-antecipacao-incluir-0001"

Parámetros de ruta

numero_contrato
string
requerido

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

Required string length: 2 - 15
Ejemplo:

"1997123478"

Cuerpo

application/json
listaCompetencias
string[] | null
requerido

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}$
Ejemplo:

Respuesta

OK

contrato
string
requerido

The contract number the rail confirmed the operation against.

Ejemplo:

"1997123478"

mensagem
string
requerido

The rail's own message.

Ejemplo:

"Antecipacao de parcela realizada com sucesso"