Zuora Release 2022.03.R5
Welcome to the release notes for Zuora Release 2022.03.R5. This article is a consolidated page of all release notes for the following Zuora products:
For the latest release notes of Zuora Revenue, see Zuora Revenue release notes.
We welcome and appreciate your feedback on this release notes article. Please use the Feedback button to let us know what you think about the new release notes.
Release schedule
For the planned schedule of upcoming Zuora releases, see Zuora Release Management in Zuora Community.
Join Release Notifications in Zuora Community to receive timely notifications about Zuora Billing, Collect, and Central Platform.
Zuora Billing
Orders and Subscriptions
Flexible Billing available for early adopters
The Flexible Billing Attributes feature is generally available and has been enabled for all customers in Sandbox environments. If you want to enable this feature in your Production environments, contact your Zuora account team for assistance.
The Flexible Billing feature provides you the capability to specify bill-to contacts and payment terms at the subscription level, and invoice subscriptions according to the same bill-to contact and payment term.
If one account has subscriptions with different payment terms and bill-to contacts, you no longer have to duplicate the account. You can update bill-to contacts and payment terms through the order actions of Terms and Conditions and Renewal.
For more information, see Flexible Billing.
New fields for Zuora Billing objects
The following fields are now available in Zuora Billing - Revenue Integration to exclude non-revenue related data from syncing to Zuora Revenue:
excludeItemBookingFromRevenueAccounting
: a Boolean value. Setting this field toTrue
excludes non-revenue related rate plan charges and order line items. The default value of this field isFalse
.excludeItemBillingFromRevenueAccounting
: a Boolean value. Setting this field toTrue
excludes non-revenue related invoice items, invoice item adjustments, credit memo items, and debit memo items. The default value of this field isFalse
.
The new fields are available on the following objects:
- Product Rate Plan Charge
- Rate Plan Charge
- Order Line Item
The excludeItemBillingFromRevenueAccounting
field is also available on the following objects:
- Invoice Item
- Invoice Item Adjustment
- Credit Memo Item
- Debit Memo Item
The Zuora UI, API, data source, data query, and AQuA have been enhanced to support these fields:
Object | Field | Supported operations | Access approaches |
---|---|---|---|
Product Rate Plan Charge |
|
|
|
Rate Plan Charge |
|
|
|
Order Line Item |
|
|
|
Credit Memo Item |
excludeItemBillingFromRevenueAccounting |
|
|
Debit Memo Item |
excludeItemBillingFromRevenueAccounting |
|
|
Invoice Item |
excludeItemBillingFromRevenueAccounting |
|
|
Invoice Item Adjustment |
excludeItemBillingFromRevenueAccounting |
|
|
For a summary of REST API updates specific to this feature, see the "Zuora Billing - Revenue Integration" section in 2022 API Changelog (2022-03-24) and API Reference: Billing.
Order Delta Metrics data generated only for active orders
When you create an order, Zuora now only generates Order Delta Metrics data if the order is active. Previously, Zuora generated Order Delta Metrics data for draft and pending orders in addition to active orders.
For more information about Order Delta Metrics, see Order Delta Metrics.
Support for adding and editing externally managed plan IDs for rate plans through Zuora UI
The Externally Managed Plan IDs field is now available on the Add Rate Plan and Edit Rate Plan page. When adding a new product rate plan to a product or editing an existing product rate plan, you can now specify one or more externally managed plan IDs for the plan.
The externally managed plan IDs are identifiers of a Zuora product rate plan used by third-party app stores such as Apple Store. After you have added the externally managed plan IDs to a plan, you can use these external IDs to reference the Zuora product rate plan.
REST API updates to support external product rate plan IDs
The following API updates are made to support external product rate plan IDs:
- A new API operation called "Retrieve a product rate plan" is now available for retrieving a product rate plan using either the product rate plan ID or an externally managed plan ID.
- The "Update a subscription" API operation now supports adding or removing rate plans for subscriptions using external catalog plan IDs.
For more information, see Retrieve a product rate plan and Update a subscription.
Invoicing and Tax
Support for specifying discounts on charges through REST API for standalone invoices
When creating or updating standalone invoices, you can now specify fixed-amount discounts directly on charges through the following operations:
- Create a standalone invoice
- Create standalone invoices
- Update an invoice
- Update invoices
Previously, you had to add invoice items with negative amounts to represent discounts.
With this enhancement, thediscountItems
nested field is available on theinvoiceItems
field for passing in discount information. You can apply up to 10 discount items to an invoice item. They can be ad-hoc discounts or discount charges from your product catalogs.
Enhancement on billing rule to generate consolidated invoices
Starting from this release, if the Allow to consolidate subscriptions, order line items and standalone invoice items into a single invoice? billing rule is set to No, subscriptions, order line items, and standalone invoice items are separated into different invoices based on their origins. Previously, only standalone invoice items were separated out, while subscriptions and order line items were still on the same invoice.
Support for applying variables to functions in HTML invoice templates
When configuring HTML invoice templates, you can now use the Cmd_Assign
command to define a global variable and use the global variable as a merge field. For example, you can display the global variable in invoice PDF files, use functions with the global variable, use the global variable in logic control, and so on.
DateAdd function available in HTML invoice templates
When configuring HTML invoice templates, you can now use the DateAdd(Value,DatePart)
function to add a date interval to a date to return a new date. The date interval can be the number of days or months or years. You can use the new dates to filter objects according to a period, for example, retrieving all payments of an account in the last month or in the last year.
Zuora CPQ
Zuora 360
This section contains release notes for the enhancements and resolved issues on the Zuora side for Zuora 360. The changes documented in this section do not require new Zuora 360 package installation.
For release notes of the enhancements and resolved issues on the Salesforce side for Zuora 360, see Zuora 360 version 5 release notes.
Resolved: Deleted subscriptions, subscription rate plans, and subscription rate plan charges not synced due to sync unreliability
Previously, due to unreliable syncs, data of the following objects in Salesforce were sometimes not removed despite the deletion of their counterparts in your Zuora tenant:
- Subscription
- Rate Plan
- Rate Plan Charge
We have enhanced the sync reliability so that data of these objects in your Zuora tenant are also removed more reliably in Salesforce. Thus this issue has been resolved.
Zuora Collect
Payments
Enhancements on error codes in API responses
Unknown errors that occurred in the following scenarios have been enhanced with more effective error codes and messages.
API Operation | Scenario | Previous error code | Current error code |
---|---|---|---|
CRUD: Create a payment REST API | Specify a wrong value for the effectiveDate field | UNKNOWN_ERROR | INVALID_VALUE |
Create a payment SOAP API | Specify a wrong value for the EffectiveDate field | UNKNOWN_ERROR | INVALID_VALUE |
Note that this update only applies to WSDL 119 or later versions.
Enhancement in using default authorization amount on Vantiv (Now Worldpay)
A newly introduced setting called Use Default Authorization Amount is now available on the Vantiv (Now Worldpay) gateway settings page. If this field is selected, the value specified in the Default Authorization Amount field will be submitted when verifying the card. If this field is not selected, a zero authorization amount will override the value in the Default Authorization Amount field and will be used on card verification.
For more information, see Vantiv (Now Worldpay) Payment Gateway.
Zuora Central Platform
Reporting
Additional currency conversion information available in data source exports
We have enhanced the following data sources to support currency conversion:
- Rate Plan Charge
The following currency conversion fields are now available:- Booking Exchange Rate Date
- Booking Provider Exchange Rate Date
- Booking Exchange Rate
Zuora determines the value of the Booking Exchange Rate Date field based on the Original Order Date field.
- Order Line Item
This data source now supports automatic currency conversion in data source exports. Automatic currency conversion is available for the following fields:- Amount
- Amount Without Tax
- Amount Per Unit
- List Price Per Unit
- List Price
To access currency conversion fields in data source exports, ensure that you have completed the following configuration by navigating to Finance Settings > Manage Currency Conversion:
- Configured your home currency
- Selected the Automatically include additional Currency Conversion information in data source exports checkbox.
For more information, see Foreign currency conversion for data source exports.
Workflow
Support for cloning workflow tasks with one click
You can now clone tasks when editing a workflow version. To clone a task, click the task on the canvas, and then click Clone.
For more information, see Edit a workflow.
Support for skipping heading rows and the trailer record in the Iteration task
The Logic: Iteration task now supports skipping a specified number of rows from the top of a CSV file. It also supports skipping the trailer record of the file. The maximum number of heading rows that can be skipped is 25.
For more information, see Logic: Iteration.
REST API
For a summary of REST API updates and documentation updates in the Zuora API Reference, see 2022 API Changelog.
SOAP API
Current WSDL version: 118
For information about how to check your version and download the latest version. see Zuora WSDL.
SOAP API change history
For a summary of updates made to the SOAP API in recent Zuora releases, see Zuora SOAP API Version History.