Crear cuenta por cobrar en Conta Azul, con una API

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

Identificador
conta_azul_create_receivable

La llamada

POST https://connect.reportei.com/api/tools/conta_azul_create_receivable/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_cliente": "<id_cliente>",
    "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ámetroTipoObligatorioDescripción
descricaostringSíDescription of the receivable.
valornumberSíTotal in reais, greater than zero.
data_competenciastringSíAccrual date (competencia), in YYYY-MM-DD.
id_clientestringSíId of the customer, a person with the Cliente profile, from List people or Create person.
conta_financeirastringSíId of the financial account that receives, from List financial accounts.
rateioarraySíSplit of valor among revenue categories, one item per category.
condicao_pagamentoobjectSíInstallments of the receivable, one for a single payment.
observacaostringNoNotes about the receivable.
referencia_externastringNoIdentifier of the receivable 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_receivable. 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.