Skip to main content
POST
Import a contract already averbado outside this gateway

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Idempotency
string
obrigatório

Required idempotency key. Absent is 422, never a generated default.

Exemplo:

"idem-import-1"

Parâmetros de caminho

numero_contrato
string
obrigatório

The contract number as the RAIL holds it (Manual 005 v1.13 §3.2.1 p.13, 2..15 alphanumerics). It is the only identifier the import takes: everything else about the contract is read back from Dataprev.

Required string length: 2 - 15
Exemplo:

"199971600000"

Corpo

application/json
parcelas_pagas
integer<int64>
padrão:0

How many monthly competências of this contract have ALREADY amortized under whoever averbou it. It must lie between 0 and the contract's own total de parcelas as the rail reports it; anything outside that is refused 422. Leave it at 0 only for a contract that has genuinely not been discounted yet — a higher value than reality makes the first saldo devedor report understate the debt, and a lower one overstates it.

Intervalo obrigatório: x >= 0
Exemplo:

7

Resposta

Created

competencia_inicio_desconto
string
obrigatório

The first payroll competência the discount runs in, as the rail's verbatim AAAAMM literal.

Exemplo:

"202601"

numero_contrato
string
obrigatório

The contract that was imported.

Exemplo:

"199971600000"

numero_parcelas
integer<int64>
obrigatório

The contract's total de parcelas, as the rail reports it. Read back, never supplied.

Exemplo:

24

origem
enum<string>
obrigatório

Always "importado" on this route — the provenance stamped on the obligation, distinguishing it forever from one this gateway averbou.

Opções disponíveis:
importado
Exemplo:

"importado"

parcelas_pagas
integer<int64>
obrigatório

The amortized count recorded on the obligation — the value sent with the request.

Exemplo:

7

saldo_devedor_dispatch_scheduled
boolean
obrigatório

Always true on a 201: the contract's first M015 saldo devedor report was scheduled durably alongside the obligation. It does NOT mean the report has been delivered to Dataprev — the outbox does that afterwards.

Exemplo:

true

situacao_emprestimo
integer<int64>
obrigatório

The rail's own situação código for the contract at the moment it was imported (Manual 005 §3.2.2 p.17). Only 0, 7, 8 and 17 are importable.

Exemplo:

0

valor_parcela
string
obrigatório

The instalment, as the rail reports it, verbatim (BRL decimal string).

Exemplo:

"1116.31"