跳到主要内容

列出费率

按从新到旧的顺序列出 requester 的费率,使用游标分页。不带筛选条件时,列表返回所有账户的费率以及向 requester 本身收取的费率。如需查看单个账户的费率明细,请使用 account_key 按该账户筛选。

Endpoint​

ENDPOINT
/billing/requester_configuration/invoices
方法
GET
STATUS
200

认证​

需要对请求进行签名。参见认证。requester 为签署请求的凭证所属的 requester。

Query params​

所有参数均为可选。

字段类型说明
start_datestring周期开始日期,格式为 yyyy-mm-dd,包含当天。
end_datestring周期结束日期,格式为 yyyy-mm-dd,包含当天。不能早于 start_date。
statusstring费率状态。status 枚举值
billing_typestring费率类型。可重复传入以组合多个类型(billing_type=account_maintenance&billing_type=outgoing_ted)。
payment_methodstring费率的付款方式。payment_method 枚举值
account_keyuuid账户 key。返回该账户的费率明细。可重复传入,最多为 page_size 的值。传入后,下面三个账户筛选条件将被忽略。
owner_document_numberstring账户持有人的 CPF 或 CNPJ,仅数字。返回该持有人所有账户的费率。
account_numberstring账号,不含校验位。
owner_namestring持有人姓名的开头部分。列表返回持有人姓名以此开头的最新 50 个账户的费率。
page_sizeinteger每页费率数量。默认 100,最小 1,最大 100。
cursorstring上一次响应中的 cursor 值,用于获取下一页。第一页不要传入。

分页​

  1. 第一次请求不传 cursor。
  2. 如果 has_next_page 为 true,使用相同的筛选条件重复请求,并将 cursor 设为响应中的 cursor。
  3. 当 has_next_page 为 false 时停止。

所有页面请保持相同的筛选条件。cursor 是该页最后一条费率的 key,仅对发起查询的 requester 有效。

响应​

字段类型说明
dataarray本页的费率。Data
requester_namestringrequester 名称。当本页包含向 requester 收取的费率(account 为 null)时返回;否则为 null。
page_sizeinteger每页费率数量。
has_next_pageboolean存在下一页时为 true。
cursorstring获取下一页时需传入 cursor 的值。最后一页为 null。
accounts_truncatedboolean当 owner_name 筛选匹配到超过 50 个账户、列表仅返回最新 50 个账户的费率时为 true。请细化姓名以查看其他账户。

Data​

字段类型说明
invoice_keyuuid费率 key。
reference_datestring费率日期,格式为 yyyy-mm-dd。
billing_typestring费率类型。
billing_type_descriptionstring费率类型说明(葡萄牙语)。
statusstring费率状态。status 枚举值
total_amountnumber费率总金额。
paid_amountnumber已付金额。
amount_owednumber未付金额。已核销的费率为 0。
payment_methodstring费率的付款方式。不符合任何方式时为 null。payment_method 枚举值
billing_account_owner_typestring被扣款账户的归属。没有扣款账户或不属于枚举中的两种时为 null。billing_account_owner_type 枚举值
payer_document_numberstringboleto 付款人的 CPF 或 CNPJ。费率不通过 boleto 收取时为 null。
accountobject产生该费率的账户。费率向 requester 本身收取时为 null。Account

Account​

字段类型说明
account_keyuuid账户 key。
account_numberstring账号,不含校验位。
account_digitstring账户校验位。
owner_namestring账户持有人姓名。
owner_document_numberstring账户持有人的 CPF 或 CNPJ。
{
"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
}

错误​

Status代码说明
400BLL000096日期不符合 yyyy-mm-dd 格式,或 end_date 早于 start_date。
400BLL000043status 不在枚举值中。
400BLL000130payment_method 不在枚举值中。
400BLL000090page_size 不是整数。
400BLL000091page_size 小于 1 或大于 100。
400BLL000132cursor 不是该 requester 的费率。
400BLL000133account_key 的数量超过 page_size 的值。
404BLL000111某个 billing_type 不存在。
422BLL000129查询超过最长时间。请选择更短的周期或按账户筛选。

错误响应体遵循标准格式(title、description、translation、code)。平台通用错误见 BaaS 错误目录中的通用错误。

枚举值​

status 枚举值​

值说明
open未结费率。
pending等待付款。
paid已结清费率。
written_off已核销费率。

payment_method 枚举值​

值说明
account_debit从账户持有人的账户扣款。
centralizing_account_debit从 requester 的集中账户扣款。
bank_slip通过 boleto 收取。
account_debit_and_bank_slip部分从账户扣款,其余通过 boleto 收取。

billing_account_owner_type 枚举值​

值说明
account_holder产生该费率的持有人账户。
centralizing_accountrequester 的集中账户。

下一步​

如需将相同的费率下载为 CSV 文件,请使用费率导出,它支持相同的筛选条件。