Listar contas a pagar no Conta Azul, por uma API

Lista as parcelas a pagar (contas a pagar) com vencimento em um período, com fornecedor, categorias, valores pagos e em aberto e status, além dos totais do período em totais. A resposta traz itens e itens_totais; pagine com pagina, e uma página menor que tamanho_pagina é a última.

Identificador
conta_azul_list_payables

A chamada

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

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
data_vencimento_destringSimFirst due date of the period, in YYYY-MM-DD.
data_vencimento_atestringSimLast due date of the period, in YYYY-MM-DD, not before data_vencimento_de.
data_pagamento_destringNãoOnly the installments paid from this date on, in YYYY-MM-DD. Requires data_pagamento_ate.
data_pagamento_atestringNãoOnly the installments paid until this date, in YYYY-MM-DD. Requires data_pagamento_de.
data_competencia_destringNãoOnly the installments with accrual date (competencia) from this date on, in YYYY-MM-DD. Requires data_competencia_ate.
data_competencia_atestringNãoOnly the installments with accrual date until this date, in YYYY-MM-DD. Requires data_competencia_de.
statusstringNãoOnly 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_categoriasstringNãoOnly the installments of these categories: ids from List categories, separated by commas.
ids_contas_financeirasstringNãoOnly the installments of these financial accounts: ids from List financial accounts, separated by commas.
descricaostringNãoOnly the installments with this description.
paginaintegerNãoPage number, starting at 1. The default is 1.
tamanho_paginaintegerNãoInstallments per page. The default is 10.

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