HighLevel: Invoices schemas (part 1)

← Invoices operations · All schemas

Create & Send — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
action	string	Required within parent	create invoice in draft mode or send mode One of: draft, send
altId	string	Required within parent	location Id / company Id based on altType
altType	string	Required within parent	Alt Type One of: location
attachments	array	Optional	attachments for the invoice
attachments[]	Model	Each item	Expand Create & Send — request body — body attachments item
automaticTaxesEnabled	boolean	Optional	Automatic taxes enabled for the Invoice
businessDetails	Model	Optional	Expand Create & Send — request body — body business Details
contactDetails	JSON	Required within parent	Contact information to send the invoice to
contactDetails (allOf 1)	Model	All variants apply	Expand Update invoice — request body — body contact Details
currency	string	Required within parent	Currency code
discount	Model	Optional	Expand Create & Send — request body — body discount
dueDate	string	Optional	Due date in YYYY-MM-DD format
id	string	Optional	id of invoice to update. If skipped, a new invoice will be created
includeTermsNote	boolean	Optional	include terms & notes with receipts
invoiceNumber	string	Optional	Invoice Number
invoiceNumberPrefix	string	Optional	prefix for invoice number
issueDate	string	Required within parent	Issue date in YYYY-MM-DD format
items	array	Required within parent	An array of items for the invoice.
items[]	Model	Each item	Expand Create & Send — request body — body items item
lateFeesConfiguration	JSON	Optional	late fees configuration
lateFeesConfiguration (allOf 1)	Model	All variants apply	Expand Create & Send — request body — body / lateFeesConfiguration / type: fixed, percentage
liveMode	boolean	Required within parent
miscellaneousCharges	JSON	Optional	miscellaneous charges for the invoice
miscellaneousCharges (allOf 1)	Model	All variants apply	Expand Create & Send — request body — body miscellaneous Charges charges, collected Miscellaneous Charges, paid Charges
name	string	Required within parent	Invoice Name
paymentMethods	JSON	Optional	Payment Methods for Invoices
paymentMethods (allOf 1)	Model	All variants apply	Expand Get Invoice Settings — response body — payment Methods stripe
paymentSchedule	JSON	Optional	split invoice into payment schedule summing up to full invoice amount
paymentSchedule (allOf 1)	Model	All variants apply	Expand Create & Send — request body — body / paymentSchedule / type: fixed, percentage
sentTo	Model	Required within parent	Expand Create & Send — request body — body sent To
termsNotes	string	Optional	Terms notes, Also supports HTML markups
tipsConfiguration	JSON	Optional	tips configuration for the invoice
tipsConfiguration (allOf 1)	Model	All variants apply	Expand Get Invoice Settings — response body — tips Configuration tips Enabled, tips Percentage
title	string	Optional	Title for the invoice
userId	string	Required within parent	id of user generating invoice

Referenced models: Create & Send — request body — body attachments item, Create & Send — request body — body business Details, Update invoice — request body — body contact Details, Create & Send — request body — body items item, Create & Send — request body — body discount, Create & Send — request body — body / lateFeesConfiguration / type: fixed, percentage, Get Invoice Settings — response body — payment Methods stripe, Get Invoice Settings — response body — tips Configuration tips Enabled, tips Percentage, Create & Send — request body — body / paymentSchedule / type: fixed, percentage, Create & Send — request body — body miscellaneous Charges charges, collected Miscellaneous Charges, paid Charges, Create & Send — request body — body sent To

Create & Send — request body — body / lateFeesConfiguration / type: fixed, percentage

Field	Type	Presence	Description and constraints
$	object	Root
enable	boolean	Required within parent	Enable late fees
frequency	JSON	Required within parent	Late Fees Frequency
frequency (allOf 1)	Model	All variants apply	Expand Create & Send — request body — body / lateFeesConfiguration / type: fixed, percentage frequency interval: minute, hour, day, week, month, one time
grace	JSON	Optional	Late Fees Grace
grace (allOf 1)	Model	All variants apply	Expand Create & Send — request body — body / lateFeesConfiguration / type: fixed, percentage grace interval: day
maxLateFees	JSON	Optional	Max late fees payable
maxLateFees (allOf 1)	Model	All variants apply	Expand Create & Send — request body — body / lateFeesConfiguration / type: fixed, percentage max Late Fees type: fixed
type	string	Required within parent	Late Fees Type One of: fixed, percentage
value	number	Required within parent	Late Fees Value

Referenced models: Create & Send — request body — body / lateFeesConfiguration / type: fixed, percentage frequency interval: minute, hour, day, week, month, one time, Create & Send — request body — body / lateFeesConfiguration / type: fixed, percentage grace interval: day, Create & Send — request body — body / lateFeesConfiguration / type: fixed, percentage max Late Fees type: fixed

Create & Send — request body — body / lateFeesConfiguration / type: fixed, percentage frequency interval: minute, hour, day, week, month, one time

Field	Type	Presence	Description and constraints
$	object	Root
interval	string	Required within parent	Late fees interval One of: minute, hour, day, week, month, one_time
intervalCount	number	Required within parent	Late fees interval count

Create & Send — request body — body / lateFeesConfiguration / type: fixed, percentage grace interval: day

Field	Type	Presence	Description and constraints
$	object	Root
interval	string	Required within parent	Late fees grace interval One of: day
intervalCount	number	Required within parent	Late fees grace interval count

Create & Send — request body — body / lateFeesConfiguration / type: fixed, percentage max Late Fees type: fixed

Field	Type	Presence	Description and constraints
$	object	Root
type	string	Required within parent	One of: fixed
value	number	Required within parent	Max late fees to pay

Create & Send — request body — body / paymentSchedule / type: fixed, percentage

Field	Type	Presence	Description and constraints
$	object	Root
schedules	array	Required within parent	payment schedule item
schedules[]	string	Each item
type	string	Required within parent	Payment schedule type One of: fixed, percentage

Create & Send — request body — body attachments item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	Id of the file selected
name	string	Required within parent	Name of the file
size	number	Required within parent	Size of the file
type	string	Required within parent	Type of the file
url	string	Required within parent	URL of the file

Create & Send — request body — body business Details

Field	Type	Presence	Description and constraints
$	object	Root
address	JSON	Optional	Business Address
address (allOf 1)	Model	All variants apply	Expand Update invoice — request body — body contact Details address
customValues	array	Optional	Custom Values
customValues[]	string	Each item
logoUrl	string	Optional	Business Logo URL
name	string	Optional	Business Name
phoneNo	string	Optional	Business Phone Number
website	string	Optional	Business Website Link

Referenced models: Update invoice — request body — body contact Details address

Create & Send — request body — body discount

Field	Type	Presence	Description and constraints
$	object	Root
type	string	Required within parent	Discount type Default: percentage One of: percentage, fixed
validOnProductIds	array	Optional	Product Ids on which discount is applicable
validOnProductIds[]	string	Each item
value	number	Optional	Discount Value Default: 0

Create & Send — request body — body items item

Field	Type	Presence	Description and constraints
$	object	Root
amount	number	Required within parent	Product amount
automaticTaxCategoryId	string	Optional	Tax category id for calculating automatic tax
currency	string	Required within parent	Currency
description	string	Optional	Invoice descriptions
isSetupFeeItem	boolean	Optional	Setupfee item, only created when 1st invoice of recurring schedule is generated
name	string	Required within parent	Invoice Item Name
priceId	string	Optional	Price Id
productId	string	Optional	Product Id
qty	number	Required within parent	Product Quantity
taxInclusive	boolean	Optional	true if item amount is tax inclusive Default: false
taxes	array	Optional	Tax
taxes[]	Model	Each item	Expand Create & Send — request body — body items item taxes item
type	string	Optional	Price type of the item One of: one_time, recurring

Referenced models: Create & Send — request body — body items item taxes item

Create & Send — request body — body items item taxes item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent
calculation	string	Optional	One of: exclusive
description	string	Optional
name	string	Required within parent
rate	number	Required within parent
taxId	string	Optional

Create & Send — request body — body miscellaneous Charges charges, collected Miscellaneous Charges, paid Charges

Field	Type	Presence	Description and constraints
$	object	Root
charges	array	Required within parent	charges for the processing fee
charges[]	array	Each item
collectedMiscellaneousCharges	number	Optional	collected miscellaneous charges
paidCharges	array	Optional	paid miscellaneous charges
paidCharges[]	Model	Each item	Expand Create & Send — request body — body miscellaneous Charges charges, collected Miscellaneous Charges, paid Charges paid Charges item

Referenced models: Create & Send — request body — body miscellaneous Charges charges, collected Miscellaneous Charges, paid Charges paid Charges item

Create & Send — request body — body miscellaneous Charges charges, collected Miscellaneous Charges, paid Charges paid Charges item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	id of the processing fee
amount	number	Required within parent	amount of the processing fee
charge	number	Required within parent	charge for the processing fee
name	string	Required within parent	name of the processing fee

Create & Send — request body — body sent To

Field	Type	Presence	Description and constraints
$	object	Root
email	array	Required within parent	Email Address
email[]	string	Each item
emailBcc	array	Optional	bcc to be kept in any sent out emails
emailBcc[]	string	Each item
emailCc	array	Optional	cc to be kept in any sent out emails
emailCc[]	string	Each item
phoneNo	array	Optional	Contact Phone Number
phoneNo[]	string	Each item

Create & Send — response body

Field	Type	Presence	Description and constraints
$	object	Root
invoice	Model	Required within parent	Expand Void invoice — response body
invoiceUrl	string	Required within parent	preview url of generated invoice

Referenced models: Void invoice — response body

Create Estimate Template — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
altId	string	Required within parent	Location Id or Agency Id
altType	string	Required within parent	One of: location
attachments	array	Optional	attachments for the invoice
attachments[]	Model	Each item	Expand Create & Send — request body — body attachments item
automaticTaxesEnabled	boolean	Optional	Automatic taxes enabled for the Estimate Default: false
businessDetails	Model	Required within parent	Expand Create & Send — request body — body business Details
currency	string	Required within parent	Currency code
discount	Model	Required within parent	Expand Create & Send — request body — body discount
estimateNumberPrefix	string	Optional	Prefix for the estimate number Default: EST-
items	array	Required within parent	An array of items for the estimate.
items[]	array	Each item
liveMode	boolean	Optional	livemode for estimate Default: true
meta	object	Optional	Meta data for the estimate
miscellaneousCharges	JSON	Optional	miscellaneous charges for the estimate
miscellaneousCharges (allOf 1)	Model	All variants apply	Expand Create & Send — request body — body miscellaneous Charges charges, collected Miscellaneous Charges, paid Charges
name	string	Required within parent	Estimate Name
sendEstimateDetails	JSON	Optional	When sending estimate directly while saving
sendEstimateDetails (allOf 1)	Model	All variants apply	Expand Send Estimate — request body — body
termsNotes	string	Optional	Terms notes, Also supports HTML markups
title	string	Optional	Title for the estimate

Referenced models: Create & Send — request body — body attachments item, Create & Send — request body — body business Details, Create & Send — request body — body discount, Create & Send — request body — body miscellaneous Charges charges, collected Miscellaneous Charges, paid Charges, Send Estimate — request body — body

Create Estimate Template — response body

Field	Type	Presence	Description and constraints
$	object	Root
__v	JSON	Required within parent
__v (anyOf 1)	number	Alternative	Version number
__v (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
_id	string	Required within parent	Unique identifier
altId	string	Required within parent	Location Id or Agency Id
altType	string	Required within parent	Known values: location
attachments	array	Optional	Attachments
attachments[]	Model	Each item	Expand Send Estimate — response body — attachments item
automaticTaxesEnabled	boolean	Required within parent	Indicates if automatic taxes are enabled for this estimate
businessDetails	JSON	Required within parent	Business details associated with the estimate
businessDetails (allOf 1)	Model	All variants apply	Expand Delete Event — request body — body
createdAt	string	Required within parent	Timestamp when created Format: date-time
currency	string	Required within parent	Currency code
deleted	boolean	Required within parent	Indicates if deleted
discount	JSON	Required within parent	Discount details for the estimate template
discount (allOf 1)	Model	All variants apply	Expand Send Estimate — response body — discount / type: percentage, fixed
estimateNumberPrefix	string	Optional	Estimate number prefix
items	array	Required within parent	An array of items
items[]	array	Each item
liveMode	boolean	Required within parent	Indicates if it is in live mode
name	string	Required within parent	Name
termsNotes	string	Optional	Terms and conditions for the estimate, supports HTML markup
title	string	Optional	Title
total	JSON	Required within parent
total (anyOf 1)	number	Alternative	Total amount
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updatedAt	string	Required within parent	Timestamp when last updated Format: date-time
updatedBy	string	Optional	User Id of who last updated

Referenced models: Delete Event — request body — body, Send Estimate — response body — attachments item, Send Estimate — response body — discount / type: percentage, fixed

Create Invoice Schedule — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
altId	string	Required within parent	location Id / company Id based on altType
altType	string	Required within parent	Alt Type One of: location
attachments	array	Optional	attachments for the invoice
attachments[]	Model	Each item	Expand Create & Send — request body — body attachments item
automaticTaxesEnabled	boolean	Optional	Automatic taxes enabled for the Invoice
businessDetails	Model	Required within parent	Expand Create & Send — request body — body business Details
contactDetails	Model	Required within parent	Expand Update invoice — request body — body contact Details
currency	string	Required within parent
discount	Model	Required within parent	Expand Create & Send — request body — body discount
invoiceNumberPrefix	string	Optional	prefix for invoice number
items	array	Required within parent
items[]	Model	Each item	Expand Create & Send — request body — body items item
lateFeesConfiguration	JSON	Optional	Late fees configuration for the invoices
lateFeesConfiguration (allOf 1)	Model	All variants apply	Expand Create & Send — request body — body / lateFeesConfiguration / type: fixed, percentage
liveMode	boolean	Required within parent
miscellaneousCharges	JSON	Optional	miscellaneous charges for the invoice
miscellaneousCharges (allOf 1)	Model	All variants apply	Expand Create & Send — request body — body miscellaneous Charges charges, collected Miscellaneous Charges, paid Charges
name	string	Required within parent
paymentMethods	JSON	Optional	Payment Methods for Invoices
paymentMethods (allOf 1)	Model	All variants apply	Expand Get Invoice Settings — response body — payment Methods stripe
schedule	Model	Required within parent	Expand Update schedule — request body — body schedule
termsNotes	string	Optional
tipsConfiguration	JSON	Optional	Configuration for tips on invoices
tipsConfiguration (allOf 1)	Model	All variants apply	Expand Get Invoice Settings — response body — tips Configuration tips Enabled, tips Percentage
title	string	Optional

Referenced models: Create & Send — request body — body attachments item, Create & Send — request body — body business Details, Update invoice — request body — body contact Details, Create & Send — request body — body items item, Create & Send — request body — body discount, Update schedule — request body — body schedule, Create & Send — request body — body / lateFeesConfiguration / type: fixed, percentage, Get Invoice Settings — response body — payment Methods stripe, Get Invoice Settings — response body — tips Configuration tips Enabled, tips Percentage, Create & Send — request body — body miscellaneous Charges charges, collected Miscellaneous Charges, paid Charges

Create Invoice from Estimate — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
altId	string	Required within parent	Location Id or Agency Id
altType	string	Required within parent	One of: location
markAsInvoiced	boolean	Required within parent	Mark Estimate as Invoiced
version	string	Optional	Version of the update request One of: v1, v2

Create Invoice from Estimate — response body

Field	Type	Presence	Description and constraints
$	object	Root
estimate	JSON	Required within parent	Estimate details
estimate (allOf 1)	Model	All variants apply	Expand Send Estimate — response body
invoice	JSON	Required within parent	Invoice details
invoice (allOf 1)	Model	All variants apply	Expand Void invoice — response body

Referenced models: Void invoice — response body, Send Estimate — response body

Create Invoice — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
altId	string	Required within parent	location Id / company Id based on altType
altType	string	Required within parent	Alt Type One of: location
attachments	array	Optional	attachments for the invoice
attachments[]	Model	Each item	Expand Create & Send — request body — body attachments item
automaticTaxesEnabled	boolean	Optional	Automatic taxes enabled for the Invoice
businessDetails	Model	Required within parent	Expand Create & Send — request body — body business Details
contactDetails	JSON	Required within parent	Contact information to send the invoice to
contactDetails (allOf 1)	Model	All variants apply	Expand Update invoice — request body — body contact Details
currency	string	Required within parent	Currency code
discount	Model	Required within parent	Expand Create & Send — request body — body discount
dueDate	string	Optional	Due date in YYYY-MM-DD format
invoiceNumber	string	Optional	Invoice Number
invoiceNumberPrefix	string	Optional	prefix for invoice number
issueDate	string	Required within parent	Issue date in YYYY-MM-DD format
items	array	Required within parent	An array of items for the invoice.
items[]	Model	Each item	Expand Create & Send — request body — body items item
lateFeesConfiguration	JSON	Optional	late fees configuration
lateFeesConfiguration (allOf 1)	Model	All variants apply	Expand Create & Send — request body — body / lateFeesConfiguration / type: fixed, percentage
liveMode	boolean	Required within parent
miscellaneousCharges	JSON	Optional	miscellaneous charges for the invoice
miscellaneousCharges (allOf 1)	Model	All variants apply	Expand Create & Send — request body — body miscellaneous Charges charges, collected Miscellaneous Charges, paid Charges
name	string	Required within parent	Invoice Name
paymentMethods	JSON	Optional	Payment Methods for Invoices
paymentMethods (allOf 1)	Model	All variants apply	Expand Get Invoice Settings — response body — payment Methods stripe
paymentSchedule	JSON	Optional	split invoice into payment schedule summing up to full invoice amount
paymentSchedule (allOf 1)	Model	All variants apply	Expand Create & Send — request body — body / paymentSchedule / type: fixed, percentage
sentTo	Model	Required within parent	Expand Create & Send — request body — body sent To
termsNotes	string	Optional	Terms notes, Also supports HTML markups
tipsConfiguration	JSON	Optional	tips configuration for the invoice
tipsConfiguration (allOf 1)	Model	All variants apply	Expand Get Invoice Settings — response body — tips Configuration tips Enabled, tips Percentage
title	string	Optional	Title for the invoice

Referenced models: Create & Send — request body — body attachments item, Create & Send — request body — body business Details, Update invoice — request body — body contact Details, Create & Send — request body — body items item, Create & Send — request body — body discount, Create & Send — request body — body / lateFeesConfiguration / type: fixed, percentage, Get Invoice Settings — response body — payment Methods stripe, Get Invoice Settings — response body — tips Configuration tips Enabled, tips Percentage, Create & Send — request body — body / paymentSchedule / type: fixed, percentage, Create & Send — request body — body miscellaneous Charges charges, collected Miscellaneous Charges, paid Charges, Create & Send — request body — body sent To

Create New Estimate — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
altId	string	Required within parent	Location Id or Agency Id
altType	string	Required within parent	One of: location
attachments	array	Optional	attachments for the invoice
attachments[]	Model	Each item	Expand Create & Send — request body — body attachments item
autoInvoice	JSON	Optional	Auto invoice for the estimate
autoInvoice (allOf 1)	Model	All variants apply	Expand Update Estimate — request body — body auto Invoice direct Payments, enabled
automaticTaxesEnabled	boolean	Optional	Automatic taxes enabled for the Estimate Default: false
businessDetails	Model	Required within parent	Expand Create & Send — request body — body business Details
contactDetails	JSON	Required within parent	Contact information to send the estimate to
contactDetails (allOf 1)	Model	All variants apply	Expand Update invoice — request body — body contact Details
currency	string	Required within parent	Currency code
discount	Model	Required within parent	Expand Create & Send — request body — body discount
estimateNumber	number	Optional	Estimate Number, if not specified will take in the next valid estimate number
estimateNumberPrefix	string	Optional	Prefix for the estimate number Default: EST-
expiryDate	string	Optional	expiry date estimate
frequencySettings	JSON	Required within parent	frequency settings for the estimate
frequencySettings (allOf 1)	Model	All variants apply	Expand Update Estimate — request body — body frequency Settings enabled, schedule
issueDate	string	Optional	issue date estimate
items	array	Required within parent	An array of items for the estimate.
items[]	Model	Each item	Expand Update Estimate — request body — body items item
liveMode	boolean	Optional	livemode for estimate Default: true
meta	object	Optional	Meta data for the estimate
miscellaneousCharges	JSON	Optional	miscellaneous charges for the estimate
miscellaneousCharges (allOf 1)	Model	All variants apply	Expand Create & Send — request body — body miscellaneous Charges charges, collected Miscellaneous Charges, paid Charges
name	string	Required within parent	Estimate Name
paymentScheduleConfig	JSON	Optional	Payment Schedule Config for the estimate
paymentScheduleConfig (allOf 1)	Model	All variants apply	Expand Update Estimate — request body — body / paymentScheduleConfig / type: fixed, percentage
sendEstimateDetails	JSON	Optional	When sending estimate directly while saving
sendEstimateDetails (allOf 1)	Model	All variants apply	Expand Send Estimate — request body — body
sentTo	JSON	Optional	Email and sent to details for the estimate
sentTo (allOf 1)	Model	All variants apply	Expand Create & Send — request body — body sent To
termsNotes	string	Optional	Terms notes, Also supports HTML markups
title	string	Optional	Title for the estimate
userId	string	Optional	User Id

Referenced models: Create & Send — request body — body attachments item, Update Estimate — request body — body auto Invoice direct Payments, enabled, Create & Send — request body — body business Details, Update invoice — request body — body contact Details, Update Estimate — request body — body items item, Update Estimate — request body — body frequency Settings enabled, schedule, Create & Send — request body — body discount, Update Estimate — request body — body / paymentScheduleConfig / type: fixed, percentage, Create & Send — request body — body miscellaneous Charges charges, collected Miscellaneous Charges, paid Charges, Send Estimate — request body — body, Create & Send — request body — body sent To

Create template — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
altId	string	Required within parent	location Id / company Id based on altType
altType	string	Required within parent	Alt Type One of: location
attachments	array	Optional	attachments for the invoice
attachments[]	string	Each item
automaticTaxesEnabled	boolean	Optional	Automatic taxes enabled for the Invoice
businessDetails	Model	Required within parent	Expand Create & Send — request body — body business Details
currency	string	Required within parent
discount	Model	Optional	Expand Create & Send — request body — body discount
internal	boolean	Optional
invoiceNumberPrefix	string	Optional	prefix for invoice number
items	array	Required within parent
items[]	Model	Each item	Expand Create & Send — request body — body items item
lateFeesConfiguration	JSON	Optional	Late fees configuration for the invoices
lateFeesConfiguration (allOf 1)	Model	All variants apply	Expand Create & Send — request body — body / lateFeesConfiguration / type: fixed, percentage
miscellaneousCharges	JSON	Optional	miscellaneous charges for the invoice
miscellaneousCharges (allOf 1)	Model	All variants apply	Expand Create & Send — request body — body miscellaneous Charges charges, collected Miscellaneous Charges, paid Charges
name	string	Required within parent	Name of the template
paymentMethods	JSON	Optional	Payment Methods for Invoices
paymentMethods (allOf 1)	Model	All variants apply	Expand Get Invoice Settings — response body — payment Methods stripe
termsNotes	string	Optional
tipsConfiguration	JSON	Optional	Configuration for tips on invoices
tipsConfiguration (allOf 1)	Model	All variants apply	Expand Get Invoice Settings — response body — tips Configuration tips Enabled, tips Percentage
title	string	Optional	Template title

Referenced models: Create & Send — request body — body business Details, Create & Send — request body — body items item, Create & Send — request body — body discount, Create & Send — request body — body / lateFeesConfiguration / type: fixed, percentage, Get Invoice Settings — response body — payment Methods stripe, Get Invoice Settings — response body — tips Configuration tips Enabled, tips Percentage, Create & Send — request body — body miscellaneous Charges charges, collected Miscellaneous Charges, paid Charges

Create template — response body

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	Template Id
altId	string	Required within parent	Location Id or Agency Id
altType	string	Required within parent	Known values: location
businessDetails	JSON	Required within parent	Business Details
businessDetails (allOf 1)	Model	All variants apply	Expand Create & Send — request body — body business Details
createdAt	string	Required within parent	created at
currency	string	Required within parent	Currency
discount	JSON	Optional	Discount
discount (allOf 1)	Model	All variants apply	Expand Send Estimate — response body — discount / type: percentage, fixed
invoiceNumberPrefix	string	Optional	prefix for invoice number
items	array	Required within parent	Invoice Items
items[]	string	Each item
name	string	Required within parent	Name of the Template
total	JSON	Required within parent
total (anyOf 1)	number	Alternative	Total Amount
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updatedAt	string	Required within parent	updated at

Referenced models: Create & Send — request body — body business Details, Send Estimate — response body — discount / type: percentage, fixed

Delete Estimate — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
altId	string	Required within parent	Location Id or Agency Id
altType	string	Required within parent	One of: location

Delete schedule — response body

Field	Type	Presence	Description and constraints
$	object	Root
success	boolean	Required within parent	success

Generate Estimate Number — response body

Field	Type	Presence	Description and constraints
$	object	Root
estimateNumber	JSON	Required within parent
estimateNumber (anyOf 1)	number	Alternative
estimateNumber (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
traceId	string	Required within parent

Generate Invoice Number — response body

Field	Type	Presence	Description and constraints
$	object	Root
invoiceNumber	JSON	Optional
invoiceNumber (anyOf 1)	number	Alternative	Invoice Number
invoiceNumber (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get Invoice Settings — response body

Field	Type	Presence	Description and constraints
$	object	Root
altId	string	Optional	Sub-Account Id
altType	string	Optional	Alt Type Known values: location
businessDetails	JSON	Optional	Business details
businessDetails (allOf 1)	Model	All variants apply	Expand Get Invoice Settings — response body — business Details address, custom Values, logo Url, name, phone No, website
customFields	array	Optional	Custom fields array Maximum items: 3
customFields[]	string	Each item
customNotification	JSON	Optional	Custom notification settings
customNotification (allOf 1)	Model	All variants apply	Expand Get Invoice Settings — response body — custom Notification customer Auto Payment Amount Changed, customer Auto Payment Failure, customer Auto Payment Info, customer Auto Payment Success, customer Payment Failure, customer Payment Success, customer Send Estimate, customer Send Invoice, team Auto Payment Failure, team Auto Payment Skip, team Auto Payment Success, team Estimate Accepted, team Estimate Declined, team Payment Failure, team Payment Success, team Recurring Send Invoice Failed
dueAfterXDays	JSON	Optional
dueAfterXDays (anyOf 1)	number	Alternative	Number of days after which invoice is due
dueAfterXDays (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
estimateNumberPrefix	string	Optional	Prefix for estimate numbers Maximum length: 10
estimatesExpireAfterXDays	JSON	Optional
estimatesExpireAfterXDays (anyOf 1)	number	Alternative	Number of days after which estimate expires
estimatesExpireAfterXDays (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
estimatesTermsNote	string	Optional	Terms and conditions for estimates
estimatesTitle	string	Optional	Title for estimates Maximum length: 40
invoiceNumberPrefix	string	Optional	Prefix for invoice numbers Maximum length: 10
lateFeesConfiguration	JSON	Optional	Late fees configuration
lateFeesConfiguration (allOf 1)	Model	All variants apply	Expand Get Invoice Settings — response body — lateFeesConfiguration / type: fixed, percentage
minimumPercentagePartialPayment	JSON	Optional
minimumPercentagePartialPayment (anyOf 1)	number	Alternative	Minimum percentage for partial payment
minimumPercentagePartialPayment (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
paymentMethods	JSON	Optional	Payment methods configuration
paymentMethods (allOf 1)	Model	All variants apply	Expand Get Invoice Settings — response body — payment Methods stripe
productSettings	JSON	Optional	Product settings
productSettings (allOf 1)	Model	All variants apply	Expand Get Invoice Settings — response body — product Settings description Optional, enable Import Product Description
reminderSettings	JSON	Optional	Reminder settings
reminderSettings (allOf 1)	Model	All variants apply	Expand Get Invoice Settings — response body — reminder Settings default Email Template Id, reminders
senderConfiguration	JSON	Optional	Sender configuration
senderConfiguration (allOf 1)	Model	All variants apply	Expand Get Invoice Settings — response body — sender Configuration from Email, from Name
termsNote	string	Optional	Terms and conditions for invoices
tipsConfiguration	JSON	Optional	Tips configuration
tipsConfiguration (allOf 1)	Model	All variants apply	Expand Get Invoice Settings — response body — tips Configuration tips Enabled, tips Percentage
title	string	Optional	Title for invoices Maximum length: 40

Referenced models: Get Invoice Settings — response body — custom Notification customer Auto Payment Amount Changed, customer Auto Payment Failure, customer Auto Payment Info, customer Auto Payment Success, customer Payment Failure, customer Payment Success, customer Send Estimate, customer Send Invoice, team Auto Payment Failure, team Auto Payment Skip, team Auto Payment Success, team Estimate Accepted, team Estimate Declined, team Payment Failure, team Payment Success, team Recurring Send Invoice Failed, Get Invoice Settings — response body — product Settings description Optional, enable Import Product Description, Get Invoice Settings — response body — sender Configuration from Email, from Name, Get Invoice Settings — response body — business Details address, custom Values, logo Url, name, phone No, website, Get Invoice Settings — response body — lateFeesConfiguration / type: fixed, percentage, Get Invoice Settings — response body — payment Methods stripe, Get Invoice Settings — response body — reminder Settings default Email Template Id, reminders, Get Invoice Settings — response body — tips Configuration tips Enabled, tips Percentage

Get Invoice Settings — response body — business Details address, custom Values, logo Url, name, phone No, website

Field	Type	Presence	Description and constraints
$	object	Root
address	Model	Optional	Expand Get Invoice Settings — response body — business Details address, custom Values, logo Url, name, phone No, website address
customValues	array	Optional
customValues[]	string	Each item
logoUrl	string	Optional
name	string	Required within parent
phoneNo	string	Optional
website	string	Optional

Referenced models: Get Invoice Settings — response body — business Details address, custom Values, logo Url, name, phone No, website address

Get Invoice Settings — response body — business Details address, custom Values, logo Url, name, phone No, website address

Field	Type	Presence	Description and constraints
$	object	Root
addressLine1	string	Optional
addressLine2	string	Optional
city	string	Optional
countryCode	string	Optional	Known values: AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KP, KR, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, GB, UA, AE, US, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW
postalCode	string	Optional
state	string	Optional

Get Invoice Settings — response body — custom Notification customer Auto Payment Amount Changed, customer Auto Payment Failure, customer Auto Payment Info, customer Auto Payment Success, customer Payment Failure, customer Payment Success, customer Send Estimate, customer Send Invoice, team Auto Payment Failure, team Auto Payment Skip, team Auto Payment Success, team Estimate Accepted, team Estimate Declined, team Payment Failure, team Payment Success, team Recurring Send Invoice Failed

Field	Type	Presence	Description and constraints
$	object	Root
customerAutoPaymentAmountChanged	Model	Required within parent	Expand Get Invoice Settings — response body — custom Notification customer Auto Payment Amount Changed, customer Auto Payment Failure, customer Auto Payment Info, customer Auto Payment Success, customer Payment Failure, customer Payment Success, customer Send Estimate, customer Send Invoice, team Auto Payment Failure, team Auto Payment Skip, team Auto Payment Success, team Estimate Accepted, team Estimate Declined, team Payment Failure, team Payment Success, team Recurring Send Invoice Failed team Payment Failure
customerAutoPaymentFailure	Model	Required within parent	Expand Get Invoice Settings — response body — custom Notification customer Auto Payment Amount Changed, customer Auto Payment Failure, customer Auto Payment Info, customer Auto Payment Success, customer Payment Failure, customer Payment Success, customer Send Estimate, customer Send Invoice, team Auto Payment Failure, team Auto Payment Skip, team Auto Payment Success, team Estimate Accepted, team Estimate Declined, team Payment Failure, team Payment Success, team Recurring Send Invoice Failed team Payment Failure
customerAutoPaymentInfo	Model	Required within parent	Expand Get Invoice Settings — response body — custom Notification customer Auto Payment Amount Changed, customer Auto Payment Failure, customer Auto Payment Info, customer Auto Payment Success, customer Payment Failure, customer Payment Success, customer Send Estimate, customer Send Invoice, team Auto Payment Failure, team Auto Payment Skip, team Auto Payment Success, team Estimate Accepted, team Estimate Declined, team Payment Failure, team Payment Success, team Recurring Send Invoice Failed team Payment Failure
customerAutoPaymentSuccess	Model	Required within parent	Expand Get Invoice Settings — response body — custom Notification customer Auto Payment Amount Changed, customer Auto Payment Failure, customer Auto Payment Info, customer Auto Payment Success, customer Payment Failure, customer Payment Success, customer Send Estimate, customer Send Invoice, team Auto Payment Failure, team Auto Payment Skip, team Auto Payment Success, team Estimate Accepted, team Estimate Declined, team Payment Failure, team Payment Success, team Recurring Send Invoice Failed team Payment Failure
customerPaymentFailure	Model	Required within parent	Expand Get Invoice Settings — response body — custom Notification customer Auto Payment Amount Changed, customer Auto Payment Failure, customer Auto Payment Info, customer Auto Payment Success, customer Payment Failure, customer Payment Success, customer Send Estimate, customer Send Invoice, team Auto Payment Failure, team Auto Payment Skip, team Auto Payment Success, team Estimate Accepted, team Estimate Declined, team Payment Failure, team Payment Success, team Recurring Send Invoice Failed team Payment Failure
customerPaymentSuccess	Model	Required within parent	Expand Get Invoice Settings — response body — custom Notification customer Auto Payment Amount Changed, customer Auto Payment Failure, customer Auto Payment Info, customer Auto Payment Success, customer Payment Failure, customer Payment Success, customer Send Estimate, customer Send Invoice, team Auto Payment Failure, team Auto Payment Skip, team Auto Payment Success, team Estimate Accepted, team Estimate Declined, team Payment Failure, team Payment Success, team Recurring Send Invoice Failed team Payment Failure
customerSendEstimate	Model	Required within parent	Expand Get Invoice Settings — response body — custom Notification customer Auto Payment Amount Changed, customer Auto Payment Failure, customer Auto Payment Info, customer Auto Payment Success, customer Payment Failure, customer Payment Success, customer Send Estimate, customer Send Invoice, team Auto Payment Failure, team Auto Payment Skip, team Auto Payment Success, team Estimate Accepted, team Estimate Declined, team Payment Failure, team Payment Success, team Recurring Send Invoice Failed team Payment Failure
customerSendInvoice	Model	Required within parent	Expand Get Invoice Settings — response body — custom Notification customer Auto Payment Amount Changed, customer Auto Payment Failure, customer Auto Payment Info, customer Auto Payment Success, customer Payment Failure, customer Payment Success, customer Send Estimate, customer Send Invoice, team Auto Payment Failure, team Auto Payment Skip, team Auto Payment Success, team Estimate Accepted, team Estimate Declined, team Payment Failure, team Payment Success, team Recurring Send Invoice Failed team Payment Failure
teamAutoPaymentFailure	Model	Required within parent	Expand Get Invoice Settings — response body — custom Notification customer Auto Payment Amount Changed, customer Auto Payment Failure, customer Auto Payment Info, customer Auto Payment Success, customer Payment Failure, customer Payment Success, customer Send Estimate, customer Send Invoice, team Auto Payment Failure, team Auto Payment Skip, team Auto Payment Success, team Estimate Accepted, team Estimate Declined, team Payment Failure, team Payment Success, team Recurring Send Invoice Failed team Payment Failure
teamAutoPaymentSkip	Model	Required within parent	Expand Get Invoice Settings — response body — custom Notification customer Auto Payment Amount Changed, customer Auto Payment Failure, customer Auto Payment Info, customer Auto Payment Success, customer Payment Failure, customer Payment Success, customer Send Estimate, customer Send Invoice, team Auto Payment Failure, team Auto Payment Skip, team Auto Payment Success, team Estimate Accepted, team Estimate Declined, team Payment Failure, team Payment Success, team Recurring Send Invoice Failed team Payment Failure
teamAutoPaymentSuccess	Model	Required within parent	Expand Get Invoice Settings — response body — custom Notification customer Auto Payment Amount Changed, customer Auto Payment Failure, customer Auto Payment Info, customer Auto Payment Success, customer Payment Failure, customer Payment Success, customer Send Estimate, customer Send Invoice, team Auto Payment Failure, team Auto Payment Skip, team Auto Payment Success, team Estimate Accepted, team Estimate Declined, team Payment Failure, team Payment Success, team Recurring Send Invoice Failed team Payment Failure
teamEstimateAccepted	Model	Required within parent	Expand Get Invoice Settings — response body — custom Notification customer Auto Payment Amount Changed, customer Auto Payment Failure, customer Auto Payment Info, customer Auto Payment Success, customer Payment Failure, customer Payment Success, customer Send Estimate, customer Send Invoice, team Auto Payment Failure, team Auto Payment Skip, team Auto Payment Success, team Estimate Accepted, team Estimate Declined, team Payment Failure, team Payment Success, team Recurring Send Invoice Failed team Payment Failure
teamEstimateDeclined	Model	Required within parent	Expand Get Invoice Settings — response body — custom Notification customer Auto Payment Amount Changed, customer Auto Payment Failure, customer Auto Payment Info, customer Auto Payment Success, customer Payment Failure, customer Payment Success, customer Send Estimate, customer Send Invoice, team Auto Payment Failure, team Auto Payment Skip, team Auto Payment Success, team Estimate Accepted, team Estimate Declined, team Payment Failure, team Payment Success, team Recurring Send Invoice Failed team Payment Failure
teamPaymentFailure	Model	Required within parent	Expand Get Invoice Settings — response body — custom Notification customer Auto Payment Amount Changed, customer Auto Payment Failure, customer Auto Payment Info, customer Auto Payment Success, customer Payment Failure, customer Payment Success, customer Send Estimate, customer Send Invoice, team Auto Payment Failure, team Auto Payment Skip, team Auto Payment Success, team Estimate Accepted, team Estimate Declined, team Payment Failure, team Payment Success, team Recurring Send Invoice Failed team Payment Failure
teamPaymentSuccess	Model	Required within parent	Expand Get Invoice Settings — response body — custom Notification customer Auto Payment Amount Changed, customer Auto Payment Failure, customer Auto Payment Info, customer Auto Payment Success, customer Payment Failure, customer Payment Success, customer Send Estimate, customer Send Invoice, team Auto Payment Failure, team Auto Payment Skip, team Auto Payment Success, team Estimate Accepted, team Estimate Declined, team Payment Failure, team Payment Success, team Recurring Send Invoice Failed team Payment Failure
teamRecurringSendInvoiceFailed	Model	Required within parent	Expand Get Invoice Settings — response body — custom Notification customer Auto Payment Amount Changed, customer Auto Payment Failure, customer Auto Payment Info, customer Auto Payment Success, customer Payment Failure, customer Payment Success, customer Send Estimate, customer Send Invoice, team Auto Payment Failure, team Auto Payment Skip, team Auto Payment Success, team Estimate Accepted, team Estimate Declined, team Payment Failure, team Payment Success, team Recurring Send Invoice Failed team Payment Failure

Referenced models: Get Invoice Settings — response body — custom Notification customer Auto Payment Amount Changed, customer Auto Payment Failure, customer Auto Payment Info, customer Auto Payment Success, customer Payment Failure, customer Payment Success, customer Send Estimate, customer Send Invoice, team Auto Payment Failure, team Auto Payment Skip, team Auto Payment Success, team Estimate Accepted, team Estimate Declined, team Payment Failure, team Payment Success, team Recurring Send Invoice Failed team Payment Failure

Get Invoice Settings — response body — custom Notification customer Auto Payment Amount Changed, customer Auto Payment Failure, customer Auto Payment Info, customer Auto Payment Success, customer Payment Failure, customer Payment Success, customer Send Estimate, customer Send Invoice, team Auto Payment Failure, team Auto Payment Skip, team Auto Payment Success, team Estimate Accepted, team Estimate Declined, team Payment Failure, team Payment Success, team Recurring Send Invoice Failed team Payment Failure

Field	Type	Presence	Description and constraints
$	object	Root
defaultEmailTemplateId	string	Optional	Default email TemplateId to be used for sending via email
emailSubject	string	Optional	Subject of email which is sent out
emailTemplate	string	Required within parent	Template to be used for sending email
enabled	boolean	Required within parent	Flag indicating if the notification is enabled or not
fromEmail	string	Optional	Email address to be used for sending email
fromName	string	Optional	Name to be used while sending email
smsTemplate	string	Required within parent	Template to be used for sending sms

Get Invoice Settings — response body — lateFeesConfiguration / type: fixed, percentage

Field	Type	Presence	Description and constraints
$	object	Root
enable	boolean	Required within parent	Enable late fees
frequency	JSON	Required within parent	Late Fees Frequency
frequency (allOf 1)	Model	All variants apply	Expand Get Invoice Settings — response body — lateFeesConfiguration / type: fixed, percentage frequency interval: minute, hour, day, week, month, one time
grace	JSON	Optional	Late Fees Grace
grace (allOf 1)	Model	All variants apply	Expand Get Invoice Settings — response body — lateFeesConfiguration / type: fixed, percentage grace interval: day
maxLateFees	JSON	Optional	Max late fees payable
maxLateFees (allOf 1)	Model	All variants apply	Expand Get Invoice Settings — response body — lateFeesConfiguration / type: fixed, percentage max Late Fees type: fixed
type	string	Required within parent	Late Fees Type Known values: fixed, percentage
value	JSON	Required within parent
value (anyOf 1)	number	Alternative	Late Fees Value
value (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Get Invoice Settings — response body — lateFeesConfiguration / type: fixed, percentage frequency interval: minute, hour, day, week, month, one time, Get Invoice Settings — response body — lateFeesConfiguration / type: fixed, percentage grace interval: day, Get Invoice Settings — response body — lateFeesConfiguration / type: fixed, percentage max Late Fees type: fixed

Get Invoice Settings — response body — lateFeesConfiguration / type: fixed, percentage frequency interval: minute, hour, day, week, month, one time

Field	Type	Presence	Description and constraints
$	object	Root
interval	string	Required within parent	Late fees interval Known values: minute, hour, day, week, month, one_time
intervalCount	JSON	Required within parent
intervalCount (anyOf 1)	number	Alternative	Late fees interval count
intervalCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get Invoice Settings — response body — lateFeesConfiguration / type: fixed, percentage grace interval: day

Field	Type	Presence	Description and constraints
$	object	Root
interval	string	Required within parent	Late fees grace interval Known values: day
intervalCount	JSON	Required within parent
intervalCount (anyOf 1)	number	Alternative	Late fees grace interval count
intervalCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get Invoice Settings — response body — lateFeesConfiguration / type: fixed, percentage max Late Fees type: fixed

Field	Type	Presence	Description and constraints
$	object	Root
type	string	Required within parent	Known values: fixed
value	JSON	Required within parent
value (anyOf 1)	number	Alternative	Max late fees to pay
value (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Get Invoice Settings — response body — payment Methods stripe

Field	Type	Presence	Description and constraints
$	object	Root
stripe	JSON	Required within parent	Payment Method
stripe (allOf 1)	Model	All variants apply	Expand Get Invoice Settings — response body — payment Methods stripe stripe enable Bank Debit Only

Referenced models: Get Invoice Settings — response body — payment Methods stripe stripe enable Bank Debit Only

Get Invoice Settings — response body — payment Methods stripe stripe enable Bank Debit Only

Field	Type	Presence	Description and constraints
$	object	Root
enableBankDebitOnly	boolean	Required within parent	Enable Bank Debit Only

Get Invoice Settings — response body — product Settings description Optional, enable Import Product Description

Field	Type	Presence	Description and constraints
$	object	Root
descriptionOptional	boolean	Optional	Flag indicating if the product description is optional or not
enableImportProductDescription	boolean	Optional	Flag indicating if the product description import is enabled or not

Get Invoice Settings — response body — reminder Settings default Email Template Id, reminders

Field	Type	Presence	Description and constraints
$	object	Root
defaultEmailTemplateId	string	Required within parent	default template Id of reminder
reminders	array	Required within parent	List of reminders
reminders[]	Model	Each item	Expand Get Invoice Settings — response body — reminder Settings default Email Template Id, reminders reminders item

Referenced models: Get Invoice Settings — response body — reminder Settings default Email Template Id, reminders reminders item

Get Invoice Settings — response body — reminder Settings default Email Template Id, reminders reminders item

Field	Type	Presence	Description and constraints
$	object	Root
emailSubject	string	Required within parent	Subject of the reminder
emailTemplate	string	Required within parent	Email template to be used for sending reminders
enabled	boolean	Required within parent	Flag indicating if the reminder is enabled or not
endTime	string	Optional	Business Hour End Time
intervalType	string	Required within parent	Interval type for the reminder Known values: yearly, monthly, weekly, daily, hourly, minutely, secondly
maxReminders	JSON	Required within parent
maxReminders (anyOf 1)	number	Alternative	Maximum number of reminders that can be sent
maxReminders (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
reminderId	string	Required within parent	Unique identifier for the reminder
reminderInvoiceCondition	string	Required within parent	Condition for sending the reminder Known values: invoice_sent, invoice_overdue
reminderName	string	Required within parent	Name of the reminder
reminderNumber	JSON	Required within parent
reminderNumber (anyOf 1)	number	Alternative	frequency gap of the reminder to exeucte
reminderNumber (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
reminderTime	string	Required within parent	Time condition for the reminder Known values: before, after
smsTemplate	string	Required within parent	SMS template to be used for sending reminders
startTime	string	Optional	Business Hour Start Time
timezone	string	Optional	Timezone at which reminder will be sent

Get Invoice Settings — response body — sender Configuration from Email, from Name

Field	Type	Presence	Description and constraints
$	object	Root
fromEmail	string	Optional	Email id to be used while sending email notification
fromName	string	Optional	Sender name to be used while sending email notification

Get Invoice Settings — response body — tips Configuration tips Enabled, tips Percentage

Field	Type	Presence	Description and constraints
$	object	Root
tipsEnabled	boolean	Required within parent	Tips enabled status
tipsPercentage	array	Required within parent	Percentage of tips allowed
tipsPercentage[]	string	Each item

Get an schedule — response body

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	Schedule Id
altId	string	Required within parent	Location Id or Agency Id
altType	string	Required within parent	Known values: location
businessDetails	JSON	Required within parent	Business Details
businessDetails (allOf 1)	Model	All variants apply	Expand Create & Send — request body — body business Details
compiledTermsNotes	string	Required within parent	Compiled terms notes
contactDetails	JSON	Required within parent	Contact Details
contactDetails (allOf 1)	Model	All variants apply	Expand Update invoice — request body — body contact Details
createdAt	string	Required within parent	created at
currency	string	Required within parent	Currency
discount	JSON	Optional	Discount
discount (allOf 1)	Model	All variants apply	Expand Send Estimate — response body — discount / type: percentage, fixed
invoices	array	Required within parent	List of invoices
invoices[]	Model	Each item	Expand Void invoice — response body
items	array	Required within parent	Invoice Items
items[]	string	Each item
liveMode	boolean	Required within parent	Live Mode
name	string	Required within parent	Name of the invoice
schedule	Model	Optional	Expand Get an schedule — response body — schedule
status	object	Required within parent	Schedule Status
termsNotes	string	Required within parent	Terms notes
title	string	Required within parent	Title
total	JSON	Required within parent
total (anyOf 1)	number	Alternative	Total Amount
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updatedAt	string	Required within parent	updated at

Referenced models: Create & Send — request body — body business Details, Update invoice — request body — body contact Details, Void invoice — response body, Send Estimate — response body — discount / type: percentage, fixed, Get an schedule — response body — schedule

Get an schedule — response body — schedule

Field	Type	Presence	Description and constraints
$	object	Root
executeAt	string	Optional
rrule	Model	Optional	Expand Get an schedule — response body — schedule rrule

Referenced models: Get an schedule — response body — schedule rrule

Get an schedule — response body — schedule rrule

Field	Type	Presence	Description and constraints
$	object	Root
count	JSON	Optional
count (anyOf 1)	number	Alternative	Max number of task executions
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
dayOfMonth	JSON	Optional
dayOfMonth (anyOf 1)	number	Alternative	-1, 1, 2, 3, ..., 27, 28
dayOfMonth (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
dayOfWeek	string	Optional	Known values: mo, tu, we, th, fr, sa, su
daysBefore	JSON	Optional
daysBefore (anyOf 1)	number	Alternative	Execute task number of days before
daysBefore (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
endDate	string	Optional	End date in YYYY-MM-DD format
endTime	string	Optional	End time in HH:mm:ss format
endType	string	Optional	End type like after, by, count
interval	JSON	Required within parent
interval (anyOf 1)	number	Alternative
interval (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
intervalType	string	Required within parent	Known values: yearly, monthly, weekly, daily, hourly, minutely, secondly
monthOfYear	string	Optional	Known values: jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec
numOfWeek	JSON	Optional
numOfWeek (anyOf 1)	number	Alternative	-1, 1, 2, 3, 4
numOfWeek (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
startDate	string	Required within parent	Start date in YYYY-MM-DD format
startTime	string	Optional	Start time in HH:mm:ss format
useStartAsPrimaryUserAccepted	boolean	Optional	Start as primary user accepted date

Get invoice — response body

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	Invoice Id
altId	string	Required within parent	Location Id or Agency Id
altType	string	Required within parent	Known values: location
amountDue	JSON	Required within parent
amountDue (anyOf 1)	number	Alternative	Total Amount Due
amountDue (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
amountPaid	JSON	Required within parent
amountPaid (anyOf 1)	number	Alternative	Amount Paid
amountPaid (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
automaticTaxesCalculated	boolean	Optional	Is Automatic taxes calculated for the Invoice items
automaticTaxesEnabled	boolean	Optional	Automatic taxes enabled for the Invoice
businessDetails	object	Required within parent	Business Details
contactDetails	object	Required within parent	Contact Details
createdAt	string	Required within parent	created at
currency	string	Required within parent	Currency
discount	object	Optional	Discount
dueDate	string	Required within parent	Due date in YYYY-MM-DD format
invoiceItems	array	Required within parent	Invoice Items
invoiceItems[]	string	Each item
invoiceNumber	JSON	Required within parent
invoiceNumber (anyOf 1)	number	Alternative	Invoice Number
invoiceNumber (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
issueDate	string	Required within parent	Issue date in YYYY-MM-DD format
liveMode	boolean	Required within parent	Live Mode
name	string	Required within parent	Name of the invoice
paymentSchedule	object	Optional	split invoice into payment schedule summing up to full invoice amount
remindersConfiguration	JSON	Optional	Reminders Configuration
remindersConfiguration (allOf 1)	Model	All variants apply	Expand Get invoice — response body — reminders Configuration reminder Execution Details List, reminder Settings
status	string	Required within parent	Invoice Status Known values: draft, sent, payment_processing, paid, void, partially_paid
title	string	Required within parent	Title
total	JSON	Required within parent
total (anyOf 1)	number	Alternative	Total Amount
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
totalSummary	Model	Required within parent	Expand Get invoice — response body — total Summary
updatedAt	string	Required within parent	updated at

Referenced models: Get invoice — response body — reminders Configuration reminder Execution Details List, reminder Settings, Get invoice — response body — total Summary

Get invoice — response body — reminders Configuration reminder Execution Details List, reminder Settings

Field	Type	Presence	Description and constraints
$	object	Root
reminderExecutionDetailsList	JSON	Required within parent	List of reminders
reminderExecutionDetailsList (allOf 1)	Model	All variants apply	Expand Delete Event — request body — body
reminderSettings	JSON	Required within parent	Reminder settings
reminderSettings (allOf 1)	Model	All variants apply	Expand Get Invoice Settings — response body — reminder Settings default Email Template Id, reminders

Referenced models: Delete Event — request body — body, Get Invoice Settings — response body — reminder Settings default Email Template Id, reminders

Get invoice — response body — total Summary

Field	Type	Presence	Description and constraints
$	object	Root
discount	JSON	Required within parent
discount (anyOf 1)	number	Alternative	discount
discount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
subTotal	JSON	Required within parent
subTotal (anyOf 1)	number	Alternative	subTotal
subTotal (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tax	JSON	Required within parent
tax (anyOf 1)	number	Alternative	tax
tax (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List Estimate Templates — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	array	Required within parent	List of estimate templates
data[]	string	Each item
totalCount	JSON	Required within parent
totalCount (anyOf 1)	number	Alternative	Total number of estimate templates available
totalCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
traceId	string	Required within parent	Unique identifier for tracing the request

List Estimates — response body

Field	Type	Presence	Description and constraints
$	object	Root
estimates	array	Required within parent	List of estimates
estimates[]	string	Each item
total	JSON	Required within parent
total (anyOf 1)	number	Alternative	Total number of estimates
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
traceId	string	Required within parent	Unique identifier for tracing the request

List invoices — response body

Field	Type	Presence	Description and constraints
$	object	Root
invoices	array	Required within parent
invoices[]	Model	Each item	Expand Get invoice — response body
total	JSON	Required within parent
total (anyOf 1)	number	Alternative	Total number of invoices
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Get invoice — response body

List schedules — response body

Field	Type	Presence	Description and constraints
$	object	Root
schedules	array	Required within parent
schedules[]	Model	Each item	Expand Get an schedule — response body
total	JSON	Required within parent
total (anyOf 1)	number	Alternative	Total number of Schedules
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Get an schedule — response body

List templates — invoices list Invoice Templates — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	array	Required within parent
data[]	Model	Each item	Expand Create template — response body
totalCount	JSON	Required within parent
totalCount (anyOf 1)	number	Alternative	Total number of Templates
totalCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Create template — response body

Manage Auto payment for an schedule invoice — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
altId	string	Required within parent	location Id / company Id based on altType
altType	string	Required within parent	Alt Type One of: location
autoPayment	JSON	Required within parent	auto-payment configuration
autoPayment (allOf 1)	Model	All variants apply	Expand Send invoice — request body — body auto Payment bacs Direct Debit, becs Direct Debit, card, card Id, customer Id, enable, payment Method Id, provider, sepa Direct Debit, type, us Bank Account
id	string	Required within parent

Referenced models: Send invoice — request body — body auto Payment bacs Direct Debit, becs Direct Debit, card, card Id, customer Id, enable, payment Method Id, provider, sepa Direct Debit, type, us Bank Account

Record a manual payment for an invoice — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
altId	string	Required within parent	location Id / company Id based on altType
altType	string	Required within parent	Alt Type One of: location
amount	number	Optional	Amount to be paid against the invoice.
card	Model	Required within parent	Expand Record a manual payment for an invoice — request body — body card
cheque	Model	Required within parent	Expand Record a manual payment for an invoice — request body — body cheque
fulfilledAt	string	Optional	Updated At to be recorded against the invoice.
meta	object	Optional
mode	string	Required within parent	manual payment method One of: cash, card, cheque, bank_transfer, other
notes	string	Required within parent	Any note to be recorded with the transaction
paymentScheduleIds	array	Optional	Payment Schedule Ids to be recorded against the invoice.
paymentScheduleIds[]	string	Each item

Referenced models: Record a manual payment for an invoice — request body — body cheque, Record a manual payment for an invoice — request body — body card

Record a manual payment for an invoice — request body — body card

Field	Type	Presence	Description and constraints
$	object	Root
brand	string	Required within parent
last4	string	Required within parent

Record a manual payment for an invoice — request body — body cheque

Field	Type	Presence	Description and constraints
$	object	Root
number	string	Required within parent	check number

Record a manual payment for an invoice — response body

Field	Type	Presence	Description and constraints
$	object	Root
invoice	Model	Required within parent	Expand Void invoice — response body
success	boolean	Required within parent	status

Referenced models: Void invoice — response body

Schedule an schedule invoice — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
altId	string	Required within parent	location Id / company Id based on altType
altType	string	Required within parent	Alt Type One of: location
autoPayment	JSON	Optional	auto-payment configuration
autoPayment (allOf 1)	Model	All variants apply	Expand Send invoice — request body — body auto Payment bacs Direct Debit, becs Direct Debit, card, card Id, customer Id, enable, payment Method Id, provider, sepa Direct Debit, type, us Bank Account
liveMode	boolean	Required within parent

Referenced models: Send invoice — request body — body auto Payment bacs Direct Debit, becs Direct Debit, card, card Id, customer Id, enable, payment Method Id, provider, sepa Direct Debit, type, us Bank Account

Send Estimate — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
action	string	Required within parent	One of: sms_and_email, send_manually, email, sms
altId	string	Required within parent	Location Id or Agency Id
altType	string	Required within parent	One of: location
estimateName	string	Optional	estimate name
liveMode	boolean	Required within parent	livemode for estimate
sentFrom	JSON	Optional	sender details for invoice, valid only if invoice is not sent manually
sentFrom (allOf 1)	Model	All variants apply	Expand Get Invoice Settings — response body — sender Configuration from Email, from Name
userId	string	Required within parent	Please ensure that the UserId corresponds to an authorized personnel, either by an employee ID or agency ID, to access this location. This account will serve as the primary channel for all future communications and updates.

Referenced models: Get Invoice Settings — response body — sender Configuration from Email, from Name

Send Estimate — response body

Field	Type	Presence	Description and constraints
$	object	Root
__v	JSON	Required within parent
__v (anyOf 1)	number	Alternative	Version number
__v (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
_id	string	Required within parent	Unique identifier
altId	string	Required within parent	Location Id or Agency Id
altType	string	Required within parent	Known values: location
attachments	array	Optional	Attachments
attachments[]	Model	Each item	Expand Send Estimate — response body — attachments item
autoInvoice	JSON	Optional	Auto-invoice settings for the estimate
autoInvoice (allOf 1)	Model	All variants apply	Expand Delete Event — request body — body
automaticTaxesCalculated	boolean	Required within parent	Indicates if automatic taxes were calculated
automaticTaxesEnabled	boolean	Required within parent	Indicates if automatic taxes are enabled for this estimate
businessDetails	JSON	Required within parent	Business details associated with the estimate
businessDetails (allOf 1)	Model	All variants apply	Expand Delete Event — request body — body
companyId	string	Required within parent	Company identifier associated with the estimate
contactDetails	JSON	Required within parent	Contact details for the estimate
contactDetails (allOf 1)	Model	All variants apply	Expand Delete Event — request body — body
createdAt	string	Required within parent	Timestamp when created Format: date-time
currency	string	Required within parent	Currency code
deleted	boolean	Required within parent	Indicates if deleted
discount	JSON	Required within parent	Discount details for the estimate template
discount (allOf 1)	Model	All variants apply	Expand Send Estimate — response body — discount / type: percentage, fixed
estimateActionHistory	array	Required within parent	History of actions taken on the estimate
estimateActionHistory[]	string	Each item
estimateNumberPrefix	string	Optional	Estimate number prefix
expiryDate	string	Required within parent	Date when the estimate expires Format: date-time
frequencySettings	JSON	Required within parent	Frequency settings for recurring estimates
frequencySettings (allOf 1)	Model	All variants apply	Expand Send Estimate — response body — frequency Settings enabled, schedule
issueDate	string	Required within parent	Date when the estimate was issued Format: date-time
items	array	Required within parent	An array of items
items[]	array	Each item
lastVisitedAt	string	Required within parent	Timestamp when the estimate was last visited Format: date-time
liveMode	boolean	Required within parent	Indicates if it is in live mode
meta	object	Required within parent	Additional metadata associated with the estimate
name	string	Required within parent	Name
sentBy	string	Optional	User who sent the estimate
sentTo	JSON	Required within parent	Recipient details for the estimate
sentTo (allOf 1)	Model	All variants apply	Expand Delete Event — request body — body
termsNotes	string	Optional	Terms and conditions for the estimate, supports HTML markup
title	string	Optional	Title
total	JSON	Required within parent
total (anyOf 1)	number	Alternative	Total amount
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
totalamountInUSD	JSON	Required within parent
totalamountInUSD (anyOf 1)	number	Alternative	Total amount in USD
totalamountInUSD (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
traceId	string	Required within parent	Trace ID for logging and debugging
updatedAt	string	Required within parent	Timestamp when last updated Format: date-time
updatedBy	string	Optional	User Id of who last updated

Referenced models: Delete Event — request body — body, Send Estimate — response body — attachments item, Send Estimate — response body — frequency Settings enabled, schedule, Send Estimate — response body — discount / type: percentage, fixed

Send Estimate — response body — attachments item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	Id of the file selected
name	string	Required within parent	Name of the file
size	JSON	Required within parent
size (anyOf 1)	number	Alternative	Size of the file
size (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
type	string	Required within parent	Type of the file
url	string	Required within parent	URL of the file

Send Estimate — response body — discount / type: percentage, fixed

Field	Type	Presence	Description and constraints
$	object	Root
type	string	Required within parent	Discount type Known values: percentage, fixed Default: percentage
validOnProductIds	array	Optional	Product Ids on which discount is applicable
validOnProductIds[]	string	Each item
value	JSON	Optional
value (anyOf 1)	number	Alternative	Discount Value Default: 0
value (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Send Estimate — response body — frequency Settings enabled, schedule

Field	Type	Presence	Description and constraints
$	object	Root
enabled	boolean	Required within parent	enabled for the frequency settings
schedule	JSON	Required within parent	schedule setting for the estimate
schedule (allOf 1)	Model	All variants apply	Expand Get an schedule — response body — schedule

Referenced models: Get an schedule — response body — schedule

Send invoice — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
action	string	Required within parent	One of: sms_and_email, send_manually, email, sms
altId	string	Required within parent	location Id / company Id based on altType
altType	string	Required within parent	Alt Type One of: location
autoPayment	JSON	Optional	auto-payment configuration
autoPayment (allOf 1)	Model	All variants apply	Expand Send invoice — request body — body auto Payment bacs Direct Debit, becs Direct Debit, card, card Id, customer Id, enable, payment Method Id, provider, sepa Direct Debit, type, us Bank Account
liveMode	boolean	Required within parent
sentFrom	JSON	Optional	sender details for invoice, valid only if invoice is not sent manually
sentFrom (allOf 1)	Model	All variants apply	Expand Get Invoice Settings — response body — sender Configuration from Email, from Name
userId	string	Required within parent	Please ensure that the UserId corresponds to an authorized personnel, either by an employee ID or agency ID, to access this location. This account will serve as the primary channel for all future communications and updates.

Referenced models: Send invoice — request body — body auto Payment bacs Direct Debit, becs Direct Debit, card, card Id, customer Id, enable, payment Method Id, provider, sepa Direct Debit, type, us Bank Account, Get Invoice Settings — response body — sender Configuration from Email, from Name

Send invoice — request body — body auto Payment bacs Direct Debit, becs Direct Debit, card, card Id, customer Id, enable, payment Method Id, provider, sepa Direct Debit, type, us Bank Account

Field	Type	Presence	Description and constraints
$	object	Root
bacsDirectDebit	Model	Optional	Expand Send invoice — request body — body auto Payment bacs Direct Debit, becs Direct Debit, card, card Id, customer Id, enable, payment Method Id, provider, sepa Direct Debit, type, us Bank Account bacs Direct Debit
becsDirectDebit	Model	Optional	Expand Send invoice — request body — body auto Payment bacs Direct Debit, becs Direct Debit, card, card Id, customer Id, enable, payment Method Id, provider, sepa Direct Debit, type, us Bank Account becs Direct Debit
card	Model	Optional	Expand Record a manual payment for an invoice — request body — body card
cardId	string	Optional
customerId	string	Optional
enable	boolean	Required within parent
paymentMethodId	string	Optional
provider	object	Optional
sepaDirectDebit	Model	Optional	Expand Send invoice — request body — body auto Payment bacs Direct Debit, becs Direct Debit, card, card Id, customer Id, enable, payment Method Id, provider, sepa Direct Debit, type, us Bank Account sepa Direct Debit
type	string	Optional
usBankAccount	Model	Optional	Expand Send invoice — request body — body auto Payment bacs Direct Debit, becs Direct Debit, card, card Id, customer Id, enable, payment Method Id, provider, sepa Direct Debit, type, us Bank Account us Bank Account

Referenced models: Send invoice — request body — body auto Payment bacs Direct Debit, becs Direct Debit, card, card Id, customer Id, enable, payment Method Id, provider, sepa Direct Debit, type, us Bank Account bacs Direct Debit, Send invoice — request body — body auto Payment bacs Direct Debit, becs Direct Debit, card, card Id, customer Id, enable, payment Method Id, provider, sepa Direct Debit, type, us Bank Account becs Direct Debit, Record a manual payment for an invoice — request body — body card, Send invoice — request body — body auto Payment bacs Direct Debit, becs Direct Debit, card, card Id, customer Id, enable, payment Method Id, provider, sepa Direct Debit, type, us Bank Account sepa Direct Debit, Send invoice — request body — body auto Payment bacs Direct Debit, becs Direct Debit, card, card Id, customer Id, enable, payment Method Id, provider, sepa Direct Debit, type, us Bank Account us Bank Account

Send invoice — request body — body auto Payment bacs Direct Debit, becs Direct Debit, card, card Id, customer Id, enable, payment Method Id, provider, sepa Direct Debit, type, us Bank Account bacs Direct Debit

Field	Type	Presence	Description and constraints
$	object	Root
last4	string	Required within parent
sort_code	string	Required within parent

Send invoice — request body — body auto Payment bacs Direct Debit, becs Direct Debit, card, card Id, customer Id, enable, payment Method Id, provider, sepa Direct Debit, type, us Bank Account becs Direct Debit

Field	Type	Presence	Description and constraints
$	object	Root
bsb_number	string	Required within parent
last4	string	Required within parent

Send invoice — request body — body auto Payment bacs Direct Debit, becs Direct Debit, card, card Id, customer Id, enable, payment Method Id, provider, sepa Direct Debit, type, us Bank Account sepa Direct Debit

Field	Type	Presence	Description and constraints
$	object	Root
bank_code	string	Required within parent
branch_code	string	Required within parent
last4	string	Required within parent

Send invoice — request body — body auto Payment bacs Direct Debit, becs Direct Debit, card, card Id, customer Id, enable, payment Method Id, provider, sepa Direct Debit, type, us Bank Account us Bank Account

Field	Type	Presence	Description and constraints
$	object	Root
bank_name	string	Required within parent
last4	string	Required within parent

Send invoice — response body

Field	Type	Presence	Description and constraints
$	object	Root
emailData	object	Required within parent
invoice	Model	Required within parent	Expand Void invoice — response body
smsData	object	Required within parent

Referenced models: Void invoice — response body

Update Estimate — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
altId	string	Required within parent	Location Id or Agency Id
altType	string	Required within parent	One of: location
attachments	array	Optional	attachments for the invoice
attachments[]	Model	Each item	Expand Create & Send — request body — body attachments item
autoInvoice	JSON	Optional	Auto invoice for the estimate
autoInvoice (allOf 1)	Model	All variants apply	Expand Update Estimate — request body — body auto Invoice direct Payments, enabled
automaticTaxesEnabled	boolean	Optional	Automatic taxes enabled for the Estimate Default: false
businessDetails	Model	Required within parent	Expand Create & Send — request body — body business Details
contactDetails	JSON	Required within parent	Contact information to send the estimate to
contactDetails (allOf 1)	Model	All variants apply	Expand Update invoice — request body — body contact Details
currency	string	Required within parent	Currency code
discount	Model	Required within parent	Expand Create & Send — request body — body discount
estimateNumber	number	Optional	Estimate Number, if not specified will take in the next valid estimate number
estimateNumberPrefix	string	Optional	Prefix for the estimate number Default: EST-
estimateStatus	string	Optional	Estimate Status One of: all, draft, sent, accepted, declined, invoiced, viewed
expiryDate	string	Optional	expiry date estimate
frequencySettings	JSON	Required within parent	frequency settings for the estimate
frequencySettings (allOf 1)	Model	All variants apply	Expand Update Estimate — request body — body frequency Settings enabled, schedule
issueDate	string	Optional	issue date estimate
items	array	Required within parent	An array of items for the estimate.
items[]	Model	Each item	Expand Update Estimate — request body — body items item
liveMode	boolean	Optional	livemode for estimate Default: true
meta	object	Optional	Meta data for the estimate
miscellaneousCharges	JSON	Optional	miscellaneous charges for the estimate
miscellaneousCharges (allOf 1)	Model	All variants apply	Expand Create & Send — request body — body miscellaneous Charges charges, collected Miscellaneous Charges, paid Charges
name	string	Required within parent	Estimate Name
paymentScheduleConfig	JSON	Optional	Payment Schedule Config for the estimate
paymentScheduleConfig (allOf 1)	Model	All variants apply	Expand Update Estimate — request body — body / paymentScheduleConfig / type: fixed, percentage
sendEstimateDetails	JSON	Optional	When sending estimate directly while saving
sendEstimateDetails (allOf 1)	Model	All variants apply	Expand Send Estimate — request body — body
sentTo	JSON	Optional	Email and sent to details for the estimate
sentTo (allOf 1)	Model	All variants apply	Expand Create & Send — request body — body sent To
termsNotes	string	Optional	Terms notes, Also supports HTML markups
title	string	Optional	Title for the estimate
userId	string	Optional	User Id

Referenced models: Create & Send — request body — body attachments item, Update Estimate — request body — body auto Invoice direct Payments, enabled, Create & Send — request body — body business Details, Update invoice — request body — body contact Details, Update Estimate — request body — body items item, Update Estimate — request body — body frequency Settings enabled, schedule, Create & Send — request body — body discount, Update Estimate — request body — body / paymentScheduleConfig / type: fixed, percentage, Create & Send — request body — body miscellaneous Charges charges, collected Miscellaneous Charges, paid Charges, Send Estimate — request body — body, Create & Send — request body — body sent To

Update Estimate — request body — body / paymentScheduleConfig / type: fixed, percentage

Field	Type	Presence	Description and constraints
$	object	Root
dateConfig	JSON	Required within parent	Due date type configuration
dateConfig (allOf 1)	Model	All variants apply	Expand Update Estimate — request body — body / paymentScheduleConfig / type: fixed, percentage date Config deposit Date Type: estimate accepted, custom, schedule Date Type: regular interval, custom
schedules	array	Required within parent	Payment Schedule Items
schedules[]	array	Each item
type	string	Required within parent	Payment Schedule Type One of: fixed, percentage

Referenced models: Update Estimate — request body — body / paymentScheduleConfig / type: fixed, percentage date Config deposit Date Type: estimate accepted, custom, schedule Date Type: regular interval, custom

Update Estimate — request body — body / paymentScheduleConfig / type: fixed, percentage date Config deposit Date Type: estimate accepted, custom, schedule Date Type: regular interval, custom

Field	Type	Presence	Description and constraints
$	object	Root
depositDateType	string	Required within parent	Deposit date type One of: estimate_accepted, custom
scheduleDateType	string	Required within parent	Payment Schedule Date Type One of: regular_interval, custom

Update Estimate — request body — body auto Invoice direct Payments, enabled

Field	Type	Presence	Description and constraints
$	object	Root
directPayments	boolean	Optional	Direct Payments
enabled	boolean	Required within parent	Enable Auto Invoice

Update Estimate — request body — body frequency Settings enabled, schedule

Field	Type	Presence	Description and constraints
$	object	Root
enabled	boolean	Required within parent	enabled for the frequency settings
schedule	JSON	Required within parent	schedule setting for the estimate
schedule (allOf 1)	Model	All variants apply	Expand Update schedule — request body — body schedule

Referenced models: Update schedule — request body — body schedule

Update Estimate — request body — body items item

Field	Type	Presence	Description and constraints
$	object	Root
amount	number	Required within parent	Product amount
attachments	array	Optional	Attachments for the line item
attachments[]	string	Each item
automaticTaxCategoryId	string	Optional	Tax category id for calculating automatic tax
currency	string	Required within parent	Currency
description	string	Optional	Invoice descriptions
isSetupFeeItem	boolean	Optional	Setupfee item, only created when 1st invoice of recurring schedule is generated
name	string	Required within parent	Invoice Item Name
priceId	string	Optional	Price Id
productId	string	Optional	Product Id
qty	number	Required within parent	Product Quantity
taxInclusive	boolean	Optional	true if item amount is tax inclusive Default: false
taxes	array	Optional	Tax
taxes[]	Model	Each item	Expand Create & Send — request body — body items item taxes item
type	string	Optional	Price type of the item One of: one_time, recurring

Referenced models: Create & Send — request body — body items item taxes item

Update estimate last visited at — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
estimateId	string	Required within parent	Estimate Id

Update invoice last visited at — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
invoiceId	string	Required within parent	Invoice Id

Update invoice late fees configuration — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
altId	string	Required within parent	location Id / company Id based on altType
altType	string	Required within parent	Alt Type One of: location
lateFeesConfiguration	JSON	Required within parent	late fees configuration
lateFeesConfiguration (allOf 1)	Model	All variants apply	Expand Create & Send — request body — body / lateFeesConfiguration / type: fixed, percentage

Referenced models: Create & Send — request body — body / lateFeesConfiguration / type: fixed, percentage

Update invoice — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
altId	string	Required within parent	location Id / company Id based on altType
altType	string	Required within parent	Alt Type One of: location
attachments	array	Optional	attachments for the invoice
attachments[]	Model	Each item	Expand Create & Send — request body — body attachments item
automaticTaxesEnabled	boolean	Optional	Automatic taxes enabled for the Invoice
businessDetails	JSON	Optional	Business details which need to be updated
businessDetails (allOf 1)	Model	All variants apply	Expand Create & Send — request body — body business Details
contactDetails	Model	Optional	Expand Update invoice — request body — body contact Details
contactId	string	Optional	Id of the contact which you need to send the invoice
currency	string	Required within parent	Currency
description	string	Optional	Description
discount	Model	Optional	Expand Create & Send — request body — body discount
dueDate	string	Required within parent	Due date in YYYY-MM-DD format
invoiceItems	array	Required within parent
invoiceItems[]	Model	Each item	Expand Create & Send — request body — body items item
invoiceNumber	string	Optional	Invoice Number
invoiceNumberPrefix	string	Optional	prefix for invoice number
issueDate	string	Required within parent	Issue date in YYYY-MM-DD format
liveMode	boolean	Optional	Payment mode
miscellaneousCharges	JSON	Optional	miscellaneous charges for the invoice
miscellaneousCharges (allOf 1)	Model	All variants apply	Expand Create & Send — request body — body miscellaneous Charges charges, collected Miscellaneous Charges, paid Charges
name	string	Required within parent	Name to be updated
paymentMethods	JSON	Optional	Payment Methods for Invoices
paymentMethods (allOf 1)	Model	All variants apply	Expand Get Invoice Settings — response body — payment Methods stripe
paymentSchedule	JSON	Optional	split invoice into payment schedule summing up to full invoice amount
paymentSchedule (allOf 1)	Model	All variants apply	Expand Create & Send — request body — body / paymentSchedule / type: fixed, percentage
termsNotes	string	Optional	Terms notes, Also supports HTML markups
tipsConfiguration	JSON	Optional	tips configuration for the invoice
tipsConfiguration (allOf 1)	Model	All variants apply	Expand Get Invoice Settings — response body — tips Configuration tips Enabled, tips Percentage
title	string	Optional	Title for the invoice
xeroDetails	object	Optional

Referenced models: Create & Send — request body — body attachments item, Create & Send — request body — body business Details, Update invoice — request body — body contact Details, Create & Send — request body — body items item, Create & Send — request body — body discount, Get Invoice Settings — response body — payment Methods stripe, Get Invoice Settings — response body — tips Configuration tips Enabled, tips Percentage, Create & Send — request body — body / paymentSchedule / type: fixed, percentage, Create & Send — request body — body miscellaneous Charges charges, collected Miscellaneous Charges, paid Charges

Update invoice — request body — body contact Details

Field	Type	Presence	Description and constraints
$	object	Root
additionalEmails	array	Optional	Secondary email addresses for the contact to be saved
additionalEmails[]	Model	Each item	Expand Update invoice — request body — body contact Details additional Emails item
address	Model	Optional	Expand Update invoice — request body — body contact Details address
companyName	string	Optional	Contact Company Name
customFields	array	Optional	Custom Values
customFields[]	string	Each item
email	string	Required within parent	Contact Email
id	string	Required within parent	Contact ID
name	string	Required within parent	Contact Name
phoneNo	string	Required within parent	Contact Phone Number

Referenced models: Update invoice — request body — body contact Details additional Emails item, Update invoice — request body — body contact Details address

Update invoice — request body — body contact Details additional Emails item

Field	Type	Presence	Description and constraints
$	object	Root
email	string	Required within parent

Update invoice — request body — body contact Details address

Field	Type	Presence	Description and constraints
$	object	Root
addressLine1	string	Optional	Address Line 1
addressLine2	string	Optional	Address Line 2
city	string	Optional	City
countryCode	string	Optional	Country Code
postalCode	string	Optional	Postal Code
state	string	Optional	State