Create receivable with the Conta Azul API

Creates a receivable (conta a receber) for a customer: valor is split among categories in rateio and among due dates in condicao_pagamento.parcelas. The response has the id of the financial event, and its installments show up in List receivables.

Identifier
conta_azul_create_receivable

The request

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "descricao": "<descricao>",
    "valor": 1,
    "data_competencia": "<data_competencia>",
    "id_cliente": "<id_cliente>",
    "conta_financeira": "<conta_financeira>",
    "rateio": [],
    "condicao_pagamento": {}
  }
}

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
descricaostringYesDescription of the receivable.
valornumberYesTotal in reais, greater than zero.
data_competenciastringYesAccrual date (competencia), in YYYY-MM-DD.
id_clientestringYesId of the customer, a person with the Cliente profile, from List people or Create person.
conta_financeirastringYesId of the financial account that receives, from List financial accounts.
rateioarrayYesSplit of valor among revenue categories, one item per category.
condicao_pagamentoobjectYesInstallments of the receivable, one for a single payment.
observacaostringNoNotes about the receivable.
referencia_externastringNoIdentifier of the receivable in your own system.

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_create_receivable. 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.