Order POST API Documentation

Purpose

This API is used to create a new order in the system. An order defines the commercial agreement between a customer and the business, detailing products or services, pricing, quantities, and contractual properties such as billing cycles, payment terms, and contract configurations. The API supports the inclusion of contract-related attributes, line items, and pricing details at the time of order creation.

Use Case

Businesses use this API to automate order creation during sales or subscription processes. It allows users to generate new customer orders that include multiple products or services, apply discounts, set billing periods, and define contract terms such as renewal and downgrade rules. For example, this API can be used to create recurring subscription orders, contract-based service agreements, or one-time product purchases with configurable pricing and terms.

Path Parameters

This endpoint does not require path parameters.

Query Parameters

This endpoint does not accept query parameters.

Request Body

                Contract
              

                Single Item
              

                Multiple Item
              

                      {
    "order": {
        "name": "Contract Discount Check 0.0.5",
        // "display_name": "order dis",
        // "description": "tax configuration",
        // "account_id": "2OIQ4LKQACP",
        // "redemption_code": "EB_ABCD",
        // "discount_amount": "100",
        // "discount_percentage": "10",
        //"shipping_profile": "PP",
        "account_id": "2561EE",
        "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": "2024-09-17", // do not work
            // // "auto_renewal_ends_on": "1 Day", // do not work
            // // "specify_period":"1 week", // do not work
            // "auto_renewal_term": "1 Week",
            // // "auto_renewal_require_customer_acceptance": "True",
            // "allow_early_termination": "TRUE",
            // "early_termination_minimum_period": "1 Day",
            // "apply_early_termination_charge": "False",
            // // "early_termination_charge_type": "Percentage",
            // // "termination_percentage_charge": "12.000000",
            // // "termination_accounting_code": "Event Charge",
            // "allow_postponement": "True",
            // "maximum_duration_per_postponement": "1 Day",
            // "maximum_postponement_count": "1",
            // "allow_trial": "True",
            // "start_contract_after_trial_ends": "true",
            // "trial_period": "1 day",
            // "trial_end_date": "2024-09-17",
            // "trial_requires_payment_method": "True",
            "allow_downgrade": "True",
            // "period_before_downgrade": "1 Day",
            // "allow_downgrade_charge": "False",
            "downgrade_charge_type": "Fixed",
            // "downgrade_charge_fixed": "23.000000",
            // "downgrade_charge_percentage": "99",
            // "downgrade_billing_period_count": "10",
            "allow_upgrade": "True"
        },
        "lines": [
            {
                "item_id": "ITEM-0001",
                "package_name": "family",
                "item_order_quantity": "1",
                // "discount": "5",
                // "discount_type": "FIXED",
                "item_price_snapshot": {
                    "pricing_rule": {
                        "price": "149.00"
                    }
                }
                // "item_price_tax": {
                //     "uuid": "e7dc5a26-ba38-41c9-8294-46e404b8d366",
                //     "code": "Tax",
                //     "rate": "0.000000"
                // }
            }
        ]
    }
}
                    

                      {
    "order": {
        // "id": "ORD-ACC-T9XN-0231",
        "account_id": "{{account_id}}",
        "currency": "AUD",
        // "redemption_code": "ITEM-0007",
        // "communication_preference": [
        //     {
        //         "media": "EMAIL",
        //         "isEnabled": "true"
        //     },
        //     {
        //         "media": "POSTAL_EMAIL",
        //         "isEnabled": "true"
        //     },
        //     {
        //         "media": "TEXT_MESSAGE",
        //         "isEnabled": "true"
        //     },
        //     {
        //         "media": "VOICE_MAIL",
        //         "isEnabled": "true"
        //     }
        // ],
        "lines": [
            {
                "item_id": "ITEM-0001",
                "package_name": "family",
                "item_order_quantity": "-10",
                "item_price_snapshot": {
                    "pricing_rule": {
                        "price": "100.0"
                    }
                }
            }
        ]
    }
}
                    

                      {
    "order": {
        "account_id": "2561EE",
        "lines": [
            {
                "item_id": "ITEM-0001",
                "package_name": "family",
                //  "item_order_quantity": "10",
                // "item_custom_attributes": [],
                "item_price_snapshot": {
                    "pricing_rule": {
                        "price": "150"
                        //  "uom": "Hectare",
                        //  "warehouse": "warehouse 999",
                        //  "pricing_schedule": "2024-01-12 00:00:00-2023-01-14 00:00:00",
                        // "pricing_level": "gold"
                    }
                },
                // "item_price_tax": {
                //     "uuid": "A658C712-DC95-4276-A6B5-5EAF072565DF"
                //  "code":"GST",
                // "rate":"12.00"
            },
            {
                "item_id": "ITEM-0002",
                "package_name": "standard",
                // "item_order_quantity": "10",
                // "item_custom_attributes": [],
                "item_price_snapshot": {
                    "pricing_rule": {
                        "price": "150"
                        //  "uom": "Hectare",
                        //  "warehouse": "warehouse 999",
                        //  "pricing_schedule": "2024-01-12 00:00:00-2023-01-14 00:00:00",
                        // "pricing_level": "gold"
                    }
                },
                // "item_price_tax": {
                //     "uuid": "A658C712-DC95-4276-A6B5-5EAF072565DF",
                //     "code": "GST",
                //     "rate": "12.00"
                // }
            }
        ]
    }
}
                    

Response

When the order is successfully created, the API returns a complete order object containing all configuration details, including system-generated identifiers, timestamps, and calculated totals. The response confirms that the order has been recorded with its associated customer account, product lines, pricing details, contract settings, and related billing configurations. It also includes default system properties such as currency, billing periods, tax configurations, and references to linked invoices and items.

Response Body

                Contract
              

                Single Item
              

                Multiple Item
              

                      {
    "order": {
        "status": "ACTIVE",
        "id": "ORD-2561EE-0600",
        "pre_order": "false",
        "quote_order": "false",
        "name": "Contract Discount Check 0.0.5",
        "display_name": "Contract Discount Check 0.0.5",
        "description": "",
        "referral_account": "",
        "customer_purchase_order_id": "",
        "shipping_profile": {},
        "shipping_cost": "0.000000",
        "discount_profile": null,
        "origin": "",
        "custom_forms": {
            "uuid": "cdabab76-ae49-4567-b2da-9d6b60b6a7ed",
            "name": "Default for Order"
        },
        "currency": {
            "uuid": "4f444464-defa-4180-a18e-e2bf4b5a84a1",
            "name": "AUD",
            "link": "https://dev-api.exsited.com/api/v1/currencies/4f444464-defa-4180-a18e-e2bf4b5a84a1"
        },
        "time_zone": {
            "uuid": "990e82c3-8cc6-4cc6-a69c-77f9caaa8b61",
            "name": "Australia/Melbourne",
            "link": "https://dev-api.exsited.com/api/v1/time_zones/990e82c3-8cc6-4cc6-a69c-77f9caaa8b61"
        },
        "invoice_note": "",
        "billing_start_date": "ORDER_START_DATE",
        "order_start_date": "2025-11-03T00:00:00Z",
        "next_billing_from_date": "2025-12-03 00:00:00.000000",
        "next_billing_from_date_utc": "2025-12-02T13:00:00Z",
        "price_tax_inclusive": "false",
        "billing_address": {},
        "shipping_address": {},
        "created_by": "test5",
        "created_on": "2025-11-03T10:36:53Z",
        "last_updated_by": "",
        "last_updated_on": "",
        "uuid": "a3aab472-6c94-48a7-9ad4-b80432413395",
        "version": "1",
        "account_id": "2561EE",
        "account_name": "basic/express - data",
        "allow_contract": "true",
        "contract_properties": {
            "require_customer_acceptance": "false",
            "requires_payment_method": "false",
            "initial_contract_term": "1 Year",
            "renew_automatically": "false",
            "allow_early_termination": "false",
            "termination_accounting_code": "",
            "allow_postponement": "false",
            "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": [],
        "custom_objects": [],
        "currency_id": "1",
        "properties": {
            "communication_profile": "",
            "invoice_mode": "AUTOMATIC",
            "invoice_term": "Billing Start Date",
            "billing_period": "1 Month",
            "consolidate_invoice": "false",
            "payment_processor": "Cash",
            "payment_mode": "MANUAL",
            "payment_term": "Net 30",
            "payment_term_alignment": "BILLING_DATE",
            "fulfillment_mode": "MANUAL",
            "fulfillment_term": "Immediately"
        },
        "invoice_id": "INV-2561EE-0671",
        "lines": [
            {
                "charge_item_uuid": "28655b88-22c5-42a9-b853-ab102193e6f6",
                "item_uuid": "a07f3435-6899-4b62-9f0f-5afc198bcf30",
                "item_id": "ITEM-0001",
                "item_name": "family item - family",
                "item_order_quantity": "1.000000",
                "shipping_cost": "0.00",
                "item_invoice_note": "",
                "item_description": "",
                "item_type": "FAMILY",
                "item_charge_type": "RECURRING",
                "item_custom_attributes": [],
                "item_properties": {
                    "billing_mode": "IN_ADVANCE",
                    "fixed_start_date": "",
                    "pro_rata_partial_unit": "false"
                },
                "item_price_snapshot": {
                    "pricing_rule": {
                        "uuid": "2535569c-7eff-47bd-9f5c-0b625eb65452",
                        "version": "3",
                        "price_type": "PER_UNIT_PRICING",
                        "price": "149.000000",
                        "uom": "",
                        "price_period": "",
                        "pricing_schedule": "",
                        "pricing_level": "",
                        "pricing_method": "0.000000",
                        "warehouse": "BareHouse"
                    }
                },
                "item_sale_tax_configuration": {
                    "sale_price_is_based_on": "",
                    "tax_code": {
                        "uuid": "",
                        "code": "",
                        "rate": "",
                        "link": ""
                    }
                },
                "isTaxExemptWhenSold": "false",
                "item_price_tax": {
                    "uuid": "58a36f3d-efaa-4ce7-bfc5-ce20c7330e6a",
                    "code": "No Tax",
                    "rate": 0.0000,
                    "link": "https://dev-api.exsited.com/api/v3/settings/taxes/58a36f3d-efaa-4ce7-bfc5-ce20c7330e6a"
                },
                "item_accounting_code": {
                    "sales_revenue": ""
                },
                "version": "1",
                "expected_delivery_date": "",
                "package_name": "family",
                "purchase_order_id": "",
                "purchase_invoice_id": "",
                "discount": 0,
                "total": "149",
                "subtotal": "149",
                "tax": "0"
            }
        ],
        "total": "149",
        "subtotal": "149",
        "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": "",
            "last_reactivated_on": "",
            "last_cancelled_on": "",
            "last_changed_on": "",
            "last_deleted_on": ""
        },
        "line_items": []
    }
}
                    

                      {
    "order": {
        // "id": "ORD-ACC-T9XN-0231",
        "account_id": "{{account_id}}",
        "currency": "AUD",
        // "redemption_code": "ITEM-0007",
        // "communication_preference": [
        //     {
        //         "media": "EMAIL",
        //         "isEnabled": "true"
        //     },
        //     {
        //         "media": "POSTAL_EMAIL",
        //         "isEnabled": "true"
        //     },
        //     {
        //         "media": "TEXT_MESSAGE",
        //         "isEnabled": "true"
        //     },
        //     {
        //         "media": "VOICE_MAIL",
        //         "isEnabled": "true"
        //     }
        // ],
        "lines": [
            {
                "item_id": "ITEM-0001",
                "package_name": "family",
                "item_order_quantity": "-10",
                "item_price_snapshot": {
                    "pricing_rule": {
                        "price": "100.0"
                    }
                }
            }
        ]
    }
}
                    

                      {
    "order": {
        "status": "ACTIVE",
        "id": "ORD-2561EE-0603",
        "pre_order": "false",
        "quote_order": "false",
        "name": "basic/express - data - family item",
        "display_name": "basic/express - data - family item",
        "description": "",
        "referral_account": "",
        "customer_purchase_order_id": "",
        "shipping_profile": {},
        "shipping_cost": "0.000000",
        "discount_profile": null,
        "origin": "",
        "custom_forms": {
            "uuid": "cdabab76-ae49-4567-b2da-9d6b60b6a7ed",
            "name": "Default for Order"
        },
        "currency": {
            "uuid": "4f444464-defa-4180-a18e-e2bf4b5a84a1",
            "name": "AUD",
            "link": "https://dev-api.exsited.com/api/v1/currencies/4f444464-defa-4180-a18e-e2bf4b5a84a1"
        },
        "time_zone": {
            "uuid": "990e82c3-8cc6-4cc6-a69c-77f9caaa8b61",
            "name": "Australia/Melbourne",
            "link": "https://dev-api.exsited.com/api/v1/time_zones/990e82c3-8cc6-4cc6-a69c-77f9caaa8b61"
        },
        "invoice_note": "",
        "billing_start_date": "ORDER_START_DATE",
        "order_start_date": "2025-11-03T00:00:00Z",
        "next_billing_from_date": "2025-12-03 00:00:00.000000",
        "next_billing_from_date_utc": "2025-12-02T13:00:00Z",
        "price_tax_inclusive": "false",
        "billing_address": {},
        "shipping_address": {},
        "created_by": "test5",
        "created_on": "2025-11-03T11:23:47Z",
        "last_updated_by": "",
        "last_updated_on": "",
        "uuid": "2e6f557d-96fa-4d72-af14-4ea964896ffd",
        "version": "1",
        "account_id": "2561EE",
        "account_name": "basic/express - data",
        "allow_contract": "false",
        "custom_attributes": [],
        "custom_objects": [],
        "currency_id": "1",
        "properties": {
            "communication_profile": "",
            "invoice_mode": "AUTOMATIC",
            "invoice_term": "Billing Start Date",
            "billing_period": "1 Month",
            "consolidate_invoice": "false",
            "payment_processor": "Cash",
            "payment_mode": "MANUAL",
            "payment_term": "Net 30",
            "payment_term_alignment": "BILLING_DATE",
            "fulfillment_mode": "MANUAL",
            "fulfillment_term": "Immediately"
        },
        "invoice_id": "INV-2561EE-0674",
        "lines": [
            {
                "charge_item_uuid": "ca695116-dd3a-4a43-a722-c85337826e32",
                "item_uuid": "a07f3435-6899-4b62-9f0f-5afc198bcf30",
                "item_id": "ITEM-0001",
                "item_name": "family item - family",
                "item_order_quantity": "1.000000",
                "shipping_cost": "0.00",
                "item_invoice_note": "",
                "item_description": "",
                "item_type": "FAMILY",
                "item_charge_type": "RECURRING",
                "item_custom_attributes": [],
                "item_properties": {
                    "billing_mode": "IN_ADVANCE",
                    "fixed_start_date": "",
                    "pro_rata_partial_unit": "false"
                },
                "item_price_snapshot": {
                    "pricing_rule": {
                        "uuid": "2535569c-7eff-47bd-9f5c-0b625eb65452",
                        "version": "3",
                        "price_type": "PER_UNIT_PRICING",
                        "price": "150.000000",
                        "uom": "",
                        "price_period": "",
                        "pricing_schedule": "",
                        "pricing_level": "",
                        "pricing_method": "0.000000",
                        "warehouse": "BareHouse"
                    }
                },
                "item_sale_tax_configuration": {
                    "sale_price_is_based_on": "",
                    "tax_code": {
                        "uuid": "",
                        "code": "",
                        "rate": "",
                        "link": ""
                    }
                },
                "isTaxExemptWhenSold": "false",
                "item_price_tax": {
                    "uuid": "58a36f3d-efaa-4ce7-bfc5-ce20c7330e6a",
                    "code": "No Tax",
                    "rate": 0.0000,
                    "link": "https://dev-api.exsited.com/api/v3/settings/taxes/58a36f3d-efaa-4ce7-bfc5-ce20c7330e6a"
                },
                "item_accounting_code": {
                    "sales_revenue": ""
                },
                "version": "1",
                "expected_delivery_date": "",
                "package_name": "family",
                "purchase_order_id": "",
                "purchase_invoice_id": "",
                "discount": 0,
                "total": "150",
                "subtotal": "150",
                "tax": "0"
            },
            {
                "charge_item_uuid": "581d1aa8-dc90-477a-a25d-3f4a8c7b94a8",
                "item_uuid": "43cc872a-8baf-4b7b-9fa1-e7b454116e20",
                "item_id": "ITEM-0002",
                "item_name": "item 1",
                "item_order_quantity": "1.000000",
                "shipping_cost": "0.00",
                "item_invoice_note": "",
                "item_description": "",
                "item_type": "STANDARD",
                "item_charge_type": "RECURRING",
                "item_custom_attributes": [],
                "item_properties": {
                    "billing_mode": "IN_ADVANCE",
                    "fixed_start_date": "",
                    "pro_rata_partial_unit": "false"
                },
                "item_price_snapshot": {
                    "pricing_rule": {
                        "uuid": "981011da-b57c-48b3-b105-9471c1dd264d",
                        "version": "2",
                        "price_type": "PER_UNIT_PRICING",
                        "price": "150.000000",
                        "uom": "",
                        "price_period": "",
                        "pricing_schedule": "",
                        "pricing_level": "",
                        "pricing_method": "0.000000",
                        "warehouse": "BareHouse"
                    }
                },
                "item_sale_tax_configuration": {
                    "sale_price_is_based_on": "SALES_TAX",
                    "tax_code": {
                        "uuid": "",
                        "code": "",
                        "rate": "",
                        "link": ""
                    }
                },
                "isTaxExemptWhenSold": "false",
                "item_price_tax": {
                    "uuid": "58a36f3d-efaa-4ce7-bfc5-ce20c7330e6a",
                    "code": "No Tax",
                    "rate": 0.0000,
                    "link": "https://dev-api.exsited.com/api/v3/settings/taxes/58a36f3d-efaa-4ce7-bfc5-ce20c7330e6a"
                },
                "item_accounting_code": {
                    "sales_revenue": ""
                },
                "version": "1",
                "expected_delivery_date": "",
                "purchase_order_id": "",
                "purchase_invoice_id": "",
                "discount": 0,
                "total": "150",
                "subtotal": "150",
                "tax": "0"
            }
        ],
        "total": "300",
        "subtotal": "300",
        "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": "",
            "last_reactivated_on": "",
            "last_cancelled_on": "",
            "last_changed_on": "",
            "last_deleted_on": ""
        },
        "line_items": []
    }
}
                    

Purpose

This endpoint cancels an existing order by marking its status as INACTIVE. The cancellation can take effect immediately or be scheduled for a future date based on the effective_date provided in the request.

Use Case

This endpoint is used when a customer or admin wants to stop an active recurring order. The function accepts an effective_date to control when the cancellation takes place. If the date is today , the order is immediately inactivated. If it is in the future, the order remains active until the scheduled cancellation date, allowing billing or service to continue for the current cycle.

Path Parameters

Parameter	Type	Description
order_id	String	Unique identifier of the order.

Query Parameters

No query parameters required for this endpoint.

Request Body

The request body includes the date when the cancellation should become effective. This allows support for both immediate and scheduled cancellations.

                JSON
              

                      {
    "order": {
        "effective_date": "EFFECTIVE_DATE"
    }
}
                    

Attribute	Type	Description
order.effective_date	String	The date (YYYY-MM-DD) when the cancellation applies.

Response

The API response confirms that the order has been successfully cancelled. It returns the updated order object, where the status is set to "INACTIVE", and includes associated metadata such as event_uuid, timestamps, item details, and all billing and fulfillment settings at the time of cancellation. Each line item is preserved with pricing, discount, and tax information to maintain a record of what was included in the order before it was cancelled. This comprehensive response ensures transparency and supports historical tracking of cancelled orders.

Response Body

                JSON
              

                      {
    "event_uuid": "EVENT_UUID",
    "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",
                "isEnabled": "BOOLEAN"
            }
        ],
        "billing_start_date": "BILLING_START_DATE",
        "order_start_date": "ORDER_START_TIMESTAMP",
        "next_billing_from_date": "EMPTY",
        "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",
        "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",
                "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": "CHARGING_PERIOD",
                    "charging_start_date": "CHARGING_START_DATE",
                    "fixed_start_date": "EMPTY",
                    "charging_and_billing_alignment": "BOOLEAN",
                    "pro_rata_partial_charging_period": "BOOLEAN",
                    "pro_rata_partial_pricing_period": "BOOLEAN",
                    "pro_rata_partial_unit": "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"
                    }
                },
                "isTaxExemptWhenSold": "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",
                "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": []
    }
}
                    

Attribute	Type	Description
event_uuid	String	Unique identifier associated with the cancellation event.
order.status	String	Updated status of the order, set to "INACTIVE" after cancellation.
order.id	String	Unique identifier of the cancelled order.
order.name	String	Name or label of the order.
order.description	String	Description of the order content.
order.currency.name	String	Currency used for the order ("AUD").
order.time_zone.name	String	Time zone configured for the order .
order.communication_preference	Array	List of communication methods enabled for the order .
order.created_by	String	Name of the user who created the order.
order.created_on	String	Timestamp of when the order was originally created.
order.last_updated_by	String	Name of the user who last modified the order.
order.last_updated_on	String	Timestamp of the most recent update to the order.
order.lines	Array	List of items in the order with pricing, quantity, and tax configurations.
order.total	String	Final total price of the order after applying discounts.
order.tax	String	Total tax amount applied to the order.
order.subtotal	String	Total amount before tax and discount.
order.properties	Object	Configuration of billing, payment, and fulfillment policies.
order.kpis	Object	Key performance indicators related to revenue, invoices, and collection.

Purpose

This endpoint reactivate an order that was previously marked as inactive or cancelled. It updates the order’s status based on a provided effective date and schedules reactivation accordingly.

Use Case

The endpoint is used when a previously cancelled order needs to be reinstated. If the effective_date is the current date, the system will reactivate the order immediately. If the date is set in the future, the order remains in a pending state until that date arrives. This is especially useful for subscription or billing systems that allow temporary suspension of services with a scheduled reactivation.

Path Parameters

Parameter	Type	Description
order_id	String	Unique identifier of the order.

Query Parameters

No query parameters required for this endpoint.

Request Body

The request body includes the effective_date, which specifies when the order should become active again.

                JSON
              

                      {
    "account": {
        "effective_date": "EFFECTIVE_DATE"
    }
}
                    

Attribute	Type	Description
order.effective_date	String	The date (YYYY-MM-DD) to reactivate the order.

Response

The endpoint return a successful reactivation request object containing an event_uuid that uniquely identifies the reactivation event. This UUID can be used for tracking or audit purposes.

Response Body

                JSON
              
                      {
    "event_uuid": "EVENT_UUID"
}

Attribute	Type	Description
event_uuid	String	UUID representing the order reactivation event.

Purpose

This endpoint creates a new note for a specific order. It supports both plain text notes and file attachments, making it useful for order-related documentation, attaching receipts, scanned documents, or additional remarks.

Use Case

Add internal or customer-facing notes to an order.
Attach supporting files (e.g., images, invoices, receipts) directly to an order.
Maintain a timeline of comments and attachments for order tracking.
Provide documentation for audits, compliance, or customer communication.

Path Parameters

Parameter	Type	Required	Description
order_id	string	Yes	Unique identifier of the order to which the note will be added.

Query Parameters

This endpoint does not support query parameters.

Request Body

The request must be sent as multipart/form-data.

Attribute	Type	Description
note	string	Content of the note.
file	file	File to attach with the note. Accepts common document and image formats.

Response

On success, the API returns the order object containing a notes object with the UUID of the newly created note. This UUID can later be used to fetch note details, list attached files, or download specific files.

Response Body

                JSON
              

                      {
    "order": {
        "notes": {
            "uuid": "UUID"
        }
    }
}
                    

Attribute	Type	Description
order	object	Container object holding the response data.
order.notes	object	Object representing the newly created note.
order.notes.uuid	string (UUID)	Unique identifier of the created note.

Purpose

This API allows users to upload one or more files as attachments to an existing order note in the system. The uploaded files are associated with a specific order and note UUID, enabling users to maintain documentation or evidence (such as images, reports, or other files) directly within the order’s record.

Use Case

Businesses often need to attach files such as delivery receipts, photos, inspection documents, or reports to order notes for tracking or audit purposes. This API supports uploading files to an order note using multipart/form-data. Each uploaded file becomes part of the order note, which can be retrieved later for reference or verification.

Path Parameters

Parameter	Type	Description
order_id	String	Unique identifier of the order to which the note belongs.
note_uuid	UUID	Unique identifier of the note where the file attachment will be uploaded.

Query Parameters

This endpoint does not accept query parameters.

Request Body

The request must be sent as multipart/form-data.

Attribute	Type	Description
file	File	File to attach with the note. Accepts common document and image formats such as PDF, PNG, JPG, DOCX, etc. Multiple files can be uploaded sequentially for the same note.

Response

Upon successful upload, the API returns a confirmation response containing the order note details and a list of files associated with that note. Each file entry includes its name, confirming that the attachment has been successfully linked to the order note. The response ensures that the uploaded files are correctly stored and retrievable within the order record.

Response Body

                JSON
              

                      {
    "order": {
        "notes": {
            "content": "<p><NOTE_CONTENT></p>",
            "files": [
                {
                    "name": "<FILE_NAME_1>"
                },
                {
                    "name": "<FILE_NAME_2>"
                }
            ]
        }
    }
}

                    

Attribute	Type	Description
order	Object	Contains details of the order associated with the uploaded note.
notes	Object	Represents the note record within the order.
content	String	The content or text body of the note.
files	Array	List of file objects attached to the note.
name	String	The filename of the uploaded file.

Purpose

This endpoint activates an existing order by setting its effective activation date. Once activated, the order transitions to ACTIVE status and triggers billing logic, pricing schedules, communication preferences, and other configured order-level behaviors within the system.

Use Case

Use this endpoint when:

An order has been created in Draft or Pending Activation state.
The customer has approved the order and the activation date is confirmed.
You need to start billing cycles, fulfillment workflows, recurring charges, and other automated processes tied to the order’s lifecycle.

Path Parameters

Parameter	Type	Description
order_id	string	The unique identifier of the order to activate.

Query Parameters

This endpoint does not accept query parameters.

Request Body

                JSON
              

                      {
    "order": {
        "effective_date": "YYYY-MM-DD"
    }
}

                    

Attribute	Type	Description
order	object	Wrapper object containing activation information.
order.effective_date	string (date)	The date on which the order becomes effective. Must follow YYYY-MM-DD format.

Response

Upon successful activation, the API returns a detailed representation of the activated order. This includes the updated status (ACTIVE), computed billing dates, time zone information, communication preferences, pricing structures, order lines, KPIs, and internal system metadata. The response confirms that the order has transitioned from a non-active state into an active lifecycle state, enabling billing, fulfillment, and revenue processes.

Response Body

                JSON
              

                      {
    "order": {
        "status": "ACTIVE",
        "id": "ORDER_ID",
        "pre_order": "BOOLEAN_VALUE",
        "quote_order": "BOOLEAN_VALUE",
        "name": "ORDER_NAME",
        "display_name": "ORDER_DISPLAY_NAME",
        "description": "ORDER_DESCRIPTION",
        "referral_account": "REFERRAL_ACCOUNT_VALUE",
        "customer_purchase_order_id": "CUSTOMER_PO_VALUE",
        "shipping_profile": {},
        "shipping_cost": "DECIMAL_VALUE",
        "discount_profile": null,
        "origin": "ORIGIN_VALUE",
        "custom_forms": {
            "uuid": "CUSTOM_FORM_UUID",
            "name": "CUSTOM_FORM_NAME"
        },
        "currency": {
            "uuid": "CURRENCY_UUID",
            "name": "CURRENCY_NAME",
            "link": "CURRENCY_LINK"
        },
        "time_zone": {
            "uuid": "TIME_ZONE_UUID",
            "name": "TIME_ZONE_NAME",
            "link": "TIME_ZONE_LINK"
        },
        "invoice_note": "INVOICE_NOTE_VALUE",
        "communication_preference": [
            {
                "media": "MEDIA_TYPE",
                "enabled": "BOOLEAN_VALUE"
            }
        ],
        "billing_start_date": "BILLING_START_DATE_VALUE",
        "order_start_date": "ORDER_START_DATE_VALUE",
        "next_billing_from_date": "NEXT_BILLING_FROM_DATE_VALUE",
        "next_billing_from_date_utc": "NEXT_BILLING_FROM_DATE_UTC_VALUE",
        "price_tax_inclusive": "BOOLEAN_VALUE",
        "billing_address": {},
        "shipping_address": {},
        "created_by": "CREATED_BY_USER",
        "created_on": "CREATED_ON_TIMESTAMP",
        "last_updated_by": "LAST_UPDATED_BY_USER",
        "last_updated_on": "LAST_UPDATED_ON_TIMESTAMP",
        "uuid": "ORDER_UUID",
        "version": "VERSION_NUMBER",
        "account_id": "ACCOUNT_ID",
        "account_name": "ACCOUNT_NAME",
        "account_email_address": "ACCOUNT_EMAIL",
        "allow_contract": "BOOLEAN_VALUE",
        "custom_attributes": [],
        "custom_objects": [],
        "currency_id": "CURRENCY_ID",
        "properties": {
            "communication_profile": "COMM_PROFILE_VALUE",
            "invoice_mode": "INVOICE_MODE_VALUE",
            "invoice_term": "INVOICE_TERM_VALUE",
            "billing_period": "BILLING_PERIOD_VALUE",
            "consolidate_invoice": "BOOLEAN_VALUE",
            "payment_processor": "PAYMENT_PROCESSOR_VALUE",
            "payment_mode": "PAYMENT_MODE_VALUE",
            "payment_term": "PAYMENT_TERM_VALUE",
            "payment_term_alignment": "TERM_ALIGNMENT_VALUE",
            "fulfillment_mode": "FULFILLMENT_MODE_VALUE",
            "fulfillment_term": "FULFILLMENT_TERM_VALUE"
        },
        "lines": [
            {
                "charge_item_uuid": "CHARGE_ITEM_UUID",
                "item_uuid": "ITEM_UUID",
                "item_id": "ITEM_ID",
                "item_name": "ITEM_NAME",
                "item_order_quantity": "QUANTITY_VALUE",
                "shipping_cost": "DECIMAL_VALUE",
                "item_invoice_note": "ITEM_NOTE_VALUE",
                "item_description": "ITEM_DESCRIPTION_VALUE",
                "item_type": "ITEM_TYPE",
                "item_charge_type": "CHARGE_TYPE",
                "item_custom_attributes": [],
                "item_properties": {
                    "billing_mode": "BILLING_MODE_VALUE"
                },
                "item_price_snapshot": {
                    "pricing_rule": {
                        "uuid": "PRICING_RULE_UUID",
                        "version": "RULE_VERSION",
                        "price_type": "PRICE_TYPE_VALUE",
                        "price": "PRICE_VALUE",
                        "uom": "UOM_VALUE",
                        "price_period": "PRICE_PERIOD_VALUE",
                        "pricing_schedule": "PRICING_SCHEDULE_VALUE",
                        "pricing_level": "PRICING_LEVEL_VALUE",
                        "pricing_method": "PRICING_METHOD_VALUE",
                        "warehouse": "WAREHOUSE_NAME"
                    }
                },
                "item_sale_tax_configuration": {
                    "sale_price_is_based_on": "TAX_BASE_VALUE",
                    "tax_code": {
                        "uuid": "TAX_CODE_UUID",
                        "code": "TAX_CODE_VALUE",
                        "rate": "TAX_RATE_VALUE",
                        "link": "TAX_CODE_LINK"
                    }
                },
                "tax_exempt_when_sold": "BOOLEAN_VALUE",
                "item_price_tax": {
                    "uuid": "TAX_UUID",
                    "code": "TAX_CODE_VALUE",
                    "rate": 0,
                    "link": "TAX_LINK"
                },
                "item_accounting_code": {
                    "sales_revenue": "ACCOUNTING_CODE_VALUE"
                },
                "version": "LINE_VERSION",
                "expected_delivery_date": "EXPECTED_DELIVERY_DATE_VALUE",
                "purchase_order_id": "PO_ID_VALUE",
                "purchase_invoice_id": "PI_ID_VALUE"
            }
        ],
        "kpis": {
            "start_date": "START_DATE_VALUE",
            "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_ISSUE_DATE_VALUE",
            "last_invoice_total": 0,
            "total_invoice": 0,
            "next_invoice_issue_date": "NEXT_INVOICE_DATE_VALUE",
            "last_reactivated_on": "LAST_REACTIVATED_DATE_VALUE",
            "last_cancelled_on": "LAST_CANCELLED_DATE_VALUE",
            "last_changed_on": "LAST_CHANGED_DATE_VALUE",
            "last_deleted_on": "LAST_DELETED_DATE_VALUE"
        },
        "line_items": []
    }
}

                    

Attribute	Type	Description
order	object	Contains all activated order details.
order.status	string	The updated order status, set to ACTIVE.
order.id	string	System-generated order identifier.
order.pre_order	string	Indicates if the order is a pre-order.
order.quote_order	string	Indicates if the order is derived from a quote.
order.name	string	Order name.
order.display_name	string	Display name for UI.
order.description	string	Optional explanation or notes.
order.currency	object	Currency applied to the order.
order.time_zone	object	Time zone associated with the order.
order.billing_start_date	string	Calculated billing start date after activation.
order.order_start_date	string	Activation timestamp.
order.communication_preference	array	List of enabled communication channels.
order.properties	object	Billing, payment, and fulfillment settings.
order.lines	array	Order line items after activation.
order.kpis	object	Order KPIs and financial statistics.

Purpose

This endpoint allows users to apply changes to an existing order by adding, removing, or modifying order line items. It also supports setting the effective date for when the changes become active. This enables billing adjustments, pricing updates, item quantity changes, and line item restructuring without recreating the order.

Use Case

Updating an existing order after customer requests modifications.
Increasing or decreasing quantities for specific items already in the order.
Updating pricing structures due to promotions or pricing rule changes.
Removing incorrect or no-longer-required order items.
Adding new line items to an active order.
Adjusting billing and invoicing by changing the effective date of the order update.
Managing contract or subscription adjustments in mid-cycle.

Path Parameters

Parameter	Type	Description
order_id	string	Unique identifier of the order to be modified. Required.

Query Parameters

This endpoint does not accept query parameters.

Request Body

                JSON
              

                      {
    "order": {
        "effective_date": "EFFECTIVE_DATE_PLACEHOLDER",
        "lines": [
            {
                "op": "REMOVE_OR_CHANGE_OR_ADD",
                "uuid": "LINE_ITEM_UUID_PLACEHOLDER",
                "item_id": "ITEM_ID_PLACEHOLDER",
                "item_order_quantity": "ITEM_QUANTITY_PLACEHOLDER",
                "item_price_snapshot": {
                    "pricing_rule": {
                        "price": "PRICE_PLACEHOLDER",
                        "uom": "UOM_PLACEHOLDER"
                    }
                }
            }
        ]
    }
}

                    

Attribute	Type	Description
order	object	Container object for order update details.
order.effective_date	string	Date (YYYY-MM-DD) on which the order change becomes effective.
order.lines	array	List of operations to perform on order line items.
order.lines[].op	string	Operation type: add, remove or change.
order.lines[].uuid	string	UUID of the charge item (required for remove and change).
order.lines[].item_id	string	Item ID for new line additions (required for add).
order.lines[].item_order_quantity	string	Quantity to add or update, depending on operation (op).
order.lines[].item_price_snapshot	object	Price structure to apply to the item.
order.lines[].item_price_snapshot.pricing_rule	object	Pricing rule snapshot at time of modification.
order.lines[].item_price_snapshot.pricing_rule.price	string	Price for the item.
order.lines[].item_price_snapshot.pricing_rule.uom	string	Unit of measurement (optional).

Response

The response returns the updated order object along with a unique event UUID that represents this modification event. It includes refreshed order metadata, current billing and pricing information, updated timestamps, and the final state of all line items after the applied changes. The system recalculates totals, taxes, discounts, and other financial fields based on the modifications, ensuring the returned object always represents the authoritative up-to-date order snapshot.

Response Body

                JSON
              

                      {
    "event_uuid": "EVENT_UUID_PLACEHOLDER",
    "order": {
        "status": "STATUS_PLACEHOLDER",
        "id": "ORDER_ID_PLACEHOLDER",
        "pre_order": "BOOLEAN_PLACEHOLDER",
        "quote_order": "BOOLEAN_PLACEHOLDER",
        "name": "ORDER_NAME_PLACEHOLDER",
        "display_name": "ORDER_DISPLAY_NAME_PLACEHOLDER",
        "description": "DESCRIPTION_PLACEHOLDER",
        "referral_account": "REFERRAL_ACCOUNT_PLACEHOLDER",
        "customer_purchase_order_id": "CUSTOMER_PO_ID_PLACEHOLDER",
        "shipping_profile": {},
        "shipping_cost": "SHIPPING_COST_PLACEHOLDER",
        "discount_profile": "DISCOUNT_PROFILE_PLACEHOLDER",
        "origin": "ORIGIN_PLACEHOLDER",
        "custom_forms": {
            "uuid": "FORM_UUID_PLACEHOLDER",
            "name": "FORM_NAME_PLACEHOLDER"
        },
        "currency": {
            "uuid": "CURRENCY_UUID_PLACEHOLDER",
            "name": "CURRENCY_NAME_PLACEHOLDER",
            "link": "CURRENCY_LINK_PLACEHOLDER"
        },
        "time_zone": {
            "uuid": "TIMEZONE_UUID_PLACEHOLDER",
            "name": "TIMEZONE_NAME_PLACEHOLDER",
            "link": "TIMEZONE_LINK_PLACEHOLDER"
        },
        "invoice_note": "INVOICE_NOTE_PLACEHOLDER",
        "communication_preference": [],
        "billing_start_date": "BILLING_START_DATE_PLACEHOLDER",
        "order_start_date": "ORDER_START_DATE_PLACEHOLDER",
        "next_billing_from_date": "NEXT_BILLING_FROM_DATE_PLACEHOLDER",
        "price_tax_inclusive": "BOOLEAN_PLACEHOLDER",
        "billing_address": {},
        "shipping_address": {},
        "created_by": "CREATED_BY_PLACEHOLDER",
        "created_on": "CREATED_ON_PLACEHOLDER",
        "last_updated_by": "LAST_UPDATED_BY_PLACEHOLDER",
        "last_updated_on": "LAST_UPDATED_ON_PLACEHOLDER",
        "uuid": "ORDER_UUID_PLACEHOLDER",
        "version": "ORDER_VERSION_PLACEHOLDER",
        "account_id": "ACCOUNT_ID_PLACEHOLDER",
        "account_name": "ACCOUNT_NAME_PLACEHOLDER",
        "allow_contract": "BOOLEAN_PLACEHOLDER",
        "custom_attributes": [],
        "custom_objects": [],
        "currency_id": "CURRENCY_ID_PLACEHOLDER",
        "properties": {},
        "invoice_id": "INVOICE_ID_PLACEHOLDER",
        "lines": [
            {
                "charge_item_uuid": "CHARGE_ITEM_UUID_PLACEHOLDER",
                "item_uuid": "ITEM_UUID_PLACEHOLDER",
                "item_id": "ITEM_ID_PLACEHOLDER",
                "item_name": "ITEM_NAME_PLACEHOLDER",
                "item_order_quantity": "ITEM_QUANTITY_PLACEHOLDER",
                "shipping_cost": "SHIPPING_COST_PLACEHOLDER",
                "item_invoice_note": "ITEM_INVOICE_NOTE_PLACEHOLDER",
                "item_description": "ITEM_DESCRIPTION_PLACEHOLDER",
                "item_type": "ITEM_TYPE_PLACEHOLDER",
                "item_charge_type": "CHARGE_TYPE_PLACEHOLDER",
                "item_custom_attributes": [],
                "item_price_snapshot": {
                    "pricing_rule": {
                        "uuid": "PRICING_RULE_UUID_PLACEHOLDER",
                        "version": "PRICING_RULE_VERSION_PLACEHOLDER",
                        "price_type": "PRICE_TYPE_PLACEHOLDER",
                        "price": "PRICE_PLACEHOLDER",
                        "uom": "UOM_PLACEHOLDER",
                        "price_period": "PRICE_PERIOD_PLACEHOLDER",
                        "pricing_schedule": "PRICING_SCHEDULE_PLACEHOLDER",
                        "pricing_level": "PRICING_LEVEL_PLACEHOLDER",
                        "pricing_method": "PRICING_METHOD_PLACEHOLDER",
                        "warehouse": "WAREHOUSE_PLACEHOLDER"
                    }
                },
                "item_sale_tax_configuration": {},
                "isTaxExemptWhenSold": "BOOLEAN_PLACEHOLDER",
                "item_price_tax": {},
                "item_accounting_code": {},
                "version": "LINE_VERSION_PLACEHOLDER",
                "expected_delivery_date": "DELIVERY_DATE_PLACEHOLDER",
                "purchase_order_id": "PO_ID_PLACEHOLDER",
                "purchase_invoice_id": "PI_ID_PLACEHOLDER",
                "discount": "DISCOUNT_PLACEHOLDER",
                "total": "LINE_TOTAL_PLACEHOLDER",
                "subtotal": "LINE_SUBTOTAL_PLACEHOLDER",
                "tax": "LINE_TAX_PLACEHOLDER"
            }
        ],
        "total": "ORDER_TOTAL_PLACEHOLDER",
        "subtotal": "ORDER_SUBTOTAL_PLACEHOLDER",
        "tax": "ORDER_TAX_PLACEHOLDER",
        "kpis": {},
        "line_items": []
    }
}

                    

Attribute	Type	Description
event_uuid	string	Unique event UUID representing this order modification.
order	object	The complete updated order object with recalculated totals.
order.status	string	Status of the order (example: ACTIVE).
order.id	string	System-generated order identifier.
order.pre_order	string	Indicates if the order was created as a pre-order.
order.quote_order	string	Indicates if the order is a quotation order.
order.name	string	Order name.
order.display_name	string	Display-friendly order name.
order.description	string	Description of the order.
order.origin	string	Value showing where the order originated from.
order.custom_forms	object	Assigned custom form metadata.
order.currency	object	Currency information for the order.
order.time_zone	object	Time zone of the order/account.
order.billing_start_date	string	Order billing start date.
order.order_start_date	string	Effective order start date.
order.price_tax_inclusive	string	Indicates if prices include tax.
order.lines	array	All updated line items.
order.lines[].op	string	Operation applied: add/remove/change.
order.lines[].uuid	string	Charge item UUID.
order.lines[].item_id	string	Associated item ID.
order.lines[].item_order_quantity	string	Updated item quantity.
order.lines[].item_price_snapshot	object	Final snapshot of pricing rules.
order.total	string	Total order amount.
order.subtotal	string	Subtotal before tax.
order.tax	string	Total tax.
order.kpis	object	Key performance indicators for the order.

Purpose

This API endpoint is used to create a new order within the system. It allows clients to define whether the order is a pre-order, specify the customer account, include line items, and optionally provide pricing or snapshot details. The API returns the fully constructed order object, including system-generated metadata such as IDs, UUIDs, pricing snapshots, billing configuration, KPIs, and other order-related details.

Use Case

Creating a new customer order using the minimum required fields (account ID and line items).
Creating a pre-order to reserve stock before fulfillment.
Adding item quantities and automatically generating default pricing snapshots based on the item configuration.
Preparing order data for subsequent invoicing, fulfillment, or contract creation.
Validating billing parameters, order structure, and line item correctness before further processing.

Path Parameters

This endpoint does not accept path parameters.

Query Parameters

This endpoint does not accept query parameters.

Request Body

                JSON
              

                      {
    "order": {
        "pre_order": "true_or_false",
        "account_id": "ACCOUNT_ID_PLACEHOLDER",
        "price_tax_inclusive": "true_or_false",
        "lines": [
            {
                "item_id": "ITEM_ID_PLACEHOLDER",
                "item_order_quantity": "QUANTITY_PLACEHOLDER"
            }
        ]
    }
}

                    

Attribute	Type	Description
order	object	Wrapper object containing order details.
order.pre_order	string	Indicates whether this is a pre-order (true or false).
order.account_id	string	Unique ID of the customer account associated with the order.
order.price_tax_inclusive	string	Indicates whether item prices include tax.
order.lines	array	List of line items included in the order.
order.lines[].item_id	string	ID of the item being ordered.
order.lines[].item_order_quantity	string	Quantity of the item to order.

Response

The response returns the full order object after successful creation. It includes system-generated IDs, UUIDs, start dates, time zone, currency details, billing rules, order properties, pricing snapshots, tax configuration, KPIs, and line item data. The response also confirms metadata such as who created the order, when it was created, internal versioning, and additional attributes or objects attached to the order. This allows the client to immediately work with a complete and validated order record along with all system-generated calculations and defaults.

Response Body

                JSON
              

                      {
    "order": {
        "status": "STATUS_PLACEHOLDER",
        "id": "ORDER_ID_PLACEHOLDER",
        "pre_order": "true_or_false",
        "quote_order": "true_or_false",
        "name": "ORDER_NAME_PLACEHOLDER",
        "display_name": "ORDER_DISPLAY_NAME_PLACEHOLDER",
        "description": "",
        "referral_account": "",
        "customer_purchase_order_id": "",
        "shipping_profile": {},
        "shipping_cost": "SHIPPING_COST_PLACEHOLDER",
        "discount_profile": null,
        "origin": "",
        "custom_forms": {
            "uuid": "FORM_UUID_PLACEHOLDER",
            "name": "FORM_NAME_PLACEHOLDER"
        },
        "currency": {
            "uuid": "CURRENCY_UUID_PLACEHOLDER",
            "name": "CURRENCY_NAME_PLACEHOLDER",
            "link": "CURRENCY_LINK_PLACEHOLDER"
        },
        "time_zone": {
            "uuid": "TIMEZONE_UUID_PLACEHOLDER",
            "name": "TIMEZONE_NAME_PLACEHOLDER",
            "link": "TIMEZONE_LINK_PLACEHOLDER"
        },
        "invoice_note": "",
        "billing_start_date": "BILLING_START_DATE_PLACEHOLDER",
        "order_start_date": "ORDER_START_DATE_PLACEHOLDER",
        "next_billing_from_date": "",
        "price_tax_inclusive": "true_or_false",
        "billing_address": {},
        "shipping_address": {},
        "created_by": "CREATED_BY_PLACEHOLDER",
        "created_on": "CREATED_ON_PLACEHOLDER",
        "last_updated_by": "",
        "last_updated_on": "",
        "uuid": "ORDER_UUID_PLACEHOLDER",
        "version": "VERSION_NUMBER_PLACEHOLDER",
        "account_id": "ACCOUNT_ID_PLACEHOLDER",
        "account_name": "ACCOUNT_NAME_PLACEHOLDER",
        "allow_contract": "true_or_false",
        "custom_attributes": [],
        "custom_objects": [],
        "currency_id": "CURRENCY_ID_PLACEHOLDER",
        "properties": {
            "communication_profile": "",
            "invoice_mode": "INVOICE_MODE_PLACEHOLDER",
            "invoice_term": "INVOICE_TERM_PLACEHOLDER",
            "billing_period": "BILLING_PERIOD_PLACEHOLDER",
            "consolidate_invoice": "true_or_false",
            "payment_processor": "PAYMENT_PROCESSOR_PLACEHOLDER",
            "payment_mode": "PAYMENT_MODE_PLACEHOLDER",
            "payment_term": "PAYMENT_TERM_PLACEHOLDER",
            "payment_term_alignment": "ALIGNMENT_PLACEHOLDER",
            "fulfillment_mode": "FULFILLMENT_MODE_PLACEHOLDER",
            "fulfillment_term": "FULFILLMENT_TERM_PLACEHOLDER"
        },
        "invoice_id": "",
        "lines": [],
        "total": "TOTAL_PLACEHOLDER",
        "subtotal": "SUBTOTAL_PLACEHOLDER",
        "tax": "TAX_PLACEHOLDER",
        "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": "",
            "last_reactivated_on": "",
            "last_cancelled_on": "",
            "last_changed_on": "",
            "last_deleted_on": ""
        },
        "line_items": []
    }
}

                    

Attribute	Type	Description
order	object	Wrapper object containing all order information.
order.status	string	Current status of the order (example: ACTIVE).
order.id	string	System-generated unique order ID.
order.pre_order	string	Indicates if this is a pre-order.
order.quote_order	string	Indicates if the order is a quotation.
order.name	string	Internal name of the order.
order.display_name	string	Human-readable order display name.
order.description	string	Optional order description.
order.referral_account	string	Referral account ID, if provided.
order.customer_purchase_order_id	string	External purchase order reference, if provided.
order.shipping_profile	object	Shipping configuration.
order.shipping_cost	string	Total shipping cost applied to the order.
order.discount_profile	object/null	Applied discount profile, if any.
order.origin	string	Defines the origin source of the order.
order.custom_forms	object	Form details linked to the order.
order.currency	object	Currency details used for the order.
order.time_zone	object	Time zone used for date/time calculations.
order.invoice_note	string	Note that will appear on invoices.
order.billing_start_date	string	Billing start date of the order.
order.order_start_date	string	Actual start date of the order.
order.next_billing_from_date	string	Next billing reference date.
order.price_tax_inclusive	string	Indicates if order prices include tax.
order.created_by	string	User who created the order.
order.created_on	string	Timestamp of order creation.
order.uuid	string	System-generated order UUID.
order.version	string	Internal revision version of the order.
order.account_id	string	Account ID linked to the order.
order.account_name	string	Account name linked to the order.
order.allow_contract	string	Whether the order can generate a contract.
order.custom_attributes	array	Custom attribute values for the order.
order.custom_objects	array	Custom objects for the order.
order.currency_id	string	Currency numeric ID.
order.properties	object	Billing and operational configuration for the order.
order.invoice_id	string	Related invoice ID if generated.
order.total	string	Total order value.
order.subtotal	string	Order subtotal.
order.tax	string	Total tax amount.
order.kpis	object	Performance indicators for the order.
order.line_items	array	Detailed line item breakdown.

Create Order: /orders

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Cancel an Order: /orders/{order_id}/cancel

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Reactivate an Order : /orders/{order_id}/reactivate

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Create Order Note: /orders/{order_id}/notes

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Upload File Attachment to an Order Note: /orders/{order_id}/notes/{note_uuid}

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Activate an Order: /orders/{order_id}/activate

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Modify an Existing Order: /orders/{order_id}/change

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Create Pre Order: /orders

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body