Retrieve Order List: /orders
GET
https://dev-api.exsited.com/api/v3/orders
Try It Out
Purpose
This endpoint fetches a paginated list of all orders in the system. Each order contains metadata such as status, order ID, currency, billing/shipping details, order lines, communication preferences, tax settings, and KPIs.
Use Case
The endpoint is used to retrieve a list of all customer orders for account-level operations, reporting, or monitoring purposes. This can include active, cancelled, or draft orders. The returned data supports use cases such as displaying order history in dashboards, tracking shipping or billing status, and analyzing invoicing KPIs.
Path Parameters
No path parameters required for this endpoint.
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| order_by | String | Field name to sort the result set. |
| direction | String | Sorting direction. Accepts asc or desc. |
| limit | Integer | Number of records to retrieve per page. |
| offset | Integer | Number of records to skip from the beginning |
Request Body
No request body is required for this endpoint.
Response
The response includes an array of orders each containing detailed information about the order including identifiers, customer references, shipping/billing information, communication settings, pricing configuration, and line items. It also includes pagination metadata to navigate through large datasets.
JSON
{
"orders": [
{
"status": "ORDER_STATUS",
"id": "ORDER_ID_1",
"pre_order": "BOOLEAN",
"quote_order": "BOOLEAN",
"name": "ORDER_NAME_1",
"display_name": "ORDER_DISPLAY_NAME_1",
"description": "ORDER_DESCRIPTION_1",
"referral_account": "EMPTY",
"customer_purchase_order_id": "CUSTOMER_PO_ID",
"shipping_profile": {},
"shipping_cost": "DECIMAL_VALUE",
"discount_profile": null,
"origin": "ORDER_ORIGIN_1",
"custom_forms": {
"uuid": "CUSTOM_FORM_UUID",
"name": "CUSTOM_FORM_NAME"
},
"currency": {
"uuid": "CURRENCY_UUID",
"name": "CURRENCY_CODE",
"link": "CURRENCY_API_LINK"
},
"time_zone": {
"uuid": "TIMEZONE_UUID",
"name": "TIMEZONE_NAME",
"link": "TIMEZONE_API_LINK"
},
"invoice_note": "INVOICE_NOTE_1",
"communication_preference": [
{
"media": "COMMUNICATION_MEDIA",
"isEnabled": "BOOLEAN"
}
],
"billing_start_date": "BILLING_START_DATE",
"order_start_date": "ORDER_START_TIMESTAMP_1",
"next_billing_from_date": "EMPTY",
"price_tax_inclusive": "BOOLEAN",
"billing_address": {
"address_line_1": "ADDRESS_LINE_1",
"address_line_2": "ADDRESS_LINE_2",
"address_line_3": "ADDRESS_LINE_3",
"address_line_4": "ADDRESS_LINE_4",
"address_line_5": "ADDRESS_LINE_5",
"city": "CITY_1",
"country": "COUNTRY_1",
"name": "EMPTY",
"post_code": "POSTAL_CODE_1",
"state": "STATE_1"
},
"shipping_address": {
"address_line_1": "ADDRESS_LINE_1",
"address_line_2": "ADDRESS_LINE_2",
"address_line_3": "ADDRESS_LINE_3",
"address_line_4": "ADDRESS_LINE_4",
"address_line_5": "ADDRESS_LINE_5",
"city": "CITY_1",
"country": "COUNTRY_1",
"name": "EMPTY",
"post_code": "POSTAL_CODE_1",
"state": "STATE_1"
},
"created_by": "CREATED_BY_1",
"created_on": "CREATION_TIMESTAMP_1",
"last_updated_by": "UPDATED_BY_1",
"last_updated_on": "UPDATE_TIMESTAMP_1",
"uuid": "ORDER_UUID_1",
"version": "VERSION_1",
"account_id": "ACCOUNT_ID",
"account_name": "ACCOUNT_NAME",
"allow_contract": "BOOLEAN",
"custom_attributes": [],
"custom_objects": [],
"currency_id": "CURRENCY_ID",
"properties": {
"communication_profile": "COMMUNICATION_PROFILE",
"invoice_mode": "INVOICE_MODE",
"invoice_term": "INVOICE_TERM",
"billing_period": "BILLING_PERIOD",
"consolidate_invoice": "BOOLEAN",
"consolidate_key": "CONSOLIDATION_KEY",
"payment_processor": "PAYMENT_PROCESSOR",
"payment_mode": "PAYMENT_MODE",
"payment_term": "PAYMENT_TERM",
"payment_term_alignment": "PAYMENT_TERM_ALIGNMENT",
"fulfillment_mode": "FULFILLMENT_MODE",
"fulfillment_term": "FULFILLMENT_TERM"
},
"lines": [
{
"charge_item_uuid": "CHARGE_ITEM_UUID_1",
"item_uuid": "ITEM_UUID_1",
"item_id": "ITEM_ID_1",
"item_name": "ITEM_NAME_1",
"item_order_quantity": "DECIMAL_VALUE",
"shipping_cost": "DECIMAL_VALUE",
"item_invoice_note": "ITEM_INVOICE_NOTE_1",
"item_description": "ITEM_DESCRIPTION_1",
"item_type": "ITEM_TYPE",
"item_charge_type": "CHARGE_TYPE",
"item_custom_attributes": [],
"item_price_snapshot": {
"pricing_rule": {
"uuid": "PRICING_RULE_UUID_1",
"version": "VERSION",
"price_type": "PRICE_TYPE",
"price": "DECIMAL_VALUE",
"uom": "EMPTY",
"price_period": "EMPTY",
"pricing_schedule": "EMPTY",
"pricing_level": "EMPTY",
"pricing_method": "DECIMAL_VALUE",
"warehouse": "WAREHOUSE_NAME"
}
},
"item_sale_tax_configuration": {
"sale_price_is_based_on": "TAX_BASIS",
"tax_code": {
"uuid": "EMPTY",
"code": "EMPTY",
"rate": "EMPTY",
"link": "EMPTY"
}
},
"isTaxExemptWhenSold": "BOOLEAN",
"item_price_tax": {
"uuid": "TAX_UUID_1",
"code": "TAX_CODE",
"rate": "DECIMAL_VALUE",
"link": "TAX_API_LINK"
},
"item_accounting_code": {
"sales_revenue": "EMPTY"
},
"version": "VERSION",
"expected_delivery_date": "EMPTY",
"discount": "DECIMAL_VALUE",
"total": "DECIMAL_VALUE",
"subtotal": "DECIMAL_VALUE",
"tax": "DECIMAL_VALUE"
}
],
"total": "DECIMAL_VALUE",
"subtotal": "DECIMAL_VALUE",
"tax": "DECIMAL_VALUE",
"kpis": {
"start_date": "EMPTY",
"estimated_total": "DECIMAL_VALUE",
"total_revenue": "DECIMAL_VALUE",
"monthly_recurring_revenue": "DECIMAL_VALUE",
"total_collected": "DECIMAL_VALUE",
"total_outstanding": "DECIMAL_VALUE",
"total_due": "DECIMAL_VALUE",
"last_invoice_issue_date": "EMPTY",
"last_invoice_total": "DECIMAL_VALUE",
"total_invoice": "DECIMAL_VALUE",
"next_invoice_issueDate": "EMPTY",
"last_reactivated_on": "EMPTY",
"last_cancelled_on": "EMPTY",
"last_changed_on": "EMPTY",
"last_deleted_on": "EMPTY"
},
"line_items": []
},
{
"status": "ORDER_STATUS",
"id": "ORDER_ID_2",
"pre_order": "BOOLEAN",
"quote_order": "BOOLEAN",
"name": "ORDER_NAME_2",
"display_name": "ORDER_DISPLAY_NAME_2",
"description": "ORDER_DESCRIPTION_2",
"referral_account": "EMPTY",
"customer_purchase_order_id": "CUSTOMER_PO_ID",
"shipping_profile": {},
"shipping_cost": "DECIMAL_VALUE",
"discount_profile": null,
"origin": "ORDER_ORIGIN_2",
"custom_forms": {
"uuid": "CUSTOM_FORM_UUID",
"name": "CUSTOM_FORM_NAME"
},
"currency": {
"uuid": "CURRENCY_UUID",
"name": "CURRENCY_CODE",
"link": "CURRENCY_API_LINK"
},
"time_zone": {
"uuid": "TIMEZONE_UUID",
"name": "TIMEZONE_NAME",
"link": "TIMEZONE_API_LINK"
},
"invoice_note": "INVOICE_NOTE_2",
"communication_preference": [
{
"media": "COMMUNICATION_MEDIA",
"isEnabled": "BOOLEAN"
}
],
"billing_start_date": "BILLING_START_DATE",
"order_start_date": "ORDER_START_TIMESTAMP_2",
"next_billing_from_date": "EMPTY",
"price_tax_inclusive": "BOOLEAN",
"billing_address": {
"address_line_1": "ADDRESS_LINE_1",
"address_line_2": "ADDRESS_LINE_2",
"address_line_3": "ADDRESS_LINE_3",
"address_line_4": "EMPTY",
"address_line_5": "ADDRESS_LINE_5",
"city": "CITY_2",
"country": "COUNTRY_2",
"name": "EMPTY",
"post_code": "POSTAL_CODE_2",
"state": "STATE_2"
},
"shipping_address": {
"address_line_1": "ADDRESS_LINE_1",
"address_line_2": "ADDRESS_LINE_2",
"address_line_3": "ADDRESS_LINE_3",
"address_line_4": "ADDRESS_LINE_4",
"address_line_5": "ADDRESS_LINE_5",
"city": "CITY_1",
"country": "COUNTRY_1",
"name": "EMPTY",
"post_code": "POSTAL_CODE_1",
"state": "STATE_1"
},
"created_by": "CREATED_BY_2",
"created_on": "CREATION_TIMESTAMP_2",
"last_updated_by": "UPDATED_BY_2",
"last_updated_on": "UPDATE_TIMESTAMP_2",
"uuid": "ORDER_UUID_2",
"version": "VERSION_2",
"account_id": "ACCOUNT_ID",
"account_name": "ACCOUNT_NAME",
"allow_contract": "BOOLEAN",
"custom_attributes": [],
"custom_objects": [],
"currency_id": "CURRENCY_ID",
"properties": {
"communication_profile": "COMMUNICATION_PROFILE",
"invoice_mode": "INVOICE_MODE",
"invoice_term": "INVOICE_TERM",
"billing_period": "BILLING_PERIOD",
"consolidate_invoice": "BOOLEAN",
"consolidate_key": "EMPTY",
"payment_processor": "PAYMENT_PROCESSOR",
"payment_mode": "PAYMENT_MODE",
"payment_term": "PAYMENT_TERM",
"payment_term_alignment": "PAYMENT_TERM_ALIGNMENT",
"fulfillment_mode": "FULFILLMENT_MODE",
"fulfillment_term": "FULFILLMENT_TERM"
},
"lines": [
{
"charge_item_uuid": "CHARGE_ITEM_UUID_2",
"item_uuid": "ITEM_UUID_1",
"item_id": "ITEM_ID_1",
"item_name": "ITEM_NAME_1",
"item_order_quantity": "DECIMAL_VALUE",
"shipping_cost": "DECIMAL_VALUE",
"item_invoice_note": "EMPTY",
"item_description": "EMPTY",
"item_type": "ITEM_TYPE",
"item_charge_type": "CHARGE_TYPE",
"item_custom_attributes": [],
"item_price_snapshot": {
"pricing_rule": {
"uuid": "PRICING_RULE_UUID_1",
"version": "VERSION",
"price_type": "PRICE_TYPE",
"price": "DECIMAL_VALUE",
"uom": "EMPTY",
"price_period": "EMPTY",
"pricing_schedule": "EMPTY",
"pricing_level": "EMPTY",
"pricing_method": "DECIMAL_VALUE",
"warehouse": "WAREHOUSE_NAME"
}
},
"item_sale_tax_configuration": {
"sale_price_is_based_on": "TAX_BASIS",
"tax_code": {
"uuid": "EMPTY",
"code": "EMPTY",
"rate": "EMPTY",
"link": "EMPTY"
}
},
"isTaxExemptWhenSold": "BOOLEAN",
"item_price_tax": {
"uuid": "TAX_UUID_2",
"code": "TAX_CODE",
"rate": "DECIMAL_VALUE",
"link": "TAX_API_LINK"
},
"item_accounting_code": {
"sales_revenue": "EMPTY"
},
"version": "VERSION",
"expected_delivery_date": "EMPTY",
"discount": "DECIMAL_VALUE",
"total": "DECIMAL_VALUE",
"subtotal": "DECIMAL_VALUE",
"tax": "DECIMAL_VALUE"
}
],
"total": "DECIMAL_VALUE",
"subtotal": "DECIMAL_VALUE",
"tax": "DECIMAL_VALUE",
"kpis": {
"start_date": "EMPTY",
"estimated_total": "DECIMAL_VALUE",
"total_revenue": "DECIMAL_VALUE",
"monthly_recurring_revenue": "DECIMAL_VALUE",
"total_collected": "DECIMAL_VALUE",
"total_outstanding": "DECIMAL_VALUE",
"total_due": "DECIMAL_VALUE",
"last_invoice_issue_date": "EMPTY",
"last_invoice_total": "DECIMAL_VALUE",
"total_invoice": "DECIMAL_VALUE",
"next_invoice_issueDate": "EMPTY",
"last_reactivated_on": "EMPTY",
"last_cancelled_on": "EMPTY",
"last_changed_on": "EMPTY",
"last_deleted_on": "EMPTY"
},
"line_items": []
}
],
"pagination": {
"records": "NUMBER",
"limit": "NUMBER",
"offset": "NUMBER",
"previous_page": "PAGINATION_URL",
"next_page": "NULL"
}
}| Attribute | Type | Description |
|---|---|---|
| orders | Array | List of order objects. |
| orders[].status | String | Status of the order . |
| orders[].id | String | Unique identifier of the order. |
| orders[].pre_order | String | Indicates if it is a pre-order (true/false). |
| orders[].quote_order | String | Indicates if it is a quote order (true/false). |
| orders[].name | String | Internal or user-defined name of the order. |
| orders[].display_name | String | Display name shown in the UI. |
| orders[].description | String | Description of the order. |
| orders[].referral_account | String | Linked referral account (if any). |
| orders[].customer_purchase_order_id | String | Customer-provided purchase order ID. |
| orders[].shipping_profile | Object | Shipping profile details (may be empty). |
| orders[].shipping_cost | String | Total shipping cost of the order. |
| orders[].discount_profile | Object/null | Discount profile applied to the order. |
| orders[].origin | String | Source/origin tag of the order. |
| orders[].custom_forms | Object | Custom form attached to the order. |
| orders[].currency | Object | Currency used for the order (uuid, name, link). |
| orders[].time_zone | Object | Time zone info (uuid, name, link). |
| orders[].invoice_note | String | Notes shown on the invoice. |
| orders[].communication_preference | Array | List of communication methods (EMAIL). |
| orders[].billing_start_date | String | Billing start date placeholder or actual value. |
| orders[].order_start_date | DateTime | Start date of the order. |
| orders[].next_billing_from_date | String | Next billing cycle date (if any). |
| orders[].price_tax_inclusive | String | Indicates if tax is included in the prices. |
| orders[].billing_address | Object | Full billing address details. |
| orders[].shipping_address | Object | Full shipping address details. |
| orders[].created_by | String | User who created the order. |
| orders[].created_on | DateTime | Timestamp when the order was created. |
| orders[].last_updated_by | String | User who last updated the order. |
| orders[].last_updated_on | DateTime | Timestamp when the order was last updated. |
| orders[].uuid | String | UUID of the order. |
| orders[].version | String | Version number of the order. |
| orders[].account_id | String | Linked account ID for the order. |
| orders[].allow_contract | String | Indicates whether contracts are allowed. |
| orders[].custom_attributes | Array | List of custom attributes (if any). |
| orders[].custom_objects | Array | List of custom objects (if any). |
| orders[].currency_id | String | Internal currency ID reference. |
| orders[].properties | Object | Key-value configuration related to billing, payment, and fulfillment. |
| orders[].lines | Array | List of ordered line items. |
| orders[].lines[].item_name | String | Name of the item ordered. |
| orders[].lines[].item_order_quantity | String | Quantity ordered. |
| orders[].lines[].item_price_snapshot | Object | Pricing rule snapshot for the item. |
| orders[].lines[].item_price_tax | Object | Tax configuration and rates for the item. |
| orders[].kpis | Object | Key performance indicators (revenue, due amounts, etc.). |
| orders[].line_items | Array | Additional line item objects (optional/empty). |
| pagination | Object | Metadata for pagination of the result set. |
| pagination.records | Integer | Total number of records in the dataset. |
| pagination.limit | Integer | Maximum number of records per page. |
| pagination.offset | Integer | Offset applied to the list of records. |
| pagination.previous_page | String/null | URL of the previous page of results. |
| pagination.next_page | String/null | URL of the next page of results. |
Retrieve Order Details: /orders/{order_id}
GET
https://dev-api.exsited.com/api/v3/orders/{order_id}
Try It Out
Purpose
This API retrieve comprehensive details of a specific order by its unique ID. It returns a complete snapshot of the order including metadata, customer configuration, item lines, pricing, billing, shipping, taxes, and key performance indicators.
Use Case
This API is used to programmatically fetch full order details, useful for account managers, billing systems, or customer service dashboards. For instance, authenticated user might use this endpoint to verify order configurations (like billing period, items, taxes, and invoice modes), check customer preferences (email notifications), and review associated line items and totals. It supports deep visibility into every aspect of the order lifecycle for validation, auditing, and operations.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| order_id | String | The unique identifier of the order . |
Query Parameters
This endpoint does not have any query parameters.
Request Body
No request body is required for this endpoint.
Response
The response returns an order object containing metadata and financial information about the order. It includes items purchased, billing and shipping configuration, tax settings, communication preferences, invoice terms, and recurring billing attributes. Each line item contains specific details such as price, tax status, fulfillment options, and associated pricing rules.
JSON
{
"order": {
"status": "ORDER_STATUS",
"id": "ORDER_ID",
"pre_order": "BOOLEAN",
"quote_order": "BOOLEAN",
"name": "ORDER_NAME",
"display_name": "ORDER_DISPLAY_NAME",
"description": "ORDER_DESCRIPTION",
"referral_account": "EMPTY",
"customer_purchase_order_id": "CUSTOMER_PO_ID",
"shipping_profile": {},
"shipping_cost": "DECIMAL_VALUE",
"discount_profile": null,
"origin": "ORDER_ORIGIN",
"custom_forms": {
"uuid": "CUSTOM_FORM_UUID",
"name": "CUSTOM_FORM_NAME"
},
"currency": {
"uuid": "CURRENCY_UUID",
"name": "CURRENCY_CODE",
"link": "CURRENCY_API_LINK"
},
"time_zone": {
"uuid": "TIMEZONE_UUID",
"name": "TIMEZONE_NAME",
"link": "TIMEZONE_API_LINK"
},
"invoice_note": "INVOICE_NOTE",
"communication_preference": [
{
"media": "COMMUNICATION_MEDIA",
"enabled": "BOOLEAN"
}
],
"billing_start_date": "BILLING_START_DATE",
"order_start_date": "ORDER_START_TIMESTAMP",
"next_billing_from_date": "NEXT_BILLING_DATE",
"next_billing_from_date_utc": "NEXT_BILLING_UTC_TIMESTAMP",
"price_tax_inclusive": "BOOLEAN",
"billing_address": {},
"shipping_address": {},
"created_by": "CREATED_BY",
"created_on": "CREATION_TIMESTAMP",
"last_updated_by": "UPDATED_BY",
"last_updated_on": "UPDATE_TIMESTAMP",
"uuid": "ORDER_UUID",
"version": "VERSION",
"account_id": "ACCOUNT_ID",
"allow_contract": "BOOLEAN",
"custom_attributes": [],
"custom_objects": [],
"currency_id": "CURRENCY_ID",
"properties": {
"communication_profile": "COMMUNICATION_PROFILE",
"invoice_mode": "INVOICE_MODE",
"invoice_term": "INVOICE_TERM",
"billing_period": "BILLING_PERIOD",
"consolidate_invoice": "BOOLEAN",
"consolidate_key": "CONSOLIDATION_KEY",
"payment_processor": "PAYMENT_PROCESSOR",
"payment_mode": "PAYMENT_MODE",
"payment_term": "PAYMENT_TERM",
"payment_term_alignment": "PAYMENT_TERM_ALIGNMENT",
"fulfillment_mode": "FULFILLMENT_MODE",
"fulfillment_term": "FULFILLMENT_TERM"
},
"lines": [
{
"charge_item_uuid": "CHARGE_ITEM_UUID",
"item_uuid": "ITEM_UUID",
"item_id": "ITEM_ID",
"item_name": "ITEM_NAME",
"item_order_quantity": "DECIMAL_VALUE",
"shipping_cost": "DECIMAL_VALUE",
"item_invoice_note": "EMPTY",
"item_description": "EMPTY",
"item_type": "ITEM_TYPE",
"item_charge_type": "CHARGE_TYPE",
"item_custom_attributes": [],
"item_properties": {
"billing_mode": "BILLING_MODE",
"charging_period": "EMPTY",
"charging_start_date": "CHARGING_START_DATE",
"charging_and_billing_alignment": "BOOLEAN",
"pro_rata_partial_charging_period": "BOOLEAN",
"pro_rata_partial_pricing_period": "BOOLEAN"
},
"item_price_snapshot": {
"pricing_rule": {
"uuid": "PRICING_RULE_UUID",
"version": "VERSION",
"price_type": "PRICE_TYPE",
"price": "DECIMAL_VALUE",
"uom": "EMPTY",
"price_period": "EMPTY",
"pricing_schedule": "EMPTY",
"pricing_level": "EMPTY",
"pricing_method": "DECIMAL_VALUE",
"warehouse": "WAREHOUSE_NAME"
}
},
"item_sale_tax_configuration": {
"sale_price_is_based_on": "TAX_BASIS",
"tax_code": {
"uuid": "EMPTY",
"code": "EMPTY",
"rate": "EMPTY",
"link": "EMPTY"
}
},
"tax_exempt_when_sold": "BOOLEAN",
"item_price_tax": {
"uuid": "EMPTY",
"code": "EMPTY",
"rate": "DECIMAL_VALUE",
"link": "EMPTY"
},
"item_accounting_code": {
"sales_revenue": "EMPTY"
},
"version": "VERSION",
"expected_delivery_date": "EMPTY"
}
],
"kpis": {
"start_date": "EMPTY",
"estimated_total": "DECIMAL_VALUE",
"total_revenue": "DECIMAL_VALUE",
"monthly_recurring_revenue": "DECIMAL_VALUE",
"total_collected": "DECIMAL_VALUE",
"total_outstanding": "DECIMAL_VALUE",
"total_due": "DECIMAL_VALUE",
"last_invoice_issue_date": "EMPTY",
"last_invoice_total": "DECIMAL_VALUE",
"total_invoice": "DECIMAL_VALUE",
"next_invoice_issue_date": "EMPTY",
"last_reactivated_on": "EMPTY",
"last_cancelled_on": "EMPTY",
"last_changed_on": "EMPTY",
"last_deleted_on": "EMPTY"
},
"line_items": []
}
}| Attribute | Type | Description |
|---|---|---|
| order.id | String | Unique order identifier |
| order.name | String | Name of the order |
| order.status | String | Status of the order |
| order.account_id | String | Associated account ID |
| order.order_start_date | String | Start date of the order (ISO 8601 format) |
| order.billing_start_date | String | Billing start date placeholder or actual date |
| order.currency.name | String | Currency used |
| order.time_zone.name | String | Time zone for order-related operations |
| order.communication_preference | Array | Preferred media for order communication |
| order.properties | Object | Order properties including invoice mode, payment terms, and fulfillment |
| order.lines[] | Array | List of order line items with pricing, tax, and charge configuration |
| order.kpis | Object | Key performance indicators like revenue, MRR, due, collected, etc. |
| order.created_by | String | Name of the user who created the order |
| order.created_on | String | Timestamp when the order was created |
| order.last_updated_by | String | Name of the user who last updated the order |
| order.last_updated_on | String | Timestamp of the last order update |
| order.uuid | String | UUID of the order |
| order.version | String | Version number of the order record |
Retrieve Order Information: /orders/{order_id}/information
GET
https://dev-api.exsited.com/api/v3/orders/{order_id}/information
Try It Out
Purpose
This endpoint retrieves comprehensive information about an active order, including order metadata, billing and shipping addresses, communication preferences, pricing details, and associated settings such as currency, time zone, and custom forms.
Use Case
The endpoint is used to fetch the latest configuration and metadata of an order in the system. This includes key attributes like the order's status, billing and shipping details, communication preferences, price settings ( tax-inclusive or not), time zone and currency settings, and links to the associated profile or forms. It is especially useful for reviewing or displaying order information in dashboards, summaries, or validation steps before invoice generation or fulfillment.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| order_id | String | The unique identifier of the order . |
Query Parameters
This endpoint does not have any query parameters.
Request Body
No request body is required for this endpoint.
Response
The API endpoint returns an order object containing detailed information about the order. It includes status, ID, type flags (pre-order or quote), name, description, billing and shipping addresses, associated custom forms, linked currency and time zone, invoice notes, start dates, price tax settings, and audit metadata like creator and timestamps. The response also includes optional fields for referral account, discount profile, and custom configurations.
JSON
{
"order": {
"status": "ORDER_STATUS",
"id": "ORDER_ID",
"pre_order": "BOOLEAN",
"quote_order": "BOOLEAN",
"name": "ORDER_NAME",
"display_name": "ORDER_DISPLAY_NAME",
"description": "ORDER_DESCRIPTION",
"referral_account": "EMPTY",
"customer_purchase_order_id": "CUSTOMER_PO_ID",
"shipping_profile": {},
"shipping_cost": "DECIMAL_VALUE",
"discount_profile": null,
"origin": "ORDER_ORIGIN",
"custom_forms": {
"uuid": "CUSTOM_FORM_UUID",
"name": "CUSTOM_FORM_NAME"
},
"currency": {
"uuid": "CURRENCY_UUID",
"name": "CURRENCY_CODE",
"link": "CURRENCY_API_LINK"
},
"time_zone": {
"uuid": "TIMEZONE_UUID",
"name": "TIMEZONE_NAME",
"link": "TIMEZONE_API_LINK"
},
"invoice_note": "INVOICE_NOTE",
"communication_preference": [
{
"media": "COMMUNICATION_MEDIA",
"enabled": "BOOLEAN"
}
],
"billing_start_date": "BILLING_START_DATE",
"order_start_date": "ORDER_START_TIMESTAMP",
"next_billing_from_date": "NEXT_BILLING_DATE",
"next_billing_from_date_utc": "NEXT_BILLING_UTC_TIMESTAMP",
"price_tax_inclusive": "BOOLEAN",
"billing_address": {
"address_line_1": "ADDRESS_LINE_1",
"address_line_2": "EMPTY",
"address_line_3": "EMPTY",
"address_line_4": "EMPTY",
"address_line_5": "EMPTY",
"city": "CITY",
"country": "COUNTRY",
"name": "EMPTY",
"post_code": "POST_CODE",
"state": "STATE"
},
"shipping_address": {
"address_line_1": "ADDRESS_LINE_1",
"address_line_2": "EMPTY",
"address_line_3": "EMPTY",
"address_line_4": "EMPTY",
"address_line_5": "EMPTY",
"city": "CITY",
"country": "COUNTRY",
"name": "EMPTY",
"post_code": "POST_CODE",
"state": "STATE"
},
"created_by": "CREATED_BY",
"created_on": "CREATION_TIMESTAMP",
"last_updated_by": "UPDATED_BY",
"last_updated_on": "UPDATE_TIMESTAMP",
"uuid": "ORDER_UUID",
"version": "VERSION",
"account_id": "ACCOUNT_ID",
"allow_contract": "BOOLEAN",
"custom_attributes": [],
"custom_objects": [],
"currency_id": "CURRENCY_ID"
}
}| Attribute | Type | Description |
|---|---|---|
| status | String | Current status of the order . |
| id | String | Unique order identifier. |
| pre_order | Boolean | Indicates if the order is a pre-order. |
| quote_order | Boolean | Indicates if the order is a quote. |
| name | String | Name assigned to the order. |
| display_name | String | Display-friendly order name. |
| description | String | Textual description of the order. |
| referral_account | String | Associated referral account (if any). |
| customer_purchase_order_id | String | Reference ID from the customer. |
| shipping_profile | Object | Shipping profile details (if applicable). |
| shipping_cost | String | Total shipping cost. |
| discount_profile | Object | Discount configuration (if any). |
| origin | String | Origin of the order. |
| custom_forms | Object | Linked custom form details. |
| currency | Object | Currency used in the order . |
| time_zone | Object | Time zone settings . |
| invoice_note | String | Additional note for invoicing. |
| communication_preference | Array | Communication methods and their enabled states. |
| billing_start_date | String | Billing start marker or placeholder. |
| order_start_date | String | ISO timestamp for order start. |
| next_billing_from_date | String | Next billing date (local format). |
| next_billing_from_date_utc | String | Next billing date in UTC. |
| price_tax_inclusive | Boolean | Whether prices include tax. |
| billing_address | Object | Full billing address. |
| shipping_address | Object | Full shipping address. |
| created_by | String | User who created the order. |
| created_on | String | Timestamp of order creation. |
| last_updated_by | String | User who last updated the order. |
| last_updated_on | String | Timestamp of last update. |
| uuid | String | Internal UUID of the order. |
| version | String | Current version of the order. |
| account_id | String | Associated account identifier. |
| allow_contract | Boolean | Indicates if contract is allowed on this order. |
| custom_attributes | Array | Custom attributes added to the order. |
| custom_objects | Array | Custom objects linked to the order. |
| currency_id | String | Currency ID used in the order. |
Restive Order Billing Preferences: /orders/{order_id}/billing-preferences
GET
https://dev-api.exsited.com/api/v3/orders/{order_id}/billing-preferences
Try It Out
Purpose
This endpoint retrieves the billing preferences and configurations for a specific order. It provides key financial and fulfillment settings such as invoice mode, billing period, payment method, and consolidation details for proper billing management.
Use Case
The endpoint is used when an admin or billing system needs to view how an order is configured for invoicing and payment. It helps determine invoice frequency, payment alignment, fulfillment settings, and processor type, allowing systems or users to audit or apply consistent billing policies to downstream processes or reports.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| order_id | String | Unique identifier of the order |
Query Parameters
This endpoint does not have any query parameters.
Request Body
No request body is required for this endpoint.
Response
The endpoint returns the billing-related properties of the specified order under the properties object. These properties include invoice configuration, payment preferences, fulfillment terms, and invoice consolidation options. This helps in understanding how the order is billed and processed.
JSON
{
"ORDER": {
"PROPERTIES": {
"COMMUNICATION_PROFILE": "STRING_VALUE",
"INVOICE_MODE": "STRING_VALUE",
"INVOICE_TERM": "STRING_VALUE",
"BILLING_PERIOD": "STRING_VALUE",
"CONSOLIDATE_INVOICE": "BOOLEAN",
"CONSOLIDATE_KEY": "STRING_VALUE",
"PAYMENT_PROCESSOR": "STRING_VALUE",
"PAYMENT_MODE": "STRING_VALUE",
"PAYMENT_TERM": "STRING_VALUE",
"PAYMENT_TERM_ALIGNMENT": "STRING_VALUE",
"FULFILLMENT_MODE": "STRING_VALUE",
"FULFILLMENT_TERM": "STRING_VALUE"
}
}
}| Attribute | Type | Description |
|---|---|---|
| communication_profile | String | Communication profile assigned to the order |
| invoice_mode | String | Mode of invoicing |
| invoice_term | String | Invoice due terms |
| billing_period | String | Frequency of billing |
| consolidate_invoice | String | Whether invoices are consolidated ("true"/"false") |
| consolidate_key | String | Key used to group consolidated invoices |
| payment_processor | String | Method of payment processing |
| payment_mode | String | Mode of payment |
| payment_term | String | Payment due policy |
| payment_term_alignment | String | Date alignment used for payment terms |
| fulfillment_mode | String | Fulfillment strategy |
| fulfillment_term | String | Time to fulfill the order |
Retrieve Order Line Items: /orders/{order_id}/lines
GET
https://dev-api.exsited.com/api/v3/orders/{order_id}/lines
Try It Out
Purpose
This API retrieves the detailed list of line items for a specific order, including item information, pricing, taxation, and shipping data.
Use Case
The API is used to inspect the individual items included in an order. This includes the item ID, name, quantity, price per unit, total shipping cost, tax details, and any additional metadata such as custom attributes or expected delivery dates. It is especially helpful for reporting, invoicing, order audits, or fulfillment operations.
Path Parameters
| Attribute | Type | Description |
|---|---|---|
| order_id | String | Unique identifier of order. |
Query Parameters
This endpoint does not have any query parameters.
Request Body
No request body is required for this endpoint.
Response
The endpoint response contains detailed information about the line items associated with a specific order. Each line includes item identifiers, names, descriptions, ordered quantity, shipping cost, and pricing information. It also includes charge type (ONE_OFF or RECURRING), tax configurations, and accounting codes. Pricing snapshots show the applied pricing rule at the time of the order, including price, type, and associated warehouse. For recurring items, billing and charging configurations such as billing mode and pro-rata flags are provided. Additionally, the response includes order-level KPIs such as estimated total, monthly recurring revenue, total collected, outstanding amount, and invoice history.
JSON
{
"ORDER": {
"LINES": [
{
"CHARGE_ITEM_UUID": "UUID_VALUE",
"ITEM_UUID": "UUID_VALUE",
"ITEM_ID": "ITEM_ID_VALUE",
"ITEM_NAME": "STRING_VALUE",
"ITEM_ORDER_QUANTITY": "NUMBER",
"SHIPPING_COST": "NUMBER",
"ITEM_INVOICE_NOTE": "STRING_VALUE",
"ITEM_DESCRIPTION": "STRING_VALUE",
"ITEM_TYPE": "STRING_VALUE",
"ITEM_CHARGE_TYPE": "STRING_VALUE",
"ITEM_CUSTOM_ATTRIBUTES": [],
"ITEM_PRICE_SNAPSHOT": {
"PRICING_RULE": {
"UUID": "UUID_VALUE",
"VERSION": "VERSION_NUMBER",
"PRICE_TYPE": "STRING_VALUE",
"PRICE": "NUMBER",
"UOM": "EMPTY",
"PRICE_PERIOD": "EMPTY",
"PRICING_SCHEDULE": "EMPTY",
"PRICING_LEVEL": "EMPTY",
"PRICING_METHOD": "NUMBER",
"WAREHOUSE": "STRING_VALUE"
}
},
"ITEM_SALE_TAX_CONFIGURATION": {
"SALE_PRICE_IS_BASED_ON": "STRING_VALUE",
"TAX_CODE": {
"UUID": "EMPTY",
"CODE": "EMPTY",
"RATE": "EMPTY",
"LINK": "EMPTY"
}
},
"TAX_EXEMPT_WHEN_SOLD": "BOOLEAN",
"ITEM_PRICE_TAX": {
"UUID": "EMPTY",
"CODE": "EMPTY",
"RATE": "EMPTY",
"LINK": "EMPTY"
},
"ITEM_ACCOUNTING_CODE": {
"SALES_REVENUE": "STRING_VALUE"
},
"VERSION": "VERSION_NUMBER",
"EXPECTED_DELIVERY_DATE": "EMPTY"
},
{
"CHARGE_ITEM_UUID": "UUID_VALUE",
"ITEM_UUID": "UUID_VALUE",
"ITEM_ID": "ITEM_ID_VALUE",
"ITEM_NAME": "STRING_VALUE",
"ITEM_ORDER_QUANTITY": "NUMBER",
"SHIPPING_COST": "NUMBER",
"ITEM_INVOICE_NOTE": "STRING_VALUE",
"ITEM_DESCRIPTION": "STRING_VALUE",
"ITEM_TYPE": "STRING_VALUE",
"ITEM_CHARGE_TYPE": "STRING_VALUE",
"ITEM_CUSTOM_ATTRIBUTES": [],
"ITEM_PRICE_SNAPSHOT": {
"PRICING_RULE": {
"UUID": "UUID_VALUE",
"VERSION": "VERSION_NUMBER",
"PRICE_TYPE": "STRING_VALUE",
"PRICE": "NUMBER",
"UOM": "EMPTY",
"PRICE_PERIOD": "EMPTY",
"PRICING_SCHEDULE": "EMPTY",
"PRICING_LEVEL": "EMPTY",
"PRICING_METHOD": "NUMBER",
"WAREHOUSE": "STRING_VALUE"
}
},
"ITEM_SALE_TAX_CONFIGURATION": {
"SALE_PRICE_IS_BASED_ON": "STRING_VALUE",
"TAX_CODE": {
"UUID": "EMPTY",
"CODE": "EMPTY",
"RATE": "EMPTY",
"LINK": "EMPTY"
}
},
"TAX_EXEMPT_WHEN_SOLD": "BOOLEAN",
"ITEM_PRICE_TAX": {
"UUID": "UUID_VALUE",
"CODE": "STRING_VALUE",
"RATE": "NUMBER",
"LINK": "URL"
},
"ITEM_ACCOUNTING_CODE": {
"SALES_REVENUE": "EMPTY"
},
"VERSION": "VERSION_NUMBER",
"EXPECTED_DELIVERY_DATE": "EMPTY"
},
{
"CHARGE_ITEM_UUID": "UUID_VALUE",
"ITEM_UUID": "UUID_VALUE",
"ITEM_ID": "ITEM_ID_VALUE",
"ITEM_NAME": "STRING_VALUE",
"ITEM_ORDER_QUANTITY": "NUMBER",
"SHIPPING_COST": "NUMBER",
"ITEM_INVOICE_NOTE": "STRING_VALUE",
"ITEM_DESCRIPTION": "STRING_VALUE",
"ITEM_TYPE": "STRING_VALUE",
"ITEM_CHARGE_TYPE": "STRING_VALUE",
"ITEM_CUSTOM_ATTRIBUTES": [],
"ITEM_PROPERTIES": {
"BILLING_MODE": "STRING_VALUE",
"CHARGING_PERIOD": "EMPTY",
"CHARGING_START_DATE": "STRING_VALUE",
"CHARGING_AND_BILLING_ALIGNMENT": "BOOLEAN",
"PRO_RATA_PARTIAL_CHARGING_PERIOD": "BOOLEAN",
"PRO_RATA_PARTIAL_PRICING_PERIOD": "BOOLEAN"
},
"ITEM_PRICE_SNAPSHOT": {
"PRICING_RULE": {
"UUID": "UUID_VALUE",
"VERSION": "VERSION_NUMBER",
"PRICE_TYPE": "STRING_VALUE",
"PRICE": "NUMBER",
"UOM": "EMPTY",
"PRICE_PERIOD": "EMPTY",
"PRICING_SCHEDULE": "EMPTY",
"PRICING_LEVEL": "EMPTY",
"PRICING_METHOD": "NUMBER",
"WAREHOUSE": "STRING_VALUE"
}
},
"ITEM_SALE_TAX_CONFIGURATION": {
"SALE_PRICE_IS_BASED_ON": "STRING_VALUE",
"TAX_CODE": {
"UUID": "EMPTY",
"CODE": "EMPTY",
"RATE": "EMPTY",
"LINK": "EMPTY"
}
},
"TAX_EXEMPT_WHEN_SOLD": "BOOLEAN",
"ITEM_PRICE_TAX": {
"UUID": "UUID_VALUE",
"CODE": "STRING_VALUE",
"RATE": "NUMBER",
"LINK": "URL"
},
"ITEM_ACCOUNTING_CODE": {
"SALES_REVENUE": "EMPTY"
},
"VERSION": "VERSION_NUMBER",
"EXPECTED_DELIVERY_DATE": "EMPTY"
},
{
"CHARGE_ITEM_UUID": "UUID_VALUE",
"ITEM_UUID": "UUID_VALUE",
"ITEM_ID": "ITEM_ID_VALUE",
"ITEM_NAME": "STRING_VALUE",
"ITEM_ORDER_QUANTITY": "NUMBER",
"SHIPPING_COST": "NUMBER",
"ITEM_INVOICE_NOTE": "EMPTY",
"ITEM_DESCRIPTION": "EMPTY",
"ITEM_TYPE": "STRING_VALUE",
"ITEM_CHARGE_TYPE": "STRING_VALUE",
"ITEM_CUSTOM_ATTRIBUTES": [],
"ITEM_PRICE_SNAPSHOT": {
"PRICING_RULE": {
"UUID": "UUID_VALUE",
"VERSION": "VERSION_NUMBER",
"PRICE_TYPE": "STRING_VALUE",
"PRICE": "NUMBER",
"UOM": "EMPTY",
"PRICE_PERIOD": "EMPTY",
"PRICING_SCHEDULE": "EMPTY",
"PRICING_LEVEL": "EMPTY",
"PRICING_METHOD": "NUMBER",
"WAREHOUSE": "STRING_VALUE"
}
},
"ITEM_SALE_TAX_CONFIGURATION": {
"SALE_PRICE_IS_BASED_ON": "STRING_VALUE",
"TAX_CODE": {
"UUID": "EMPTY",
"CODE": "EMPTY",
"RATE": "EMPTY",
"LINK": "EMPTY"
}
},
"TAX_EXEMPT_WHEN_SOLD": "BOOLEAN",
"ITEM_PRICE_TAX": {
"UUID": "UUID_VALUE",
"CODE": "STRING_VALUE",
"RATE": "NUMBER",
"LINK": "URL"
},
"ITEM_ACCOUNTING_CODE": {
"SALES_REVENUE": "EMPTY"
},
"VERSION": "VERSION_NUMBER",
"EXPECTED_DELIVERY_DATE": "EMPTY"
}
],
"KPIS": {
"START_DATE": "EMPTY",
"ESTIMATED_TOTAL": "NUMBER",
"TOTAL_REVENUE": "NUMBER",
"MONTHLY_RECURRING_REVENUE": "NUMBER",
"TOTAL_COLLECTED": "NUMBER",
"TOTAL_OUTSTANDING": "NUMBER",
"TOTAL_DUE": "NUMBER",
"LAST_INVOICE_ISSUE_DATE": "EMPTY",
"LAST_INVOICE_TOTAL": "NUMBER",
"TOTAL_INVOICE": "NUMBER",
"NEXT_INVOICE_ISSUE_DATE": "EMPTY",
"LAST_REACTIVATED_ON": "EMPTY",
"LAST_CANCELLED_ON": "EMPTY",
"LAST_CHANGED_ON": "EMPTY",
"LAST_DELETED_ON": "EMPTY"
},
"LINE_ITEMS": []
}
}| Attribute | Type | Description |
|---|---|---|
| order.lines | Array | List of line items in the order. |
| lines.charge_item_uuid | String | Unique identifier of the charge item. |
| lines.item_uuid | String | Unique identifier of the item. |
| lines.item_id | String | Item code used in the system. |
| lines.item_name | String | Name of the item. |
| lines.item_order_quantity | String | Quantity of the item ordered. |
| lines.shipping_cost | String | Shipping cost associated with the item. |
| lines.item_invoice_note | String | Note included on invoice for the item. |
| lines.item_description | String | Description of the item. |
| lines.item_type | String | Type of item, e.g., STANDARD. |
| lines.item_charge_type | String | Charge type, e.g., ONE_OFF or RECURRING. |
| lines.item_custom_attributes | Array | Custom attributes related to the item. |
| lines.item_price_snapshot | Object | Pricing snapshot of the item at the time of order. |
| item_price_snapshot.pricing_rule | Object | Pricing rule details (UUID, version, type, amount, warehouse, etc.). |
| lines.item_sale_tax_configuration | Object | Tax configuration and basis for sale price. |
| lines.tax_exempt_when_sold | String | Indicates if the item is tax-exempt when sold. |
| lines.item_price_tax | Object | Tax code applied to the item, including rate and reference link. |
| lines.item_accounting_code | Object | Accounting code used for item revenue categorization. |
| lines.version | String | Version of the line item. |
| lines.expected_delivery_date | String | Expected delivery date of the item, if any. |
| lines.item_properties | Object | (If present) Advanced billing/charging options like pro-rata flags, etc. |
| order.kpis | Object | Key performance indicators for the order (total, MRR, invoices, etc.). |
| order.line_items | Array | (Deprecated or empty) List of legacy line item entries. |
Retrieve Order a single Line Item: /orders/{order_id}/lines/{line_uuid}
GET
https://dev-api.exsited.com/api/v3/orders/{order_id}/lines/{line_uuid}
Try It Out
Purpose
This API retrieves detailed information about a specific line item within an order. It is useful for fetching granular details related to a single product or service in the order, including pricing, taxation, shipping, and accounting information.
Use Case
This API is used to display or analyze a particular line item from an order for example, to show full charge breakdowns, verify shipping costs, check applicable taxes, or review the pricing rule applied to that item. This endpoint enables order audit functionality and item-level insight for billing or reporting workflows.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| order_id | String | The unique identifier of the order. |
| line_uuid | String | The unique identifier of the specific line item. |
Query Parameters
This endpoint does not have any query parameters.
Request Body
No request body is required for this endpoint.
Response
The response contains the full details of the specified line item (charge) from the order. It includes identifiers such as item_id and charge_item_uuid, as well as pricing information, tax configuration, charge type, version, and expected delivery date. It also includes KPIs related to the order such as total revenue, total due, and invoicing stats.
JSON
{
"ORDER": {
"CHARGE": {
"CHARGE_ITEM_UUID": "UUID_VALUE",
"ITEM_UUID": "UUID_VALUE",
"ITEM_ID": "ITEM_ID_VALUE",
"ITEM_NAME": "STRING_VALUE",
"ITEM_ORDER_QUANTITY": "NUMBER",
"SHIPPING_COST": "NUMBER",
"ITEM_INVOICE_NOTE": "EMPTY",
"ITEM_DESCRIPTION": "EMPTY",
"ITEM_TYPE": "STRING_VALUE",
"ITEM_CHARGE_TYPE": "STRING_VALUE",
"ITEM_CUSTOM_ATTRIBUTES": [],
"ITEM_PRICE_SNAPSHOT": {
"PRICING_RULE": {
"UUID": "UUID_VALUE",
"VERSION": "VERSION_NUMBER",
"PRICE_TYPE": "STRING_VALUE",
"PRICE": "NUMBER",
"UOM": "EMPTY",
"PRICE_PERIOD": "EMPTY",
"PRICING_SCHEDULE": "EMPTY",
"PRICING_LEVEL": "EMPTY",
"PRICING_METHOD": "NUMBER",
"WAREHOUSE": "STRING_VALUE"
}
},
"ITEM_SALE_TAX_CONFIGURATION": {
"SALE_PRICE_IS_BASED_ON": "STRING_VALUE",
"TAX_CODE": {
"UUID": "EMPTY",
"CODE": "EMPTY",
"RATE": "EMPTY",
"LINK": "EMPTY"
}
},
"TAX_EXEMPT_WHEN_SOLD": "BOOLEAN",
"ITEM_PRICE_TAX": {
"UUID": "UUID_VALUE",
"CODE": "STRING_VALUE",
"RATE": "NUMBER",
"LINK": "URL"
},
"ITEM_ACCOUNTING_CODE": {
"SALES_REVENUE": "EMPTY"
},
"VERSION": "VERSION_NUMBER",
"EXPECTED_DELIVERY_DATE": "EMPTY"
},
"KPIS": {
"START_DATE": "EMPTY",
"ESTIMATED_TOTAL": "NUMBER",
"TOTAL_REVENUE": "NUMBER",
"MONTHLY_RECURRING_REVENUE": "NUMBER",
"TOTAL_COLLECTED": "NUMBER",
"TOTAL_OUTSTANDING": "NUMBER",
"TOTAL_DUE": "NUMBER",
"LAST_INVOICE_ISSUE_DATE": "EMPTY",
"LAST_INVOICE_TOTAL": "NUMBER",
"TOTAL_INVOICE": "NUMBER",
"NEXT_INVOICE_ISSUE_DATE": "EMPTY",
"LAST_REACTIVATED_ON": "EMPTY",
"LAST_CANCELLED_ON": "EMPTY",
"LAST_CHANGED_ON": "EMPTY",
"LAST_DELETED_ON": "EMPTY"
},
"LINE_ITEMS": []
}
}| Attribute | Type | Description |
|---|---|---|
| order.charge.charge_item_uuid | String | Unique identifier of the charge item. |
| order.charge.item_uuid | String | Unique identifier of the item. |
| order.charge.item_id | String | Item's code or ID. |
| order.charge.item_name | String | Name of the item. |
| order.charge.item_order_quantity | String | Ordered quantity of the item. |
| order.charge.shipping_cost | String | Shipping cost for this item. |
| order.charge.item_invoice_note | String | Additional notes for the invoice. |
| order.charge.item_description | String | Description of the item. |
| order.charge.item_type | String | Type of the item (e.g., STANDARD). |
| order.charge.item_charge_type | String | Charge type (e.g., ONE_OFF). |
| order.charge.item_custom_attributes | Array | Any custom attributes associated with the item. |
| order.charge.item_price_snapshot | Object | Pricing rule snapshot applied to the item. |
| order.charge.item_sale_tax_configuration | Object | Sale tax configuration for the item. |
| order.charge.tax_exempt_when_sold | String | Indicates whether the item is tax-exempt when sold. |
| order.charge.item_price_tax | Object | Tax details such as code, rate, and tax link. |
| order.charge.item_accounting_code | Object | Accounting code such as sales revenue account. |
| order.charge.version | String | Version of the item configuration. |
| order.charge.expected_delivery_date | String | Expected delivery date for the item. |
| order.kpis | Object | Key performance indicators of the order including revenue and invoices. |
| order.line_items | Array | An array (empty in this case) for additional line item objects. |