Skip to main content

Zuora Collect Release Notes


Zuora Collect Release Notes

Zuora Collect does not have a fixed schedule for product releases. We publish release notes only when a release contains user-facing changes.

April 12, 2021- Configurable Lockbox

Enhancement for identifying the reasons for failed payments

An enhancement for identifying the reasons for failed payments has now been released. Previously, the failure reason was only contained on the details page of each payment record. You need to open the page one by one to check the message. Now the reasons for all failed payments are also included in the failed record report. To access the failed record report, on the Run tab, click the menu icon and then click Generate Failed Payments.

See Using the Configurable Lockbox feature for more information.

Improved user experience in displaying payment records

Previously, when you processed a payment that was applied to multiple billing documents in Configurable Lockbox, a payment record was created for each document that the payment was applied to. We have now condensed the record display by showing only one payment record for all the applied documents.

March 2, 2021- Collections Window

If the Invoice Settlement feature is enabled in the tenant, the information of debit memos is now available on the account details page in Collections Window. You can view debit memos of an account in addition to the invoice details, payments, and retry status as previously provided.

For more information, see Manage accounts in collections for more information.

February 16, 2021 - Configurable Payment Retry

Starting from February 16, 2021, Configurable Payment Retry no longer provides native support for changing payment gateways as part of the retry logic. The default payment gateway and payment method identified on the account are now used for payment retry attempts.

You can still change gateways for payment retry and manage the corresponding logic through an external system such as Workflow, instead of Configurable Payment Retry. If you do not update your existing configuration to remove this changing gateway logic, the application will ignore the request of changing gateways and continue to retry at the designated time. 

For more information, see Configure the Configurable Payment Retry feature.

February 10, 2021 - Collections Window

The Update account agent API operation for Collections Window is now available. It allows you to update the collections agent that is displayed within the Collections Window UI, and the custom field for the agent displayed in account details within the Zuora UI.

To learn about the available API operations, see the Collections Window section in the Collect API Reference.

February 9, 2021 - Configurable Lockbox

We have enhanced the Configurable Lockbox feature to support payment processing against debit memos for the Account Only process.

The following processing options are now available in the Account Document Processing Options setting if you have the Invoice Settlement feature enabled in your Zuora tenant:

  • Debit Memos Only
  • Debit Memo First Then Invoices
  • Invoices First Then Debit Memos
  • Find Next Oldest Invoice or Debit Memo 

This enhancement will not impact your current processing. If you want to include debit memo support in your existing lockbox files, you have to modify your configurations for the particular lockbox file format. 

For more information, see Configure the Configurable Lockbox feature.

January 21, 2021 - Statement Generator and Notes

We released several enhancements to Statement Generator and Notes.

Statement Generator

  • Statement Generator now supports the following merge fields:
    • Account.UnappliedBalance
    • Account.UnappliedCreditMemoAmount
    • Account.UnappliedDebitMemoAmount
    • Payment.UnappliedPayment 
    • For details, see Merge fields supported by Statement Generator.
  • A new field called attach_to_account is now available in the request body of the Create an ad hoc statement run API operation. This field is used to indicate whether the generated statement is attached to the account. 
  • The Create an ad hoc statement run API operation now pulls credit memo data based on the specified time range. The start date and end date are taken into consideration to determine the credit memos that will be extracted. Previously, this operation would pull all credit memos instead of those ones within the indicated date range.  


We have enhanced the Notes feature to support a specific date range within which the notes will be exported. The changes include:

  • In the Export tab of the Notes UI, the following fields have been added:
    • Start Date
    • End Date
  • In the Get Comments API operation, the following query parameters are now supported:
    • start_date
    • end_date

You can use either UI or API to set the start date and end date. If you do not specify them, all notes will be exported.
For more information, see Using the Notes feature and Collect API Reference.

December 16, 2020 - Configurable Lockbox

We have optimized the user interface of the Configurable Lockbox feature. There are no functionality changes, but some operation flows and UI labels have been changed.

There are now four tabs:

  • Dashboard: Displays the recent lockbox runs.
  • Lockboxes: Manage existing lockboxes and add new lockboxes. 
  • Runs: View lockbox runs.
  • Payments: View payment details in lockbox runs.

For details, see Configure the Configurable Lockbox feature and Using the Configurable Lockbox feature.

November 10, 2020 - Collections Window and Notes

We released several enhancements to Collections Window and Notes.

Collections Window

  • You can delete an agent that is not assigned to any accounts.
    Deleting an agent does not prohibit the agent from accessing Collections Window. It just removes the agent from the list for the current user. Any user can perform this operation.
  • Bill-to and sold-to contact details for an account can now be edited in Collections Window. Any user can edit the contact details.
  • You can now edit account-level custom fields for an account in Collections Window. 
    You need to enable the custom fields first in the Settings tab. Any user can edit account-level custom fields.
  • The "Account Number" column has been added to the list of accounts in the Accounts tab and the list of invoices in the Invoices tab. You can now view the account number for every account or invoice record in the lists.

For details, see Configure the Collections Window feature and Using the Collections Window feature.


You can now change the active status of a user from active to deactivated or vice versa. When a user is deactivated, it cannot be mentioned in a note section, or assigned a follow-up task in Collections Window. Comments by the user, or follow-up tasks that were already assigned to the user are not affected. The name of a deactivated user is grayed out. A deactivated user is not removed from the list of users in Notes. You can determine whether a user is active or not by its value (True or False) in the Active column.

Whether a user is active or not has no impact on the collection agent.

For details, see Using the Notes feature.

October 28, 2020 - Advanced Payment Manager

We released an enhancement to the Advanced Payment Manager feature of Collect. With the enhancement, Advanced Payment Manager now accepts direct debit payments. Previously, direct debit payments were rejected in Advanced Payment Manager.

August 31, 2020 - APIs for Collections Window are available for use

We just released the APIs for the Collections Window feature. Collections Window APIs use basic authentication. The user name is the email address that you use for logging in Zuora. The password is the API token that is shown in the settings of Collections Window.

To learn about the available API operations, see the Collections Window section in the Collect API Reference.

August 14, 2020 - Notes APIs released

We have released APIs for the Notes feature. The Notes APIs use API-token for authentication. You need to use "API-Token" as the header key and the API token that is shown in the Setting tab of Notes as the value.

To learn about the available API operations, see the Notes section in the Collect API Reference.

August 6, 2020 - cookie management enhancements

We have improved the cookie management logic for Zuora environments to address the bad-request errors that customers may experience when accessing Marketplace, Collect, and Workflow in Zuora. Previously, customers need to clear their cookies manually to work around the issue. With the improved logic, the issue is now fixed.

For the fix to work, you need to manually clear the cookies for your tenant environment for the last time.

If you use Chrome, please take the steps below to clear the cookies for your Zuora environments. 

  1. Open the Zuora tenant page. 
  2. Start the Chrome DevTool by right-clicking anywhere and selecting Inspect.
  3. Navigate to Application > Clear storage
  4. Ensure Cookies is selected, and click Clear site data.

 If you use other browsers, take appropriate steps to remove cookies for *, or remove cookies for all websites.

July 31, 2020 - Disputes

We will stop provisioning new instances of the Disputes feature from August 1, 2020. We will work with existing customers to transition to a new solution, and plan to remove access to Disputes for all existing customers by October 1, 2020.

April 21, 2020 - Advanced Payment Manager

We have optimized the user interface of the Advanced Payment Manager feature. There are no functionality changes, but some operation flows and UI labels have been changed.

The new UI consists of four tabs.

  • Payment Runs: This is the default tab when you start the Advanced Payment Manager. It displays payment runs that are ongoing or have completed in Advanced Payment Manager. In this tab, you can view the details of a payment run, or start a one-off payment run.

  • Schedules: Displays payment run schedules that are have been defined. You can view or edit the schedules, or create a new payment run schedule.

  • Metrics: The available metrics include the number of payment runs that are running or have been completed, the number of payments that are being processed or have been processed, and the number of active schedules. 

  • Settings: In this tab, you can configure the following settings:

    • General settings, including the time zone, retry rules, and payment methods.
    • Settings that are related to payment rules and document processing.
    • Settings for callouts that are triggered after payment runs.

For details about the changes, see Configure the Advanced Payment Manager feature and Using the Advanced Payment Manager feature.

March 24, 2020 - Collections Window and Notes

We have released two Early Adopter features in Collections Window and Notes. Features that are in the Early Adopter program are available to existing customers for final verifications before they are made generally available.

  • In Collections Window, you can now create a follow-up task to track the collection of a particular payment or account. Follow-up collection tasks are not tied to workflows.
    For details, see Create a follow-up task.
  • In Notes, you can now create a user group for easier communication. By typing @ and then the group name, you can mention a group by the group name in a note in Collections Window. After a group is mentioned in a note, all users in the group will receive an email about the message, as well as a notification in Collections Window.
    For details, see Manage user groups.

Release Notes in 2019

  • December 5, 2019 - Statement Generator
  • November 20, 2019
  • October 9, 2019 - Disputes
  • September 23, 2019 - Advanced Payment Manager
  • September 18, 2019 - Collections Window
  • August 9, 2019 - Advanced Payment Manager
  • July 10, 2019 - Configurable Payment Retry
  • June 18, 2019 - Advanced Payment Manager