Guides | Intend Knowledge Base

Field	Description
`sale_id` (required)	[integer] Unique identifier of the sale to retrieve.
`client_id` (optional)	[integer] If provided, limits results to sales belonging to the specified client.

A successful request returns HTTP 200 and provides comprehensive details of a specific sale or order, including order information, payment details, buyer information, itemized product details, delivery information, taxes, discounts, and related invoice data. It is typically returned after querying a sale by its unique ID or code.

Field	Description
`id`	[integer] Sale ID.
`code`	[string] Order code or reference number.
`order_date`	[string] Date and time the order was created.
`expiry_date`	[string] Expiry date of the order
`type`	[string] Type of order (e.g., "PROFORMA ORDER").
`department`	[string] Department associated with the sale.
`client_reference`	[string] Client reference.
`agent_reference`	[string] Agent reference.
`sidemark`	[string] Sidemark reference.
`currency`	[string] Currency code used for the sale.
`measurement`	[string] Measurement system used (e.g., Metric).
`fx_rate`	[integer] Foreign exchange rate applied.
`sub_total`	[integer] Total amount before discounts and taxes.
`discount`	[integer] Discount amount applied.
`discount_rate`	[integer] Discount rate (%) applied.
`net_total`	[integer] Total net price.
`tax_amount`	[integer] Total after discount, before tax and delivery.
`tax_rate`	[integer] Tax rate applied (%)
`tax_ref`	[object] Tax reference with code and value (see "Tax ref object" below).
`delivery_amount`	[integer] Delivery charge for the sale.
`delivery_tax`	[integer] Tax applied on delivery charges.
`total_amount`	[integer] Total payable amount including tax and delivery.
`commission_amount`	[integer] Commission charged on the sale.
`commission_rate`	[integer] Commission rate (%) applied.
`payment_status`	[string] Payment status (e.g., "Completed", "Pending", etc.).
`payment_completed_on`	[string] Datetime when payment was completed.
`payment_request_type`	[string] Type of payment requested (e.g., full, partial).
`amount_to_pay`	[integer] Remaining amount to pay.
`payment_due`	[integer] Amount due for payment.
`paid_amount`	[integer] Amount already paid.
`refunded_amount`	[integer] Amount refunded to the client.
`credited_amount`	[integer] Amount credited to client account.
`source`	[string] Source of the sale (e.g., web, POS).
`source_status`	[string] Status of the source (e.g., "D" for Draft).
`created_on`	[string] Timestamp when the order was created.
`invoice`	[object] Invoice details (see "Invoice object" below).
`buyer`	[object] Buyer detail information (see "Buyer object" below).
`items`	[object] Items details (see "Items object" below).
`cancel_status`	[boolean] 0 = Not cancelled, 1 = Cancelled.
`cancelled_on`	[string] Datetime of cancellation.
`cancelled_reason`	[string] Reason for cancellation.

Tax ref object

Field	Description
`code`	[string] Tax code.
`value`	[integer] Tax percentage value.

Items object

Field	Description
`id`	[integer] Unique ID of the invoice.
`code`	[string] Invoice code/reference.
`type`	[string] Type of invoice (e.g., "VAT Invoice").
`invoice_date`	[string] Date and time when the invoice was created.

Buyer object

Field	Description
`client_id`	[integer] Unique ID of the client.
`client_account`	[string] Account code of the client.
`agent_id`	[integer] Unique ID of the associated agent.
`agent_account`	[string] Account code of the agent.
`title`	[string] Title of the client (e.g., Mr., Ms.).
`first_name`	[string] First name of the client.
`last_name`	[string] Last name of the client.
`contact_name`	[string] Name to be used for contact purposes.
`email`	[string] Email address of the client.
`phone`	[string] Phone number of the client.
`address_street_1`	[string] Primary street address.
`address_street_2`	[string] Secondary street address.
`address_town`	[string] Town or city of the client.
`address_county`	[string] County or state of the client.
`address_post_code`	[string] Postal code.
`address_country`	[string] Country name.

Items object

Field	Description
`id`	[integer] Unique ID of the item.
`name`	[string] Name of the item/product.
`code`	[string] Item code or SKU.
`description`	[string] Item description.
`selling_unit`	[string] Unit of sale (e.g., Metre, Piece).
`selling_unit_sm`	[string] Short form of the selling unit (e.g., m, pc).
`mode`	[string] Mode of item (e.g., Product, Service).
`type`	[string] Type of item (e.g., Unit, Bulk).
`quantity`	[number] Quantity ordered.
`marked_price`	[number] Original marked price per unit.
`discount_rate`	[number] Discount rate applied to the item.
`selling_price`	[number] Selling price per unit after discount.
`tax_applicable`	[number] Flag indicating if tax is applicable (1 = yes, 0 = no).
`sold_in_group`	[number] Flag indicating if sold in a group (1 = yes, 0 = no).
`group_label`	[string] Label for the group if applicable.
`group_quantity`	[number] Quantity within the group.
`backorder`	[string] Backorder status, if any.
`dispatch_quantity`	[number] Quantity dispatched so far.
`dispatch_status`	[string] Current dispatch status (e.g., pending, dispatched).
`dispatch_status_changed_on`	[string] Timestamp when dispatch status was last updated.
`returnable`	[number] Flag if item is returnable (1 = yes, 0 = no).
`return_status`	[string] Return status of the item (e.g., none, requested).
`return_quantity`	[number] Quantity returned, if any.
`delivery`	[object] Delivery details for the item (see "Delivery object").

Delivery object

Field	Description
`title`	[string] Name/title of the recipient.
`first_name`	[string] First name of the recipient.
`last_name`	[string] Last name of the recipient.
`email`	[string] Email of the recipient.
`phone`	[string] Phone number of the recipient.
`address_street_1`	[string] Primary street address for delivery.
`address_street_2`	[string] Secondary street address.
`address_town`	[string] Town/city for delivery.
`address_county`	[string] County/state for delivery.
`address_post_code`	[string] Postal code for delivery.
`address_country`	[string] Country for delivery.
`delivery_charge`	[integer] Delivery charge for this item.
`delivery_charge_tax`	[integer] Tax applied on delivery charge.
`postage_charge`	[integer] Postage cost.
`shipping_category`	[string] Shipping category.

Query Sale

Request

Response

Tax ref object

Items object

Buyer object

Items object

Delivery object