Skip to main content

Fee statement

Returns a list of the fees charged to a specific billing account in the selected period.

Request

ENDPOINT
/billing/requester_configuration/billing_account/BILLING_ACCOUNT_KEY/invoices
METHOD
GET

Path Params

FieldTypeDescription
BILLING_ACCOUNT_KEYstringid (uuid) of the billing account whose fees will be listed.

Query Params

FieldTypeDescription
start_datestringStart date of the period, in yyyy-mm-dd format. Optional.
end_datestringEnd date of the period, in yyyy-mm-dd format. Optional.
statusstringFilters by fee status. Optional. Status enumerator
billing_typestringFilters by fee type. Can be provided more than once to combine types. Optional.
pageintegerPage number. Default 1.
page_sizeintegerNumber of fees per page. Default 20, maximum 50.

Response

STATUS
200
Response Body
{
"data": [
{
"invoice_key": "d1f4a2b6-8c3e-4f5a-9b7d-2e6c8a0f1d3b",
"reference_date": "2026-06-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
},
{
"invoice_key": "b2e5c3a7-9d4f-4a6b-8c1e-3f7d9b1a2c4e",
"reference_date": "2026-06-15",
"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
}
],
"page": 1,
"page_size": 20,
"has_next_page": false
}

Response Body

FieldTypeDescription
dataarrayList of charged fees. Data
pageintegerReturned page.
page_sizeintegerNumber of fees per page.
has_next_pagebooleanIndicates whether there are more pages of results.

Data

FieldTypeDescription
invoice_keystringid (uuid) of the fee.
reference_datestringReference date of the fee, in yyyy-mm-dd format.
billing_typestringFee type (enumerator).
billing_type_descriptionstringDescription of the fee type.
statusstringFee status. Status enumerator
total_amountnumberTotal amount of the fee.
paid_amountnumberAmount already paid of the fee.
amount_owednumberOutstanding amount of the fee. Written-off fees (written_off) return 0.

Enumerators

Status enumerator

EnumeratorDescription
openOpen fee.
pendingFee awaiting payment.
paidSettled fee.
written_offWritten-off fee.
STATUS
4XX
Response Body: Error
{
"title": "titulo",
"description": "description in English",
"translation": "descrição em portugues",
"code": "codigo"
}
HTTP CodeQI Code
code
Title
title
Description
description
Translation
translation
400BLL000096Invalid Date FormatDates must be formatted as 'yyyy-mm-dd'.Datas devem ser formatadas como 'aaaa-mm-dd'
400BLL000043Bad RequestInvalid status enumeratorStatus informado não é válido
400BLL000090Invalid value for paramsPage Size and Page Number must be integersPage Size e Page Number devem ser números inteiros
400BLL000091Page size too largeRequested page size above limit of 50Tamanho de página requerido acima do limite de 50
400BLL000063Bad RequestNot allowed to view fees in unavailable accountsConta indisponível.