List boletos

GET {{baseUrl}}/{{version}}/boleto

Get a list of non-deleted boletos in chunks of at most 100. If you need smaller chunks, use the limit parameter.

Request Params

KeyDatatypeRequiredDescription
cursornullString used to get the next batch of results.
limitnullNumber of results per cursor. Max = 100.
afternullFilter entities created after this date.
beforenullFilter entities created before this date.
statusnullFilter boletos by the specified status.
tagsnullFilter entities that contain the specified tags.
idsnullList of strings to get specific entities by ids.
fieldsnullList of strings to filter response JSON keys.

RESPONSES

status: OK

{"cursor":"CkYKFAoHY3JlYXRlZBIJCIO0we2JqOsCEipqE2l-YXBpLW1zLWNoYXJnZS1zYnhyEwsSBkNoYXJnZRiAgID87eScCAwYACAB","boletos":[{"taxId":"20.018.183/0001-80","overdueLimit":59,"fine":2,"id":"5756110329872384","receiverName":"Stark Bank S.A.","city":"Sao Paulo","fee":0,"streetLine2":"Apt 63","district":"Morro Dos Ingleses","streetLine1":"R Dos Ingleses, 586","due":"2020-12-03T02:59:59.999999+00:00","discounts":[],"workspaceId":"4888651368497152","interest":1,"status":"paid","tags":[],"zipCode":"01329-000","line":"34191.09107 11206.937309 71444.640008 1 84570000051000","name":"Stark Bank S.A.","created":"2020-08-19T20:11:58.645880+00:00","receiverTaxId":"20.018.183/0001-80","barCode":"34191845700000510001091011206937307144464000","amount":51000,"stateCode":"SP","descriptions":[]},{"taxId":"20.018.183/0001-80","overdueLimit":59,"fine":2,"id":"4630210423029760","receiverName":"Stark Bank S.A.","city":"Sao Paulo","fee":0,"streetLine2":"Apt 63","district":"Morro Dos Ingleses","streetLine1":"R Dos Ingleses, 586","due":"2020-11-03T02:59:59.999999+00:00","discounts":[],"workspaceId":"4888651368497152","interest":1,"status":"paid","tags":[],"zipCode":"01329-000","line":"34191.09107 11206.857309 71444.640008 2 84270000051000","name":"Stark Bank S.A.","created":"2020-08-19T20:11:58.645763+00:00","receiverTaxId":"20.018.183/0001-80","barCode":"34192842700000510001091011206857307144464000","amount":51000,"stateCode":"SP","descriptions":[]}]}