Skip to main content
GET
Get Invoice Settings

Headers

Version
enum<string>
required

API Version

Available options:
2021-07-28

Query Parameters

altId
string
required

Location Id or Agency Id

Example:

"6578278e879ad2646715ba9c"

altType
enum<string>
required
Available options:
location

Response

Successful response

altId
string

Sub-Account Id

Example:

"6578278e879ad2646715ba9c"

altType
enum<string>

Alt Type

Available options:
location
Example:

"location"

termsNote
string

Terms and conditions for invoices

Example:

"Payment is due within 30 days."

estimatesTermsNote
string

Terms and conditions for estimates

Example:

"This estimate is valid for 30 days."

title
string

Title for invoices

Maximum string length: 40
Example:

"INVOICE"

estimatesTitle
string

Title for estimates

Maximum string length: 40
Example:

"ESTIMATE"

invoiceNumberPrefix
string

Prefix for invoice numbers

Maximum string length: 10
Example:

"INV-"

estimateNumberPrefix
string

Prefix for estimate numbers

Maximum string length: 10
Example:

"EST-"

dueAfterXDays
number

Number of days after which invoice is due

Example:

30

estimatesExpireAfterXDays
number

Number of days after which estimate expires

Example:

30

minimumPercentagePartialPayment
number

Minimum percentage for partial payment

Example:

25

customFields
string[]

Custom fields array

Maximum array length: 3
Example:
customNotification
object
businessDetails
object
senderConfiguration
object
productSettings
object
reminderSettings
object
lateFeesConfiguration
object
tipsConfiguration
object
paymentMethods
object
Last modified on March 8, 2026