费率对账单

返回所选周期内向特定收费账户收取的费率列表。

Request

ENDPOINT

/billing/requester_configuration/billing_account/BILLING_ACCOUNT_KEY/invoices

MÉTODO

GET

Path Params

字段	类型	描述
BILLING_ACCOUNT_KEY	string	将列出其费率的收费账户 id（uuid）。

Query Params

字段	类型	描述
start_date	string	周期的起始日期，格式为 yyyy-mm-dd。可选。
end_date	string	周期的结束日期，格式为 yyyy-mm-dd。可选。
status	string	按费率状态筛选。可选。 状态枚举值
billing_type	string	按费率类型筛选。可多次提供以组合多种类型。可选。
page	integer	页码。默认 1。
page_size	integer	每页费率数量。默认 20，最大 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

字段	类型	描述
data	array	收取的费率列表。 Data
page	integer	返回的页码。
page_size	integer	每页费率数量。
has_next_page	boolean	表示是否还有更多结果页。

Data

字段	类型	描述
invoice_key	string	费率 id（uuid）。
reference_date	string	费率的参考日期，格式为 yyyy-mm-dd。
billing_type	string	费率类型（枚举值）。
billing_type_description	string	费率类型的描述。
status	string	费率状态。 状态枚举值
total_amount	number	费率的总金额。
paid_amount	number	费率已付金额。
amount_owed	number	费率未结清金额。已核销费率（written_off）返回 0。

枚举值

状态枚举值

枚举值	描述
open	未结清费率。
pending	等待付款的费率。
paid	已结清费率。
written_off	已核销费率。

STATUS

4XX

Response Body: Error

{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo"
}

HTTP 代码	QI 代码 code	标题 title	描述（英文） description	描述（葡文） translation
400	BLL000096	Invalid Date Format	Dates must be formatted as 'yyyy-mm-dd'.	Datas devem ser formatadas como 'aaaa-mm-dd'
400	BLL000043	Bad Request	Invalid status enumerator	Status informado não é válido
400	BLL000090	Invalid value for params	Page Size and Page Number must be integers	Page Size e Page Number devem ser números inteiros
400	BLL000091	Page size too large	Requested page size above limit of 50	Tamanho de página requerido acima do limite de 50
400	BLL000063	Bad Request	Not allowed to view fees in unavailable accounts	Conta indisponível.