Extrato de tarifas

Retorna uma lista das tarifas cobradas em uma conta de cobrança específica no período selecionado.

Request

ENDPOINT

/billing/requester_configuration/billing_account/BILLING_ACCOUNT_KEY/invoices

MÉTODO

GET

Path Params

Campo	Tipo	Descrição
BILLING_ACCOUNT_KEY	string	id (uuid) da conta de cobrança cujas tarifas serão listadas.

Query Params

Campo	Tipo	Descrição
start_date	string	Data inicial do período, no formato aaaa-mm-dd. Opcional.
end_date	string	Data final do período, no formato aaaa-mm-dd. Opcional.
status	string	Filtra pelo status da tarifa. Opcional. Enumerador status
billing_type	string	Filtra pelo tipo de tarifa. Pode ser informado mais de uma vez para combinar tipos. Opcional.
page	integer	Número da página. Padrão 1.
page_size	integer	Quantidade de tarifas por página. Padrão 20, máximo 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

Campo	Tipo	Descrição
data	array	Lista de tarifas cobradas. Data
page	integer	Página retornada.
page_size	integer	Quantidade de tarifas por página.
has_next_page	boolean	Indica se existem mais páginas de resultados.

Data

Campo	Tipo	Descrição
invoice_key	string	id (uuid) da tarifa.
reference_date	string	Data de referência da tarifa, no formato aaaa-mm-dd.
billing_type	string	Tipo da tarifa (enumerador).
billing_type_description	string	Descrição do tipo da tarifa.
status	string	Status da tarifa. Enumerador status
total_amount	number	Valor total da tarifa.
paid_amount	number	Valor já pago da tarifa.
amount_owed	number	Valor em aberto da tarifa. Tarifas baixadas (written_off) retornam 0.

Enumeradores

Enumerador Status

Enumerador	Descrição
open	Tarifa em aberto.
pending	Tarifa aguardando pagamento.
paid	Tarifa quitada.
written_off	Tarifa baixada.

STATUS

4XX

Response Body: Error

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

Código HTTP	Código QI code	Título title	Descrição (eng) description	Descrição (ptbr) 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.