Criar conta a receber no Conta Azul, por uma API

Cria uma conta a receber para um cliente: valor é dividido entre categorias em rateio e entre vencimentos em condicao_pagamento.parcelas. A resposta traz o id do evento financeiro, e suas parcelas aparecem em Listar contas a receber.

Identificador
conta_azul_create_receivable

A chamada

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": {}
  }
}

Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.

Parâmetros

As descrições dos parâmetros seguem a documentação oficial do app, em inglês.

ParâmetroTipoObrigatórioDescrição
descricaostringSimDescription of the receivable.
valornumberSimTotal in reais, greater than zero.
data_competenciastringSimAccrual date (competencia), in YYYY-MM-DD.
id_clientestringSimId of the customer, a person with the Cliente profile, from List people or Create person.
conta_financeirastringSimId of the financial account that receives, from List financial accounts.
rateioarraySimSplit of valor among revenue categories, one item per category.
condicao_pagamentoobjectSimInstallments of the receivable, one for a single payment.
observacaostringNãoNotes about the receivable.
referencia_externastringNãoIdentifier of the receivable in your own system.

Conexões possíveis

O seu cliente conecta a conta do Conta Azul uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.

OAuth com o app do seu produto

Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/conta_azul, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.

A resposta

Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.

Pronta para agentes de IA

O input desta tool é um JSON Schema, disponível em GET /api/tools/conta_azul_create_receivable. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Conta Azul

Ver as 13 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.