
Conta Azul tools
The 13 Conta Azul operations your product runs on your customer's account through Connect. All of them use the same endpoint, POST /api/tools/{tool}/execute.
- 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.
- Create receivablePOSTCreates 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.
- Create payablePOSTCreates a payable (conta a pagar) to a supplier: 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 payables.
- List salesGETLists the sales issued in a period, with number, customer, total and situation, plus totais and quantidades of the approved, canceled and waiting sales. The response has itens and total_itens; page with pagina, and a page shorter than tamanho_pagina is the last one.
- List categoriesGETLists the financial categories, with id, name and tipo (RECEITA or DESPESA). The id goes in rateio.id_categoria of Create receivable and Create payable. Page with pagina, and a page shorter than tamanho_pagina is the last one.
- List financial accountsGETLists the financial accounts of the company, like bank accounts, cash and credit cards, with id, name, bank and whether it is the default one. The id goes in conta_financeira of Create receivable and Create payable. Page with pagina, and a page shorter than tamanho_pagina is the last one.
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.
