The date on which the order is signed. If the contract effective date field is omitted or set to null for any order action under the order, the system uses the order date as the contract effective date.

Commitments Action*

Indicates whether to create a commitment.

Value: create

string

Commitments Currency*

Currency of the commitment.

string <= 100 characters

The description of the commitment

string<= 500 characters

Commitments Name*

The name of the commitment.

String <= 255 characters

Commitments > Commitment Number

Unique identifier assigned to a commitment record.

string

Commitments > Priority*

Specifies the evaluation order of commitments. A lower numeric value indicates a higher priority. If multiple commitments have the same priority value, the system evaluates the commitment created earlier first.

integer

Enum: "NotPrepaid","FullyPrepaid"

Example: FullyPrepaid

string

Commitments Type*

Enum: "MinCommitment","MaxCommitment"

String

string(date)

Commitments > Account Receivable Accounting Code

The accounting code on the commitment object for customers.

string <= 100 characters

Specifies how commitment periods are aligned within a commitment.

Default: CommitmentStartDate Enum: "CommitmentStartDate","SpecificDate"

string

Specifies whether the charge is taxable. If this field is set to true, both the fields TaxCode and TaxMode must be specified.

boolean

Specifies the tax classification applied to the charge.

string<= 100 characters

commitments > TaxMode

Enum: "TaxInclusive", "TaxExclusive"

string

Commitments > Adjustment Liability Accounting Code

Specifies the accounting code used to track liability-related adjustments for the commitment on the customer account

string<= 100 characters

Commitments > Deferred Revenue Accounting Code

Specifies the deferred revenue accounting code for the commitment.

string <= 100 characters

Commitments > Recognized Revenue Accounting Code

Specifies the recognized revenue accounting code for the commitment.

string<= 100 characters

Commitments > Revenue Amortization Method

Specifies the method used to recognize and amortize revenue associated with the commitment.

string <= 200 characters

Commitments > Revenue Recognition Rule

Specifies the rule used to determine the revenue associated with the commitment is recognized.

string <= 255 characters

Commitments > Revenue Recognition Timing

Specifies the timing method used for revenue recognition on the commitment.

string <= 200 characters

Commitments ​> Adjustment Liability Accounting Code

Specifies the accounting code to record liability-related adjustments for the commitment.

string <= 100 characters

Commitments > Adjustment Revenue Accounting Code

string <= 100 characters

Commitments > ​Contract Asset Accounting Code

Specifies the accounting code to record contract liability amounts associated with the commitment.

string <= 100 characters

Commitments ​> Contract Liability Accounting Code

Specifies the accounting code to record recognized revenue amounts for the commitment.

string <= 100 characters

Commitments ​> Contract Recognized Revenue Accounting Code

string <= 100 characters

Commitments > Unbilled Receivables Accounting Code

string <= 100 characters

Commitments​ > Exclude Item Billing From Revenue Accounting

boolean

Commitments > Is Allocation Eligible

Indicates whether the commitment is eligible for revenue allocation during the revenue recognition process.

boolean

Commitments > ​isUnbilled

Commitments > Eligible Account Conditions > Field

Specifies the account field name used in a single eligibility condition.

string

Commitments > Eligible Account Conditions > Operator

Specifies the comparison operator used in a single eligibility condition.

Example:

• eq: equal, field = value
• neq: not equal, field != value
• gt: greater than, field > value
• lt: less than, field < value
• gte: greater than or equal, field >= value
• lte: less than or equal, field <= value - lk: like, field like value
• in: in, field in value, multiple values are separated by commas
• nl: null, field is null
• nnl: not null, field is not null

string

Commitments > Eligible Account Conditions > Value

Specifies the value or list of comma-separated values used to evaluate a single eligibility condition.

string

Commitments > Eligible Account Conditions > Conditions

Array of objects

Commitments > Eligible Account Conditions > Relation

Specifies the logical relationship among the conditions.

string

Commitments > Eligible Charge Conditions > Field

Specifies the charge-related field name used in a single eligibility condition.

string

Commitments > Eligible Charge Conditions > Operator

Specifies the comparison operator used in a single eligibility condition.

Example:

• eq: equal, field = value
• neq: not equal, field != value
• gt: greater than, field > value
• lt: less than, field < value
• gte: greater than or equal, field >= value
• lte: less than or equal, field <= value
• lk: like, field like value
• in: in, field in value, multiple values are separated by commas
• nl: null, field is null
• nnl: not null, field is not null

string

Commitments > Eligible Charge Conditions > Value

Specifies the value or list of comma-separated values used to evaluate a single eligibility condition.

string

Commitments > Eligible Charge Conditions > Conditions

array of objects

Commitments > Eligible Charge Conditions > Relation

Specifies the logical relationship among the conditions.

string

Commitments Is Unbilled

This field is used to dictate how to perform the accounting during revenue recognition.

Note: This field is only available if you have the Order to Revenue feature enabled.

boolean

Commitments > Schedules > Action

Value: create

string

Commitments > Schedules > Amount*

Specifies the committed amount for each period in the commitment schedule.

integer

Commitments > Schedules > Amount Base

Specifies the level to which the committed amount applies.

Default: CommitmentPeriod

string

Commitments > Schedules > Period Type

Specifies the frequency type of each period in the commitment schedule, such as monthly or yearly.

Default: "Month"

Enum: "Month","Quarter","SemiAnnual","Year","SpecificMonths","SinglePeriod"

string

Commitments > Schedules > Specific Period Length

Specifies the exact duration of each period in the commitment schedule.

integer

Commitments > Schedules > Start Date*

Specifies the start date of the commitment schedule.

string (date)

Commitments > Schedules >End Date*

Specifies the end date of the commitment schedule period.

string (date)

Commitments > Schedules > Prepayment Definition Prepayment Frequency

The prepayment frequency for the prepayment definition.

If the value is Specific_Months, Specific_Weeks, or Specific_Days, use the specificFrequency field to specify the duration.

string

Commitments > Schedules > Prepayment Definition Specific Frequency

The specific frequency length.

This field is required when prepaymentFrequency is Specific_Months, Specific_Weeks, or Specific_Days.

integer

Commitments > Schedules > Prepayment Definition Custom Fields

Container for custom fields of a prepayment definition object.

object

Existing Account Id

The account ID under which this order will be created. This field sets the default invoice owner account and subscription owner account for any new subscriptions in the order. To override these defaults for individual subscriptions, use the subscriptionOwnerAccountNumber and invoiceOwnerAccountNumber nested fields in the subscriptions field. If you want to relax the restriction that the existingAccountNumber must be the invoice owner of the subscriptions in this order, submit a request to Zuora Global Support.

string

Existing Account Number*

The account number under which this order will be created. This field sets the default invoice owner account and subscription owner account for any new subscriptions in the order. To override these defaults for individual subscriptions, use the subscriptionOwnerAccountNumber and invoiceOwnerAccountNumber nested fields in the subscriptions field. If you want to relax the restriction that the existingAccountNumber must be the invoice owner of the subscriptions in this order, submit a request to Zuora Global Support.

string <= 70 characters

order Number

The order number of the new order. If not provided, system will auto-generate a number for this order.Note: The characters #, ?, and / are not allowed in this field. Additionally, to ensure compatibility with the UI when viewing orders, use only the following special characters: _,-, ., ~, *, (, ), and '.

string <= 100 characters

status

The status of the order. The default value is Completed. The following values are supported:

• Draft: The order is in draft status.
• Pending: The order is in pending status.
• Completed: The order is in completed status.
• Scheduled: The order is in scheduled status and it is only valid if the Scheduled Orders feature is enabled.
• Executing: The scheduled order is executed by a scheduler and it is only valid if the Scheduled Orders feature is enabled.
• Failed: The scheduled order has failed.

Enum: "Draft","Pending","Completed","Scheduled","Executing","Failed"

string

Scheduling Options Scheduled Date

The date for the order scheduled.

string (date)

Scheduling Options Scheduled Date Policy

Date policy of the scheduled order.

string