FreshBooks tools
The 14 FreshBooks operations your product runs on your customer's account through Connect. All of them use the same endpoint, POST /api/tools/{tool}/execute.
- Get current userGETReturns the connected user. Each item of business_memberships has the role of the user and a business with its name and account_id, the account_id every other tool asks for. A business without account_id has no accounting, and the other tools do not work on it.
- List clientsGETLists the active and archived clients of a business, with id, names, organization, email, phones, address and currency. The response has result.clients, page, pages and total: raise page until it reaches pages.
- Create clientPOSTCreates a client and returns it in result.client, with the id that invoices use as customerid and expenses as clientid. The fields go inside client.
- Update clientPUTChanges the fields sent on a client; the others stay as they are. The fields go inside client.
- List invoicesGETLists the active and archived invoices of a business, without their lines: id, invoice_number, customerid, organization, create_date, due_date, amount, outstanding, paid, v3_status and payment_status. The response has result.invoices, page, pages and total: raise page until it reaches pages.
- Get invoiceGETReturns one invoice in result.invoice, without its lines: number, client, dates, amount, outstanding, paid, discount, notes, terms, v3_status and payment_status.
- Create invoicePOSTCreates a draft invoice and returns it in result.invoice. The fields go inside invoice, which needs customerid and create_date; the lines set the amount. A draft does not count in the reports and the client cannot open it: Send invoice emails it or marks it as sent.
- Update invoicePUTChanges the fields sent on an invoice, like dates, number, notes, terms or discount; the others stay as they are. The fields go inside invoice. Lines are not changed here: a PUT with lines replaces all of them, and no tool reads the current lines.
- Send invoicePUTEmails an invoice to email_recipients, with action_email true, or only marks it as sent, with action_mark_as_sent true for an invoice delivered another way. Either way it leaves draft and starts counting in the reports. Send one of the two actions and no other invoice field: FreshBooks ignores the rest.
- Create paymentPOSTRecords a payment received on an invoice, like a bank transfer or cash, and returns it in result.payment. The fields go inside payment, with invoiceid and amount. The invoice turns partial or paid according to the amount.
- List expensesGETLists the expenses of a business, with id, amount, date, vendor, categoryid, clientid, notes and status. The response has result.expenses, page, pages and total: raise page until it reaches pages.
- Create expensePOSTCreates an expense and returns it in result.expense. The fields go inside expense, which needs categoryid; amount and date are the usual ones.
- Update expensePUTChanges the fields sent on an expense; the others stay as they are. The fields go inside expense.
- List expense categoriesGETLists the expense categories of a business, like Advertising, with categoryid, the id Create expense asks for, and parentid. The response has result.categories, page, pages and total.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.

Conta Azul