Skip to main content
POST
Recuperar el margen consignable disponible de un trabajador

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Cuerpo

application/json
codigoInscricaoEmpregador
enum<string>
requerido

Employer inscription TYPE code: 1 = CNPJ, 2 = CPF.

Opciones disponibles:
1,
2
Ejemplo:

"1"

The worker's grupo-1 consent evidence. Relayed verbatim; never synthesized here.

cpf
string
requerido

Worker CPF, exactly 11 digits — a CPF is eleven digits by definition (Manual 002 v1.15 §3.1.1 p.8 types the request field Número, 11 algarismos). Body-only by design: a path or query CPF leaks into access logs and spans.

Pattern: ^[0-9]{11}$
Ejemplo:

"12345678901"

matricula
string
requerido

Employment bond matrícula.

Ejemplo:

"M-1"

numeroInscricaoEmpregador
string
requerido

Employer inscription number, relayed verbatim as Texto. Required: Manual 002 v1.15 §3.3.1 marks it Obrigatório on the worker data read.

Minimum string length: 1
Ejemplo:

"12345678000199"

contractRef
string

Client-chosen correlation reference echoed onto the emitted consignado.margin.fetched fact.

Ejemplo:

"req-1"

Respuesta

OK

asOf
string<date-time>
requerido

Instant the gateway observed this margin (UTC).

Ejemplo:

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

availableMargin
string
requerido

Available consignable margin (decimal string, BRL). Never a float.

Ejemplo:

"1234.56"

availableRemuneration
string
requerido

Disposable remuneration base (decimal string, BRL). Never a float.

Ejemplo:

"5000.00"

activeOrSuspendedLoans
integer<int64>

How many consignados already sit active or suspended on this bond. Manual 002 v1.15 §3.3.2 p.17 publishes the ceiling: 9 per employment bond, so a bond at 9 takes no tenth however much margin it shows. Absent when the rail said nothing; 0 is a live count.

Ejemplo:

2

blockType
object

The consignado block on this employment bond (Manual 002 v1.15 §3.3.2 table p.18: 0 no block, 1 blocked by the worker, 2 blocked by the MTE). A blocked bond can show a POSITIVE margin and still take no consignado, so this is not derivable from availableMargin. Code 0 is a live value.

contractRef
string

The correlation reference the request supplied.

Ejemplo:

"req-1"

eligible
boolean

The rail's own eligibility verdict for this worker. ABSENT when the read carried no verdict — which is NOT the same statement as false. Decode into a nullable boolean: collapsing absence into false recreates a refusal the rail never made.

Ejemplo:

true

grossPay
string

The worker's gross pay for the period the margin was computed against (decimal string, BRL). The denominator the margin is a slice of. Absent when the rail did not publish it — never "0".

Ejemplo:

"7000.00"

ineligibilityReason
object

WHY the rail refused (Manual 002 v1.15 §3.3.2 code table p.16: 1 legacy loan in eSocial, 2 legacy loan reported by the institution, 3 zero remuneration, 4 bond has a termination date, 5 no remuneration in the last competência, 6 invalid labour regime, 7 invalid worker category, 8 bond whose previous loan closed on termination, 9 employer not in the programme). The codes are not one kind: 3 and 5 clear with the next payroll competência, 4 never clears.

severanceAvailablePercent
string

The share of severance pay available as collateral on this bond (Manual 002 v1.15 §3.3.2 p.17, NÚMERO(3,2)) — a PERCENT PER the manual, as an exact decimal string relayed verbatim and never converted. 40.00 means forty percent, not 0.40.

Ejemplo:

"40.00"

terminationDate
string<date-time>

The BOND's termination date (Manual 002 v1.15 §3.3.2 p.15). A bond with one has no future payroll for an instalment to be discounted from. Absent when the bond is not terminated.

Ejemplo:

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

terminationReasonCode
string

The eSocial termination-reason code, relayed VERBATIM and never interpreted. Manual 002 v1.15 §3.3.2 p.15 types it "Número, 2 algarismos" and points at the eSocial "Motivos de Desligamento" table rather than reproducing it; JSON has no leading-zero literal, so a code beginning with 0 arrives one digit short and travels that way. Zero-pad to the published width before looking it up.

Ejemplo:

"2"