Get 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
| Category | Parameter / Field | Type | Operators | Description | Example |
|---|---|---|---|---|---|
| Sorting | order_by | string | – | Field name to sort results. | order_by=code |
| direction | string | – | Sorting direction. Accepts asc or desc. | direction=asc | |
| Pagination | limit | integer | – | Number of records per page. | limit=20 |
| offset | integer | – | Records to skip from the start. | offset=0 | |
| Filtering | status | constant | eq, ne | Filter by order status. | orders/status eq 'ACTIVE' |
| code | string | eq, ne, contain, not_contain | Filter by order code. | orders/code contain 'INV' | |
| currency | string | eq, ne, contain, not_contain | Filter by order currency. | orders/currency eq 'AUD' | |
| created_by | string | eq, ne | Filter by creator of the order. | orders/created_by eq 'Implementer' | |
| created_on | date | eq, ne, gt, ge, lt, le | Filter by creation date. Date format: 'yyyy-mm-dd' |
orders/created_on ge datetime'2024-01-01' | |
| last_updated_by | string | eq, ne | Filter by user who last updated. | orders/last_updated_by ne 'Admin' | |
| last_updated_on | date | eq, ne, gt, ge, lt, le | Filter by last update date. Date format: 'yyyy-mm-dd' |
orders/last_updated_on le datetime'2024-12-31' | |
| uuid | string | eq, ne, contain, not_contain | Filter by unique identifier. | orders/uuid eq '123e4567-e89b-12d3-a456-426614174' | |
| account_id | string | eq, ne, contain, not_contain | Filter by linked account. | orders/account_id eq 'ACC123' | |
| invoice_mode | string | eq, ne, contain, not_contain | Filter by invoice mode. | orders/invoice_mode eq 'AUTO' | |
| invoice_term | string | eq, ne, contain, not_contain | Filter by invoice term. | orders/invoice_term eq 'NET30' | |
| billing_period | string | eq, ne, contain, not_contain | Filter by billing period. | orders/billing_period contain 'MONTHLY' | |
| payment_processor | string | eq, ne, contain, not_contain | Filter by payment processor. | orders/payment_processor eq 'Stripe' | |
| payment_mode | string | eq, ne, contain, not_contain | Filter by payment mode. | orders/payment_mode eq 'Credit Card' | |
| payment_term | string | eq, ne, contain, not_contain | Filter by payment term. | orders/payment_term ne NULL | |
| payment_term_alignment | string | eq, ne, contain, not_contain | Filter by payment term alignment. | orders/payment_term_alignment eq 'START_DATE' | |
| fulfillment_mode | string | eq, ne, contain, not_contain | Filter by fulfillment mode. | orders/fulfillment_mode eq 'MANUAL' |
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. |
Get 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 |
Get 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. |
Get 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 |
Get 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. |
Get Order Line Item by ID: /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. |
Get All Notes for a Specific Order: /orders/{order_id}/notes
GET
https://dev-api.exsited.com/api/v3/orders/{order_id}/notes
Try It Out
Purpose
This API retrieves all notes associated with a specific order. Notes allow users to store contextual comments, updates, or supporting information against an order record, optionally with file attachments and custom attributes.
Use Case
- View all notes linked to a customer order.
- Track order history and communication.
- Attach supporting files (example: PDFs, images) to order notes.
- Retrieve metadata such as creator, timestamps, and custom attributes for auditing and reporting.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| order_id | string | Yes | Unique identifier of the order for which notes are being retrieved. |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | int | No | Maximum number of notes to return per request (default: 20). |
| offset | int | No | Number of records to skip before starting to return results (used for pagination). |
Request Body
This endpoint does not require a request body.
Response
The response contains an order object that includes a notes array with one or more note objects and pagination details. Each note provides full information about its content, associated files, author details, creation and update timestamps, and any defined custom attributes. This enables clients to retrieve not only the textual comments but also structured metadata to manage order-related notes effectively. The pagination object provides navigational details for handling large sets of notes across multiple requests.
Response Body
JSON
{
"order": {
"notes": [
{
"uuid": "UUID",
"version": "VERSION",
"content": "NOTE_CONTENT",
"files": [],
"created_by": "CREATED_BY",
"created_on": "CREATED_ON",
"last_updated_by": "LAST_UPDATED_BY",
"last_updated_on": "LAST_UPDATED_ON",
"custom_attributes": [
{
"name": "CUSTOM_ATTRIBUTE_NAME",
"value": "CUSTOM_ATTRIBUTE_VALUE"
},
{
"name": "CUSTOM_ATTRIBUTE_NAME",
"value": "CUSTOM_ATTRIBUTE_VALUE"
}
]
}
],
"pagination": {
"records": "RECORDS",
"limit": "LIMIT",
"offset": "OFFSET",
"previous_page": "PREVIOUS_PAGE",
"next_page": "NEXT_PAGE"
}
}
}| Attribute | Type | Description |
|---|---|---|
| order | object | Container object holding notes and pagination data. |
| order.notes | array | List of notes associated with the order. |
| order.notes[].uuid | string (UUID) | Unique identifier of the note. |
| order.notes[].version | string | Version number of the note (used for concurrency control). |
| order.notes[].content | string (HTML/text) | Content of the note, supports formatted text/HTML. |
| order.notes[].files | array | List of files attached to the note (empty if none). |
| order.notes[].created_by | string | Username or identifier of the user who created the note. |
| order.notes[].created_on | string (date-time) | Timestamp when the note was created (ISO 8601). |
| order.notes[].last_updated_by | string | User who last updated the note (empty if never updated). |
| order.notes[].last_updated_on | string (date-time) | Timestamp of the last update (empty if never updated). |
| order.notes[].custom_attributes | array | List of custom attributes assigned to the note. |
| order.notes[].custom_attributes[].name | string | Name of the custom attribute. |
| order.notes[].custom_attributes[].value | string | Value of the custom attribute. |
| order.pagination | object | Metadata for paginated results. |
| order.pagination.records | integer | Total number of note records retrieved. |
| order.pagination.limit | integer | Limit applied per request. |
| order.pagination.offset | integer | Offset applied for the request. |
| order.pagination.previous_page | string | Link to the previous page of results (empty if none). |
| order.pagination.next_page | string | Link to the next page of results (NULL if none). |
Get a Specific Note from a Specific Order: /orders/{order_id}/notes/{note_uuid}
GET
https://dev-api.exsited.com/api/v3/orders/{order_id}/notes/{note_uuid}
Try It Out
Purpose
This API retrieves the details of a specific note associated with a given order. It allows clients to fetch the full content, metadata, and custom attributes of a single note for auditing, reporting, or contextual reference.
Use Case
- Retrieve the full content of a specific note tied to an order.
- Access metadata (author, timestamps, version) for auditing.
- Fetch and display custom attributes applied to the note.
- Confirm whether attached files exist for the note.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| order_id | string | Yes | Unique identifier of the order to which the note belongs. |
| note_uuid | string (UUID) | Yes | Unique identifier of the specific note to retrieve. |
Query Parameters
This endpoint does not support query parameters.
Request Body
This endpoint does not require a request body.
Response
The response returns an order object that contains a single note object. The note object includes its unique identifier, version, note content (with HTML formatting support), metadata about its creation and updates, attached files (if any), and custom attributes. This structure ensures that consumers of the API have access to both the core content and contextual metadata of the note.
Response Body
JSON
{
"order": {
"note": {
"uuid": "UUID",
"version": "VERSION",
"content": "NOTE_CONTENT",
"files": [],
"created_by": "CREATED_BY",
"created_on": "CREATED_ON",
"last_updated_by": "LAST_UPDATED_BY",
"last_updated_on": "LAST_UPDATED_ON",
"custom_attributes": []
}
}
}| Attribute | Type | Description |
|---|---|---|
| order | object | Container object holding the note data. |
| order.note | object | The specific note associated with the order. |
| order.note.uuid | string (UUID) | Unique identifier of the note. |
| order.note.version | string | Version number of the note (used for concurrency control). |
| order.note.content | string (HTML/text) | Content of the note, supports formatted text/HTML. |
| order.note.files | array | List of files attached to the note (empty if none). |
| order.note.created_by | string | Username or identifier of the user who created the note. |
| order.note.created_on | string (date-time) | Timestamp when the note was created (ISO 8601 format). |
| order.note.last_updated_by | string | User who last updated the note (empty if never updated). |
| order.note.last_updated_on | string (date-time) | Timestamp of the last update (empty if never updated). |
| order.note.custom_attributes | array | List of custom attributes assigned to the note. |
| order.note.custom_attributes[].name | string | Name of the custom attribute. |
| order.note.custom_attributes[].value | string | Value of the custom attribute. |
Get All Files of an Order Note: /orders/{order_id}/notes/{note_uuid}/files
GET
https://dev-api.exsited.com/api/v3/orders/{order_id}/notes/{note_uuid}/files
Try It Out
Purpose
This API retrieves the list of files attached to a specific order note. It allows users to fetch metadata such as file identifiers, names, and versions for further use (example: file download, preview, or audit).
Use Case
- Retrieve all files attached to a specific order note.
- Display or list file names and metadata to end users.
- Enable auditing and version tracking of files linked to notes.
- Support workflows that require file download or preview from note records.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| order_id | string | Yes | Unique identifier of the order to which the note belongs. |
| note_uuid | string (UUID) | Yes | Unique identifier of the note whose files are being retrieved. |
Query Parameters
This endpoint does not support query parameters.
Request Body
This endpoint does not require a request body.
Response
The response returns an order object containing the note, which holds the list of attached files. Each file object provides a unique identifier, the original filename, and its version number. Additionally, the custom_attributes array is included, which may contain user-defined metadata applied to files or notes. This ensures the consumer has access to both system-managed file data and optional user-defined attributes.
Response Body
JSON
{
"order": {
"note": {
"files": [
{
"uuid": "FILE_UUID",
"name": "FILE_NAME",
"version": "FILE_VERSION"
}
],
"custom_attributes": []
}
}
}| Attribute | Type | Description |
|---|---|---|
| order | object | Container object holding the note and file data. |
| order.note | object | The note object containing file and attribute details. |
| order.note.files | array | List of files attached to the note. |
| order.note.files[].uuid | string (UUID) | Unique identifier of the file. |
| order.note.files[].name | string | Original name of the uploaded file. |
| order.note.files[].version | string | Version number of the file (used for version control). |
| order.note.custom_attributes | array | List of custom attributes associated with the note or files. |
| order.note.custom_attributes[].name | string | Name of the custom attribute. |
| order.note.custom_attributes[].value | string | Value of the custom attribute. |
Get a Specific File of an Order Note: /orders/{order_id}/notes/{note_uuid}/files/{file_uuid}
GET
https://dev-api.exsited.com/api/v3/orders/{order_id}/notes/{note_uuid}/files/{file_uuid}
Try It Out
Purpose
This API retrieves detailed metadata of a single file attached to a specific order note. It allows clients to fetch file information such as UUID, name, and version for validation, auditing, or preparing for file download.
Use Case
- Retrieve details of a specific file attached to an order note.
- Validate file metadata before download or further processing.
- Track file versions for auditing and compliance.
- Display individual file details in user interfaces.
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| order_id | string | Yes | Unique identifier of the order. |
| note_uuid | string (UUID) | Yes | Unique identifier of the order note. |
| file_uuid | string (UUID) | Yes | Unique identifier of the file attached to the note. |
Query Parameters
This endpoint does not support query parameters.
Request Body
No request body is required for this endpoint.
Response
The response provides the order object containing the note, which includes a single file object. The file object carries metadata such as the unique identifier, original filename, and version of the file. Additionally, custom_attributes may hold user-defined metadata that can extend the standard file details, allowing flexibility in business-specific workflows.
Response Body
JSON
{
"order": {
"note": {
"file": {
"uuid": "FILE_UUID",
"name": "FILE_NAME",
"version": "FILE_VERSION"
},
"custom_attributes": []
}
}
}| Attribute | Type | Description |
|---|---|---|
| order | object | Container object holding the note and file details. |
| order.note | object | The note object containing the file and attributes. |
| order.note.file | object | Metadata of the requested file. |
| order.note.file.uuid | string (UUID) | Unique identifier of the file. |
| order.note.file.name | string | Original name of the uploaded file. |
| order.note.file.version | string | Version number of the file (used for version tracking). |
| order.note.custom_attributes | array | List of custom attributes associated with the note or file. |
| order.note.custom_attributes[].name | string | Name of the custom attribute. |
| order.note.custom_attributes[].value | string | Value of the custom attribute. |
Get Specific Order Details from Bulk Order: /bulk_result/{bulk_id}/{request_id}
GET
https://dev-api.exsited.com/api/v3/bulk_result/{bulk_id}/{request_id}
Try It Out
Purpose
This API retrieves the details of a specific order processed under a bulk operation. A Bulk ID represents the parent bulk job (example: importing or processing up to 500 orders at once), and each individual order inside that bulk job is assigned a Request ID. This endpoint allows you to extract details of a single order by referencing both its Bulk ID and Request ID.
Use Case
- Retrieve the details of a specific order processed as part of a bulk job.
- Audit or troubleshoot an individual order request within a bulk submission.
- Validate the success or failure status of one order without checking the entire bulk result.
- Fetch contract, billing, pricing, and line item details for a particular order in the bulk job.
- Extract a single order’s information for integration with external systems (example: ERP, invoicing, or fulfillment systems).
- Use in error handling workflows to reprocess or correct specific failed orders from a bulk job.
- Simplify reporting and reconciliation by pulling out details of one order among hundreds in a bulk run.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| bulk_id | string | Unique identifier of the bulk request. |
| request_id | string | Unique identifier of the specific request inside the bulk operation. |
Query Parameters
This endpoint does not accept query parameters.
Request Body
This endpoint does not require a request body.
Response
On success, the API returns detailed information about the specific order corresponding to the given bulk_id and request_id. The response contains attributes describing the order’s status, identifiers, pricing, billing, shipping, contracts, custom attributes, line items, and KPIs. The response can include nested objects (example: currency, time zone, contract properties, item properties, tax details). This allows users to fully understand the order configuration, pricing structure, and processing metadata at the request level within the bulk operation.
Response Body
JSON
{
"order": {
"status": "ACTIVE",
"id": "ORD-XXXXX-1234",
"pre_order": "false",
"quote_order": "false",
"name": "Sample Order Name",
"display_name": "Sample Display Name",
"description": "",
"manager": "",
"referral_account": "",
"customer_purchase_order_id": "",
"shipping_profile": {},
"shipping_cost": "0.000000",
"discount_profile": null,
"origin": "",
"custom_forms": {
"uuid": "form-uuid",
"name": "Default Form"
},
"currency": {
"uuid": "currency-uuid",
"name": "USD",
"link": "https://{{domain_stage}}/api/v1/currencies/currency-uuid"
},
"time_zone": {
"uuid": "tz-uuid",
"name": "America/New_York",
"link": "https://{{domain_stage}}/api/v1/time_zones/tz-uuid"
},
"invoice_note": "",
"billing_start_date": "ORDER_START_DATE",
"order_start_date": "2025-09-29T00:00:00Z",
"next_billing_from_date": "2025-10-01 00:00:00.000000",
"next_billing_from_date_utc": "2025-09-30T14:00:00Z",
"price_tax_inclusive": "true",
"billing_address": {},
"shipping_address": {},
"created_by": "System",
"created_on": "2025-09-29T03:22:05Z",
"last_updated_by": "",
"last_updated_on": "",
"uuid": "order-uuid",
"version": "1",
"account_id": "ACC-1234",
"account_name": "Sample Account",
"allow_contract": "true",
"contract_properties": {
"require_customer_acceptance": "false",
"requires_payment_method": "false",
"initial_contract_term": "1 Year",
"renew_automatically": "true",
"auto_renewal_ends_on": "",
"auto_renewal_term": "1 Week",
"auto_renewal_require_customer_acceptance": "false",
"allow_early_termination": "true",
"early_termination_minimum_period": "",
"apply_early_termination_charge": "false",
"early_termination_charge_type": "Fixed",
"termination_fixed_charge": "",
"termination_accounting_code": "",
"allow_postponement": "true",
"maximum_duration_per_postponement": "1 Day",
"maximum_postponement_count": "1",
"allow_trial": "false",
"allow_downgrade": "true",
"period_before_downgrade": "",
"allow_downgrade_charge": "false",
"downgrade_charge_type": "Fixed",
"downgrade_charge_fixed": "",
"allow_upgrade": "true",
"termination_notice_period": ""
},
"custom_attributes": [
{
"name": "Custom_Field_1",
"value": "Value1"
}
],
"custom_objects": [],
"currency_id": "32",
"properties": {
"communication_profile": "",
"invoice_mode": "AUTOMATIC",
"invoice_term": "Billing Start Date",
"billing_period": "1 Month",
"consolidate_invoice": "true",
"consolidate_key": "key-uuid",
"payment_processor": "Cash",
"payment_mode": "AUTOMATIC",
"payment_term": "Due on Receipt",
"payment_term_alignment": "BILLING_DATE",
"fulfillment_mode": "MANUAL",
"fulfillment_term": "Immediately"
},
"invoice_id": "INV-XXXX",
"lines": [
{
"charge_item_uuid": "charge-item-uuid",
"item_uuid": "item-uuid",
"item_id": "0001",
"item_name": "Sample Item",
"item_order_quantity": "1.000000",
"shipping_cost": "0.00",
"item_invoice_note": "",
"item_description": "",
"item_type": "FAMILY",
"item_charge_type": "RECURRING",
"item_custom_attributes": [
{
"name": "Custom_Item_Field",
"value": "Value"
}
],
"item_properties": {
"billing_mode": "IN_ADVANCE",
"charging_period": "Same as billing period",
"charging_start_date": "SUBSCRIPTION_START_DATE",
"fixed_start_date": "",
"charging_and_billing_alignment": "true"
},
"item_price_snapshot": {
"pricing_rule": {
"uuid": "pricing-rule-uuid",
"version": "1",
"price_type": "PER_UNIT_PRICING",
"price": "0.000000",
"pricing_method": "0.000000"
}
},
"item_sale_tax_configuration": {
"sale_price_is_based_on": "SALES_TAX",
"tax_code": {
"uuid": "",
"code": "",
"rate": "",
"link": ""
}
},
"item_price_tax": {
"uuid": "tax-uuid",
"code": "No Tax",
"rate": 0.0000,
"link": "https://{{domain_stage}}/api/v3/settings/taxes/tax-uuid"
},
"version": "1",
"package_name": "Basic Package",
"purchase_order_id": "",
"purchase_invoice_id": "",
"discount": 0,
"total": "0",
"subtotal": "0",
"tax": "0"
}
],
"total": "0",
"subtotal": "0",
"tax": "0",
"kpis": {
"start_date": "",
"estimated_total": 0,
"total_revenue": 0,
"monthly_recurring_revenue": 0,
"total_collected": 0,
"total_outstanding": 0,
"total_due": 0,
"last_invoice_issue_date": "",
"last_invoice_total": 0,
"total_invoice": 0,
"next_invoice_issueDate": ""
},
"line_items": []
}
}
| Attribute | Type | Description |
|---|---|---|
| order | object | The order object containing all order details retrieved from the bulk operation. |
| order.status | string | Status of the order (example: ACTIVE, INACTIVE). |
| order.id | string | Unique identifier of the order. |
| order.name | string | Internal name of the order. |
| order.display_name | string | Display name shown in UI. |
| order.account_id | string | Associated account ID. |
| order.account_name | string | Name of the account linked to this order. |
| order.currency | object | Currency details including UUID, name, and link. |
| order.contract_properties | object | Contract settings like renewal, downgrade, termination options. |
| order.custom_attributes | array | Custom fields associated with the order. |
| order.lines | array | Line items purchased in the order with pricing and tax details. |
| order.kpis | object | Key performance indicators such as revenue, outstanding amounts, invoices. |
| order.created_by | string | User or system that created the order. |
| order.created_on | datetime | Timestamp when the order was created. |
| order.last_updated_by | string | User who last updated the order. |
| order.last_updated_on | datetime | Timestamp of last update. |
Get Orders for an Specific Account: /accounts/{account_id}/orders
GET
https://dev-api.exsited.com/api/v3/accounts/{account_id}/orders
Try It Out
Purpose
This API retrieves all orders associated with a specific account. It provides comprehensive order-level information including general order details, financial summaries, billing and shipping data, order lines, pricing and taxation details, and KPI metrics. This endpoint is primarily used for displaying or managing a customer’s order history, retrieving order details for billing or reporting, and integrating order data with external systems such as CRM, ERP, or accounting platforms.
Use Case
- Retrieve all orders belonging to a specific account.
- Display order lists and summaries in a customer or admin dashboard.
- Fetch financial and KPI data for reporting or analytics.
- Integrate order details with ERP or invoice generation systems.
- Retrieve line item and pricing information for each order.
- Validate order states such as ACTIVE, CANCELLED, or PENDING.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| account_id | string | Unique identifier of the account. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | integer | Specifies the number of records per page. |
| offset | integer | Specifies the starting point for pagination. |
| status | string | Filter orders by status. |
| sort | string | Sort the results by a specific field. |
Request Body
This endpoint does not require a request body.
Response
On success, the API returns a list of all orders associated with the specified account. Each order includes general order information (such as status, name, description, and timestamps), currency and timezone details, pricing configuration, billing and shipping details, and line item details including pricing, tax, and accounting information. The response also includes key financial metrics and pagination metadata for efficient traversal across large datasets. This endpoint enables users and integrations to analyze, manage, or display comprehensive order information at the account level.
Response Body
JSON
{
"account": {
"orders": [
{
"status": "{{status}}",
"id": "{{order_id}}",
"pre_order": "{{boolean}}",
"quote_order": "{{boolean}}",
"name": "{{order_name}}",
"display_name": "{{display_name}}",
"description": "{{description}}",
"manager": "{{manager_name}}",
"referral_account": "{{referral_account}}",
"customer_purchase_order_id": "{{customer_po_id}}",
"shipping_profile": {},
"shipping_cost": "{{shipping_cost}}",
"discount_profile": "{{discount_profile}}",
"origin": "{{origin}}",
"custom_forms": {
"uuid": "{{form_uuid}}",
"name": "{{form_name}}"
},
"currency": {
"uuid": "{{currency_uuid}}",
"name": "{{currency_name}}",
"link": "{{currency_link}}"
},
"time_zone": {
"uuid": "{{timezone_uuid}}",
"name": "{{timezone_name}}",
"link": "{{timezone_link}}"
},
"invoice_note": "{{invoice_note}}",
"communication_preference": [
{
"media": "{{communication_media}}",
"isEnabled": "{{boolean}}"
}
],
"billing_start_date": "{{billing_start_date}}",
"order_start_date": "{{order_start_date}}",
"next_billing_from_date": "{{next_billing_from_date}}",
"price_tax_inclusive": "{{boolean}}",
"billing_address": {},
"shipping_address": {},
"created_by": "{{created_by}}",
"created_on": "{{created_on}}",
"last_updated_by": "{{last_updated_by}}",
"last_updated_on": "{{last_updated_on}}",
"uuid": "{{order_uuid}}",
"version": "{{version}}",
"account_id": "{{account_id}}",
"account_name": "{{account_name}}",
"allow_contract": "{{boolean}}",
"custom_attributes": [
{
"name": "{{attribute_name}}",
"value": "{{attribute_value}}"
}
],
"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}}",
"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}}"
},
"invoice_id": "{{invoice_id}}",
"lines": [
{
"item_serial_or_batch_number": "{{serial_or_batch_number}}",
"charge_item_uuid": "{{charge_item_uuid}}",
"item_uuid": "{{item_uuid}}",
"item_id": "{{item_id}}",
"item_name": "{{item_name}}",
"item_order_quantity": "{{item_order_quantity}}",
"shipping_cost": "{{shipping_cost}}",
"item_invoice_note": "{{item_invoice_note}}",
"item_description": "{{item_description}}",
"item_type": "{{item_type}}",
"item_charge_type": "{{item_charge_type}}",
"item_custom_attributes": [],
"item_price_snapshot": {
"pricing_rule": {
"uuid": "{{pricing_rule_uuid}}",
"version": "{{pricing_version}}",
"price_type": "{{price_type}}",
"price": "{{price}}",
"uom": "{{uom}}",
"pricing_method": "{{pricing_method}}",
"warehouse": "{{warehouse}}"
}
},
"item_sale_tax_configuration": {
"sale_price_is_based_on": "{{sale_price_basis}}",
"tax_code": {
"uuid": "{{tax_uuid}}",
"code": "{{tax_code}}",
"rate": "{{tax_rate}}",
"link": "{{tax_link}}"
}
},
"isTaxExemptWhenSold": "{{boolean}}",
"item_price_tax": {
"uuid": "{{tax_uuid}}",
"code": "{{tax_code}}",
"rate": "{{tax_rate}}",
"link": "{{tax_link}}"
},
"item_accounting_code": {
"sales_revenue": "{{sales_revenue_code}}"
},
"version": "{{version}}",
"expected_delivery_date": "{{expected_delivery_date}}",
"purchase_order_id": "{{purchase_order_id}}",
"purchase_invoice_id": "{{purchase_invoice_id}}",
"discount": "{{discount}}",
"total": "{{total}}",
"subtotal": "{{subtotal}}",
"tax": "{{tax}}"
}
],
"total": "{{total}}",
"subtotal": "{{subtotal}}",
"tax": "{{tax}}",
"kpis": {
"start_date": "{{start_date}}",
"estimated_total": "{{estimated_total}}",
"total_revenue": "{{total_revenue}}",
"monthly_recurring_revenue": "{{mrr}}",
"total_collected": "{{total_collected}}",
"total_outstanding": "{{total_outstanding}}",
"total_due": "{{total_due}}"
},
"line_items": []
}
],
"pagination": {
"records": "{{records}}",
"limit": "{{limit}}",
"offset": "{{offset}}",
"previous_page": "{{previous_page}}",
"next_page": "{{next_page}}"
}
}
}
| Attribute | Type | Description |
|---|---|---|
| account | object | Contains all order data related to the account. |
| account.orders | array | List of all orders under the account. |
| account.orders[].status | string | Current status of the order. |
| account.orders[].id | string | Unique order identifier. |
| account.orders[].name | string | Order name. |
| account.orders[].display_name | string | Display-friendly name of the order. |
| account.orders[].currency | object | Currency details of the order. |
| account.orders[].time_zone | object | Time zone used for the order. |
| account.orders[].communication_preference | array | Preferred communication methods for the order. |
| account.orders[].lines | array | Line items included in the order. |
| account.orders[].lines[].item_name | string | Name of the ordered item. |
| account.orders[].lines[].item_order_quantity | number | Quantity of the ordered item. |
| account.orders[].lines[].item_price_snapshot | object | Pricing rule snapshot applied at the time of the order. |
| account.orders[].lines[].item_sale_tax_configuration | object | Tax configuration for the item. |
| account.orders[].lines[].item_price_tax | object | Tax details applied to the item. |
| account.orders[].lines[].item_accounting_code | object | Accounting code for sales revenue. |
| account.orders[].subtotal | number | Order subtotal before tax. |
| account.orders[].tax | number | Total tax applied. |
| account.orders[].total | number | Grand total for the order. |
| account.orders[].kpis | object | Key performance indicators and financial metrics. |
| account.pagination | object | Pagination details for navigating through records. |
Get PDF of an Specific Order: /orders/{order_id}/pdf
GET
https://dev-api.exsited.com/api/v3/orders/{order_id}/pdf
Try It Out
Purpose
This endpoint retrieves the PDF representation of a specific order identified by its order ID. It provides the order in a ready-to-download and shareable format, including all relevant billing, item, and payment details.
Use Case
Businesses or users can use this endpoint to generate a detailed PDF of an order for record-keeping, sharing with customers, or auditing purposes. For example, a client might request a copy of their invoice in PDF format for their own financial tracking.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| order_id | String | Unique identifier of the order. |
Query Parameters
No query parameter is required for this endpoint.
Request Body
No data is required for the request body.
Response
The response is a PDF file containing the full order details, including the billing and shipping addresses, itemized charges, tax information, and total amount paid or due.
Response Body
