InvoiceVersion: v3

Get Invoice Settings

GET/invoices/settings

Get the invoice settings for the given location

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:invoices.readonly

Auth methods:OAuthPrivate Integration

Token types:Sub-Account TokenAgency Token

Request

Headers

Versionstringrequired

API Version

Available optionsv3

Query Parameters

altIdstringrequired

Location Id or Agency Id

Example:6578278e879ad2646715ba9c

altTypestringrequired

Available optionslocation

Response

application/json

Successful response

altIdstring

Sub-Account Id

Example:6578278e879ad2646715ba9c

altTypestring

Alt Type

Available optionslocation

Example:location

termsNotestring

Terms and conditions for invoices

Example:Payment is due within 30 days.

estimatesTermsNotestring

Terms and conditions for estimates

Example:This estimate is valid for 30 days.

titlestring

Title for invoices

Possible values: <= 40 characters

Example:INVOICE

estimatesTitlestring

Title for estimates

Possible values: <= 40 characters

Example:ESTIMATE

invoiceNumberPrefixstring

Prefix for invoice numbers

Possible values: <= 10 characters

Example:INV-

estimateNumberPrefixstring

Prefix for estimate numbers

Possible values: <= 10 characters

Example:EST-

dueAfterXDaysnumber

Number of days after which invoice is due

Example:30

estimatesExpireAfterXDaysnumber

Number of days after which estimate expires

Example:30

minimumPercentagePartialPaymentnumber

Minimum percentage for partial payment

Example:25

customFieldsstring[]

Custom fields array

Possible values: <= 3

Example:["6578278e879ad2646715baxc","6901e9fb77ac4d701ba0b996"]

customNotificationobject

Custom notification settings

businessDetailsobject

Business details

senderConfigurationobject

Sender configuration

productSettingsobject

Product settings

reminderSettingsobject

Reminder settings

lateFeesConfigurationobject

Late fees configuration

tipsConfigurationobject

Tips configuration

paymentMethodsobject

Payment methods configuration