@robinpath/freshbooks
v0.3.0
Published
FreshBooks API — invoices and clients for small business accounting. Uses the encrypted credential vault (OAuth2 access token).
Readme
@robinpath/freshbooks
FreshBooks module for RobinPath.
Why use this module?
The freshbooks module lets you:
- listClients
- getClient
- createClient
- updateClient
- listInvoices
All functions are callable directly from RobinPath scripts with a simple, consistent API.
Installation
robinpath add @robinpath/freshbooksQuick Start
1. Set up credentials
freshbooks.setCredentials "your-credentials"2. listClients
freshbooks.listClientsAvailable Functions
| Function | Description |
|----------|-------------|
| freshbooks.setCredentials | Configure freshbooks credentials. |
| freshbooks.listClients | listClients |
| freshbooks.getClient | getClient |
| freshbooks.createClient | createClient |
| freshbooks.updateClient | updateClient |
| freshbooks.listInvoices | listInvoices |
| freshbooks.getInvoice | getInvoice |
| freshbooks.createInvoice | createInvoice |
| freshbooks.updateInvoice | updateInvoice |
| freshbooks.sendInvoice | sendInvoice |
| freshbooks.listExpenses | listExpenses |
| freshbooks.getExpense | getExpense |
| freshbooks.createExpense | createExpense |
| freshbooks.listTimeEntries | listTimeEntries |
| freshbooks.createTimeEntry | createTimeEntry |
| freshbooks.listPayments | listPayments |
| freshbooks.createPayment | createPayment |
| freshbooks.getUser | getUser |
| freshbooks.getAccount | getAccount |
Examples
listClients
freshbooks.listClientsgetClient
freshbooks.getClientcreateClient
freshbooks.createClientIntegration with RobinPath
import { RobinPath } from "@wiredwp/robinpath";
import Module from "@robinpath/freshbooks";
const rp = new RobinPath();
rp.registerModule(Module.name, Module.functions);
rp.registerModuleMeta(Module.name, Module.functionMetadata);
const result = await rp.executeScript(`
freshbooks.setCredentials "your-credentials"
freshbooks.listClients
`);Full API Reference
See MODULE.md for complete documentation including all parameters, return types, error handling, and advanced examples.
Related Modules
@robinpath/quickbooks— QuickBooks module for complementary functionality@robinpath/xero— Xero module for complementary functionality@robinpath/invoice— Invoice module for complementary functionality@robinpath/json— JSON module for complementary functionality
License
MIT
