Atualizar parcela no Conta Azul, por uma API

Atualiza parte de uma parcela de conta a receber ou a pagar, como o vencimento, o valor ou a forma de pagamento. Envie a versao retornada por Obter parcela: a atualização é recusada se ela faltar ou estiver desatualizada.

Identificador
conta_azul_update_installment

A chamada

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "id": "<id>",
    "versao": 1
  }
}

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
idstringSimId of the installment (UUID), from List receivables or List payables.
versaointegerSimCurrent versao of the installment, from Get installment.
vencimentostringNãoNew due date, in YYYY-MM-DD.
data_pagamento_esperadostringNãoExpected payment date, in YYYY-MM-DD.
descricaostringNãoDescription of the installment.
notastringNãoNote on the installment.
metodo_pagamentostringNãoPayment method of the installment.Valores: BOLETO_BANCARIO, PIX_PAGAMENTO_INSTANTANEO, CARTAO_CREDITO, CARTAO_DEBITO, TRANSFERENCIA_BANCARIA, DEPOSITO_BANCARIO, DINHEIRO, CHEQUE, CARTEIRA_DIGITAL, OUTRO, SEM_PAGAMENTO
id_conta_financeirastringNãoId of the financial account of the installment, from List financial accounts.
composicao_valorobjectNãoValue of the installment. Inside it, desconto, juros, multa and taxa become 0 when left out, and valor_bruto stays as it is.

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