
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
| Parameter | Type | Required | Description |
|---|---|---|---|
| descricao | string | Yes | Description of the receivable. |
| valor | number | Yes | Total in reais, greater than zero. |
| data_competencia | string | Yes | Accrual date (competencia), in YYYY-MM-DD. |
| id_cliente | string | Yes | Id of the customer, a person with the Cliente profile, from List people or Create person. |
| conta_financeira | string | Yes | Id of the financial account that receives, from List financial accounts. |
| rateio | array | Yes | Split of valor among revenue categories, one item per category. |
| condicao_pagamento | object | Yes | Installments of the receivable, one for a single payment. |
| observacao | string | No | Notes about the receivable. |
| referencia_externa | string | No | Identifier 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
- List peopleGETLists the people of the company, which are its customers, suppliers and carriers, optionally filtered by text, profile or type. The response has items and totalItems; page with pagina, and a page shorter than tamanho_pagina is the last one.
- Get personGETReturns one person, with type, document, email, phones, addresses, profiles and the amounts overdue to pay and to receive.
- Create personPOSTCreates a person, which is a customer, a supplier or a carrier according to perfis. nome and tipo_pessoa are required; send cpf for an individual and cnpj for a company. The response has the id of the person.
- Update personPATCHUpdates part of a person: only the fields sent change. To change an existing address, send its id from Get person.
- List receivablesGETLists 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.
- List payablesGETLists the installments to pay (contas a pagar) due in a period, with supplier, 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.
- Get installmentGETReturns one installment of a receivable or payable, with due date, value composition, payments (baixas), charges and versao, which Update installment requires.
- Update installmentPATCHUpdates part of an installment of a receivable or payable, like the due date, the value or the payment method. Send the versao returned by Get installment: the update is refused when it is missing or out of date.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
