Quote Endpoints

Quotes & Orders

QuotationHeader

GET /Quotation

Summary: List of QuotationHeader

Returns multiple QuotationHeader records. Requires authentication.

Parameter	Type	Description
awaiting_approval	boolean	Filter by quotes awaiting approval
client_id	integer	Filter by client
closed	boolean	Filter by closed status
count	integer	Number of records to return
currentclientorall	integer	Scope filter (current client or all)
includelines	boolean	Include line items in response
my_approvals	boolean	Filter to quotes awaiting your approval
needsprocessing	boolean	Filter by needs-processing status
open	boolean	Filter by open status
order	string	Primary sort field
order2–order5	string	Secondary–fifth sort fields
orderdesc–orderdesc5	boolean	Descending sort flags for each order field
page_no	integer	Page number (when paginating)
page_size	integer	Page size (when paginating)
pageinate	boolean	Enable pagination
processed	boolean	Filter by processed status
quote_status	string	Filter by quote status
search	string	Full-text search string
site_id	integer	Filter by site
ticket_id	integer	Filter by associated ticket
user_id	integer	Filter by user
filetype_filter	string	Filter to quotes that contain an attachment with the specified file type

Response 200: QuotationHeader_View

---

POST /Quotation

Creates one or more QuotationHeader records.

Request body: Array of QuotationHeader

Response 201: QuotationHeader

---

GET /Quotation/{id}

Summary: Get one QuotationHeader

Returns a single QuotationHeader by ID. Requires authentication.

Parameter	Type	Description
id (path, required)	integer	Quote ID
includedetails	boolean	Include extra detail objects in response
isportalview	boolean	Return portal-specific view

Response 200: QuotationHeader

---

DELETE /Quotation/{id}

Deletes a QuotationHeader by ID.

Parameter	Type	Description
id (path, required)	integer	Quote ID

Response 200: OK

---

POST /Quotation/Approval

Submits an approval decision for one or more quotes.

Request body: Array of QuotationApproval

Response 200: OK

---

POST /Quotation/View

Records viewer activity on a quote.

Request body: Array of Viewers

Response 200: OK

---

POST /Quotation/Lines

Creates or updates quotation line items.

Request body: Array of QuotationDetail

Response 200: OK

---

OrderHead

GET /SalesOrder

Summary: List of OrderHead

Returns multiple OrderHead (sales order) records. Requires authentication.

Parameter	Type	Description
advanced_search	string	Advanced search string
billing_date	string	Filter by billing date
client_id	integer	Filter by client
client_ids	string	Filter by multiple clients (comma-separated)
closed	boolean	Filter by closed status
count	integer	Number of records to return
idonly	boolean	Return IDs only
needsconsigning	boolean	Filter by needs-consigning status
needsinvoicing	boolean	Filter by needs-invoicing status
needsordering	boolean	Filter by needs-ordering status
open	boolean	Filter by open status
order–order5	string	Sort fields (primary through fifth)
orderdesc–orderdesc5	boolean	Descending sort flags
page_no	integer	Page number
page_size	integer	Page size
pageinate	boolean	Enable pagination
quote_status	string	Filter by quote/order status
ready_for_invoicing	boolean	Filter by ready-for-invoicing status
search	string	Full-text search string
site_id	integer	Filter by site
ticket_id	integer	Filter by associated ticket
toplevel_id	integer	Filter by top-level client
user_id	integer	Filter by user

Response 200: OrderHead_View

---

POST /SalesOrder

Creates one or more sales orders.

Request body: Array of OrderHead

Response 201: OrderHead

---

GET /SalesOrder/{id}

Summary: Get one OrderHead

Returns a single sales order by ID. Requires authentication.

Parameter	Type	Description
id (path, required)	integer	Sales order ID
consignablelines	boolean	Return only consignable lines
includedetails	boolean	Include extra detail objects
invoiceablelines	boolean	Return only invoiceable lines
oneline	integer	Return a specific line
pendingpolines	boolean	Return only lines with pending purchase orders

Response 200: OrderHead

---

DELETE /SalesOrder/{id}

Deletes a sales order by ID.

Parameter	Type	Description
id (path, required)	integer	Sales order ID

Response 200: OK

---

POST /SalesOrder/View

Records viewer activity on a sales order.

Request body: Array of Viewers

Response 200: OK

---

OrderLine

GET /OrderLine

Returns order line records.

Response 200: OK

---

SupplierOrderHeader

GET /PurchaseOrder

Summary: List of SupplierOrderHeader

Returns multiple purchase order (supplier order) records. Requires authentication.

Parameter	Type	Description
awaiting_approval	boolean	Filter by suppliers awaiting approval
awaitingstock	boolean	Filter by suppliers awaiting stock
client_id	integer	Filter by client
closed	boolean	Filter by closed status
count	integer	Number of records to return
deliver_to_us	boolean	Filter on delivery-to-us option
deliver_to_user_salesorder_id	integer	Filter by sales order for delivery
my_approvals	boolean	Filter by suppliers awaiting your approval
open	boolean	Filter by open status
order	string	Primary sort field name
order2–order5	string	Secondary–fifth sort field names
orderdesc	boolean	Descending sort on first order field
orderdesc2–orderdesc5	boolean	Descending sort on remaining order fields
page_no	integer	Page number when paginating
page_size	integer	Page size when paginating
pageinate	boolean	Enable pagination
po_status	string	Filter by PO status (comma-separated)
salesorder_id	integer	Filter by associated sales order
search	string	Full-text search string
site_id	integer	Filter by site
supplier_id	integer	Filter by supplier
ticket_id	integer	Filter by associated ticket
unsent	boolean	Filter by unsent status
user_id	integer	Filter by user

Response 200: SupplierOrderHeader_View

---

POST /PurchaseOrder

Creates one or more purchase orders.

Request body: Array of SupplierOrderHeader

Response 201: SupplierOrderHeader

---

GET /PurchaseOrder/{id}

Summary: Get one SupplierOrderHeader

Returns a single purchase order by ID. Requires authentication.

Parameter	Type	Description
id (path, required)	integer	Purchase order ID
extrareceivablelines	boolean	Include deliver-to-us lines where received quantity exceeds current stock
includedetails	boolean	Include extra objects in response
invoiceablelines	boolean	Return only invoiceable lines
receivablelines	boolean	Include only consignable (receivable) lines

Response 200: SupplierOrderHeader

---

DELETE /PurchaseOrder/{id}

Deletes a purchase order by ID.

Parameter	Type	Description
id (path, required)	integer	Purchase order ID

Response 200: OK

---

POST /PurchaseOrder/confirmreceipt

Confirms receipt of goods for a purchase order.

Request body: SupplierOrderHeader

Response 200: OK

---

POST /PurchaseOrder/View

Records viewer activity on a purchase order.

Request body: Array of Viewers

Response 200: OK

---

ConsignmentHeader

GET /Consignment

Summary: List of ConsignmentHeader

Returns multiple consignment records. Requires authentication.

Parameter	Type	Description
count	integer	Number of records to return
idonly	boolean	Return IDs only
order–order5	string	Sort fields (primary through fifth)
orderdesc–orderdesc5	boolean	Descending sort flags
page_no	integer	Page number
page_size	integer	Page size
pageinate	boolean	Enable pagination

Response 200: OK

---

POST /Consignment

Creates one or more consignment records.

Request body: Array of ConsignmentHeader

Response 200: OK

---

GET /Consignment/{id}

Summary: Get one ConsignmentHeader

Returns a single consignment by ID. Requires authentication.

Parameter	Type	Description
id (path, required)	integer	Consignment ID
includedetails	boolean	Include extra detail objects

Response 200: OK

---

DELETE /Consignment/{id}

Deletes a consignment by ID.

Parameter	Type	Description
id (path, required)	integer	Consignment ID
deleteOrder	boolean	Also delete the associated order

Response 200: OK

---