Listar cuentas por pagar en Conta Azul, con una API

Lista las cuotas por pagar (contas a pagar) con vencimiento en un período, con proveedor, categorías, montos pagados y abiertos y estado, además de los totales del período en totais. La respuesta trae itens e itens_totais; pagina con pagina, y una página menor que tamanho_pagina es la última.

Identificador
conta_azul_list_payables

La llamada

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

Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.

Parámetros

Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.

ParámetroTipoObligatorioDescripción
data_vencimento_destringSíFirst due date of the period, in YYYY-MM-DD.
data_vencimento_atestringSíLast due date of the period, in YYYY-MM-DD, not before data_vencimento_de.
data_pagamento_destringNoOnly the installments paid from this date on, in YYYY-MM-DD. Requires data_pagamento_ate.
data_pagamento_atestringNoOnly the installments paid until this date, in YYYY-MM-DD. Requires data_pagamento_de.
data_competencia_destringNoOnly the installments with accrual date (competencia) from this date on, in YYYY-MM-DD. Requires data_competencia_ate.
data_competencia_atestringNoOnly the installments with accrual date until this date, in YYYY-MM-DD. Requires data_competencia_de.
statusstringNoOnly 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_categoriasstringNoOnly the installments of these categories: ids from List categories, separated by commas.
ids_contas_financeirasstringNoOnly the installments of these financial accounts: ids from List financial accounts, separated by commas.
descricaostringNoOnly the installments with this description.
paginaintegerNoPage number, starting at 1. The default is 1.
tamanho_paginaintegerNoInstallments per page. The default is 10.

Conexiones posibles

Tu cliente conecta su cuenta de Conta Azul una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.

OAuth con la app de tu producto

Registras la app OAuth de tu producto una sola vez, con POST /api/merchants/credentials/conta_azul, y tu cliente autoriza la cuenta en una pantalla de consentimiento. Connect renueva el token cuando está por vencer.

La respuesta

Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.

Lista para agentes de IA

El input de esta tool es un JSON Schema, disponible en GET /api/tools/conta_azul_list_payables. Se convierte en la definición de tool de tu agente sin conversión.

Otras tools de Conta Azul

Ver las 13 tools

Toolkits de la misma categoría

Ver los 100 toolkits

Mira Connect aplicado a tu producto.

Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.