
Listar contas a receber no Conta Azul, por uma API
Lista as parcelas a receber (contas a receber) com vencimento em um período, com cliente, 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_receivables
A chamada
POST https://connect.reportei.com/api/tools/conta_azul_list_receivables/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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| data_vencimento_de | string | Sim | First due date of the period, in YYYY-MM-DD. |
| data_vencimento_ate | string | Sim | Last due date of the period, in YYYY-MM-DD, not before data_vencimento_de. |
| data_pagamento_de | string | Não | Only the installments paid from this date on, in YYYY-MM-DD. Requires data_pagamento_ate. |
| data_pagamento_ate | string | Não | Only the installments paid until this date, in YYYY-MM-DD. Requires data_pagamento_de. |
| data_competencia_de | string | Não | Only the installments with accrual date (competencia) from this date on, in YYYY-MM-DD. Requires data_competencia_ate. |
| data_competencia_ate | string | Não | Only the installments with accrual date until this date, in YYYY-MM-DD. Requires data_competencia_de. |
| status | string | Não | Only the installments in these statuses, separated by commas: EM_ABERTO (open), ATRASADO (overdue), RECEBIDO (received), RECEBIDO_PARCIAL (partly received), RENEGOCIADO (renegotiated) and PERDIDO (written off). For example EM_ABERTO,ATRASADO. |
| ids_clientes | string | Não | Only the installments of these customers: ids from List people, separated by commas. |
| ids_categorias | string | Não | Only the installments of these categories: ids from List categories, separated by commas. |
| ids_contas_financeiras | string | Não | Only the installments of these financial accounts: ids from List financial accounts, separated by commas. |
| descricao | string | Não | Only the installments with this description. |
| pagina | integer | Não | Page number, starting at 1. The default is 1. |
| tamanho_pagina | integer | Não | Installments 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_receivables. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Conta Azul
- Listar pessoasGETLista as pessoas da empresa, que são seus clientes, fornecedores e transportadoras, com filtro opcional por texto, perfil ou tipo. A resposta traz items e totalItems; pagine com pagina, e uma página menor que tamanho_pagina é a última.
- Obter pessoaGETRetorna uma pessoa, com tipo, documento, email, telefones, endereços, perfis e os valores em atraso a pagar e a receber.
- Criar pessoaPOSTCria uma pessoa, que é cliente, fornecedor ou transportadora conforme perfis. nome e tipo_pessoa são obrigatórios; envie cpf para pessoa física e cnpj para empresa. A resposta traz o id da pessoa.
- Atualizar pessoaPATCHAtualiza parte de uma pessoa: só os campos enviados mudam. Para alterar um endereço existente, envie o id dele obtido em Obter pessoa.
- Listar contas a pagarGETLista 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.
- Obter parcelaGETRetorna uma parcela de uma conta a receber ou a pagar, com vencimento, composição do valor, pagamentos (baixas), cobranças e versao, que Atualizar parcela exige.
- Atualizar parcelaPATCHAtualiza 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.
- Criar conta a receberPOSTCria 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.
Toolkits da mesma categoria
Ver os 100 toolkitsVeja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
