
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ámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| data_vencimento_de | string | Sí | First due date of the period, in YYYY-MM-DD. |
| data_vencimento_ate | string | Sí | Last due date of the period, in YYYY-MM-DD, not before data_vencimento_de. |
| data_pagamento_de | string | No | Only the installments paid from this date on, in YYYY-MM-DD. Requires data_pagamento_ate. |
| data_pagamento_ate | string | No | Only the installments paid until this date, in YYYY-MM-DD. Requires data_pagamento_de. |
| data_competencia_de | string | No | Only the installments with accrual date (competencia) from this date on, in YYYY-MM-DD. Requires data_competencia_ate. |
| data_competencia_ate | string | No | Only the installments with accrual date until this date, in YYYY-MM-DD. Requires data_competencia_de. |
| status | string | No | Only 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_categorias | string | No | Only the installments of these categories: ids from List categories, separated by commas. |
| ids_contas_financeiras | string | No | Only the installments of these financial accounts: ids from List financial accounts, separated by commas. |
| descricao | string | No | Only the installments with this description. |
| pagina | integer | No | Page number, starting at 1. The default is 1. |
| tamanho_pagina | integer | No | Installments 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
- Listar personasGETLista las personas de la empresa, que son sus clientes, proveedores y transportistas, con filtro opcional por texto, perfil o tipo. La respuesta trae items y totalItems; pagina con pagina, y una página menor que tamanho_pagina es la última.
- Obtener personaGETDevuelve una persona, con tipo, documento, email, teléfonos, direcciones, perfiles y los montos vencidos por pagar y por cobrar.
- Crear personaPOSTCrea una persona, que es cliente, proveedor o transportista según perfis. nome y tipo_pessoa son obligatorios; envía cpf para persona física y cnpj para empresa. La respuesta trae el id de la persona.
- Actualizar personaPATCHActualiza parte de una persona: solo cambian los campos enviados. Para cambiar una dirección existente, envía su id obtenido en Obtener persona.
- Listar cuentas por cobrarGETLista las cuotas por cobrar (contas a receber) con vencimiento en un período, con cliente, 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.
- Obtener cuotaGETDevuelve una cuota de una cuenta por cobrar o por pagar, con vencimiento, composición del valor, pagos (baixas), cobros y versao, que Actualizar cuota exige.
- Actualizar cuotaPATCHActualiza parte de una cuota de cuenta por cobrar o por pagar, como el vencimiento, el valor o la forma de pago. Envía la versao devuelta por Obtener cuota: la actualización se rechaza si falta o está desactualizada.
- Crear cuenta por cobrarPOSTCrea una cuenta por cobrar para un cliente: valor se divide entre categorías en rateio y entre vencimientos en condicao_pagamento.parcelas. La respuesta trae el id del evento financiero, y sus cuotas aparecen en Listar cuentas por cobrar.
Toolkits de la misma categoría
Ver los 100 toolkitsMira Connect aplicado a tu producto.
Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.
