FreshBooks – Gotchas
The best cloud based small business accounting software. Send invoices, track time, manage receipts, expenses, and accept credit cards.
19 gotchas across 8 resources
These are connector-specific behaviors and limitations to be aware of when integrating.
Bill Payments2 gotchas
billPaymentsUpdateThe transaction_date field is required.
billPaymentsDeleteDelete will set the payment to inactive and will soft delete it, meaning it will stop appearing in the list API call. However, it can still be found via the get by id call.
Bills3 gotchas
billsAllThe Freshbooks Bills api is currently in beta.
billsOneThe Freshbooks Bills api is currently in beta.
billsDeleteDelete will set the bill to inactive and will soft delete it, meaning it will stop appearing in the list API call. However, it can still be found via the get by id call.
Credit Notes1 gotcha
creditNotesDeleteDelete will set the credit note to inactive and will soft delete it, meaning it will stop appearing in the list API call. However, it can still be found via the get by id call.
Customers3 gotchas
customersAddFreshbooks API set status to active by default for new customers. To change the status, you can use the Update Customer endpoint.
customersUpdateThe status field can be updated to either "active" or "archived".
customersDeleteDelete will set the customer to inactive and will soft delete it, meaning it will stop appearing in the list API call. However, it can still be found via the get by id call.
Invoice Items1 gotcha
invoiceItemsDeleteDelete will set the invoice item to inactive and will soft delete it, meaning it will stop appearing in the list API call. However, it can still be found via the get by id call.
Invoices5 gotchas
invoicesAllFreshBooks supports up to two taxes per line item (taxName1/taxAmount1 and taxName2/taxAmount2).
The unified API supports one tax_rate per line item, so Apideck maps the tax with the largest rate as
tax_rate (name, rate, code) and sets tax_amount to the combined total of both taxes applied to the line.
If you need both individual tax values, use the raw query parameter (?raw=true) to access the original
FreshBooks response, where both taxName1/taxAmount1 and taxName2/taxAmount2 are available on each line item.
invoicesAddThe status field can be set to either "submitted", "partially_paid", "paid" or "draft". The due_date and invoice_date fields are required for the invoice to be created.
invoicesOneFreshBooks supports up to two taxes per line item (taxName1/taxAmount1 and taxName2/taxAmount2).
The unified API supports one tax_rate per line item, so Apideck maps the tax with the largest rate as
tax_rate (name, rate, code) and sets tax_amount to the combined total of both taxes applied to the line.
If you need both individual tax values, use the raw query parameter (?raw=true) to access the original
FreshBooks response, where both taxName1/taxAmount1 and taxName2/taxAmount2 are available on each line item.
invoicesUpdateThe status field can be set to either "submitted" or "draft". The other available statuses are set by the Freshbooks API and cannot be updated manually. The due_date and invoice_date fields are required for the due date to be updated.
invoicesDeleteDelete will set the invoice to inactive and will soft delete it, meaning it will stop appearing in the list API call. However, it can still be found via the get by id call.
Payments1 gotcha
paymentsDeleteDelete will set the payment to inactive and will soft delete it, meaning it will stop appearing in the list API call. However, it can still be found via the get by id call.
Suppliers3 gotchas
suppliersAddFreshbooks API set status to active by default for new suppliers. To change the status, you can use the Update Supplier endpoint.
suppliersUpdateThe status field can be updated to either "active" or "archived".
suppliersDeleteDelete will set the supplier to inactive and will soft delete it, meaning it will stop appearing in the list API call.