
Crear cuenta por pagar en Conta Azul, con una API
Crea una cuenta por pagar a un proveedor: 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 pagar.
- Identificador
- conta_azul_create_payable
La llamada
POST https://connect.reportei.com/api/tools/conta_azul_create_payable/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"descricao": "<descricao>",
"valor": 1,
"data_competencia": "<data_competencia>",
"id_fornecedor": "<id_fornecedor>",
"conta_financeira": "<conta_financeira>",
"rateio": [],
"condicao_pagamento": {}
}
}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 |
|---|---|---|---|
| descricao | string | Sí | Description of the payable. |
| valor | number | Sí | Total in reais, greater than zero. |
| data_competencia | string | Sí | Accrual date (competencia), in YYYY-MM-DD. |
| id_fornecedor | string | Sí | Id of the supplier, a person with the Fornecedor profile, from List people or Create person. |
| conta_financeira | string | Sí | Id of the financial account that pays, from List financial accounts. |
| rateio | array | Sí | Split of valor among expense categories, one item per category. |
| condicao_pagamento | object | Sí | Installments of the payable, one for a single payment. |
| observacao | string | No | Notes about the payable. |
| referencia_externa | string | No | Identifier of the payable in your own system. |
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_create_payable. 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.
- Listar cuentas por pagarGETLista 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.
- 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.
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.
