FreshbooksAPI

FREE
By dimashirokov
Updated 8 months ago
Business Software
-/10
Popularity Score
-
Latency
-
Success Rate

FreshbooksAPI API Documentation

Send invoices, track time, manage receipts, expenses

View API Details
POSTcreateExpense
POSTcreateSingleClient
POSTcreateSingleInvoice
POSTcreateSingleItem
POSTcreateSinglePayment
POSTcreateSingleTax
POSTdeleteSingleClient
POSTdeleteSingleExpense
POSTdeleteSingleInvoice
POSTdeleteSingleItem
POSTdeleteSinglePayment
POSTdeleteSingleStaff
POSTdeleteSingleTax
POSTgetAccessToken
POSTgetAllExpenseCategories
POSTgetAllExpenses
POSTgetClients
POSTgetExpense
POSTgetIdentityInfo
POSTgetInvoices
POSTgetItems
POSTgetPayments
POSTgetSingleClient
POSTgetSingleExpenseCategory
POSTgetSingleInvoice
POSTgetSingleItem
POSTgetSinglePayment
POSTgetSingleStaff
POSTgetSingleTax
POSTgetStaffs
POSTgetSystemInfo
POSTgetTaxes
POSTrefreshAccessToken
POSTupdateSingleClient
POSTupdateSingleExpense
POSTupdateSingleInvoice
POSTupdateSingleItem
POSTupdateSinglePayment
POSTupdateSingleStaff
POSTupdateSingleTax
POSTupdateSingleInvoice

This endpoint allows to update single invoice.

Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
Required Parameters
accountIdSTRING
REQUIREDThe ID of the account.
customerIdSTRING
REQUIREDThe ID of the client.
invoiceIdSTRING
REQUIREDThe ID of the invoice.
accessTokenSTRING
REQUIREDAccess token obtained from getAccessToken method.
Optional Parameters
parentNUMBER
OPTIONALid of object this invoice was generated from, 0 if none.
autoBillSELECT
OPTIONALwhether this invoice has a credit card saved.
basecampIdNUMBER
OPTIONALid of connected basecamp account, 0 if none.
codeSTRING
OPTIONALzip code for address on invoice.
invoiceNumberSTRING
OPTIONALuser-specified and visible invoice id.
vatNumberSTRING
OPTIONALValue Added Tax number if provided.
ownerIdNUMBER
OPTIONALid of creator of invoice. 1 if business admin, other if created by e.g. a contractor.
citySTRING
OPTIONALcity for address on invoice.
paymentStatusSELECT
OPTIONALdescription of payment status. One of 'unpaid', 'partial', 'paid', and 'auto-paid'. See the v3_status table on this page for descriptions of each.
languageSTRING
OPTIONALtwo-letter language code, e.g. "en".
streetSTRING
OPTIONALstreet for address on invoice.
discountValueSTRING
OPTIONALdecimal-string amount.
disputeStatusSTRING
OPTIONALdescription of whether invoice has been disputed.
notesSTRING
OPTIONALNotes listed on invoice.
lnameSTRING
OPTIONALLast name of client being invoiced.
organizationSTRING
OPTIONALName of organization being invoiced.
depositAmountSTRING
OPTIONALamount required as deposit, null if none.
poNumberSTRING
OPTIONALPost Office box number for address on invoice.
showAttachmentsSELECT
OPTIONALwhether attachments on invoice are rendered.
statusSTRING
OPTIONALInvoice Status.
lastOrderStatusSTRING
OPTIONALdescribes status of last attempted payment.
v3StatusSTRING
OPTIONALdescription of Invoice Status, see V3 Status Table.
discountDescriptionSTRING
OPTIONALpublic note about discount.
estimateIdNUMBER
OPTIONALid of associated estimate, 0 if none.
autobillStatusSTRING
OPTIONALone of retry, failed, or success.
generationDateDATEPICKER
OPTIONALdate invoice generated from object, null if it wasn't, YYYY-MM-DD if it was.
depositStatusSELECT
OPTIONALdescription of deposits applied to invoice. One of 'paid', 'unpaid', 'partial', 'none', and 'converted'.
countrySTRING
OPTIONALCountry for address on invoice.
vatNameSTRING
OPTIONALValue Added Tax name if provided.
visStateSELECT
OPTIONAL0 for active, 1 for deleted.
addressSTRING
OPTIONALFirst line of address on invoice.
fnameSTRING
OPTIONALFirst name of Client on invoice.
depositPercentageSTRING
OPTIONALpercent of the invoice's value required as a deposit.
currencyCodeSTRING
OPTIONALthree-letter currency code for invoice.
createDateDATEPICKER
OPTIONALThe date of the invoice.
street2STRING
OPTIONALsecond line of street for address on invoice.
termsSTRING
OPTIONALterms listed on invoice.
provinceSTRING
OPTIONALProvince for address on invoice.
dueOffsetDaysNUMBER
OPTIONALNumber of days from creation that invoice is due.
Code Snippet
Install SDK
Response ExampleSchema

Install SDK for (Node.js)Unirest

OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication