Financeiro / Boletos / Listar Boletos

Listar todos os boletos, menos os pendentes

Query strings

Query StringFinalidade
situationsituação dos boletos:
pending: boletos na fila de geração
active: boletos gerados
removing: boletos na fila de cancelamento
removed: boletos cancelados
inactive: boletos cancelados
settled: boletos quitados
FieldTypeField Name correspondingDescriptionReturn Type
billetIntegerBoletoRetorna o ID do boleto na plataforma externainteger
billetIdIntegerID do boletoRetorna o ID do boleto no Operandinteger
billetValueDecimalValor do boletoRetorna o valor do boletodecimal
companyNationalDocumentStringEmpresaCNPJ referente a empresa vinculadastring
createdDateDatetimedata e hora de criaçãoRetorna a data e hora de criaçãodatetime
descriptionStringDescriçãoRetorna o texto do demonstrativo do boletostring
finBillIdIntegerID da faturaRetorna o ID da fatura relacionada no Operandinteger
fineForDelayDecimalMulta por atrasoRetorna a multa por atrasodecimal
instructionsStringInstruçõesRetorna a instruções para o caixastring
latePaymentInterestDecimalJuros de moraRetorna o juros de moradecimal
situationStringSituaçãoRetorna a situação'pending'
updatedDateDatetimeData e hora de alteraçãoRetorna a data e hora de alteraçãodecimal
urlStringUrlRetorna a url do boleto na plataforma externastring
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Filtro de situação dos boletos

Headers
string
Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json