List what each averbado contract of this tenant still owes
Walks the tenant’s saldo devedor obligation book, lowest contract number first: what each averbado contract still owes, as this gateway itself reports it to the payroll rail under M015.
‘valor_saldo_devedor’ is DERIVED on every read and never stored: it is the nominal remaining balance, published BESIDE ‘valor_parcela’, ‘numero_parcelas’ and ‘parcelas_pagas’ precisely so a client can redo the multiplication and see the same figure the rail was given. ‘valor_parcela’ is republished byte for byte as the schedule stores it and is never re-scaled, because a reformatted number would make the screen and the rail report two spellings of one amount.
‘quitado’ is likewise derived, as parcelas_pagas >= numero_parcelas, the same predicate the M015 clock’s own scan filters on. It is not a stored flag, because two owners of that fact would disagree.
Filter with ‘quitado=true’ for the settled obligations or ‘quitado=false’ for the ones still paying. OMITTING the parameter is the whole book, which is what an operator arriving with no filter is asking for, and it is the only way to see a settled obligation at all: the table’s own index deliberately excludes them, and they are exactly the rows a client reconciling a finished contract comes to check.
‘proximo_marco’ is ALWAYS null today. The column exists and its only intended writer, the ANBIMA calendar clock, does not write it yet. It is published anyway so a screen has one name for the fact rather than two once a writer appears. ‘ultimo_envio_at’ is null until this gateway has reported the obligation at least once, and it travels as null rather than as the zero instant.
The worker’s CPF is deliberately absent from every row. It is on the table only because M015 resends it on each report, and this screen answers its question without it.
Paging is keyset over the contract number, which is half the table’s own primary key, so the page costs an index walk and no sort. Send the previous page’s page.next_after as after. has_more is true exactly when another page exists, and next_after is null exactly when it is false, so a client loop may terminate on either. The cursor never expires; a cursor this service did not mint is refused with 422 rather than silently restarting the walk from the top.
It answers from a LOCAL table and never reaches the Dataprev rail, so it cannot answer 501 and it is served on a deployment with the rail off entirely. The tenant is derived from the validated identity and is never read from the request.
Authorizations
JWT bearer token issued by the identity provider.
Query Parameters
Narrows the page to settled obligations (true) or to the ones still paying (false). Omitted means the whole book, which is never the same as either half.
true, false "false"
The previous page's page.next_after. Omitted starts at the lowest contract number. A cursor this service did not mint is refused, never restarted from the top.
"eyJ2IjoxLCJyIjoiYm9hcmQiLCJ0IjoiMjAyNi0wOC0xNFQwOToxMjozM1oiLCJrIjpbImMwMDEyIl19"
Maximum number of obligations to return. Omitted means the ceiling of 200.
1 <= x <= 20050