Skip to main content

List fees

Lists the requester's fees, from newest to oldest, with cursor pagination. Without filters, the list returns the fees of every account and the fees charged to the requester itself. To see the fee statement of one account, filter by that account with account_key.

Endpoint​

ENDPOINT
/billing/requester_configuration/invoices
METHOD
GET
STATUS
200

Authentication​

Requires a signed request. See Authentication. The requester is the one whose credential signs the request.

Query params​

All parameters are optional.

FieldTypeDescription
start_datestringStart date of the period, in yyyy-mm-dd format, inclusive.
end_datestringEnd date of the period, in yyyy-mm-dd format, inclusive. Cannot be earlier than start_date.
statusstringFee status. status enumerator
billing_typestringFee type. Can be repeated to combine types (billing_type=account_maintenance&billing_type=outgoing_ted).
payment_methodstringPayment method of the fee. payment_method enumerator
account_keyuuidAccount key. Returns the fee statement of that account. Can be repeated, up to the value of page_size. When sent, the three account filters below are ignored.
owner_document_numberstringCPF or CNPJ of the account holder, digits only. Returns the fees of every account of that holder.
account_numberstringAccount number, without the check digit.
owner_namestringBeginning of the holder's name. The list returns the fees of the 50 newest accounts whose holder name starts with this value.
page_sizeintegerNumber of fees per page. Default 100, minimum 1, maximum 100.
cursorstringThe cursor value of the previous response, to fetch the next page. Do not send it on the first page.

Pagination​

  1. Make the first request without cursor.
  2. If has_next_page is true, repeat the request with the same filters and cursor set to the cursor of the response.
  3. Stop when has_next_page is false.

Keep the same filters on every page. The cursor is the key of the last fee of the page and is only valid for the requester that made the query.

Response​

FieldTypeDescription
dataarrayFees of the page. Data
requester_namestringName of the requester. Filled when the page has a fee charged to the requester (account null); otherwise null.
page_sizeintegerNumber of fees per page.
has_next_pagebooleantrue when there is a next page.
cursorstringValue to send in cursor to fetch the next page. null on the last page.
accounts_truncatedbooleantrue when the owner_name filter matched more than 50 accounts and the list returned only the fees of the 50 newest. Refine the name to see the others.

Data​

FieldTypeDescription
invoice_keyuuidFee key.
reference_datestringFee date, in yyyy-mm-dd format.
billing_typestringFee type.
billing_type_descriptionstringDescription of the fee type, in Portuguese.
statusstringFee status. status enumerator
total_amountnumberTotal amount of the fee.
paid_amountnumberAmount already paid.
amount_owednumberOutstanding amount. 0 for a written-off fee.
payment_methodstringPayment method of the fee. null when it matches no method. payment_method enumerator
billing_account_owner_typestringWho owns the debited account. null when no account is debited or when it is neither of the two in the enumerator. billing_account_owner_type enumerator
payer_document_numberstringCPF or CNPJ of the bank slip payer. null when the fee is not charged by bank slip.
accountobjectAccount that originated the fee. null when the fee is charged to the requester itself. Account

Account​

FieldTypeDescription
account_keyuuidAccount key.
account_numberstringAccount number, without the check digit.
account_digitstringAccount check digit.
owner_namestringName of the account holder.
owner_document_numberstringCPF or CNPJ of the account holder.
{
"data": [
{
"invoice_key": "d1f4a2b6-8c3e-4f5a-9b7d-2e6c8a0f1d3b",
"reference_date": "2026-10-01",
"billing_type": "account_maintenance",
"billing_type_description": "Tarifa de Manutenção de Conta",
"status": "paid",
"total_amount": 30.00,
"paid_amount": 30.00,
"amount_owed": 0.00,
"payment_method": "account_debit",
"billing_account_owner_type": "account_holder",
"payer_document_number": null,
"account": {
"account_key": "5b0e8c1a-3f2d-4e6b-9a7c-1d2e3f4a5b6c",
"account_number": "1234567",
"account_digit": "8",
"owner_name": "Empresa Exemplo Ltda",
"owner_document_number": "96969879000101"
}
},
{
"invoice_key": "b2e5c3a7-9d4f-4a6b-8c1e-3f7d9b1a2c4e",
"reference_date": "2026-09-30",
"billing_type": "outgoing_ted",
"billing_type_description": "Tarifa de Envio de TED",
"status": "open",
"total_amount": 20.00,
"paid_amount": 0.00,
"amount_owed": 20.00,
"payment_method": "centralizing_account_debit",
"billing_account_owner_type": "centralizing_account",
"payer_document_number": null,
"account": null
}
],
"requester_name": "Requester Exemplo S.A.",
"page_size": 2,
"has_next_page": true,
"cursor": "b2e5c3a7-9d4f-4a6b-8c1e-3f7d9b1a2c4e",
"accounts_truncated": false
}

Errors​

StatusCodeDescription
400BLL000096Date not in yyyy-mm-dd format, or end_date earlier than start_date.
400BLL000043status is not in the enumerator.
400BLL000130payment_method is not in the enumerator.
400BLL000090page_size is not an integer.
400BLL000091page_size lower than 1 or greater than 100.
400BLL000132cursor is not a fee of the requester.
400BLL000133More account_key values than the value of page_size.
404BLL000111One of the billing_type values does not exist.
422BLL000129The query exceeded the maximum time. Choose a shorter period or filter by account.

The error body follows the standard format (title, description, translation, code). General platform errors are in the common errors of the BaaS error catalog.

Enumerators​

status enumerator​

ValueDescription
openOpen fee.
pendingAwaiting payment.
paidPaid fee.
written_offWritten-off fee.

payment_method enumerator​

ValueDescription
account_debitDebit from the account holder's account.
centralizing_account_debitDebit from the requester's centralizing account.
bank_slipCharged by bank slip.
account_debit_and_bank_slipPart debited from the account, the rest charged by bank slip.

billing_account_owner_type enumerator​

ValueDescription
account_holderAccount of the holder that originated the fee.
centralizing_accountCentralizing account of the requester.

Next step​

To download the same fees as a CSV file, use the fee export, which accepts the same filters.