Get Order List: /orders
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
converted_order
Filter converted order (eq, ne)
| Parameter | Type | Description |
|---|---|---|
| order_by | string | Field name to sort results. |
| direction | string | Sorting direction. Accepts asc or desc. |
| limit | integer | Number of records per page. |
| offset | integer | Records to skip from the start. |
| status | constant | Filter by order status. |
| code | string | Filter by order code. |
| currency | string | Filter by order currency. |
| created_by | string | Filter by creator of the order. |
| created_on | date | Filter by creation date. Date format: 'yyyy-mm-dd' |
| last_updated_by | string | Filter by user who last updated. |
| last_updated_on | date | Filter by last update date. Date format: 'yyyy-mm-dd' |
| uuid | string | Filter by unique identifier. |
| account_id | string | Filter by linked account. |
| invoice_mode | string | Filter by invoice mode. |
| invoice_term | string | Filter by invoice term. |
| billing_period | string | Filter by billing period. |
| payment_processor | string | Filter by payment processor. |
| payment_mode | string | Filter by payment mode. |
| quote_order | string | Filter by quote order |
| converted_order | string | Filter by converted order (eq, ne) |
| payment_term | string | Filter by payment term. |
| payment_term_alignment | string | Filter by payment term alignment. |
| fulfillment_mode | string | Filter by fulfillment mode. |
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.
Response Body
{
"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. |
| status | String | Status of the order . |
| id | String | Unique identifier of the order. |
| pre_order | String | Indicates if it is a pre-order (true/false). |
| quote_order | String | Indicates if it is a quote order (true/false). |
| name | String | Internal or user-defined name of the order. |
| display_name | String | Display name shown in the UI. |
| description | String | Description of the order. |
| referral_account | String | Linked referral account (if any). |
| customer_purchase_order_id | String | Customer-provided purchase order ID. |
| shipping_profile | Object | Shipping profile details (may be empty). |
| shipping_cost | String | Total shipping cost of the order. |
| discount_profile | Object/null | Discount profile applied to the order. |
| origin | String | Source/origin tag of the order. |
| custom_forms | Object | Custom form attached to the order. |
| currency | Object | Currency used for the order (uuid, name, link). |
| time_zone | Object | Time zone info (uuid, name, link). |
| invoice_note | String | Notes shown on the invoice. |
| communication_preference | Array | List of communication methods (EMAIL). |
| billing_start_date | String | Billing start date placeholder or actual value. |
| order_start_date | DateTime | Start date of the order. |
| next_billing_from_date | String | Next billing cycle date (if any). |
| price_tax_inclusive | String | Indicates if tax is included in the prices. |
| billing_address | Object | Full billing address details. |
| shipping_address | Object | Full shipping address details. |
| created_by | String | User who created the order. |
| created_on | DateTime | Timestamp when the order was created. |
| last_updated_by | String | User who last updated the order. |
| last_updated_on | DateTime | Timestamp when the order was last updated. |
| uuid | String | UUID of the order. |
| version | String | Version number of the order. |
| account_id | String | Linked account ID for the order. |
| allow_contract | String | Indicates whether contracts are allowed. |
| custom_attributes | Array | List of custom attributes (if any). |
| custom_objects | Array | List of custom objects (if any). |
| currency_id | String | Internal currency ID reference. |
| properties | Object | Key-value configuration related to billing, payment, and fulfillment. |
| lines | Array | List of ordered line items. |
| item_name | String | Name of the item ordered. |
| item_order_quantity | String | Quantity ordered. |
| item_price_snapshot | Object | Pricing rule snapshot for the item. |
| item_price_tax | Object | Tax configuration and rates for the item. |
| kpis | Object | Key performance indicators (revenue, due amounts, etc.). |
| 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}
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.
Response Body
{
"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 |
|---|---|---|
| id | String | Unique order identifier |
| name | String | Name of the order |
| status | String | Status of the order |
| account_id | String | Associated account ID |
| order_start_date | String | Start date of the order (ISO 8601 format) |
| billing_start_date | String | Billing start date placeholder or actual date |
| currency.name | String | Currency used |
| time_zone.name | String | Time zone for order-related operations |
| communication_preference | Array | Preferred media for order communication |
| properties | Object | Order properties including invoice mode, payment terms, and fulfillment |
| lines[] | Array | List of order line items with pricing, tax, and charge configuration |
| kpis | Object | Key performance indicators like revenue, MRR, due, collected, etc. |
| created_by | String | Name of the user who created the order |
| created_on | String | Timestamp when the order was created |
| last_updated_by | String | Name of the user who last updated the order |
| last_updated_on | String | Timestamp of the last order update |
| uuid | String | UUID of the order |
| version | String | Version number of the order record |
Get Order Information: /orders/{order_id}/information
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.
Response Body
{
"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
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.
Response Body
{
"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
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.
Response Body
{
"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 |
|---|---|---|
| lines | Array | List of line items in the order. |
| charge_item_uuid | String | Unique identifier of the charge item. |
| .item_uuid | String | Unique identifier of the item. |
| item_id | String | Item code used in the system. |
| item_name | String | Name of the item. |
| item_order_quantity | String | Quantity of the item ordered. |
| shipping_cost | String | Shipping cost associated with the item. |
| item_invoice_note | String | Note included on invoice for the item. |
| item_description | String | Description of the item. |
| item_type | String | Type of item, e.g., STANDARD. |
| item_charge_type | String | Charge type, e.g., ONE_OFF or RECURRING. |
| item_custom_attributes | Array | Custom attributes related to the item. |
| item_price_snapshot | Object | Pricing snapshot of the item at the time of order. |
| pricing_rule | Object | Pricing rule details (UUID, version, type, amount, warehouse, etc.). |
| item_sale_tax_configuration | Object | Tax configuration and basis for sale price. |
| tax_exempt_when_sold | String | Indicates if the item is tax-exempt when sold. |
| item_price_tax | Object | Tax code applied to the item, including rate and reference link. |
| item_accounting_code | Object | Accounting code used for item revenue categorization. |
| version | String | Version of the line item. |
| expected_delivery_date | String | Expected delivery date of the item, if any. |
| item_properties | Object | (If present) Advanced billing/charging options like pro-rata flags, etc. |
| kpis | Object | Key performance indicators for the order (total, MRR, invoices, etc.). |
| line_items | Array | (Deprecated or empty) List of legacy line item entries. |
Get Order Line Item by ID: /orders/{order_id}/lines/{line_uuid}
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.
Response Body
{
"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 |
|---|---|---|
| charge_item_uuid | String | Unique identifier of the charge item. |
| item_uuid | String | Unique identifier of the item. |
| item_id | String | Item's code or ID. |
| item_name | String | Name of the item. |
| item_order_quantity | String | Ordered quantity of the item. |
| shipping_cost | String | Shipping cost for this item. |
| item_invoice_note | String | Additional notes for the invoice. |
| item_description | String | Description of the item. |
| item_type | String | Type of the item (e.g., STANDARD). |
| item_charge_type | String | Charge type (e.g., ONE_OFF). |
| item_custom_attributes | Array | Any custom attributes associated with the item. |
| item_price_snapshot | Object | Pricing rule snapshot applied to the item. |
| item_sale_tax_configuration | Object | Sale tax configuration for the item. |
| tax_exempt_when_sold | String | Indicates whether the item is tax-exempt when sold. |
| item_price_tax | Object | Tax details such as code, rate, and tax link. |
| item_accounting_code | Object | Accounting code such as sales revenue account. |
| version | String | Version of the item configuration. |
| expected_delivery_date | String | Expected delivery date for the item. |
| kpis | Object | Key performance indicators of the order including revenue and invoices. |
| 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
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 | Description |
|---|---|---|
| order_id | string | Unique identifier of the order for which notes are being retrieved. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | int | Maximum number of notes to return per request (default: 20). |
| offset | int | 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
{
"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. |
| notes | array | List of notes associated with the order. |
| uuid | string (UUID) | Unique identifier of the note. |
| version | string | Version number of the note (used for concurrency control). |
| content | string (HTML/text) | Content of the note, supports formatted text/HTML. |
| files | array | List of files attached to the note (empty if none). |
| created_by | string | Username or identifier of the user who created the note. |
| created_on | string (date-time) | Timestamp when the note was created (ISO 8601). |
| last_updated_by | string | User who last updated the note (empty if never updated). |
| last_updated_on | string (date-time) | Timestamp of the last update (empty if never updated). |
| custom_attributes | array | List of custom attributes assigned to the note. |
| name | string | Name of the custom attribute. |
| value | string | Value of the custom attribute. |
| pagination | object | Metadata for paginated results. |
| records | integer | Total number of note records retrieved. |
| limit | integer | Limit applied per request. |
| offset | integer | Offset applied for the request. |
| previous_page | string | Link to the previous page of results (empty if none). |
| 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}
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 | Description |
|---|---|---|
| order_id | string | Unique identifier of the order to which the note belongs. |
| note_uuid | string (UUID) | 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
{
"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. |
| note | object | The specific note associated with the order. |
| note.uuid | string (UUID) | Unique identifier of the note. |
| version | string | Version number of the note (used for concurrency control). |
| content | string (HTML/text) | Content of the note, supports formatted text/HTML. |
| files | array | List of files attached to the note (empty if none). |
| created_by | string | Username or identifier of the user who created the note. |
| created_on | string (date-time) | Timestamp when the note was created (ISO 8601 format). |
| last_updated_by | string | User who last updated the note (empty if never updated). |
| last_updated_on | string (date-time) | Timestamp of the last update (empty if never updated). |
| custom_attributes | array | List of custom attributes assigned to the note. |
| name | string | Name of the custom attribute. |
| value | string | Value of the custom attribute. |
Get All Files of an Order Note: /orders/{order_id}/notes/{note_uuid}/files
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 | Description |
|---|---|---|
| order_id | string | Unique identifier of the order to which the note belongs. |
| note_uuid | string (UUID) | 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
{
"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. |
| note | object | The note object containing file and attribute details. |
| files | array | List of files attached to the note. |
| uuid | string (UUID) | Unique identifier of the file. |
| name | string | Original name of the uploaded file. |
| version | string | Version number of the file (used for version control). |
| custom_attributes | array | List of custom attributes associated with the note or files. |
| name | string | Name of the custom attribute. |
| value | string | Value of the custom attribute. |
Get a Specific File of an Order Note: /orders/{order_id}/notes/{note_uuid}/files/{file_uuid}
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 | Description |
|---|---|---|
| order_id | string | Unique identifier of the order. |
| note_uuid | string | Unique identifier of the order note. |
| file_uuid | string | 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
{
"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. |
| note | object | The note object containing the file and attributes. |
| note.file | object | Metadata of the requested file. |
| file.uuid | string (UUID) | Unique identifier of the file. |
| file.name | string | Original name of the uploaded file. |
| file.version | string | Version number of the file (used for version tracking). |
| custom_attributes | array | List of custom attributes associated with the note or file. |
| name | string | Name of the custom attribute. |
| value | string | Value of the custom attribute. |
Get Specific Order Details from Bulk Order: /bulk_result/{bulk_id}/{request_id}
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
{
"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. |
| status | string | Status of the order (example: ACTIVE, INACTIVE). |
| id | string | Unique identifier of the order. |
| name | string | Internal name of the order. |
| display_name | string | Display name shown in UI. |
| account_id | string | Associated account ID. |
| account_name | string | Name of the account linked to this order. |
| currency | object | Currency details including UUID, name, and link. |
| contract_properties | object | Contract settings like renewal, downgrade, termination options. |
| custom_attributes | array | Custom fields associated with the order. |
| lines | array | Line items purchased in the order with pricing and tax details. |
| kpis | object | Key performance indicators such as revenue, outstanding amounts, invoices. |
| created_by | string | User or system that created the order. |
| created_on | datetime | Timestamp when the order was created. |
| last_updated_by | string | User who last updated the order. |
| last_updated_on | datetime | Timestamp of last update. |
Get Orders for an Specific Account: /accounts/{account_id}/orders
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
{
"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. |
| orders | array | List of all orders under the account. |
| status | string | Current status of the order. |
| id | string | Unique order identifier. |
| name | string | Order name. |
| display_name | string | Display-friendly name of the order. |
| currency | object | Currency details of the order. |
| time_zone | object | Time zone used for the order. |
| communication_preference | array | Preferred communication methods for the order. |
| lines | array | Line items included in the order. |
| item_name | string | Name of the ordered item. |
| item_order_quantity | number | Quantity of the ordered item. |
| item_price_snapshot | object | Pricing rule snapshot applied at the time of the order. |
| item_sale_tax_configuration | object | Tax configuration for the item. |
| item_price_tax | object | Tax details applied to the item. |
| item_accounting_code | object | Accounting code for sales revenue. |
| subtotal | number | Order subtotal before tax. |
| tax | number | Total tax applied. |
| total | number | Grand total for the order. |
| kpis | object | Key performance indicators and financial metrics. |
| pagination | object | Pagination details for navigating through records. |
Get PDF of an Specific Order: /orders/{order_id}/pdf
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
Retrieve Notes Across All Orders: /orders/notes
Purpose
Retrieve notes across every order in the system in a single paginated response, without requiring a specific order ID. This endpoint aggregates notes from all orders and returns them under a unified order.notes collection, giving consumers a global view of order-related communications, annotations, and contextual information. Each note in the response contains its HTML-formatted content, attached files, audit metadata (creator, creation timestamp, last editor, last update timestamp), a version number for optimistic concurrency control, and a watcher list divided into internal and external participants. Pagination is supported through limit and offset query parameters, making it efficient to iterate through large result sets without loading everything into memory at once.
Use Case
This endpoint is used to build organization-wide dashboards or audit views of order communications without having to query each order individually. Compliance and audit teams can use it to scan all order notes in chronological order to verify that required approvals, comments, and sign-offs are present across the entire order book. Customer success and operations teams can leverage the aggregated view to monitor recent activity, flag stale threads, or identify orders requiring follow-up. Integration systems commonly use this endpoint to synchronize order notes into external CRM, ticketing, or reporting platforms, paginating through the complete set to keep downstream systems current. It also supports analytical workflows where teams need to measure communication volume, watcher involvement, or custom attribute usage across the entire order portfolio.
Path Parameters
No path parameters required.
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| records | Integer | Total number of matching records (optional) |
| limit | Integer | Maximum number of notes to return (optional) |
| offset | Integer | Number of records to skip for pagination (optional) |
| previous_page | String (URL) | URL for the previous page (optional) |
| next_page | String (URL) | URL for the next page (optional) |
Request Body
This endpoint does not require a request body.
Response
Returns a paginated list of notes aggregated across all orders. Each note object includes its UUID, version number, HTML-formatted content, an array of attached files, full audit fields (created_by, created_on, last_updated_by, last_updated_on), and a watcherList object split into internal_watchers (organization users identified by email) and external_watchers (external contacts identified by email and account ID). Each note also carries an array of custom attributes for tenant-specific metadata. The pagination object at the same level as the notes array contains the total record count, the current limit and offset, and URLs for the previous and next pages to simplify iteration.
Response Body
{
"order": {
"notes": [
{
"uuid": "NOTE_UUID",
"version": "NOTE_VERSION",
"content": "NOTE_CONTENT_HTML",
"files": [],
"created_by": "CREATED_BY_USER",
"created_on": "CREATED_ON_DATETIME",
"last_updated_by": "LAST_UPDATED_BY_USER",
"last_updated_on": "LAST_UPDATED_ON_DATETIME",
"watcherList": {
"internal_watchers": [
{
"email": "INTERNAL_WATCHER_EMAIL"
}
],
"external_watchers": [
{
"email": "EXTERNAL_WATCHER_EMAIL",
"account_id": "WATCHER_ACCOUNT_ID"
}
]
},
"custom_attributes": []
}
],
"pagination": {
"records": "TOTAL_RECORD_COUNT",
"limit": "PAGE_LIMIT",
"offset": "PAGE_OFFSET",
"previous_page": "PREVIOUS_PAGE_URL",
"next_page": "NEXT_PAGE_URL"
}
}
}| Attribute | Type | Description |
|---|---|---|
| order.notes | Array | Aggregated list of notes across all orders |
| uuid | String (UUID) | Unique identifier for the note |
| version | String | Version number of the note |
| content | String (HTML) | Note content, may contain HTML markup |
| files | Array | Files attached to the note |
| created_by | String | Username of the note creator |
| created_on | String (ISO 8601) | Timestamp when the note was created |
| last_updated_by | String | Username of the last editor |
| last_updated_on | String (ISO 8601) | Timestamp of the last update |
| watcherList.internal_watchers | Array | Internal users watching this note |
| watcherList.external_watchers | Array | External contacts watching this note |
| custom_attributes | Array | Custom attributes for the note |
| pagination.records | Integer | Total number of matching notes |
| pagination.limit | Integer | Page size limit |
| pagination.offset | Integer | Current page offset |
| pagination.previous_page | String (URL) | URL for the previous page |
| pagination.next_page | String (URL) | URL for the next page |
Retrieve All Notes Across All Orders: /orders/all_notes
Purpose
Retrieve the complete set of notes across every order in a single paginated response. This endpoint aggregates notes from all orders under a unified order.notes collection, giving consumers a global view of order-related communications, annotations, and contextual information. Each note in the response contains its HTML-formatted content, attached files, audit metadata (creator, creation timestamp, last editor, last update timestamp), a version number for optimistic concurrency control, and a watcher list divided into internal and external participants. Pagination is supported through limit and offset query parameters to support efficient traversal of large datasets.
Use Case
This endpoint is used to build organization-wide dashboards or audit views of order communications without having to query each order individually. Compliance and audit teams scan all order notes in chronological order to verify required approvals, comments, and sign-offs exist across the entire order book. Customer success and operations teams leverage the aggregated view to monitor recent activity, flag stale threads, or identify orders requiring follow-up. Integration systems use this endpoint to synchronize order notes into external CRM, ticketing, or reporting platforms, paginating through the full set to keep downstream systems current. Analytical workflows benefit by measuring communication volume, watcher involvement, and custom attribute usage across the entire order portfolio.
Path Parameters
No path parameters required.
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| records | Integer | Total number of matching records (optional) |
| limit | Integer | Maximum number of notes to return (optional) |
| offset | Integer | Number of records to skip for pagination (optional) |
| previous_page | String (URL) | URL for the previous page (optional) |
| next_page | String (URL) | URL for the next page (optional) |
Request Body
This endpoint does not require a request body.
Response
Returns a paginated list of all notes across all orders. Each note object includes its UUID, version, HTML content, attached files array, audit metadata (creator, creation timestamp, last editor, last update timestamp), and a watcherList split into internal and external watchers. Each note also includes an array of custom attributes for tenant-specific metadata. Pagination metadata at the root of the order object provides the total record count, current limit and offset, and URLs for previous and next pages.
Response Body
{
"order": {
"notes": [
{
"uuid": "NOTE_UUID",
"version": "NOTE_VERSION",
"content": "NOTE_CONTENT_HTML",
"files": [],
"created_by": "CREATED_BY_USER",
"created_on": "CREATED_ON_DATETIME",
"last_updated_by": "LAST_UPDATED_BY_USER",
"last_updated_on": "LAST_UPDATED_ON_DATETIME",
"watcherList": {
"internal_watchers": [
{
"email": "INTERNAL_WATCHER_EMAIL"
}
],
"external_watchers": [
{
"email": "EXTERNAL_WATCHER_EMAIL",
"account_id": "WATCHER_ACCOUNT_ID"
}
]
},
"custom_attributes": []
}
],
"pagination": {
"records": "TOTAL_RECORD_COUNT",
"limit": "PAGE_LIMIT",
"offset": "PAGE_OFFSET",
"previous_page": "PREVIOUS_PAGE_URL",
"next_page": "NEXT_PAGE_URL"
}
}
}| Attribute | Type | Description |
|---|---|---|
| order.notes | Array | Aggregated list of notes across all orders |
| uuid | String (UUID) | Unique identifier for the note |
| version | String | Version number of the note |
| content | String (HTML) | Note content, may contain HTML markup |
| files | Array | Files attached to the note |
| created_by | String | Username of the note creator |
| created_on | String (ISO 8601) | Timestamp when the note was created |
| last_updated_by | String | Username of the last editor |
| last_updated_on | String (ISO 8601) | Timestamp of the last update |
| watcherList.internal_watchers | Array | Internal users watching this note |
| watcherList.external_watchers | Array | External contacts watching this note |
| custom_attributes | Array | Custom attributes for the note |
| pagination.records | Integer | Total number of matching notes |
| pagination.limit | Integer | Page size limit |
| pagination.offset | Integer | Current page offset |
| pagination.previous_page | String (URL) | URL for the previous page |
| pagination.next_page | String (URL) | URL for the next page |
Retrieve Notes Across All Quote Order: /quotes/notes
Purpose
Retrieve notes across every quote in the system in a single paginated response, without needing to target a specific quote by ID. This endpoint aggregates quote notes into a unified collection, returning each note with its HTML-formatted content, attached files, audit metadata, version number, and a watcher list split into internal and external participants. It mirrors the structure of the global order notes endpoint, making it straightforward for consumers to reuse parsing and rendering logic across both entity types. Pagination through limit and offset query parameters supports efficient traversal of large result sets, which is especially useful for tenants with a high volume of quoting activity.
Use Case
This endpoint is used to build a global view of quote communications and annotations for sales, revenue, and customer success teams. Sales operations can monitor recent quote activity, track follow-up notes, and identify stale or unresponsive threads without querying each quote individually. Compliance and audit teams can scan across all quotes to verify that required disclosures, approvals, and pricing justifications are documented. Integration systems use the endpoint to synchronize quote notes into external CRM and sales enablement platforms, paginating through the full set to keep downstream systems aligned with the source of truth. Analytics workflows also benefit by aggregating communication volume, watcher participation, and custom attribute patterns to measure quoting effectiveness and collaboration health.
Path Parameters
No path parameters required.
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| records | Integer | Total number of matching records (optional) |
| limit | Integer | Maximum number of notes to return (optional) |
| offset | Integer | Number of records to skip for pagination (optional) |
| previous_page | String (URL) | URL for the previous page (optional) |
| next_page | String (URL) | URL for the next page (optional) |
Request Body
This endpoint does not require a request body.
Response
Returns a paginated list of notes aggregated across all quotes. Although the endpoint targets quotes, the response container is order.notes to preserve structural consistency with the order notes endpoints, allowing consumers to share parsing logic. Each note object includes its UUID, version, HTML content, attached files, audit fields (created_by, created_on, last_updated_by, last_updated_on), and a watcherList with internal_watchers (organization users by email) and external_watchers (external contacts by email and account ID). Custom attributes are returned as an array for tenant-specific metadata. The pagination object provides the total record count, current limit and offset, and URLs for previous and next pages.
Response Body
{
"order": {
"notes": [
{
"uuid": "NOTE_UUID",
"version": "NOTE_VERSION",
"content": "NOTE_CONTENT_HTML",
"files": [],
"created_by": "CREATED_BY_USER",
"created_on": "CREATED_ON_DATETIME",
"last_updated_by": "LAST_UPDATED_BY_USER",
"last_updated_on": "LAST_UPDATED_ON_DATETIME",
"watcherList": {
"internal_watchers": [
{
"email": "INTERNAL_WATCHER_EMAIL"
}
],
"external_watchers": [
{
"email": "EXTERNAL_WATCHER_EMAIL",
"account_id": "WATCHER_ACCOUNT_ID"
}
]
},
"custom_attributes": []
}
],
"pagination": {
"records": "TOTAL_RECORD_COUNT",
"limit": "PAGE_LIMIT",
"offset": "PAGE_OFFSET",
"previous_page": "PREVIOUS_PAGE_URL",
"next_page": "NEXT_PAGE_URL"
}
}
}| Attribute | Type | Description |
|---|---|---|
| order.notes | Array | Aggregated list of notes across all quotes |
| uuid | String (UUID) | Unique identifier for the note |
| version | String | Version number of the note |
| content | String (HTML) | Note content, may contain HTML markup |
| files | Array | Files attached to the note |
| created_by | String | Username of the note creator |
| created_on | String (ISO 8601) | Timestamp when the note was created |
| last_updated_by | String | Username of the last editor |
| last_updated_on | String (ISO 8601) | Timestamp of the last update |
| watcherList.internal_watchers | Array | Internal users watching this note |
| watcherList.external_watchers | Array | External contacts watching this note |
| custom_attributes | Array | Custom attributes for the note |
| pagination.records | Integer | Total number of matching notes |
| pagination.limit | Integer | Page size limit |
| pagination.offset | Integer | Current page offset |
| pagination.previous_page | String (URL) | URL for the previous page |
| pagination.next_page | String (URL) | URL for the next page |
Retrieve Invoices for a Quote: /quotes/{id}/invoices
Purpose
Retrieve the paginated list of invoices generated from a specific quote, identified by the quote's order ID. The response wraps the quote under an order object containing an invoices array, where each invoice carries its full state — status, ID, type, custom form binding, currency, customer purchase order ID, billing/issue/due dates (with their alternate equivalents), origin, financial totals (subtotal, tax, total, paid, due), shipping cost, payment status, last payment snapshot, discount amount, tax inclusivity flag, account and order associations, KPIs (outstanding, overdue, last payment date, payment/credit applied, credit issued, lifecycle timestamps), audit fields, custom attributes, custom objects, and a lines array describing the invoice line items. A pagination object at the same level as the invoices array supports navigation through long-running billing schedules.
Use Case
Once a quote is accepted and converted into a billable record, it may produce a single invoice for one-off sales or a sequence of invoices for recurring or milestone-based billing. Finance teams, customer success, and revenue operations frequently need to answer the question: "Which invoices did this quote produce, and what is their current status?" Collections officers investigating an overdue balance commonly start from the quote and drill into the specific delinquent invoice. Customer success managers verify that all expected invoices from a recurring quote have been issued and reflect the agreed schedule. Integrations with accounting and revenue recognition systems pull this list to reconcile quote-to-cash flows and ensure their downstream ledgers match the source of truth. The endpoint scopes results to one quote, with pagination, so callers do not need to filter or merge global invoice feeds client-side.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| id | String | Unique identifier of the quote whose invoices are to be retrieved. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | Integer | Maximum number of invoices to return (optional). |
| offset | Integer | Number of records to skip for pagination (optional). |
| direction | String | Sort direction, e.g. "asc" or "desc" (optional). |
| order_by | String | Field to order results by (optional). |
Request Body
This endpoint does not require a request body.
Response
Returns a paginated list of invoices generated from the quote. Each invoice object includes lifecycle and identity fields (status, id, type, uuid, version), associated form and currency, customer purchase order reference, full billing/issue/due date set with alternate values, financial totals, payment status with last payment snapshot, KPIs covering outstanding/overdue/payment-applied/credit-applied figures and lifecycle timestamps, audit fields, custom attributes and objects, and a lines array describing each invoice line. The pagination object provides total record count, page limit and offset, and previous/next page URLs.
Response Body
{
"order": {
"invoices": [
{
"status": "invoice_status",
"id": "invoice_id",
"type": "invoice_type",
"custom_form": {
"uuid": "custom_form_uuid",
"name": "custom_form_name"
},
"currency": {
"uuid": "currency_uuid",
"name": "currency_name",
"link": "currency_link"
},
"customer_purchase_order_id": "customer_purchase_order_id",
"billing_start_date": "billing_start_date",
"alternate_billing_start_date": "alternate_billing_start_date",
"billing_end_date": "billing_end_date",
"alternate_billing_end_date": "alternate_billing_end_date",
"issue_date": "issue_date",
"alternate_issue_date": "alternate_issue_date",
"due_date": "due_date",
"alternate_due_date": "alternate_due_date",
"origin": "origin",
"subtotal": "subtotal",
"tax": "tax",
"total": "total",
"paid": "paid",
"due": "due",
"shipping_cost": "shipping_cost",
"payment_status": "payment_status",
"last_payment": {
"id": "last_payment_id",
"amount": "last_payment_amount",
"created_at": "last_payment_created_at"
},
"discount_amount": "discount_amount",
"price_tax_inclusive": "price_tax_inclusive",
"invoice_note": "invoice_note",
"account_id": "account_id",
"account_name": "account_name",
"order_id": "order_id",
"kpis": {
"outstanding": "outstanding",
"overdue": "overdue",
"last_payment_date": "last_payment_date",
"payment_applied": "payment_applied",
"credit_applied": "credit_applied",
"credit_issued": "credit_issued",
"last_reactivated_on": "last_reactivated_on",
"last_cancelled_on": "last_cancelled_on",
"last_amended_on": "last_amended_on",
"voided_on": "voided_on",
"deleted_on": "deleted_on"
},
"created_by": "created_by",
"created_on": "created_on_timestamp",
"last_updated_by": "last_updated_by",
"last_updated_on": "last_updated_on_timestamp",
"uuid": "invoice_uuid",
"version": "version_number",
"custom_attributes": [],
"custom_objects": [],
"lines": [
{
"item_serial_or_batch_number": "item_serial_or_batch_number",
"subtotal": "line_subtotal",
"total": "line_total",
"tax": {
"amount": "tax_amount",
"uuid": "tax_uuid",
"code": "tax_code",
"rate": "tax_rate",
"link": "tax_link"
},
"accounting_code": {
"sales_revenue": "sales_revenue"
},
"item_uuid": "item_uuid",
"item_id": "item_id",
"item_name": "item_name",
"item_order_quantity": "item_order_quantity",
"item_uom": "item_uom",
"item_warehouse": "item_warehouse",
"pricing_snapshot_uuid": "pricing_snapshot_uuid",
"charging_start_date": "charging_start_date",
"alternate_charging_start_date": "alternate_charging_start_date",
"charging_end_date": "charging_end_date",
"alternate_charging_end_date": "alternate_charging_end_date",
"uuid": "line_uuid",
"version": "line_version"
}
]
}
],
"pagination": {
"records": "total_records",
"limit": "page_limit",
"offset": "page_offset",
"previous_page": "previous_page",
"next_page": "next_page"
}
}
}| Attribute | Type | Description |
|---|---|---|
| order.invoices | Array | List of invoices generated from the quote. |
| status | String | Lifecycle status of the invoice. |
| id | String | Invoice identifier. |
| type | String | Invoice type. |
| custom_form | Object | Custom form binding (uuid, name). |
| currency | Object | Currency reference (uuid, name, link). |
| customer_purchase_order_id | String | Customer's purchase order reference. |
| billing_start_date | String | Billing period start. |
| billing_end_date | String | Billing period end. |
| issue_date | String | Date the invoice was issued. |
| due_date | String | Date the invoice is due. |
| subtotal | String | Pre-tax invoice subtotal. |
| tax | String | Total tax applied. |
| total | String | Final invoice total. |
| paid | String | Amount paid against the invoice. |
| due | String | Outstanding amount remaining. |
| payment_status | String | Payment lifecycle status. |
| last_payment | Object | Snapshot of the most recent payment. |
| account_id | String | Owning account ID. |
| order_id | String | Originating order ID. |
| kpis | Object | KPI block (outstanding, overdue, last payment, applied/issued credit, lifecycle timestamps). |
| lines | Array | Invoice line items. |
| uuid | String (UUID) | Invoice UUID. |
| version | String | Invoice version number. |
| custom_attributes | Array | Custom attributes for the invoice. |
| custom_objects | Array | Custom objects linked to the invoice. |
| pagination.records | Integer | Total matching invoices. |
| pagination.limit | Integer | Page size limit. |
| pagination.offset | Integer | Current page offset. |
| pagination.previous_page | String (URL) | Previous page URL. |
| pagination.next_page | String (URL) | Next page URL. |
Retrieve Invoices for a Quote Order: /quote-orders/{id}/invoices
Purpose
Retrieve the paginated list of invoices generated from a quote-typed order, identified by the quote order's ID. The response wraps the result under a quote_order object containing an invoices array — distinct from the regular /quotes/{id}/invoices endpoint, whose response uses an order wrapper. Each invoice carries the same field set as the quote variant (lifecycle, identity, custom form, currency, billing/issue/due dates, financials, payment status, KPIs, audit, custom attributes, custom objects, lines). The pagination block supports navigation through quote orders that produce many invoices over recurring billing schedules.
Use Case
Quote orders represent the pre-conversion stage of the customer lifecycle: a negotiated proposal that, once accepted, generates one or more invoices according to the agreed billing schedule. Finance, revenue operations, and customer success teams routinely need to answer "Which invoices has this quote order produced, and what is their current status?" Collections officers investigating an overdue balance start from the quote order and drill into the specific delinquent invoice. Customer success verifies that recurring invoices on a quote order have all been issued. Integrations with accounting and revenue recognition systems pull this list to reconcile quote-order-to-cash flows. The endpoint provides this quote-order-scoped invoice view in a single call, with pagination handling long-running billing schedules without forcing the caller to merge a global invoice feed client-side.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| id | String | Unique identifier of the quote order whose invoices are to be retrieved. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| limit | Integer | Maximum number of invoices to return (optional). |
| offset | Integer | Number of records to skip for pagination (optional). |
| direction | String | Sort direction, e.g. "asc" or "desc" (optional). |
| order_by | String | Field to order results by (optional). |
Request Body
This endpoint does not require a request body
Response
Returns a paginated list of invoices generated from the quote order, wrapped under a quote_order object. Each invoice object carries the full set of lifecycle, identity, financial, payment, KPI, audit, custom-attribute, custom-object, and line fields described for the quote-invoice endpoint. The pagination object provides total record count, page limit and offset, and previous/next page URLs.
Response Body
{
"quote_order": {
"invoices": [
{
"status": "invoice_status",
"id": "invoice_id",
"type": "invoice_type",
"custom_form": {
"uuid": "custom_form_uuid",
"name": "custom_form_name"
},
"currency": {
"uuid": "currency_uuid",
"name": "currency_name",
"link": "currency_link"
},
"customer_purchase_order_id": "customer_purchase_order_id",
"billing_start_date": "billing_start_date",
"alternate_billing_start_date": "alternate_billing_start_date",
"billing_end_date": "billing_end_date",
"alternate_billing_end_date": "alternate_billing_end_date",
"issue_date": "issue_date",
"alternate_issue_date": "alternate_issue_date",
"due_date": "due_date",
"alternate_due_date": "alternate_due_date",
"origin": "origin",
"subtotal": "subtotal",
"tax": "tax",
"total": "total",
"paid": "paid",
"due": "due",
"shipping_cost": "shipping_cost",
"payment_status": "payment_status",
"last_payment": {
"id": "last_payment_id",
"amount": "last_payment_amount",
"created_at": "last_payment_created_at"
},
"discount_amount": "discount_amount",
"price_tax_inclusive": "price_tax_inclusive",
"invoice_note": "invoice_note",
"account_id": "account_id",
"account_name": "account_name",
"order_id": "order_id",
"kpis": {
"outstanding": "outstanding",
"overdue": "overdue",
"last_payment_date": "last_payment_date",
"payment_applied": "payment_applied",
"credit_applied": "credit_applied",
"credit_issued": "credit_issued",
"last_reactivated_on": "last_reactivated_on",
"last_cancelled_on": "last_cancelled_on",
"last_amended_on": "last_amended_on",
"voided_on": "voided_on",
"deleted_on": "deleted_on"
},
"created_by": "created_by",
"created_on": "created_on_timestamp",
"last_updated_by": "last_updated_by",
"last_updated_on": "last_updated_on_timestamp",
"uuid": "invoice_uuid",
"version": "version_number",
"custom_attributes": [],
"custom_objects": [],
"lines": [
{
"item_serial_or_batch_number": "item_serial_or_batch_number",
"subtotal": "line_subtotal",
"total": "line_total",
"tax": {
"amount": "tax_amount",
"uuid": "tax_uuid",
"code": "tax_code",
"rate": "tax_rate",
"link": "tax_link"
},
"accounting_code": {
"sales_revenue": "sales_revenue"
},
"item_uuid": "item_uuid",
"item_id": "item_id",
"item_name": "item_name",
"item_order_quantity": "item_order_quantity",
"item_uom": "item_uom",
"item_warehouse": "item_warehouse",
"pricing_snapshot_uuid": "pricing_snapshot_uuid",
"charging_start_date": "charging_start_date",
"alternate_charging_start_date": "alternate_charging_start_date",
"charging_end_date": "charging_end_date",
"alternate_charging_end_date": "alternate_charging_end_date",
"uuid": "line_uuid",
"version": "line_version"
}
]
}
],
"pagination": {
"records": "total_records",
"limit": "page_limit",
"offset": "page_offset",
"previous_page": "previous_page",
"next_page": "next_page"
}
}
}| Attribute | Type | Description |
|---|---|---|
| quote_order.invoices | Array | List of invoices generated from the quote order. |
| status | String | Lifecycle status of the invoice. |
| id | String | Invoice identifier. |
| type | String | Invoice type. |
| custom_form | Object | Custom form binding (uuid, name). |
| currency | Object | Currency reference (uuid, name, link). |
| customer_purchase_order_id | String | Customer's purchase order reference. |
| billing_start_date | String | Billing period start. |
| billing_end_date | String | Billing period end. |
| issue_date | String | Date the invoice was issued. |
| due_date | String | Date the invoice is due. |
| subtotal | String | Pre-tax invoice subtotal. |
| tax | String | Total tax applied. |
| total | String | Final invoice total. |
| paid | String | Amount paid against the invoice. |
| due | String | Outstanding amount remaining. |
| payment_status | String | Payment lifecycle status. |
| last_payment | Object | Snapshot of the most recent payment. |
| account_id | String | Owning account ID. |
| order_id | String | Originating quote order ID. |
| kpis | Object | KPI block (outstanding, overdue, last payment, applied/issued credit, lifecycle timestamps). |
| lines | Array | Invoice line items. |
| uuid | String (UUID) | Invoice UUID. |
| version | String | Invoice version number. |
| custom_attributes | Array | Custom attributes for the invoice. |
| custom_objects | Array | Custom objects linked to the invoice. |
| pagination.records | Integer | Total matching invoices. |
| pagination.limit | Integer | Page size limit. |
| pagination.offset | Integer | Current page offset. |
| pagination.previous_page | String (URL) | Previous page URL. |
| pagination.next_page | String (URL) | Next page URL. |
Retrieve Payment Methods for an Order: /orders/{id}/payment-methods
Purpose
Retrieve the full collection of payment methods associated with a specific order, identified by the order ID. The response wraps the order under an order object containing a paymentMethods array, where each entry carries the complete state of the payment instrument: processor classification (processorType, paymentProcessor), lifecycle fields (status, default, reference, version, uuid), usage metrics (paymentCount, lastUsedOn, lastUsedResult, errorCountSinceLastSuccess), order-scoping fields (specifiedOrders, useForSpecifiedOrders), an embedded processor block describing the upstream gateway configuration, and the card-specific fields (cardType, token, cardNumber, expiryMonth, expiryYear, cardCvv, nameOnCard) when the method is a card. Audit fields (createdBy, createdOn, lastUpdatedBy, lastUpdatedOn) accompany every record so consumers can reconstruct the change trail without a follow-up call. The endpoint is read-only and does not require pagination — all payment methods bound to the target order are returned in a single response.
Use Case
Orders frequently carry their own payment-method scope rather than relying solely on the parent account's default instruments — for example, when a customer wants a particular card billed for one specific subscription, when finance overrides a default for a high-value order, or when a payment method has been explicitly tied to specified orders only via useForSpecifiedOrders. Billing automation, self-service portals, and customer service consoles need a fast, order-scoped read of which payment methods are currently in play, which is the default, what the last charge result was, and how many consecutive failures have accumulated. This endpoint provides that view in a single call. Collections and dunning workflows poll it to identify orders whose default payment instrument has accumulated repeated failures, signalling the need to retry on a fallback method or escalate to the account holder. Customer service agents pull it when a customer disputes a charge or asks which card was on file at the time. Integrations syncing into external CRM, accounting, or fraud-monitoring platforms consume it to keep downstream systems aligned with the order's current payment configuration. Because the response includes both processor metadata and card-specific fields, callers can render a complete payment-methods panel in a single fetch without merging data from the account-level endpoint.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| id | String | Unique identifier of the order whose payment methods are to be retrieved. |
Query Parameters
No query parameters required.
Request Body
This endpoint does not require a request body.
Response
Returns the order's bound payment methods wrapped under an order object containing a paymentMethods array. Each method entry includes processor classification (processorType, paymentProcessor), lifecycle and identity fields (status, default, reference, uuid, version), usage metrics (paymentCount, lastUsedOn, lastUsedResult, errorCountSinceLastSuccess), order-scoping fields (specifiedOrders, useForSpecifiedOrders), an embedded processor block describing upstream gateway configuration, card-specific fields (cardType, token, cardNumber, expiryMonth, expiryYear, cardCvv, nameOnCard) when applicable, and full audit fields (createdBy, createdOn, lastUpdatedBy, lastUpdatedOn). The payload uses camelCase keys throughout, distinct from the snake_case style used by note and usage endpoints — clients deserializing the body must preserve key casing. Errors follow the standard envelope: 404 if the order ID does not exist, 401/403 for authorisation failures, and 5xx for server-side issues.
Response Body
{
"order": {
"paymentMethods": [
{
"processorType": "PROCESSOR_TYPE",
"paymentProcessor": "PAYMENT_PROCESSOR",
"status": "STATUS",
"default": "IS_DEFAULT",
"reference": "PAYMENT_METHOD_REFERENCE",
"paymentCount": "PAYMENT_COUNT",
"lastUsedOn": "LAST_USED_ON",
"createdBy": "CREATED_BY_USER",
"createdOn": "CREATED_ON_DATETIME",
"lastUpdatedBy": "LAST_UPDATED_BY_USER",
"lastUpdatedOn": "LAST_UPDATED_ON_DATETIME",
"uuid": "PAYMENT_METHOD_UUID",
"version": "VERSION",
"specifiedOrders": [],
"useForSpecifiedOrders": "USE_FOR_SPECIFIED_ORDERS",
"processor": {},
"cardType": "CARD_TYPE",
"token": "CARD_TOKEN",
"cardNumber": "MASKED_CARD_NUMBER",
"expiryMonth": "EXPIRY_MONTH",
"expiryYear": "EXPIRY_YEAR",
"cardCvv": "CARD_CVV",
"nameOnCard": "NAME_ON_CARD",
"lastUsedResult": "LAST_USED_RESULT",
"errorCountSinceLastSuccess": "ERROR_COUNT_SINCE_LAST_SUCCESS"
}
]
}
}| Attribute | Type | Description |
|---|---|---|
| order.paymentMethods | Array | Collection of payment methods bound to the order. |
| processorType | String | Classification of the upstream processor (e.g. card, ACH, wallet). |
| paymentProcessor | String | Name of the payment processor handling this method. |
| status | String | Lifecycle status of the payment method. |
| default | String | Flag indicating whether this method is the default for the order. |
| reference | String | Human-readable reference for the payment method. |
| paymentCount | String | Total successful payments processed using this method. |
| lastUsedOn | String (ISO 8601) | Timestamp of the most recent use of this method. |
| createdBy | String | Username of the creator. |
| createdOn | String (ISO 8601) | Creation timestamp. |
| lastUpdatedBy | String | Username of the most recent editor. |
| lastUpdatedOn | String (ISO 8601) | Most recent update timestamp. |
| uuid | String (UUID) | Unique identifier of the payment method. |
| version | String | Version number of the payment method record. |
| specifiedOrders | Array | Orders this method is explicitly scoped to, when scoping is enabled. |
| useForSpecifiedOrders | String | Flag controlling whether this method is restricted to specified orders only. |
| processor | Object | Embedded processor configuration block. |
| cardType | String | Card brand/type (e.g. VISA, MASTERCARD) when applicable. |
| token | String | Tokenised card reference held by the processor. |
| cardNumber | String | Masked card number for display. |
| expiryMonth | String | Card expiry month. |
| expiryYear | String | Card expiry year. |
| cardCvv | String | Card CVV (typically masked or empty in responses). |
| nameOnCard | String | Cardholder name. |
| lastUsedResult | String | Outcome of the last charge attempted with this method. |
| errorCountSinceLastSuccess | String | Consecutive failure count since the last successful charge. |