跳到主要内容

查询费率导出

查询一个费率导出申请。申请状态为 done 时,响应包含文件名和下载链接。

Endpoint​

ENDPOINT
/billing/invoices/exports/INVOICE_EXPORT_KEY
方法
GET
STATUS
200

认证​

需要对请求进行签名。参见认证。

路径参数​

字段类型必填描述长度
INVOICE_EXPORT_KEYuuid是导出申请的 key,在申请导出时返回。36

响应​

字段类型描述
invoice_export_keyuuid导出申请的 key。
statusstringpending、processing、done 或 expired。参见导出申请状态。
filtersobject申请的筛选条件。
row_countinteger已写入的费率数量。在 done 和 expired 时为最终值。
created_atstring申请的日期和时间。
finished_atstring文件就绪的日期和时间,或 null。
expires_atstring文件可下载的截止日期和时间,或 null。
file_namestring文件名,格式为 tarifas-<申请日期>.csv。仅在 done 时返回;其他状态为 null。
download_urlstring下载链接,有效期 1 小时。仅在 done 时返回;其他状态为 null。
{
"invoice_export_key": "7a9c0a5e-1b2f-4c3d-9e8f-0123456789ab",
"status": "done",
"filters": {
"start_date": "2026-09-01",
"end_date": "2026-09-30",
"payment_method": null,
"status": null,
"billing_types": [],
"owner_document_number": null,
"account_number": null,
"owner_name": null,
"account_key": null
},
"row_count": 1250000,
"created_at": "2026-10-15T14:03:11",
"finished_at": "2026-10-15T14:09:40",
"expires_at": "2026-10-22T14:09:38",
"file_name": "tarifas-2026-10-15.csv",
"download_url": "https://storage.googleapis.com/EXEMPLO/tarifas.csv?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Expires=3600"
}
  • 每次查询都会生成新的链接,有效期为 1 小时。链接过期后,再次查询申请即可获取新链接。
  • 文件就绪后可保留 7 天,直到 expires_at。之后申请变为 expired,file_name 和 download_url 返回 null,需要重新申请。

文件格式​

一个 CSV 文件,包含该申请的所有费率,每行一条:

  • UTF-8 编码(带 BOM),分隔符为 ;,换行符为 CRLF。
  • 日期格式为 dd/mm/yyyy;金额使用逗号作为小数点(30,00)。
  • 列标题为葡萄牙语,顺序如下:Data(日期)、Tarifa(费率)、Status(状态)、Método de pagamento(支付方式)、Conta(账户)、Titular(持有人)、Documento do titular(持有人证件号)、Documento do pagador do boleto(boleto 付款人证件号)、Valor(金额)、Valor pago(已付金额)、Valor devido(应付金额)。
  • 向 requester 本身收取、没有来源账户的费率,Conta 和 Documento do titular 为空,Titular 为 requester 的名称。

错误​

Status代码描述
404BLL000135申请不存在或属于其他 requester。

错误响应体采用标准格式(title、description、translation、code)。上表列出了本 endpoint 的错误码;平台通用错误(如 QIT000001)参见 BaaS 错误目录中的通用错误。

相关 Webhook​

invoice_export webhook 会在申请变为 done 时通知,无需轮询。