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
POSTcreateSingleInvoice

This endpoint allows to create single invoice.

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

Install SDK for (Node.js)Unirest

OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication