Orders - create order line item
This reference guide provides a comprehensive list of fields associated with the Create Order Line Item data dictionary.
This article lists all the fields associated with the Create Order Line Item data dictionary in Zuora.
Note: Fields with an asterisk mark indicate mandatory fields.
| Name | Description | Value |
|---|---|---|
| IsNewOrder | Marker Column | TRUE or FALSE |
| Existing Account Number* | The account number under which this order will be created. Note that this actually specifies the invoice owner's account for the subscriptions included in this order. | string <= 70 characters |
| Order Date* | The date the order is signed. If the contract effective date field is skipped or its value is left as null, all the order actions under this order will use this order date as the contract effective date. | string <date> |
| orderNumber | The order number of the new order. If not provided, system will auto-generate a number for this order. The order number must not contain a slash. | string <= 100 characters |
| Status | The status of the order. Default value: Completed. The following values are supported:
| string |
| IsNeworderlineitem | Marker Column | TRUE or FALSE |
| Order Line Items Amount Per Unit | The actual charged amount per unit for the Order Line Item.If you set the inlineDiscountType, inlineDiscountPerUnit, and listPricePerUnit fields, the system will automatically generate the amountPerUnit field. You shall not set the amountPerUnit field by yourself. | number |
| Order Line Items Description | The description of the Order Line Item. | string <= 500 characters |
| Order Line Items Item Name | The name of the Order Line Item. | string |
| Order Line Items Item Type | The type of the Order Line Item.Enum: Product Fee Services | string |
| Order Line Items List Price Per Unit | The list price per unit for the Order Line Item. | number |
| Order Line Items Product Code | The product code for the Order Line Item. | string |
| Order Line Items Purchase Order Number | Used by customers to specify the Purchase Order Number provided by the buyer. | string |
| Order Line Items Quantity | The quantity of units, such as the number of authors in a hosted wiki service. | number |
| Order Line Items Transaction End Date | The date a transaction is completed. The default value of this field is the transaction start date. It should always be equal to or later than the value of the transactionStartDate field. | string <date> |
| Order Line Items Transaction Start Date | The date a transaction starts. The default value of this field is the order date. | string <date> |
| Order Line Items Item Number | The number of the Order Line Item. Use this field to specify a custom item number for your Order Line Item. If you are to use this field, you must set all the item numbers in an order when there are several order line items in the order. | string |
| Order Line Items Unit of measure | Specifies the units to measure usage. | string |
| Order Line Items Accounting Code | The accounting code for the Order Line Item. | string |
| Order Line Items AdjustmentRevenueAccountingCode | The accounting code on the Order Line Item object for customers using Zuora Billing - Revenue Integration . | string |
| Order Line Items Bill Target Date* | The target date for the Order Line Item to be picked up by bill run for billing. | string <date> |
| Order Line Items Bill To | The ID of the bill-to-contact of an order line item. Specify an existing contact under the billing account as the bill-to contact of the order line item. The billing account is the order account. | string |
| Order Line Items Billing Rule | Default: "TriggerWithoutFulfillment" The billing rule for the Order Line Item. Enum: "TriggerWithoutFulfillment" "TriggerAsFulfillmentOccurs" | string |
| Order Line Items ContractAssetAccountingCode | The accounting code on the Order Line Item object for customers using Zuora Billing - Revenue Integration. | string |
| Order Line Items ContractLiabilityAccountingCode | The accounting code on the Order Line Item object for customers using Zuora Billing - Revenue Integration. | string |
| Order Line Items ContractRecognizedRevenueAccountingCode | The accounting code on the Order Line Item object for customers using Zuora Billing - Revenue Integration. | string |
| Order Line Items Currency Code | The currency for the order line item. You can specify a currency when creating an order line item through theCreate an orderCreate an order operation. | string |
| Order Line Items Deferred Revenue Accounting Code | The deferred revenue accounting code for the Order Line Item. | string |
| Order Line Items Exclude Item Billing From Revenue Accounting | Default: false The flag to exclude Order Line Item related invoice items, invoice item adjustments, credit memo items, and debit memo items from revenue accounting. Note: This field is only available if you have the Order to Revenue or Zuora Billing - Revenue Integration feature enabled. | boolean |
| Order Line Items Exclude Item Booking From Revenue Accounting | Default: false The flag to exclude Order Line Item from revenue accounting. Note: This field is only available if you have the Order to Revenue or Zuora Billing - Revenue Integration feature enabled. | boolean |
| Order Line Items Inline Discount Per Unit | Use this field in accordance with the inlineDiscountType field, in the following manner: If the inlineDiscountType field is set as Percentage, this field specifies the discount percentage for each unit of the order line item. For exmaple, if you specify 5 in this field, the discount percentage is 5%. If the inlineDiscountType field is set as FixedAmount, this field specifies the discount amount on each unit of the order line item. For exmaple, if you specify 10 in this field, the discount amount on each unit of the order line item is 10. Once you set the inlineDiscountType, inlineDiscountPerUnit, and listPricePerUnit fields, the system will automatically generate the amountPerUnit field. You shall not set the amountPerUnit field by yourself. | number |
| Order Line Items Inline Discount Type | Use this field to specify the inline discount type, which can be Percentage, FixedAmount, or None. The default value is Percentage. Use this field together with the inlineDiscountPerUnit field to specify inline discounts for order line items. The inline discount is applied to the list price of an order line item. Once you set the inlineDiscountType, inlineDiscountPerUnit, and listPricePerUnit fields, the system will automatically generate the amountPerUnit field. You shall not set the amountPerUnit field by yourself. Enum: "Percentage" "FixedAmount" "None" | string |
| Order Line Items isAllocationEligible | This field is used to identify if the charge segment is allocation eligible in revenue recognition. Note: This feature is in the Early Adopter phase. If you want to use the feature, submit a request at Zuora Global Support, and we will evaluate whether it is suitable for your use cases. | boolean |
| Order Line Items isUnbilled | This field is used to dictate how to perform the accounting during revenue recognition. Note: This feature is in the Early Adopter phase. If you want to use the feature, submit a request at Zuora Global Support, and we will evaluate whether it is suitable for your use cases. | boolean |
| Order Line Items Item Category | Default: "Sales" The category for the Order Line Item, to indicate a product sale or return. Enum: "Sales" "Return" | string |
| Order Line Items Item State | The number of the Order Line Item. Use this field to specify a custom item number for your Order Line Item. If you are to use this field, you must set all the item numbers in an order when there are several order line items in the order. | string |
| Order Line Items itemState | The state of an Order Line Item. If you want to generate billing documents for order line items, you must set this field to SentToBilling. For invoice preview, you do not need to set this field. See State transitions for an order, order line item, and fulfillment for more information. Enum: "Executing" "Booked" "SentToBilling" "Complete" "Cancelled" | string |
| Order Line Items Original Order Line Item Number | The number of the original sale order line item for a return order line item. | string |
| Order Line Items Original Order Number | The number of the original sale order for a return order line item. | string |
| Order Line Items Owner Account Number | Use this field to assign an existing account as the owner of an order line item. | string |
| Order Line Items Product Rate Plan Charge Id | Id of a Product Rate Plan Charge. Only one-time charges are supported. | string |
| Order Line Items Recognized Revenue Accounting Code | The recognized revenue accounting code for the Order Line Item. | string |
| Order Line Items Related Subscription Number | Use this field to relate an order line item to a subscription when you create the order line item. To relate an order line item to a new subscription that is yet to be created in the same "Create an order" call, use this field in combination with the subscriptions > subscriptionNumber field in the "Create an order" operation. Specify this field to the same value as that of the subscriptions > subscription number field when you make the Create an Order Ccall. To relate an order line item to an existing subscription, specify this field to the subscription number of the existing subscription. | string |
| Order Line Items Revenue Recognition Rule | The Revenue Recognition rule for the Order Line Item. | string |
| Order Line Items RevenueRecognitionTiming | Specifies the type of revenue recognition timing. This API Reference lists predefined options as enum values. Depending on the revenue recognition policy configuration in the Zuora Billing UI, other options might also be available. Note: Note: This field is only available if you have the Order to Revenue feature enabled. Enum: "Upon Billing Document Posting Date" "Upon Order Activation Date | string <= 200 characters |
| Order Line Items RevenueAmortizationMethod | Specifies the type of revenue amortization method. This API Reference lists predefined options as enum values. Depending on the revenue recognition policy configuration in the Zuora Billing UI, other options might also be available. Note: Note: This field is only available if you have the Order to Revenue feature enabled. Enum: "Immediate" "Ratable Using Start And End Dates | string <= 200 characters |
| Order Line Items Invoice Group Number | The number of the invoice group associated with the order line item. After enabling the Invoice Grouping feature, you can specify invoice group numbers to bill subscriptions and order line items based on specific criteria. For the same account, Zuora generates separate invoices for subscriptions and order line items, each identified by unique invoice group numbers. For more information, see Invoice Grouping. Note: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body and the value of this field is null in the response body. If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to null in the response body. You can specify this field on a sales order line item when its state (that is, the itemState field) is Executing, Booked, or SentToBilling. | string or null <= 255 characters |
| Order Line Items Sequence Set Id | The ID of the sequence set associated with the order line item. Note: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body, and its value is null in the response body. If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to null in the response body. You can specify this field on a sales order line item when its state (that is, the itemState field) is Executing, Booked, or SentToBilling. | string |
| Order Line Items Payment Term | The payment term name associated with the order line item. Note: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body, and its value is null in the response body. If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to null in the response body. You can specify this field on a sales order line item when its state (that is, the itemState field) is Executing, Booked, or SentToBilling. | string |
| Order Line Items Invoice Template Id | The ID of the invoice template associated with the order line item. Note: If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body, and its value is null in the response body. If you have the Flexible Billing Attributes feature enabled, and you do not specify this field in the request during subscription creation, the value of this field is automatically set to null in the response body. You can specify this field on a sales order line item when its state (that is, the itemState field) is Executing, Booked, or SentToBilling. | string |
| Order Line Items Sold To | Use this field to assign an existing account as the sold-to contact of an order line item, by the following rules: If the ownerAccountNumber field is set, then this field must be the ID of a contact that belongs to the owner account of the order line item. If the ownerAccountNumber field is not set, then this field must be the ID of a contact that belongs to the billing account of the order line item. The billing account is the order account. | string |
| Order Line Items Tax Code | The tax code for the Order Line Item. | string |
| Order Line Items Tax Mode | The tax mode for the Order Line Item. Enum: "TaxInclusive" "TaxExclusive" | string |
| Order Line Items Unbilled Receivable Accounting Code | The accounting code on the Order Line Item object for customers using Zuora Billing - Revenue Integration. | string |
| Scheduling Options Scheduled Date | The date for the scheduled order. | string <date> |
| Scheduling Options Scheduled Date Policy | The policy that determines the date for a scheduled order. | SpecificDate |