Crear pago en FreshBooks, con una API
Registra un pago recibido en una factura, como transferencia bancaria o efectivo, y lo devuelve en result.payment. Los campos van dentro de payment, con invoiceid y amount. La factura pasa a parcial o pagada según el monto.
- Identificador
- freshbooks_create_payment
La llamada
POST https://connect.reportei.com/api/tools/freshbooks_create_payment/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"account_id": "<account_id>",
"payment": {}
}
}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 |
|---|---|---|---|
| account_id | string | Sí | account_id of a business, from Get current user. |
| payment | object | Sí | The payment received. |
Conexiones posibles
Tu cliente conecta su cuenta de FreshBooks 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/freshbooks, 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/freshbooks_create_payment. Se convierte en la definición de tool de tu agente sin conversión.
Otras tools de FreshBooks
- Obtener usuario actualGETDevuelve el usuario conectado. Cada elemento de business_memberships trae el rol del usuario y un business con nombre y account_id, el account_id que piden todas las demás herramientas. Un negocio sin account_id no tiene contabilidad, y las demás herramientas no funcionan en él.
- Listar clientesGETLista los clientes activos y archivados de un negocio, con id, nombres, organización, email, teléfonos, dirección y moneda. La respuesta trae result.clients, page, pages y total: aumenta page hasta llegar a pages.
- Crear clientePOSTCrea un cliente y lo devuelve en result.client, con el id que las facturas usan como customerid y los gastos como clientid. Los campos van dentro de client.
- Actualizar clientePUTCambia los campos enviados de un cliente; los demás quedan como están. Los campos van dentro de client.
- Listar facturasGETLista las facturas activas y archivadas de un negocio, sin sus líneas: id, invoice_number, customerid, organization, create_date, due_date, amount, outstanding, paid, v3_status y payment_status. La respuesta trae result.invoices, page, pages y total: aumenta page hasta llegar a pages.
- Obtener facturaGETDevuelve una factura en result.invoice, sin sus líneas: número, cliente, fechas, amount, outstanding, paid, discount, notes, terms, v3_status y payment_status.
- Crear facturaPOSTCrea una factura en borrador y la devuelve en result.invoice. Los campos van dentro de invoice, que necesita customerid y create_date; las líneas definen el monto. Un borrador no cuenta en los informes y el cliente no puede abrirlo: Enviar factura lo manda por email o lo marca como enviado.
- Actualizar facturaPUTCambia los campos enviados de una factura, como fechas, número, notes, terms o discount; los demás quedan como están. Los campos van dentro de invoice. Las líneas no se cambian aquí: un PUT con lines las reemplaza todas, y ninguna herramienta lee las líneas actuales.
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.

Conta Azul