Mettre à jour une échéance avec l'API Conta Azul

Met à jour une partie d'une échéance de créance ou de dette, comme la date d'échéance, le montant ou le mode de paiement. Envoyez la versao renvoyée par Obtenir une échéance : la mise à jour est refusée si elle manque ou n'est plus à jour.

Identifiant
conta_azul_update_installment

L'appel

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
  }
}

Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.

Paramètres

Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.

ParamètreTypeObligatoireDescription
idstringOuiId of the installment (UUID), from List receivables or List payables.
versaointegerOuiCurrent versao of the installment, from Get installment.
vencimentostringNonNew due date, in YYYY-MM-DD.
data_pagamento_esperadostringNonExpected payment date, in YYYY-MM-DD.
descricaostringNonDescription of the installment.
notastringNonNote on the installment.
metodo_pagamentostringNonPayment method of the installment.Valeurs : BOLETO_BANCARIO, PIX_PAGAMENTO_INSTANTANEO, CARTAO_CREDITO, CARTAO_DEBITO, TRANSFERENCIA_BANCARIA, DEPOSITO_BANCARIO, DINHEIRO, CHEQUE, CARTEIRA_DIGITAL, OUTRO, SEM_PAGAMENTO
id_conta_financeirastringNonId of the financial account of the installment, from List financial accounts.
composicao_valorobjectNonValue of the installment. Inside it, desconto, juros, multa and taxa become 0 when left out, and valor_bruto stays as it is.

Connexions possibles

Votre client connecte son compte Conta Azul une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.

OAuth avec l'app de votre produit

Vous enregistrez une fois l'app OAuth de votre produit, avec POST /api/merchants/credentials/conta_azul, et votre client autorise le compte sur un écran de consentement. Connect renouvelle le token avant son expiration.

La réponse

En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.

Prête pour les agents IA

L'input de cette tool est un JSON Schema, disponible via GET /api/tools/conta_azul_update_installment. Il devient la définition de tool de votre agent sans conversion.

Autres tools Conta Azul

Voir les 13 tools

Toolkits de la même catégorie

Voir les 100 toolkits

Voyez Connect appliqué à votre produit.

Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.