HighLevel: Proposals schemas

← Proposals operations · All schemas

List documents — response body

Field	Type	Presence	Description and constraints
$	object	Root
documents	array	Required within parent	List of documents
documents[]	Model	Each item	Expand List documents — response body — documents item
total	JSON	Required within parent
total (anyOf 1)	number	Alternative	Total records available
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
whiteLabelBaseUrl	JSON	Optional
whiteLabelBaseUrl (anyOf 1)	number	Alternative	WhiteLabel url for document
whiteLabelBaseUrl (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
whiteLabelBaseUrlForInvoice	JSON	Optional
whiteLabelBaseUrlForInvoice (anyOf 1)	number	Alternative	WhiteLabel url for invoice
whiteLabelBaseUrlForInvoice (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List documents — response body — documents item

List documents — response body — documents item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	Unique identifier
createdAt	string	Required within parent	Date to (ISO 8601)
deleted	boolean	Required within parent	Whether the document is deleted
documentId	string	Required within parent	Document Id
documentRevision	JSON	Required within parent
documentRevision (anyOf 1)	number	Alternative	Number of times document is moved to draft state
documentRevision (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
fillableFields	array	Required within parent	Fillable fields
fillableFields[]	Model	Each item	Expand List documents — response body — documents item fillable Fields item
grandTotal	JSON	Required within parent	Grand total object of the document
grandTotal (allOf 1)	Model	All variants apply	Expand List documents — response body — documents item grand Total amount, currency, discount Percentage, discounts
isExpired	boolean	Required within parent	Whether the document is expired
links	array	Required within parent	Links for the document if its sent
links[]	Model	Each item	Expand Send document — response body — links item
locale	string	Required within parent	Locale of the location
locationId	string	Required within parent	Location Id
name	string	Required within parent	Name of the document
paymentStatus	array	Required within parent	Payment status
paymentStatus[]	string	Each item	Known values: waiting_for_payment, paid, no_payment
recipients	array	Required within parent	Recipients
recipients[]	Model	Each item	Expand List documents — response body — documents item recipients item
status	array	Required within parent	Document status
status[]	string	Each item	Known values: draft, sent, viewed, completed, accepted
type	string	Required within parent	Type of the document
updatedAt	string	Required within parent	Date start from (ISO 8601)

Referenced models: List documents — response body — documents item fillable Fields item, List documents — response body — documents item grand Total amount, currency, discount Percentage, discounts, Send document — response body — links item, List documents — response body — documents item recipients item

List documents — response body — documents item fillable Fields item

Field	Type	Presence	Description and constraints
$	object	Root
entityType	string	Required within parent	Entity type Known values: contacts, users
fieldId	string	Required within parent	Field Id
hasCompleted	boolean	Required within parent	Has the field been completed
id	string	Required within parent	Id
isRequired	boolean	Required within parent	Is the field required
recipient	string	Required within parent	Recipient
type	string	Required within parent	Element type Known values: Page, Text, Image, Video, Table, ProductList, PageBreak, Signature, PaymentDetails, TextField, DateField, InitialsField, Checkbox, Row, Column
value	string	Required within parent	Value of the field

List documents — response body — documents item grand Total amount, currency, discount Percentage, discounts

Field	Type	Presence	Description and constraints
$	object	Root
amount	JSON	Required within parent
amount (anyOf 1)	number	Alternative	Total amount before discounts
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currency	string	Required within parent	Currency of the total amount
discountPercentage	JSON	Required within parent
discountPercentage (anyOf 1)	number	Alternative	Total discount percentage applied
discountPercentage (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
discounts	array	Required within parent	List of applied discounts
discounts[]	Model	Each item	Expand List documents — response body — documents item grand Total amount, currency, discount Percentage, discounts discounts item

Referenced models: List documents — response body — documents item grand Total amount, currency, discount Percentage, discounts discounts item

List documents — response body — documents item grand Total amount, currency, discount Percentage, discounts discounts item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	Unique identifier for the discount
type	string	Required within parent	Type of discount Known values: percentage, custom_amount
value	JSON	Required within parent
value (anyOf 1)	number	Alternative	Discount value (either a percentage or custom amount)
value (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

List documents — response body — documents item recipients item

Field	Type	Presence	Description and constraints
$	object	Root
contactName	string	Optional	Recipient contact name
country	string	Optional	Recipient country
email	string	Required within parent	Recipient Email
entityName	string	Optional	Recipient entity name
firstName	string	Optional	Recipient First Name
hasCompleted	boolean	Required within parent	Recipient has completed the document
id	string	Required within parent	Recipient Id
imgUrl	string	Optional	Recipient image url
initialsImgUrl	string	Optional	Recipient initials image url
ip	string	Optional	Recipient ip
isPrimary	boolean	Required within parent	Recipient is primary
lastName	string	Optional	Recipient Last Name
lastViewedAt	string	Optional	Recipient last viewed date
phone	string	Optional	Recipient Phone
phoneNumber	string	Optional	Recipient Phone Number
role	string	Required within parent	Recipient role Known values: user, signer
shareLink	string	Optional	Share link
signedDate	string	Optional	Recipient signed date
signingOrder	JSON	Required within parent
signingOrder (anyOf 1)	number	Alternative	Recipient signing order
signingOrder (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
userAgent	string	Optional	Recipient user agent

List templates — proposals list Documents Contracts Templates — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	array	Required within parent	Array of templates
data[]	Model	Each item	Expand List templates — proposals list Documents Contracts Templates — response body — data item
total	JSON	Required within parent
total (anyOf 1)	number	Alternative	Total number of templates
total (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
traceId	string	Optional	Trace ID for request tracking

Referenced models: List templates — proposals list Documents Contracts Templates — response body — data item

List templates — proposals list Documents Contracts Templates — response body — data item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	Template ID
createdAt	string	Required within parent	Template creation date
deleted	boolean	Required within parent	Whether the template is deleted
docFormUrl	string	Optional	Document form URL (only present when isPublicDocument is true)
documentCount	JSON	Optional
documentCount (anyOf 1)	number	Alternative	Document count (only present when isPublicDocument is true)
documentCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
id	string	Required within parent	Template ID (alias for _id)
isPublicDocument	boolean	Required within parent	Whether the template is a public document
locationId	string	Required within parent	Location ID
name	string	Required within parent	Template name
type	string	Required within parent	Template type Known values: proposal, estimate, contentLibrary
updatedAt	string	Required within parent	Template last update date
updatedBy	string	Required within parent	User ID who last updated the template
version	JSON	Required within parent
version (anyOf 1)	number	Alternative	Template version
version (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Send document — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
ccRecipients	array	Optional	CC Recipient
ccRecipients[]	Model	Each item	Expand Send document — request body — body cc Recipients item
documentId	string	Required within parent	Document Id
documentName	string	Optional	Document Name
locationId	string	Required within parent	Location Id
medium	string	Optional	Medium to be used for sending the document One of: link, email
notificationSettings	JSON	Optional
notificationSettings (allOf 1)	Model	All variants apply	Expand Send document — request body — body notification Settings receive, sender
sentBy	string	Required within parent	Sent ByUser Id

Referenced models: Send document — request body — body cc Recipients item, Send document — request body — body notification Settings receive, sender

Send document — request body — body cc Recipients item

Field	Type	Presence	Description and constraints
$	object	Root
contactName	string	Required within parent	Contact Name
email	string	Required within parent	Email
firstName	string	Required within parent	First Name
id	string	Required within parent	Contact ID
imageUrl	string	Required within parent	Contact Image URL
lastName	string	Required within parent	Last Name

Send document — request body — body notification Settings receive, sender

Field	Type	Presence	Description and constraints
$	object	Root
receive	Model	Required within parent	Expand Send document — request body — body notification Settings receive, sender receive
sender	Model	Required within parent	Expand Send document — request body — body notification Settings receive, sender sender

Referenced models: Send document — request body — body notification Settings receive, sender receive, Send document — request body — body notification Settings receive, sender sender

Send document — request body — body notification Settings receive, sender receive

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

Send document — request body — body notification Settings receive, sender sender

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

Send document — response body

Field	Type	Presence	Description and constraints
$	object	Root
links	array	Required within parent	Links for all recipients
links[]	Model	Each item	Expand Send document — response body — links item
success	boolean	Required within parent	Success status

Referenced models: Send document — response body — links item

Send document — response body — links item

Field	Type	Presence	Description and constraints
$	object	Root
createdBy	string	Required within parent	Created by user ID
deleted	boolean	Required within parent	Whether the document is deleted
documentId	string	Required within parent	Document ID
documentRevision	JSON	Required within parent
documentRevision (anyOf 1)	number	Alternative	Document revision number
documentRevision (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
entityName	string	Required within parent	Entity name that the recipient belongs to Known values: contacts, users
recipientCategory	string	Required within parent	Recipient category (recipient, cc, or bcc) Known values: recipient, cc, bcc
recipientId	string	Required within parent	Recipient ID
referenceId	string	Required within parent	Reference ID

Send template — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
contactId	string	Required within parent	Contact Id
locationId	string	Required within parent	Location Id
opportunityId	string	Optional	Opportunity Id
sendDocument	boolean	Optional	Send Document
templateId	string	Required within parent	Template Id
userId	string	Required within parent	User Id