List receivables with the Conta Azul API

Lists the installments to receive (contas a receber) due in a period, with customer, categories, amounts paid and open and status, plus the totals of the period in totais. The response has itens and itens_totais; page with pagina, and a page shorter than tamanho_pagina is the last one.

Identifier
conta_azul_list_receivables

The request

POST https://connect.reportei.com/api/tools/conta_azul_list_receivables/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "data_vencimento_de": "<data_vencimento_de>",
    "data_vencimento_ate": "<data_vencimento_ate>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
data_vencimento_destringYesFirst due date of the period, in YYYY-MM-DD.
data_vencimento_atestringYesLast due date of the period, in YYYY-MM-DD, not before data_vencimento_de.
data_pagamento_destringNoOnly the installments paid from this date on, in YYYY-MM-DD. Requires data_pagamento_ate.
data_pagamento_atestringNoOnly the installments paid until this date, in YYYY-MM-DD. Requires data_pagamento_de.
data_competencia_destringNoOnly the installments with accrual date (competencia) from this date on, in YYYY-MM-DD. Requires data_competencia_ate.
data_competencia_atestringNoOnly the installments with accrual date until this date, in YYYY-MM-DD. Requires data_competencia_de.
statusstringNoOnly the installments in these statuses, separated by commas: EM_ABERTO (open), ATRASADO (overdue), RECEBIDO (received), RECEBIDO_PARCIAL (partly received), RENEGOCIADO (renegotiated) and PERDIDO (written off). For example EM_ABERTO,ATRASADO.
ids_clientesstringNoOnly the installments of these customers: ids from List people, separated by commas.
ids_categoriasstringNoOnly the installments of these categories: ids from List categories, separated by commas.
ids_contas_financeirasstringNoOnly the installments of these financial accounts: ids from List financial accounts, separated by commas.
descricaostringNoOnly the installments with this description.
paginaintegerNoPage number, starting at 1. The default is 1.
tamanho_paginaintegerNoInstallments per page. The default is 10.

Supported connections

Your customer connects their Conta Azul account once, with one of the modes below. The same connection serves every tool of the toolkit.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/conta_azul, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/conta_azul_list_receivables. It becomes your agent's tool definition with no conversion.

Other Conta Azul tools

See all 13 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.