--- title: Create Draft Change Order slug: create-draft-change-order docTags: createdAt: 2026-08-25T19:28:59.170Z --- { "id": "vzj-RNMI2L80xt0ibFWPV", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://api.nue.io/change-orders", "servers": [ { "url": "https://api.nue.io/change-orders", "description": "**Production Environment** - Live production server for all customer-facing operations. Use this for production integrations with real customer data and transactions." }, { "url": "https://api.sandbox.nue.io/change-orders", "description": "**Sandbox Environment** - Safe testing environment with sample data for development and integration testing. No rate limits apply. Data is reset weekly. Perfect for prototyping and QA testing." } ], "name": "Create Draft Change Order", "description": "This endpoint allows you to create a preview or draft order change.", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "", "schema": [ { "name": "options", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "previewInvoice", "kind": "optional", "type": "boolean", "description": "Whether to generate preview invoices. Default is true" }, { "name": "calculateTax", "kind": "optional", "type": "boolean", "description": "Whether to calculate tax for the order. Default is false" } ] }, { "name": "timeZone", "kind": "optional", "type": "string", "description": "

The timezone for the order, required for date calculations

" }, { "name": "products", "kind": "optional", "type": "array", "description": "

Array of new products to add (cross-sell). Must be accompanied by at least one entry in assetChanges.

", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "priceBookEntryId", "kind": "required", "type": "string", "description": "Price book entry ID identifying the product to add" }, { "name": "quantity", "kind": "required", "type": "number", "description": "

Quantity to add (must be positive)

" }, { "name": "subscriptionStartDate", "kind": "required", "type": "string", "description": "Effective start date for the new product", "format": "date" }, { "name": "subscriptionTerm", "kind": "optional", "type": "number", "description": "Subscription term in months. Mutually exclusive with coTermAsset" }, { "name": "coTermAsset", "kind": "optional", "type": "string", "description": "

Existing subscription number (e.g. SUB-000200) to co-term with. Mutually exclusive with subscriptionTerm

" }, { "name": "autoRenew", "kind": "optional", "type": "boolean", "description": "

Whether the subscription should auto-renew

" }, { "name": "defaultRenewalTerm", "kind": "optional", "type": "number", "description": "

Renewal term in months when auto-renew is enabled

" }, { "name": "billingTiming", "kind": "optional", "type": "string", "description": "

Billing timing, e.g. In Advance, In Arrears

" }, { "name": "billingPeriod", "kind": "optional", "type": "string", "description": "

Billing frequency, e.g. Month, Year

" }, { "name": "billCycleDay", "kind": "optional", "type": "string", "description": "Day of the billing cycle" }, { "name": "billCycleStartMonth", "kind": "optional", "type": "string", "description": "Starting month for annual billing cycles" }, { "name": "description", "kind": "optional", "type": "string", "description": "Custom description for the new product" }, { "name": "priceTagIds", "kind": "optional", "type": "array", "description": "Price tag IDs to apply discounts", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "priceTagCodes", "kind": "optional", "type": "array", "description": "

Price tag codes (alternative to IDs)

", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "customFields", "kind": "optional", "type": "object", "description": "Custom field values to populate on the order product", "example": "", "schema": [] }, { "name": "addOns", "kind": "optional", "type": "array", "description": "

Bundle add-ons to include with the new product

", "modelRef": "#/components/schemas/NewProductAddOn", "customType": "NewProductAddOn[]", "schema": [ { "name": "productOptionId", "kind": "required", "type": "string", "description": "

Product option ID. For dynamic options, use the composite ID format: {productOptionId}_{priceBookEntryId}

" }, { "name": "productOptionQuantity", "kind": "required", "type": "number", "description": "

Quantity of the add-on

" }, { "name": "subscriptionTerm", "kind": "optional", "type": "number", "description": "Term in months if different from parent" }, { "name": "coTermAsset", "kind": "optional", "type": "string", "description": "

Co-term with an existing subscription

" }, { "name": "subscriptionStartDate", "kind": "optional", "type": "string", "description": "Start date if different from parent", "format": "date" }, { "name": "billingTiming", "kind": "optional", "type": "string", "description": "Billing timing override" }, { "name": "billingPeriod", "kind": "optional", "type": "string", "description": "Billing period override" }, { "name": "billCycleDay", "kind": "optional", "type": "string", "description": "Bill cycle day override" }, { "name": "billCycleStartMonth", "kind": "optional", "type": "string", "description": "Bill cycle start month override" }, { "name": "priceTagIds", "kind": "optional", "type": "array", "description": "Price tag IDs", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "priceTagCodes", "kind": "optional", "type": "array", "description": "Price tag codes", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "customFields", "kind": "optional", "type": "object", "description": "Custom field values", "example": "", "schema": [] }, { "name": "addOns", "kind": "optional", "type": "array", "description": "

Nested add-ons (recursive)

", "modelRef": "#/components/schemas/NewProductAddOn", "customType": "NewProductAddOn[]", "schema": [ { "name": "", "description": "", "customType": "Circular-Reference" } ] } ] } ] }, { "name": "assetChanges", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "changeType", "kind": "required", "type": "string", "description": "Type of change to apply to the asset.", "enum": [ "UpdateQuantity", "UpdateTerm", "Renew", "CoTerm", "Cancel", "ConvertFreeTrial", "Upgrade", "Downgrade", "Swap", "Reconfigure" ] }, { "name": "assetNumber", "kind": "required", "type": "string", "description": "

Unique identifier for the asset (subscription name)

" }, { "name": "quantity", "kind": "optional", "type": "number", "description": "

Change quantity for the asset (required for UpdateQuantity)

" }, { "name": "startDate", "kind": "optional", "type": "string", "description": "

Start date for the change (required for UpdateQuantity, Upgrade, Downgrade, Swap, Reconfigure)

", "format": "date" }, { "name": "term", "kind": "optional", "type": "number", "description": "

Change term for the subscription (required for UpdateTerm)

" }, { "name": "renewalTerm", "kind": "optional", "type": "number", "description": "

Term for renewal (required for Renew)

" }, { "name": "coTermDate", "kind": "optional", "type": "string", "description": "

Date to coterminate the subscription to (required for CoTerm)

", "format": "date" }, { "name": "cancellationDate", "kind": "optional", "type": "string", "description": "

Date to cancel the subscription (required for Cancel)

", "format": "date" }, { "name": "targetPriceBookEntryId", "kind": "optional", "type": "string", "description": "

ID of the target price book entry (required for Upgrade, Downgrade, Swap)

" }, { "name": "addOns", "kind": "optional", "type": "array", "description": "

Array of add-on configurations for bundle reconfiguration (required for Reconfigure)

", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "productOptionId", "kind": "required", "type": "string", "description": "

Product option ID for bundle add-on

" }, { "name": "reconfigureEffectiveDate", "kind": "required", "type": "string", "description": "

When add-on change takes effect

", "format": "date" }, { "name": "productOptionQuantity", "kind": "required", "type": "number", "description": "

Quantity of the add-on

" } ] } ] } ], "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "ApiKeyAuth", "name": "nue-api-key", "kind": "optional", "type": "apiKey", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "201", "description": "

Change order draft/preview created successfully

", "jsonExample": "", "isExpanded": true, "subExamples": [ { "label": "GENERATED", "code": "// Change order draft/preview created successfully\n{\n \"status\": \"\",\n \"data\": {\n \"assets\": [\n {\n \"assetCompositeId\": \"\",\n \"assetLevel\": 0,\n \"assetNumber\": \"\",\n \"assetProvidedById\": \"\",\n \"assetServicedById\": \"\",\n \"assetVersion\": 0,\n \"billingPeriod\": \"\",\n \"billingTiming\": \"\",\n \"cancellationDate\": \"\",\n \"contactId\": \"\",\n \"createdById\": \"\",\n \"createdDate\": \"\",\n \"customerId\": \"\",\n \"description\": \"\",\n \"entityId\": \"\",\n \"externalId\": \"\",\n \"externalName\": \"\",\n \"id\": \"\",\n \"installDate\": \"\",\n \"internalAsset\": false,\n \"isCompetitorProduct\": false,\n \"lastModifiedById\": \"\",\n \"lastModifiedDate\": \"\",\n \"lastVersionedAssetId\": \"\",\n \"listPrice\": 0,\n \"locationId\": \"\",\n \"name\": \"\",\n \"orderProductId\": \"\",\n \"originalAssetId\": \"\",\n \"parentAssetObject\": \"\",\n \"parentId\": \"\",\n \"price\": 0,\n \"priceBookEntryId\": \"\",\n \"priceBookId\": \"\",\n \"productCode\": \"\",\n \"productDescription\": \"\",\n \"productFamily\": \"\",\n \"productId\": \"\",\n \"purchaseDate\": \"\",\n \"quantity\": 0,\n \"reconfigureEffectiveDate\": \"\",\n \"rootId\": \"\",\n \"salesPrice\": 0,\n \"serialNumber\": \"\",\n \"sku\": \"\",\n \"startDate\": \"\",\n \"status\": \"\",\n \"statusReason\": \"\",\n \"taxAmount\": 0,\n \"tcv\": 0,\n \"totalAcv\": 0,\n \"totalAmount\": 0,\n \"totalPrice\": 0,\n \"totalTcv\": 0,\n \"uniqueIdentifier\": \"\",\n \"uomId\": \"\",\n \"usageEndDate\": \"\",\n \"product\": \"\"\n }\n ],\n \"entitlements\": [\n {\n \"billingPeriod\": \"\",\n \"billingTiming\": \"\",\n \"cancellationDate\": \"\",\n \"createdById\": \"\",\n \"createdDate\": \"\",\n \"customerId\": \"\",\n \"endDate\": \"\",\n \"entitlementCompositeId\": \"\",\n \"entitlementLevel\": 0,\n \"entitlementNumber\": \"\",\n \"entitlementVersion\": 0,\n \"externalId\": \"\",\n \"externalName\": \"\",\n \"id\": \"\",\n \"isDeleted\": false,\n \"lastModifiedById\": \"\",\n \"lastModifiedDate\": \"\",\n \"lastVersionedEntitlementId\": \"\",\n \"listPrice\": 0,\n \"name\": \"\",\n \"netSalesPrice\": 0,\n \"orderNumber\": \"\",\n \"orderOnDate\": \"\",\n \"orderProductId\": \"\",\n \"originalEntitlementId\": \"\",\n \"originalEntitlementNumber\": \"\",\n \"parentEntitlementObject\": \"\",\n \"parentId\": \"\",\n \"priceBookEntryId\": \"\",\n \"priceBookId\": \"\",\n \"product\": \"\",\n \"productId\": \"\",\n \"productName\": \"\",\n \"quantity\": 0,\n \"quantityDimension\": \"\",\n \"reconfigureEffectiveDate\": \"\",\n \"rootId\": \"\",\n \"salesPrice\": 0,\n \"startDate\": \"\",\n \"status\": \"\",\n \"taxAmount\": 0,\n \"tcv\": 0,\n \"termDimension\": \"\",\n \"totalACV\": 0,\n \"totalAmount\": 0,\n \"totalPrice\": 0,\n \"totalTCV\": 0,\n \"uomId\": \"\"\n }\n ],\n \"order\": {\n \"customerId\": \"\",\n \"discountAmount\": 0,\n \"discountPercentage\": 0,\n \"effectiveDate\": \"\",\n \"id\": \"\",\n \"listTotal\": 0,\n \"name\": \"\",\n \"priceBookId\": \"\",\n \"status\": \"\",\n \"subtotal\": 0,\n \"systemDiscount\": 0,\n \"systemDiscountAmount\": 0,\n \"taxAmount\": 0,\n \"totalAmount\": 0,\n \"totalPrice\": 0\n },\n \"orderProducts\": [\n {\n \"actualQuantity\": 0,\n \"billingTiming\": \"\",\n \"carvesEligible\": false,\n \"customerId\": \"\",\n \"deltaACV\": 0,\n \"deltaARR\": 0,\n \"deltaCMRR\": 0,\n \"deltaTCV\": 0,\n \"discount\": 0,\n \"discountAmount\": 0,\n \"evergreen\": false,\n \"id\": \"\",\n \"lineType\": \"\",\n \"listPrice\": 0,\n \"listTotalPrice\": 0,\n \"name\": \"\",\n \"netSalesPrice\": 0,\n \"orderId\": \"\",\n \"priceBookEntryId\": \"\",\n \"productId\": \"\",\n \"quantity\": 0,\n \"rootId\": \"\",\n \"salesPrice\": 0,\n \"sortOrder\": 0,\n \"status\": \"\",\n \"subscriptionEndDate\": \"\",\n \"subscriptionStartDate\": \"\",\n \"subscriptionTerm\": 0,\n \"subtotal\": 0,\n \"systemDiscount\": 0,\n \"systemDiscountAmount\": 0,\n \"taxAmount\": 0,\n \"totalAmount\": 0,\n \"totalPrice\": 0,\n \"uomId\": \"\"\n }\n ],\n \"previews\": [\n {\n \"assetNumber\": \"\",\n \"priceSummary\": {\n \"totalPrice\": 0,\n \"totalAmount\": 0,\n \"todayChargePrice\": 0,\n \"todayChargeAmount\": 0,\n \"nextBillingPeriodPrice\": 0,\n \"nextBillingPeriodAmount\": 0,\n \"nextBillingDate\": \"\"\n }\n }\n ],\n \"warnings\": [\n {}\n ]\n }\n}" }, { "label": "Success Response", "code": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"assets\": [],\n \"entitlements\": [],\n \"order\": {\n \"customerId\": \"...\",\n \"discountAmount\": 1,\n \"discountPercentage\": 1,\n \"effectiveDate\": \"...\",\n \"id\": \"...\",\n \"listTotal\": 1,\n \"name\": \"...\",\n \"priceBookId\": \"...\",\n \"status\": \"...\",\n \"subtotal\": 1,\n \"systemDiscount\": 1,\n \"systemDiscountAmount\": 1,\n \"taxAmount\": 1,\n \"totalAmount\": 1,\n \"totalPrice\": 1\n },\n \"orderProducts\": [],\n \"deltas\": {\n \"deltaTCV\": 1200,\n \"deltaACV\": 1200,\n \"deltaCMRR\": 100\n }\n }\n}" } ], "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "status", "kind": "optional", "type": "string", "description": "The status of the request" }, { "name": "data", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "assets", "kind": "optional", "type": "array", "description": "List of assets related to the change order", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "assetCompositeId", "kind": "optional", "type": "string", "description": "Composite ID of the asset" }, { "name": "assetLevel", "kind": "optional", "type": "integer", "description": "Level of the asset in the hierarchy" }, { "name": "assetNumber", "kind": "optional", "type": "string", "description": "Unique number identifying the asset" }, { "name": "assetProvidedById", "kind": "optional", "type": "string", "description": "ID of the entity that provided the asset" }, { "name": "assetServicedById", "kind": "optional", "type": "string", "description": "ID of the entity servicing the asset" }, { "name": "assetVersion", "kind": "optional", "type": "integer", "description": "Version number of the asset" }, { "name": "billingPeriod", "kind": "optional", "type": "string", "description": "Billing period for the asset" }, { "name": "billingTiming", "kind": "optional", "type": "string", "description": "Timing of billing for the asset" }, { "name": "cancellationDate", "kind": "optional", "type": "string", "description": "Date when the asset was or will be cancelled", "format": "date-time" }, { "name": "contactId", "kind": "optional", "type": "string", "description": "ID of the contact associated with the asset" }, { "name": "createdById", "kind": "optional", "type": "string", "description": "ID of the user who created the asset" }, { "name": "createdDate", "kind": "optional", "type": "string", "description": "Date and time when the asset was created", "format": "date-time" }, { "name": "customerId", "kind": "optional", "type": "string", "description": "ID of the customer associated with the asset" }, { "name": "description", "kind": "optional", "type": "string", "description": "Description of the asset" }, { "name": "entityId", "kind": "optional", "type": "string", "description": "ID of the entity associated with the asset" }, { "name": "externalId", "kind": "optional", "type": "string", "description": "

Mapping to an identifier from an external system, in this case Salesforce

" }, { "name": "externalName", "kind": "optional", "type": "string", "description": "

Mapping to the name from an external system, in this case Salesforce

" }, { "name": "id", "kind": "optional", "type": "string", "description": "Unique identifier for the asset" }, { "name": "installDate", "kind": "optional", "type": "string", "description": "Date when the asset was installed", "format": "date-time" }, { "name": "internalAsset", "kind": "optional", "type": "boolean", "description": "Indicates if the asset is internal" }, { "name": "isCompetitorProduct", "kind": "optional", "type": "boolean", "description": "Indicates if the asset is a competitor product" }, { "name": "lastModifiedById", "kind": "optional", "type": "string", "description": "ID of the user who last modified the asset" }, { "name": "lastModifiedDate", "kind": "optional", "type": "string", "description": "Date and time when the asset was last modified", "format": "date-time" }, { "name": "lastVersionedAssetId", "kind": "optional", "type": "string", "description": "ID of the last versioned asset" }, { "name": "listPrice", "kind": "optional", "type": "number", "description": "List price of the asset" }, { "name": "locationId", "kind": "optional", "type": "string", "description": "ID of the location associated with the asset" }, { "name": "name", "kind": "optional", "type": "string", "description": "Name of the asset" }, { "name": "orderProductId", "kind": "optional", "type": "string", "description": "ID of the order product associated with the asset" }, { "name": "originalAssetId", "kind": "optional", "type": "string", "description": "ID of the original asset" }, { "name": "parentAssetObject", "kind": "optional", "type": "string", "description": "Object type of the parent asset" }, { "name": "parentId", "kind": "optional", "type": "string", "description": "ID of the parent asset" }, { "name": "price", "kind": "optional", "type": "number", "description": "Price of the asset" }, { "name": "priceBookEntryId", "kind": "optional", "type": "string", "description": "ID of the price book entry for the asset" }, { "name": "priceBookId", "kind": "optional", "type": "string", "description": "ID of the price book for the asset" }, { "name": "productCode", "kind": "optional", "type": "string", "description": "Code of the product associated with the asset" }, { "name": "productDescription", "kind": "optional", "type": "string", "description": "Description of the product associated with the asset" }, { "name": "productFamily", "kind": "optional", "type": "string", "description": "Family of the product associated with the asset" }, { "name": "productId", "kind": "optional", "type": "string", "description": "ID of the product associated with the asset" }, { "name": "purchaseDate", "kind": "optional", "type": "string", "description": "Date when the asset was purchased", "format": "date-time" }, { "name": "quantity", "kind": "optional", "type": "number", "description": "Quantity of the asset" }, { "name": "reconfigureEffectiveDate", "kind": "optional", "type": "string", "description": "Effective date of asset reconfiguration", "format": "date-time" }, { "name": "rootId", "kind": "optional", "type": "string", "description": "ID of the root asset" }, { "name": "salesPrice", "kind": "optional", "type": "number", "description": "Sales price of the asset" }, { "name": "serialNumber", "kind": "optional", "type": "string", "description": "Serial number of the asset" }, { "name": "sku", "kind": "optional", "type": "string", "description": "Stock Keeping Unit of the asset" }, { "name": "startDate", "kind": "optional", "type": "string", "description": "Start date of the asset", "format": "date-time" }, { "name": "status", "kind": "optional", "type": "string", "description": "Current status of the asset" }, { "name": "statusReason", "kind": "optional", "type": "string", "description": "Reason for the current status" }, { "name": "taxAmount", "kind": "optional", "type": "number", "description": "Tax amount for the asset" }, { "name": "tcv", "kind": "optional", "type": "number", "description": "Total Contract Value of the asset" }, { "name": "totalAcv", "kind": "optional", "type": "number", "description": "Total Annual Contract Value of the asset" }, { "name": "totalAmount", "kind": "optional", "type": "number", "description": "Total amount for the asset" }, { "name": "totalPrice", "kind": "optional", "type": "number", "description": "Total price of the asset" }, { "name": "totalTcv", "kind": "optional", "type": "number", "description": "Total Total Contract Value of the asset" }, { "name": "uniqueIdentifier", "kind": "optional", "type": "string", "description": "Unique identifier for the asset" }, { "name": "uomId", "kind": "optional", "type": "string", "description": "ID of the Unit of Measure for the asset" }, { "name": "usageEndDate", "kind": "optional", "type": "string", "description": "End date of asset usage", "format": "date-time" }, { "name": "product", "kind": "optional", "type": "map", "description": "Product object.", "example": "", "customType": "map", "schema": [] } ] }, { "name": "entitlements", "kind": "optional", "type": "array", "description": "List of entitlements associated with the change order", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "billingPeriod", "kind": "optional", "type": "string", "description": "Billing period for the entitlement" }, { "name": "billingTiming", "kind": "optional", "type": "string", "description": "Timing of billing for the entitlement" }, { "name": "cancellationDate", "kind": "optional", "type": "string", "description": "Date when the entitlement was or will be cancelled", "format": "date-time" }, { "name": "createdById", "kind": "optional", "type": "string", "description": "ID of the user who created the entitlement" }, { "name": "createdDate", "kind": "optional", "type": "string", "description": "Date and time when the entitlement was created", "format": "date-time" }, { "name": "customerId", "kind": "optional", "type": "string", "description": "ID of the customer associated with the entitlement" }, { "name": "endDate", "kind": "optional", "type": "string", "description": "End date of the entitlement", "format": "date-time" }, { "name": "entitlementCompositeId", "kind": "optional", "type": "string", "description": "Composite ID of the entitlement" }, { "name": "entitlementLevel", "kind": "optional", "type": "integer", "description": "Level of the entitlement in the hierarchy" }, { "name": "entitlementNumber", "kind": "optional", "type": "string", "description": "Unique number identifying the entitlement" }, { "name": "entitlementVersion", "kind": "optional", "type": "integer", "description": "Version number of the entitlement" }, { "name": "externalId", "kind": "optional", "type": "string", "description": "

Mapping to an identifier from an external system, in this case Salesforce

" }, { "name": "externalName", "kind": "optional", "type": "string", "description": "

Mapping to the name from an external system, in this case Salesforce

" }, { "name": "id", "kind": "optional", "type": "string", "description": "Unique identifier for the entitlement" }, { "name": "isDeleted", "kind": "optional", "type": "boolean", "description": "Indicates if the entitlement is deleted" }, { "name": "lastModifiedById", "kind": "optional", "type": "string", "description": "ID of the user who last modified the entitlement" }, { "name": "lastModifiedDate", "kind": "optional", "type": "string", "description": "Date and time when the entitlement was last modified", "format": "date-time" }, { "name": "lastVersionedEntitlementId", "kind": "optional", "type": "string", "description": "ID of the last versioned entitlement" }, { "name": "listPrice", "kind": "optional", "type": "number", "description": "List price of the entitlement" }, { "name": "name", "kind": "optional", "type": "string", "description": "Name of the entitlement" }, { "name": "netSalesPrice", "kind": "optional", "type": "number", "description": "Net sales price of the entitlement" }, { "name": "orderNumber", "kind": "optional", "type": "string", "description": "Order number associated with the entitlement" }, { "name": "orderOnDate", "kind": "optional", "type": "string", "description": "Date when the order was placed", "format": "date-time" }, { "name": "orderProductId", "kind": "optional", "type": "string", "description": "ID of the order product associated with the entitlement" }, { "name": "originalEntitlementId", "kind": "optional", "type": "string", "description": "ID of the original entitlement" }, { "name": "originalEntitlementNumber", "kind": "optional", "type": "string", "description": "Number of the original entitlement" }, { "name": "parentEntitlementObject", "kind": "optional", "type": "string", "description": "Object type of the parent entitlement" }, { "name": "parentId", "kind": "optional", "type": "string", "description": "ID of the parent entitlement" }, { "name": "priceBookEntryId", "kind": "optional", "type": "string", "description": "ID of the price book entry for the entitlement" }, { "name": "priceBookId", "kind": "optional", "type": "string", "description": "ID of the price book for the entitlement" }, { "name": "product", "kind": "optional", "type": "map", "description": "Product object.", "example": "", "customType": "map", "schema": [] }, { "name": "productId", "kind": "optional", "type": "string", "description": "ID of the product associated with the entitlement" }, { "name": "productName", "kind": "optional", "type": "string", "description": "Name of the product associated with the entitlement" }, { "name": "quantity", "kind": "optional", "type": "number", "description": "Quantity of the entitlement" }, { "name": "quantityDimension", "kind": "optional", "type": "string", "description": "Dimension of the quantity" }, { "name": "reconfigureEffectiveDate", "kind": "optional", "type": "string", "description": "Effective date of entitlement reconfiguration", "format": "date-time" }, { "name": "rootId", "kind": "optional", "type": "string", "description": "ID of the root entitlement" }, { "name": "salesPrice", "kind": "optional", "type": "number", "description": "Sales price of the entitlement" }, { "name": "startDate", "kind": "optional", "type": "string", "description": "Start date of the entitlement", "format": "date-time" }, { "name": "status", "kind": "optional", "type": "string", "description": "Current status of the entitlement" }, { "name": "taxAmount", "kind": "optional", "type": "number", "description": "Tax amount for the entitlement" }, { "name": "tcv", "kind": "optional", "type": "number", "description": "Total Contract Value of the entitlement" }, { "name": "termDimension", "kind": "optional", "type": "string", "description": "Dimension of the term" }, { "name": "totalACV", "kind": "optional", "type": "number", "description": "Total Annual Contract Value of the entitlement" }, { "name": "totalAmount", "kind": "optional", "type": "number", "description": "Total amount for the entitlement" }, { "name": "totalPrice", "kind": "optional", "type": "number", "description": "Total price of the entitlement" }, { "name": "totalTCV", "kind": "optional", "type": "number", "description": "Total Total Contract Value of the entitlement" }, { "name": "uomId", "kind": "optional", "type": "string", "description": "ID of the Unit of Measure for the entitlement" } ] }, { "name": "order", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "customerId", "kind": "optional", "type": "string", "description": "" }, { "name": "discountAmount", "kind": "optional", "type": "number", "description": "" }, { "name": "discountPercentage", "kind": "optional", "type": "number", "description": "" }, { "name": "effectiveDate", "kind": "optional", "type": "string", "description": "" }, { "name": "id", "kind": "optional", "type": "string", "description": "" }, { "name": "listTotal", "kind": "optional", "type": "number", "description": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "" }, { "name": "priceBookId", "kind": "optional", "type": "string", "description": "" }, { "name": "status", "kind": "optional", "type": "string", "description": "" }, { "name": "subtotal", "kind": "optional", "type": "number", "description": "" }, { "name": "systemDiscount", "kind": "optional", "type": "number", "description": "" }, { "name": "systemDiscountAmount", "kind": "optional", "type": "number", "description": "" }, { "name": "taxAmount", "kind": "optional", "type": "number", "description": "" }, { "name": "totalAmount", "kind": "optional", "type": "number", "description": "" }, { "name": "totalPrice", "kind": "optional", "type": "number", "description": "" } ] }, { "name": "orderProducts", "kind": "optional", "type": "array", "description": "List of order products created for the change order", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "actualQuantity", "kind": "optional", "type": "number", "description": "The actual quantity of the product ordered" }, { "name": "billingTiming", "kind": "optional", "type": "string", "description": "

The timing of billing for this product (e.g., in advance, in arrears)

" }, { "name": "carvesEligible", "kind": "optional", "type": "boolean", "description": "Indicates if the product is eligible for carves" }, { "name": "customerId", "kind": "optional", "type": "string", "description": "The unique identifier of the customer" }, { "name": "deltaACV", "kind": "optional", "type": "number", "description": "The change in Annual Contract Value" }, { "name": "deltaARR", "kind": "optional", "type": "number", "description": "The change in Annual Recurring Revenue" }, { "name": "deltaCMRR", "kind": "optional", "type": "number", "description": "The change in Committed Monthly Recurring Revenue" }, { "name": "deltaTCV", "kind": "optional", "type": "number", "description": "The change in Total Contract Value" }, { "name": "discount", "kind": "optional", "type": "number", "description": "The discount percentage applied to the product" }, { "name": "discountAmount", "kind": "optional", "type": "number", "description": "The total discount amount applied to the product" }, { "name": "evergreen", "kind": "optional", "type": "boolean", "description": "Indicates if the product has an evergreen subscription" }, { "name": "id", "kind": "optional", "type": "string", "description": "The unique identifier of the order product" }, { "name": "lineType", "kind": "optional", "type": "string", "description": "

The type of line item (e.g., product, service)

" }, { "name": "listPrice", "kind": "optional", "type": "number", "description": "The list price of the product" }, { "name": "listTotalPrice", "kind": "optional", "type": "number", "description": "The total list price for the quantity ordered" }, { "name": "name", "kind": "optional", "type": "string", "description": "The name of the product" }, { "name": "netSalesPrice", "kind": "optional", "type": "number", "description": "The net sales price after discounts" }, { "name": "orderId", "kind": "optional", "type": "string", "description": "The unique identifier of the parent order" }, { "name": "priceBookEntryId", "kind": "optional", "type": "string", "description": "The unique identifier of the price book entry" }, { "name": "productId", "kind": "optional", "type": "string", "description": "The unique identifier of the product" }, { "name": "quantity", "kind": "optional", "type": "number", "description": "The quantity of the product ordered" }, { "name": "rootId", "kind": "optional", "type": "string", "description": "The root identifier for related products" }, { "name": "salesPrice", "kind": "optional", "type": "number", "description": "The sales price of the product" }, { "name": "sortOrder", "kind": "optional", "type": "number", "description": "The sort order of the product in the order" }, { "name": "status", "kind": "optional", "type": "string", "description": "The current status of the order product" }, { "name": "subscriptionEndDate", "kind": "optional", "type": "string", "description": "The end date of the subscription" }, { "name": "subscriptionStartDate", "kind": "optional", "type": "string", "description": "The start date of the subscription" }, { "name": "subscriptionTerm", "kind": "optional", "type": "number", "description": "The term length of the subscription in months" }, { "name": "subtotal", "kind": "optional", "type": "number", "description": "The subtotal for this order product" }, { "name": "systemDiscount", "kind": "optional", "type": "number", "description": "

The system-applied discount percentage

" }, { "name": "systemDiscountAmount", "kind": "optional", "type": "number", "description": "

The system-applied discount amount

" }, { "name": "taxAmount", "kind": "optional", "type": "number", "description": "The tax amount for this order product" }, { "name": "totalAmount", "kind": "optional", "type": "number", "description": "The total amount for this order product including tax" }, { "name": "totalPrice", "kind": "optional", "type": "number", "description": "The total price for this order product before tax" }, { "name": "uomId", "kind": "optional", "type": "string", "description": "The unique identifier of the Unit of Measure" } ] }, { "name": "previews", "kind": "optional", "type": "array", "description": "

Per-asset billing preview for the change order. Returned when options.previewInvoice is true (the default).

", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "assetNumber", "kind": "optional", "type": "string", "description": "The subscription asset number." }, { "name": "priceSummary", "kind": "optional", "type": "object", "description": "

Billing impact of this change. See the Create Draft Change Orders guide, Reading the Billing Preview.

", "example": "", "schema": [ { "name": "totalPrice", "kind": "optional", "type": "number", "description": "

Value of the change over the rest of the subscription term, before tax. This is not a billing-period amount.

" }, { "name": "totalAmount", "kind": "optional", "type": "number", "description": "

Same as totalPrice at the preview level. Order-level tax, when calculated, is returned on the order (order.tax and order.totalAmount).

" }, { "name": "todayChargePrice", "kind": "optional", "type": "number", "description": "

Amount of the invoice generated for the change today, before tax: the prorated amount from the change date to the next bill date. Its size depends on the subscription's billing period, billing timing and bill cycle day. 0 when no invoice is generated today (for example, billed in arrears).

" }, { "name": "todayChargeAmount", "kind": "optional", "type": "number", "description": "

The same invoice as todayChargePrice, including tax. Invoice previews do not call the tax engine, so this currently equals todayChargePrice. The amount charged at activation is this invoice plus the tax calculated when the invoice is generated.

" }, { "name": "nextBillingPeriodPrice", "kind": "optional", "type": "number", "description": "

Price of the following billing period, before tax. Can currently be returned as 0; do not rely on it for display.

" }, { "name": "nextBillingPeriodAmount", "kind": "optional", "type": "number", "description": "

Amount of the following billing period. Can currently be returned as 0; do not rely on it for display.

" }, { "name": "nextBillingDate", "kind": "optional", "type": "string", "description": "Date of the next regular invoice for the subscription.", "format": "date" } ] } ] }, { "name": "warnings", "kind": "optional", "type": "array", "description": "Any warnings generated during the order preview process.", "example": "", "itemType": "object", "customType": "object[]", "itemExample": "", "itemDefault": "" } ] } ], "isExpanded": true } ] }, { "statusCode": "400", "description": "

Bad Request - The request was malformed or contained invalid parameters

", "jsonExample": "", "isExpanded": true }, { "statusCode": "401", "description": "

Unauthorized - Authentication information is missing or invalid

", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "Im1lUbYadvGdErMQFff5m", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.nue.io/change-orders \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"products\": [\n {\n \"priceBookEntryId\": \"\",\n \"quantity\": \"\",\n \"subscriptionStartDate\": \"\",\n \"addOns\": [\n {\n \"productOptionId\": \"\",\n \"productOptionQuantity\": \"\"\n }\n ]\n }\n ],\n \"assetChanges\": [\n {\n \"changeType\": \"\",\n \"assetNumber\": \"\",\n \"addOns\": [\n {\n \"productOptionId\": \"\",\n \"reconfigureEffectiveDate\": \"\",\n \"productOptionQuantity\": \"\"\n }\n ]\n }\n ]\n }'" }, { "id": "vIlFo296Po4stA4pcgDl_", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"products\": [\n {\n \"priceBookEntryId\": \"\",\n \"quantity\": \"\",\n \"subscriptionStartDate\": \"\",\n \"addOns\": [\n {\n \"productOptionId\": \"\",\n \"productOptionQuantity\": \"\"\n }\n ]\n }\n ],\n \"assetChanges\": [\n {\n \"changeType\": \"\",\n \"assetNumber\": \"\",\n \"addOns\": [\n {\n \"productOptionId\": \"\",\n \"reconfigureEffectiveDate\": \"\",\n \"productOptionQuantity\": \"\"\n }\n ]\n }\n ]\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.nue.io/change-orders\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "n1C50ym4Xac_xoHD4gMOY", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.nue.io/change-orders\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"products\": [\n {\n \"priceBookEntryId\": \"\",\n \"quantity\": \"\",\n \"subscriptionStartDate\": \"\",\n \"addOns\": [\n {\n \"productOptionId\": \"\",\n \"productOptionQuantity\": \"\"\n }\n ]\n }\n ],\n \"assetChanges\": [\n {\n \"changeType\": \"\",\n \"assetNumber\": \"\",\n \"addOns\": [\n {\n \"productOptionId\": \"\",\n \"reconfigureEffectiveDate\": \"\",\n \"productOptionQuantity\": \"\"\n }\n ]\n }\n ]\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "YPI0NNMWDm1r02axH-CqR", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.nue.io/change-orders\"\n\npayload = json.dumps({\n \"products\": [\n {\n \"priceBookEntryId\": \"\",\n \"quantity\": \"\",\n \"subscriptionStartDate\": \"\",\n \"addOns\": [\n {\n \"productOptionId\": \"\",\n \"productOptionQuantity\": \"\"\n }\n ]\n }\n ],\n \"assetChanges\": [\n {\n \"changeType\": \"\",\n \"assetNumber\": \"\",\n \"addOns\": [\n {\n \"productOptionId\": \"\",\n \"reconfigureEffectiveDate\": \"\",\n \"productOptionQuantity\": \"\"\n }\n ]\n }\n ]\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "Im1lUbYadvGdErMQFff5m" }, "results": { "languages": [ { "id": "response-0-201", "language": "201", "code": "// Change order draft/preview created successfully\n{\n \"status\": \"\",\n \"data\": {\n \"assets\": [\n {\n \"assetCompositeId\": \"\",\n \"assetLevel\": 0,\n \"assetNumber\": \"\",\n \"assetProvidedById\": \"\",\n \"assetServicedById\": \"\",\n \"assetVersion\": 0,\n \"billingPeriod\": \"\",\n \"billingTiming\": \"\",\n \"cancellationDate\": \"\",\n \"contactId\": \"\",\n \"createdById\": \"\",\n \"createdDate\": \"\",\n \"customerId\": \"\",\n \"description\": \"\",\n \"entityId\": \"\",\n \"externalId\": \"\",\n \"externalName\": \"\",\n \"id\": \"\",\n \"installDate\": \"\",\n \"internalAsset\": false,\n \"isCompetitorProduct\": false,\n \"lastModifiedById\": \"\",\n \"lastModifiedDate\": \"\",\n \"lastVersionedAssetId\": \"\",\n \"listPrice\": 0,\n \"locationId\": \"\",\n \"name\": \"\",\n \"orderProductId\": \"\",\n \"originalAssetId\": \"\",\n \"parentAssetObject\": \"\",\n \"parentId\": \"\",\n \"price\": 0,\n \"priceBookEntryId\": \"\",\n \"priceBookId\": \"\",\n \"productCode\": \"\",\n \"productDescription\": \"\",\n \"productFamily\": \"\",\n \"productId\": \"\",\n \"purchaseDate\": \"\",\n \"quantity\": 0,\n \"reconfigureEffectiveDate\": \"\",\n \"rootId\": \"\",\n \"salesPrice\": 0,\n \"serialNumber\": \"\",\n \"sku\": \"\",\n \"startDate\": \"\",\n \"status\": \"\",\n \"statusReason\": \"\",\n \"taxAmount\": 0,\n \"tcv\": 0,\n \"totalAcv\": 0,\n \"totalAmount\": 0,\n \"totalPrice\": 0,\n \"totalTcv\": 0,\n \"uniqueIdentifier\": \"\",\n \"uomId\": \"\",\n \"usageEndDate\": \"\",\n \"product\": \"\"\n }\n ],\n \"entitlements\": [\n {\n \"billingPeriod\": \"\",\n \"billingTiming\": \"\",\n \"cancellationDate\": \"\",\n \"createdById\": \"\",\n \"createdDate\": \"\",\n \"customerId\": \"\",\n \"endDate\": \"\",\n \"entitlementCompositeId\": \"\",\n \"entitlementLevel\": 0,\n \"entitlementNumber\": \"\",\n \"entitlementVersion\": 0,\n \"externalId\": \"\",\n \"externalName\": \"\",\n \"id\": \"\",\n \"isDeleted\": false,\n \"lastModifiedById\": \"\",\n \"lastModifiedDate\": \"\",\n \"lastVersionedEntitlementId\": \"\",\n \"listPrice\": 0,\n \"name\": \"\",\n \"netSalesPrice\": 0,\n \"orderNumber\": \"\",\n \"orderOnDate\": \"\",\n \"orderProductId\": \"\",\n \"originalEntitlementId\": \"\",\n \"originalEntitlementNumber\": \"\",\n \"parentEntitlementObject\": \"\",\n \"parentId\": \"\",\n \"priceBookEntryId\": \"\",\n \"priceBookId\": \"\",\n \"product\": \"\",\n \"productId\": \"\",\n \"productName\": \"\",\n \"quantity\": 0,\n \"quantityDimension\": \"\",\n \"reconfigureEffectiveDate\": \"\",\n \"rootId\": \"\",\n \"salesPrice\": 0,\n \"startDate\": \"\",\n \"status\": \"\",\n \"taxAmount\": 0,\n \"tcv\": 0,\n \"termDimension\": \"\",\n \"totalACV\": 0,\n \"totalAmount\": 0,\n \"totalPrice\": 0,\n \"totalTCV\": 0,\n \"uomId\": \"\"\n }\n ],\n \"order\": {\n \"customerId\": \"\",\n \"discountAmount\": 0,\n \"discountPercentage\": 0,\n \"effectiveDate\": \"\",\n \"id\": \"\",\n \"listTotal\": 0,\n \"name\": \"\",\n \"priceBookId\": \"\",\n \"status\": \"\",\n \"subtotal\": 0,\n \"systemDiscount\": 0,\n \"systemDiscountAmount\": 0,\n \"taxAmount\": 0,\n \"totalAmount\": 0,\n \"totalPrice\": 0\n },\n \"orderProducts\": [\n {\n \"actualQuantity\": 0,\n \"billingTiming\": \"\",\n \"carvesEligible\": false,\n \"customerId\": \"\",\n \"deltaACV\": 0,\n \"deltaARR\": 0,\n \"deltaCMRR\": 0,\n \"deltaTCV\": 0,\n \"discount\": 0,\n \"discountAmount\": 0,\n \"evergreen\": false,\n \"id\": \"\",\n \"lineType\": \"\",\n \"listPrice\": 0,\n \"listTotalPrice\": 0,\n \"name\": \"\",\n \"netSalesPrice\": 0,\n \"orderId\": \"\",\n \"priceBookEntryId\": \"\",\n \"productId\": \"\",\n \"quantity\": 0,\n \"rootId\": \"\",\n \"salesPrice\": 0,\n \"sortOrder\": 0,\n \"status\": \"\",\n \"subscriptionEndDate\": \"\",\n \"subscriptionStartDate\": \"\",\n \"subscriptionTerm\": 0,\n \"subtotal\": 0,\n \"systemDiscount\": 0,\n \"systemDiscountAmount\": 0,\n \"taxAmount\": 0,\n \"totalAmount\": 0,\n \"totalPrice\": 0,\n \"uomId\": \"\"\n }\n ],\n \"previews\": [\n {\n \"assetNumber\": \"\",\n \"priceSummary\": {\n \"totalPrice\": 0,\n \"totalAmount\": 0,\n \"todayChargePrice\": 0,\n \"todayChargeAmount\": 0,\n \"nextBillingPeriodPrice\": 0,\n \"nextBillingPeriodAmount\": 0,\n \"nextBillingDate\": \"\"\n }\n }\n ],\n \"warnings\": [\n {}\n ]\n }\n}", "subExamples": [ { "label": "GENERATED", "code": "// Change order draft/preview created successfully\n{\n \"status\": \"\",\n \"data\": {\n \"assets\": [\n {\n \"assetCompositeId\": \"\",\n \"assetLevel\": 0,\n \"assetNumber\": \"\",\n \"assetProvidedById\": \"\",\n \"assetServicedById\": \"\",\n \"assetVersion\": 0,\n \"billingPeriod\": \"\",\n \"billingTiming\": \"\",\n \"cancellationDate\": \"\",\n \"contactId\": \"\",\n \"createdById\": \"\",\n \"createdDate\": \"\",\n \"customerId\": \"\",\n \"description\": \"\",\n \"entityId\": \"\",\n \"externalId\": \"\",\n \"externalName\": \"\",\n \"id\": \"\",\n \"installDate\": \"\",\n \"internalAsset\": false,\n \"isCompetitorProduct\": false,\n \"lastModifiedById\": \"\",\n \"lastModifiedDate\": \"\",\n \"lastVersionedAssetId\": \"\",\n \"listPrice\": 0,\n \"locationId\": \"\",\n \"name\": \"\",\n \"orderProductId\": \"\",\n \"originalAssetId\": \"\",\n \"parentAssetObject\": \"\",\n \"parentId\": \"\",\n \"price\": 0,\n \"priceBookEntryId\": \"\",\n \"priceBookId\": \"\",\n \"productCode\": \"\",\n \"productDescription\": \"\",\n \"productFamily\": \"\",\n \"productId\": \"\",\n \"purchaseDate\": \"\",\n \"quantity\": 0,\n \"reconfigureEffectiveDate\": \"\",\n \"rootId\": \"\",\n \"salesPrice\": 0,\n \"serialNumber\": \"\",\n \"sku\": \"\",\n \"startDate\": \"\",\n \"status\": \"\",\n \"statusReason\": \"\",\n \"taxAmount\": 0,\n \"tcv\": 0,\n \"totalAcv\": 0,\n \"totalAmount\": 0,\n \"totalPrice\": 0,\n \"totalTcv\": 0,\n \"uniqueIdentifier\": \"\",\n \"uomId\": \"\",\n \"usageEndDate\": \"\",\n \"product\": \"\"\n }\n ],\n \"entitlements\": [\n {\n \"billingPeriod\": \"\",\n \"billingTiming\": \"\",\n \"cancellationDate\": \"\",\n \"createdById\": \"\",\n \"createdDate\": \"\",\n \"customerId\": \"\",\n \"endDate\": \"\",\n \"entitlementCompositeId\": \"\",\n \"entitlementLevel\": 0,\n \"entitlementNumber\": \"\",\n \"entitlementVersion\": 0,\n \"externalId\": \"\",\n \"externalName\": \"\",\n \"id\": \"\",\n \"isDeleted\": false,\n \"lastModifiedById\": \"\",\n \"lastModifiedDate\": \"\",\n \"lastVersionedEntitlementId\": \"\",\n \"listPrice\": 0,\n \"name\": \"\",\n \"netSalesPrice\": 0,\n \"orderNumber\": \"\",\n \"orderOnDate\": \"\",\n \"orderProductId\": \"\",\n \"originalEntitlementId\": \"\",\n \"originalEntitlementNumber\": \"\",\n \"parentEntitlementObject\": \"\",\n \"parentId\": \"\",\n \"priceBookEntryId\": \"\",\n \"priceBookId\": \"\",\n \"product\": \"\",\n \"productId\": \"\",\n \"productName\": \"\",\n \"quantity\": 0,\n \"quantityDimension\": \"\",\n \"reconfigureEffectiveDate\": \"\",\n \"rootId\": \"\",\n \"salesPrice\": 0,\n \"startDate\": \"\",\n \"status\": \"\",\n \"taxAmount\": 0,\n \"tcv\": 0,\n \"termDimension\": \"\",\n \"totalACV\": 0,\n \"totalAmount\": 0,\n \"totalPrice\": 0,\n \"totalTCV\": 0,\n \"uomId\": \"\"\n }\n ],\n \"order\": {\n \"customerId\": \"\",\n \"discountAmount\": 0,\n \"discountPercentage\": 0,\n \"effectiveDate\": \"\",\n \"id\": \"\",\n \"listTotal\": 0,\n \"name\": \"\",\n \"priceBookId\": \"\",\n \"status\": \"\",\n \"subtotal\": 0,\n \"systemDiscount\": 0,\n \"systemDiscountAmount\": 0,\n \"taxAmount\": 0,\n \"totalAmount\": 0,\n \"totalPrice\": 0\n },\n \"orderProducts\": [\n {\n \"actualQuantity\": 0,\n \"billingTiming\": \"\",\n \"carvesEligible\": false,\n \"customerId\": \"\",\n \"deltaACV\": 0,\n \"deltaARR\": 0,\n \"deltaCMRR\": 0,\n \"deltaTCV\": 0,\n \"discount\": 0,\n \"discountAmount\": 0,\n \"evergreen\": false,\n \"id\": \"\",\n \"lineType\": \"\",\n \"listPrice\": 0,\n \"listTotalPrice\": 0,\n \"name\": \"\",\n \"netSalesPrice\": 0,\n \"orderId\": \"\",\n \"priceBookEntryId\": \"\",\n \"productId\": \"\",\n \"quantity\": 0,\n \"rootId\": \"\",\n \"salesPrice\": 0,\n \"sortOrder\": 0,\n \"status\": \"\",\n \"subscriptionEndDate\": \"\",\n \"subscriptionStartDate\": \"\",\n \"subscriptionTerm\": 0,\n \"subtotal\": 0,\n \"systemDiscount\": 0,\n \"systemDiscountAmount\": 0,\n \"taxAmount\": 0,\n \"totalAmount\": 0,\n \"totalPrice\": 0,\n \"uomId\": \"\"\n }\n ],\n \"previews\": [\n {\n \"assetNumber\": \"\",\n \"priceSummary\": {\n \"totalPrice\": 0,\n \"totalAmount\": 0,\n \"todayChargePrice\": 0,\n \"todayChargeAmount\": 0,\n \"nextBillingPeriodPrice\": 0,\n \"nextBillingPeriodAmount\": 0,\n \"nextBillingDate\": \"\"\n }\n }\n ],\n \"warnings\": [\n {}\n ]\n }\n}" }, { "label": "Success Response", "code": "{\n \"status\": \"SUCCESS\",\n \"data\": {\n \"assets\": [],\n \"entitlements\": [],\n \"order\": {\n \"customerId\": \"...\",\n \"discountAmount\": 1,\n \"discountPercentage\": 1,\n \"effectiveDate\": \"...\",\n \"id\": \"...\",\n \"listTotal\": 1,\n \"name\": \"...\",\n \"priceBookId\": \"...\",\n \"status\": \"...\",\n \"subtotal\": 1,\n \"systemDiscount\": 1,\n \"systemDiscountAmount\": 1,\n \"taxAmount\": 1,\n \"totalAmount\": 1,\n \"totalPrice\": 1\n },\n \"orderProducts\": [],\n \"deltas\": {\n \"deltaTCV\": 1200,\n \"deltaACV\": 1200,\n \"deltaCMRR\": 100\n }\n }\n}" } ] }, { "id": "response-1-400", "language": "400", "code": "// Bad Request - The request was malformed or contained invalid parameters\n" }, { "id": "response-2-401", "language": "401", "code": "// Unauthorized - Authentication information is missing or invalid\n" } ], "selectedLanguageId": "response-0-201" } }, "children": [ { "text": "" } ] }