Quote Schema

Schemas

QuotationHeader_View

Paginated list response for quotation queries.

Property	Type	Description
page_no	integer	Current page number
page_size	integer	Records per page
record_count	integer	Total matching records
quotes	array of QuotationHeader	Quote records
columns_id	integer	View column config ID
columns_tilehtml	string	Tile HTML template
columns	array of ViewColumnsDetails	Column configuration

---

QuotationHeader

The main quote object.

Property	Type	Description
id	integer	Quote ID
title	string	Quote title
status	integer	Quote status code
date	datetime	Quote date
expiry_date	datetime	Expiry date
total	double	Quote total
carriage_desc	string	Carriage/shipping description
carriage_price	double	Carriage/shipping price
tax_total_estimate	double	Estimated tax total
po_ref	string	Client PO reference
ponumber	string	PO number
note	string	Internal notes
scope	string	Scope of work
risk	string	Risk assessment
ticket_id	integer	Associated ticket ID
user_id	integer	Contact/user ID
user_name	string	Contact/user name
site_id	integer	Site ID
site_name	string	Site name
client_id	integer	Client ID
client_name	string	Client name
agent_id	integer	Agent ID
assigned_agent	integer	Assigned agent ID
assigned_agent_name	string	Assigned agent name
currency	string	Currency symbol
currency_code	integer	Currency code ID
currency_conversion_rate	double	Currency conversion rate
approvalname	string	Name of approver
approvalemailaddress	string	Approver email
approvaldatetime	datetime	Approval timestamp
approvalnote	string	Approval note
approvalstate	integer	Approval state code
internal_approval_status	integer	Internal approval status
approval_start	boolean	Whether approval process has started
requires_approval	boolean	Whether quote requires approval
can_approve	boolean	Whether current user can approve
salesorder_id	integer	Associated sales order ID
_create_so	boolean	Trigger: create sales order on save
lines	array of QuotationDetail	Quote line items
signature	string	Approval signature
quote_viewed	boolean	Whether quote has been viewed
portal_display_type	integer	How quote is displayed in portal
last_update_time	datetime	Last modification timestamp
workflow_id	integer	Workflow ID
workflow_step	integer	Current workflow step
customfields	array of CustomField	Custom field values

---

QuotationApproval

Payload for submitting a quote approval decision.

Property	Type	Description
id	integer	Quote ID being approved
token	string	Approval token
result	boolean	Approval decision (true = approved, false = rejected)
approvalname	string	Name of approver
approvalemailaddress	string	Approver email address
approvalnote	string	Approval note or rejection reason
ponumber	string	PO number provided on approval
signature	string	Signature data
optional_lines	array of QuotationDetail	Optional line selections
customfields	array of CustomField	Custom field values
message	string	Message to include
countersignoutcome	integer	Counter-signature outcome
countersign_action_id	integer	Counter-sign action ID

---

QuotationDetail

A single line item on a quote.

Property	Type	Description
id	integer	Line item ID
qhid	integer	Parent quote header ID
sort_seq	integer	Display sort order
productcode	string	Product code
name	string	Line item name
description	string	Line item description
costprice	double	Unit cost price
baseprice	double	Base unit price
net_total	double	Net total (read-only)
total_price	double	Total price
total_tax	double	Total tax
total_discount	double	Total discount
tax_rate	double	Tax rate
discount_perc	double	Discount percentage
margin	double	Margin
item_id	integer	Catalogue item ID
item_sku	string	Item SKU
item_recurring	boolean	Whether item is recurring
note	string	Line item note
note_hidden	boolean	Whether note is hidden from client
optional	boolean	Whether line is optional
approval_status	integer	Line-level approval status
supplier_id	integer	Supplier ID
supplier_name	string	Supplier name
startdate	datetime	Contract start date
autorenew	boolean	Auto-renew flag
line_periods	integer	Number of contract periods
group_id	integer	Line group ID
customfields	array of CustomField	Custom field values

---

OrderHead_View

Paginated list response for sales order queries.

Property	Type	Description
page_no	integer	Current page number
page_size	integer	Records per page
record_count	integer	Total matching records
salesorders	array of OrderHead	Sales order records
columns_id	integer	View column config ID
columns_tilehtml	string	Tile HTML template
columns	array of ViewColumnsDetails	Column configuration

---

OrderHead

The main sales order object.

Property	Type	Description
id	integer	Sales order ID
title	string	Order title
status	integer	Order status code
open_status	integer	Open/closed status
date	datetime	Order date
ship_date	datetime	Shipping date
invoice_date	datetime	Invoice date
total	double	Order total
cost	double	Total cost
profit	double	Profit
tax_total	double	Total tax
outstanding_total	double	Outstanding amount
note	string	Order notes
po_number	string	Customer PO number
summary	string	Order summary
client_id	integer	Client ID
client_name	string	Client name
user_id	integer	Contact/user ID
user_name	string	Contact/user name
site_id	integer	Site ID
site_name	string	Site name
assigned_agent	integer	Assigned agent ID
assigned_agent_name	string	Assigned agent name
ticket_id	integer	Associated ticket ID
quotation_id	integer	Originating quote ID
consignment_id	integer	Associated consignment ID
currency	string	Currency symbol
currency_code	integer	Currency code ID
currency_conversion_rate	double	Currency conversion rate
lines	array of OrderLine	Sales order line items
purchaseorder_count	integer	Number of associated POs
invoice_count	integer	Number of associated invoices
percentage_invoiced	double	Percentage already invoiced
do_not_invoice	boolean	Suppress invoicing flag
_create_invoice	boolean	Trigger: create invoice on save
_create_invoice_method	integer	Invoice creation method
_create_invoice_percentage	double	Percentage to invoice
_create_invoice_amount	double	Fixed amount to invoice
_create_po	boolean	Trigger: create purchase order on save
linked_to_ticket	boolean	Whether order is linked to a ticket
linked_to_project	boolean	Whether order is linked to a project
last_update_time	datetime	Last modification timestamp
customfields	array of CustomField	Custom field values

---

SupplierOrderHeader_View

Paginated list response for purchase order queries.

Property	Type	Description
page_no	integer	Current page number
page_size	integer	Records per page
record_count	integer	Total matching records
purchaseorders	array of SupplierOrderHeader	Purchase order records
columns_id	integer	View column config ID
columns_tilehtml	string	Tile HTML template
columns	array of ViewColumnsDetails	Column configuration

---

SupplierOrderHeader

The main purchase order object.

Property	Type	Description
id	integer	Purchase order ID
title	string	PO title
status	integer	PO status code
po_ref	string	PO reference number
3rd_party_ponumber	string	Third-party PO number
date	datetime	PO date
datesent	datetime	Date sent to supplier
est_delivery_date	datetime	Estimated delivery date
duedate	datetime	Due date
price	double	Order price (ex. carriage)
total	double	Order total
tax_total	double	Total tax
carriage_desc	string	Carriage description
carriage_price	double	Carriage cost
note	string	Order notes
supplier_id	integer	Supplier ID
supplier_name	string	Supplier name
client_id	integer	Client ID
client_name	string	Client name
user_id	integer	User/contact ID
user_name	string	User/contact name
site_id	integer	Site ID
site_name	string	Site name
ticket_id	integer	Associated ticket ID
salesorder_id	integer	Associated sales order ID
assigned_agent	integer	Assigned agent ID
assigned_agent_name	string	Assigned agent name
approval_status	integer	Approval status code
approval_start	boolean	Whether approval has been started
requires_approval	boolean	Whether PO requires approval
goodsin_status	integer	Goods-in status
receipt_confirmed	boolean	Whether receipt is confirmed
receipt_confirmation_date	datetime	Receipt confirmation date
deliver_to_us	boolean	Deliver to MSP address
deliver_to_so_address	boolean	Deliver to sales order address
deliver_to_ticket_address	boolean	Deliver to ticket address
currency	string	Currency symbol
currency_code	integer	Currency code ID
currency_conversion_rate	double	Currency conversion rate
invoice_count	integer	Number of associated invoices
percentage_invoiced	double	Percentage already invoiced
_create_invoice	boolean	Trigger: create invoice on save
lines	array of SupplierOrderDetail	PO line items
customfields	array of CustomField	Custom field values

---

ConsignmentHeader

A consignment (goods dispatch/delivery) record.

Property	Type	Description
id	integer	Consignment ID
date	datetime	Consignment date
note	string	Notes
ticket_id	integer	Associated ticket ID
site_id	integer	Delivery site ID
salesorder_id	integer	Associated sales order ID
user_name	string	User name
address	string	Delivery address text
stockbin_id	integer	Stock bin ID
is_return	boolean	Whether this is a return
is_stock_to_stock	boolean	Stock-to-stock transfer
lines	array of ConsignmentDetail	Consignment line items
assets	array of Device_List	Associated assets
pdftemplate_id	integer	PDF template ID

---

Viewers

Payload for recording who has viewed a quote/order.

Property	Type	Description
id	integer	Record ID (quote/order ID)
changeseq	integer	Change sequence number
current_action_type	string	Current action type
viewers	array of Uname_List	List of viewers

---