HighLevel: Invoices schemas (part 2)

← Invoices operations · All schemas

Update 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
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
items	array	Required within parent
items[]	Model	Each item	Expand Create & Send — request body — body items item
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
schedule	Model	Required within parent	Expand Update schedule — request body — body schedule
termsNotes	string	Optional
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 miscellaneous Charges charges, collected Miscellaneous Charges, paid Charges

Update schedule — request body — body schedule

Field	Type	Presence	Description and constraints
$	object	Root
executeAt	string	Optional
rrule	Model	Optional	Expand Update schedule — request body — body schedule rrule

Referenced models: Update schedule — request body — body schedule rrule

Update schedule — request body — body schedule rrule

Field	Type	Presence	Description and constraints
$	object	Root
count	number	Optional	Max number of task executions
dayOfMonth	number	Optional	-1, 1, 2, 3, ..., 27, 28
dayOfWeek	string	Optional	One of: mo, tu, we, th, fr, sa, su
daysBefore	number	Optional	Execute task number of days before
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	number	Required within parent
intervalType	string	Required within parent	One of: yearly, monthly, weekly, daily, hourly, minutely, secondly
monthOfYear	string	Optional	One of: jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec
numOfWeek	number	Optional	-1, 1, 2, 3, 4
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

Update template late fees configuration — invoices update Invoice Payment Methods 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
paymentMethods	JSON	Optional	Payment Methods for Invoices
paymentMethods (allOf 1)	Model	All variants apply	Expand Get Invoice Settings — response body — payment Methods stripe

Referenced models: Get Invoice Settings — response body — payment Methods stripe

Update 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
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
items	array	Required within parent
items[]	Model	Each item	Expand Create & Send — request body — body items item
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
termsNotes	string	Optional
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 miscellaneous Charges charges, collected Miscellaneous Charges, paid Charges

Void 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

Void 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
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]+)?$
updatedAt	string	Required within parent	updated at