List All Bill Payments


What it does:

Retrieves a paginated list of boletos for the authenticated company. Supports cursor-based pagination and filtering by status.

Query Parameters:

KeyFieldTypeRequiredDefault
limitIntegerFalse10
directionStringFalsenext
cursorStringFalse-
filtersStringFalse-

Payload Response Example:

{
   "data":[
      {
         "bankAccountId":"019540f6-a870-7927-b97b-cdbbeb13f390",
         "id":"123e4567-e89b-12d3-a456-426614174000",
         "companyId":"company_789",
         "amount":{
            "value":10000,
            "currency":"BRL"
         },
         "type":"DM",
         "barCode":"34191090010000000001234567890123456789",
         "line":"34191.09001 00000.000012 34567.890123 4 09001000000000",
         "ourNumber":"00001649435",
         "referenceNumber":"REF-123456",
         "payer":{
            "name":"John Doe",
            "taxId":"12345678901",
            "address":{
               "street":"Av. Paulista",
               "number":"1000",
               "district":"Bela Vista",
               "city":"São Paulo",
               "state":"SP",
               "zipCode":"01310000"
            }
         },
         "dueDate":"2025-08-29",
         "states":[
            {
               "status":"CREATED",
               "reason":null,
               "atTime":"2025-08-01T10:00:00Z"
            }
         ],
         "currentState":{
            "status":"CREATED",
            "reason":null,
            "atTime":"2025-08-01T10:00:00Z"
         },
         "amountPaid":null,
         "paidAt":null,
         "createdAt":"2025-08-01T10:00:00Z",
         "updatedAt":"2025-08-01T10:00:00Z"
      }
   ],
   "limit":5,
   "direction":"next",
   "cursor":null,
   "nextCursor":"eyJpZCI6IjEyMyJ9",
   "totalMatches":1
}