Mass Order Entry fields in amendment
This document provides details on the fields available in the Mass Order Entry template, including required fields and conditional entries based on tenant features and custom fields.
The following table describes the information that you can enter in the Mass Order Entry template:
The template you download may not include all the fields listed below, depending on which features your tenant is using. Also, if your tenant uses custom fields for Rate Plan Charges, the custom fields are included in the template.
|
Column |
Required? |
Description |
|---|---|---|
|
(custom fields) |
No |
If you have created custom fields for Rate Plan Charge, download the template after creating them, and they will automatically appear in the template. |
|
Subscription Code |
Yes |
Subscription Number (unique value). If there is more than one charge in the subscription, enter
Prev
for any subsequent lines for that subscription. Example:
|
|
Subscription Version |
No |
Leave this empty. |
|
Account Number |
No |
Leave this empty. |
|
Order Type |
Yes |
String defining the amendment type. Enter this information in the first line of the amendment only. If there is more than one charge in the amendment, please leave any subsequent lines empty for that amendment. Possible values are:
|
|
Order Name (amendments only) |
Yes |
Name of the amendment |
|
Initial Term |
Conditional |
Initial Term of the new Subscription. Only required for Terms and Conditions Amendment. Set to 1 or greater. If term type is EVERGREEN, must be empty. |
|
Renewal Term |
Conditional |
Renewal Term of new Subscription. Only required for Terms and Conditions Amendment. Set to 1 or greater. If term type is EVERGREEN, must be empty. |
|
Term Commitment |
No |
Leave this empty. |
|
AutoRenew |
Conditional |
Specifies whether to automatically renew this subscription at the end of the term. Only required for Terms and Conditions Amendment. Possible values are
|
|
Term Start Date |
Conditional |
Start of of the new subscription term, also used as the basis of renewal date. Only required for Terms and Conditions Amendment - otherwise leave empty.
|
|
Save as Draft |
No |
Leave this empty. |
|
Contract Effective Date |
Yes |
Effective Date of the amendment, as MM/DD/YYYY. |
|
Service Activation Date |
Yes |
Activation Date of the amendment, as MM/DD/YYYY. |
|
Customer Acceptance Date |
Yes |
Date upon which the customer will accept the amendment, as MM/DD/YYYY. |
|
Cancel Subscription Date |
Conditional |
Required if Order Type is
|
|
Product SKU |
Yes |
Product SKU
|
|
Product Name |
Yes |
Product Name
|
|
Rate Plan ID |
Yes |
Internal Zuora rate plan ID
|
|
Rate Plan Name |
Yes |
Rate plan name
|
|
Rate Plan Component ID |
Yes |
Internal Zuora Rate Plan ID
|
|
Charge Name |
Yes |
Product Rate Plan Charge Name
|
|
Charge Description |
No |
Charge description. Leave empty or enter the charge description as it appears in the product catalog. |
|
Price |
No |
Price being charged. Numeric with two decimal places. Example:
|
|
Quantity |
No |
Units being charged
|
|
# Periods To Prepay |
No |
Leave this empty. |
|
Overage Included Units |
No |
Leave this empty.
|
|
Overage Price |
No |
Leave this empty. |
|
Overage (Smoothing) # Periods |
No |
Leave this empty. |
|
Accounting Code |
No |
Accounting code associated with your acting system. |
|
Revenue Recognition Code |
No |
Enter the Revenue Recognition Code as configured on the charge line. |
|
Revenue Recognition Trigger Date |
No |
Enter the Revenue Recognition Trigger Date as configured on the charge line. Possible values are as follows:
|
|
Subscription Term Type |
Yes |
Specify TERMED or EVERGREEN |
|
Overage Credit Back Option |
No |
Leave this empty. |
|
Overage Credit Back Rate |
No |
Leave this empty. |
|
Invoice Separate |
No |
Leave this empty. Also, this column may not be present in the template you download, depending on your tenant setting for the option "Enable Subscriptions to be Invoiced Separately". You cannot modify the "Invoice Separate" field through the Mass Order Entry feature. To modify it, you can use the Update a subscription operation. |
|
Price Change Option |
No |
Leave this empty. |
|
Price Increase Percentage |
No |
Leave this empty. |
|
Use Discount Specific Accounting Code |
No |
Leave this empty. |
|
Invoice Account Number |
No |
Leave this empty. |
|
Destination Account Number |
No |
Leave this empty. |
|
Destination Invoice Account Number |
No |
Leave this empty. |
|
Usage Record Rating Option |
No |
Leave this empty. |