Welcome to Zuora Product Documentation

Explore our rich library of product information

Configure holds

Learn how to configure revenue holds and transfer holds in Zuora Revenue, including prerequisites and field definitions.

Revenue holds and transfer holds are part of the policy configuration in Zuora Revenue.

Before you begin

If you want to set up a hold that is released based on events, make sure the hold event is already created in event setup. For more information, see Event Setup.

Set up a hold

  1. Navigate to Policies > Holds and Approvals. The Revenue Holds page is displayed listing all defined revenue hold rules.

  2. To create a hold, create the New Hold icon (+). The New Hold window is displayed.

  3. Provide the detailed configuration information for the hold using the field definitions below:

    Field

    Description and Functional Impact

    Name

    Provide a unique name for the hold.

    Description

    Enter a short description of the hold's business purpose.

    Enabled

    Toggle to Yes to make the hold active and available for use

    Hold Type

    Select

    • Revenue Hold (blocks schedule creation), or

    • Transfer Hold (blocks GL posting).

    Hold level

    Select the scope of the hold:

    • RC

    • POB

    • Line.

    Release Event

    Select a revenue release event, if applicable.

    System Requirement: You must either define a Release Event, set Allow Manual Release to Yes, or both. The system will block saving if both are empty/No.

    Schedule Type

    For Transfer Holds only - Determines which schedules are blocked for transfer.

    • Revenue

    • Allocation

    • Both

    For Revenue Holds, the system disables this field.

    Start Date

    The effective start date range of the hold.

    If both start/end dates are provided, the Start Date must be on or before the End Date.

    End Date

    The effective end date range of the hold.

    If both start/end dates are provided, the Start Date must be on or before the End Date.

    Allow Manual Release

    Specify whether users can clear the hold from the Workbench.

    System Requirement: Must be Yes if no Release Event is selected.

    Allow Manual Apply

    Specify whether users can apply the hold from the Workbench.

    Toggling to No hides this hold from the manual Workbench dropdown menus. Note: Setting this to No does not prevent the system from auto-applying the hold during Data Collection.

    Expiry Details

    To configure an auto-expiring hold, select the date parameter in the Based On field (e.g., Revenue End Date). You must then define the Duration Type (Days or Months) and the numerical Duration. For example, 3 months after the revenue end date.

  4. If this hold will strictly be applied manually by users, you can click Save to complete the setup. If you want the system to automatically apply this hold, proceed to configure the automation rules based on your selected Hold Level in the following section.

  5. Navigate to Setups > Application > Functionality, to ensure the Holds Enabled toggle is set to Yes after saving the above setup. If the Holds Enabled is No, the system does not run automated hold processing during Data Collection, even when hold criteria and advanced rules are configured.