Lister les dettes avec l'API Conta Azul

Liste les échéances à payer (contas a pagar) arrivant à échéance sur une période, avec fournisseur, catégories, montants payés et ouverts et statut, plus les totaux de la période dans totais. La réponse contient itens et itens_totais ; paginez avec pagina, et une page plus courte que tamanho_pagina est la dernière.

Identifiant
conta_azul_list_payables

L'appel

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "data_vencimento_de": "<data_vencimento_de>",
    "data_vencimento_ate": "<data_vencimento_ate>"
  }
}

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
data_vencimento_destringOuiFirst due date of the period, in YYYY-MM-DD.
data_vencimento_atestringOuiLast due date of the period, in YYYY-MM-DD, not before data_vencimento_de.
data_pagamento_destringNonOnly the installments paid from this date on, in YYYY-MM-DD. Requires data_pagamento_ate.
data_pagamento_atestringNonOnly the installments paid until this date, in YYYY-MM-DD. Requires data_pagamento_de.
data_competencia_destringNonOnly the installments with accrual date (competencia) from this date on, in YYYY-MM-DD. Requires data_competencia_ate.
data_competencia_atestringNonOnly the installments with accrual date until this date, in YYYY-MM-DD. Requires data_competencia_de.
statusstringNonOnly the installments in these statuses, separated by commas: EM_ABERTO (open), ATRASADO (overdue), RECEBIDO (paid), RECEBIDO_PARCIAL (partly paid), RENEGOCIADO (renegotiated) and PERDIDO (written off). For example EM_ABERTO,ATRASADO.
ids_categoriasstringNonOnly the installments of these categories: ids from List categories, separated by commas.
ids_contas_financeirasstringNonOnly the installments of these financial accounts: ids from List financial accounts, separated by commas.
descricaostringNonOnly the installments with this description.
paginaintegerNonPage number, starting at 1. The default is 1.
tamanho_paginaintegerNonInstallments per page. The default is 10.

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