Skip to main content

Update Revenue Schedules

Zuora

Update Revenue Schedules

The Update Revenue Schedules mass action allows you to mass update revenue schedules. This reference describes the columns supported in the upload file and the columns added to the response file. See Mass Updater for more information.

Prerequisites 

This mass action has the following prerequisites:

Redistribute revenue schedule in the closed accounting period

You can redistribute revenue schedules into open Accounting Periods. The offset revenue recognition will be generated automatically in the next open accounting if you choose the automatic distribution method. No matter how it's re-distributed, existing revenue event items in the closed accounting period keep the same, and Zuora generates corresponding new revenue event items in the open accounting period.

Suppose a portion of the redistribution date range falls into closed Accounting Periods. In that case, any revenue associated with closed Accounting Periods will be instead distributed to the next open Accounting Period, along with the offset revenue recognition.

Upload file columns 

The following table describes the columns supported in the upload file.

Column Required? Description

Group ID

Optional

ID of the group that the record belongs to. If a record with a Group ID fails, any subsequent records in that group will not be processed.

Type: string

Character limit: 255

Revenue Schedule Number

Required

Number of the revenue schedule you want to update, for example, RS-00000001.

Type: string

Character limit: 100

Revenue Schedule Reference ID

Optional

Reference ID associated with the revenue schedule. This optional ID is used to link the revenue schedule to an external transaction or entity.

Type: string

Character limit: 60

Revenue Schedule Notes

Optional

Notes you want to associate with the revenue schedule.

Type: string

Character limit: 2,000

Revenue Schedule:<Custom Field>

Optional

Custom field you have defined on the revenue schedule. You can enter any value you have defined for the custom field.

You can add any number of columns for custom fields.

Type: string

Revenue Event Type

Required

System ID or label of the revenue event type that describes the creation of this revenue schedule.

The revenue event type must be active in Finance Settings > Revenue Event Types.

Type: string

Character limit: 60

Revenue Event Notes

Optional

Additional information about the revenue event.

Type: string

Character limit: 2,000

Revenue Event:<Custom Field>

Optional

Custom field you have defined on the revenue event. You can enter any value you have defined for the custom field.

You can add any number of columns for custom fields.

Type: string

Distribution Type

Required

How you want to distribute the revenue. Valid values are:

  • Manual: Fixed Amount
  • Manual: Delta Amount
  • Ratable: Daily Distribution
  • Ratable: Monthly Distribution (Front Load)
  • Ratable: Monthly Distribution (Back Load)
  • Ratable: Monthly Distribution (Proration by Days)
  • Specific Date: delta amount
  • Specific Date: delta percent total
  • Specific Date: delta percent undistributed

See Components and Configuration Options for more information about Front Load, Back Load, and Proration by Days for Monthly Distribution.

To use any of the Monthly Distribution options, you must enable the Monthly recognition over time model in Finance Settings > Manage Revenue Recognition Models.

Type: enum

Character limit: 100

Recognition Start

Required if you use a ratable Distribution Type

Start date of the revenue recognition period. Zuora creates a Revenue Schedule distributing revenue between Recognition Start and Recognition End dates.

The date must be in YYYY-MM-DD format.

Type: date

Recognition End

Required if you use a ratable Distribution Type

End date of the revenue recognition period.

The date must be in YYYY-MM-DD format.

Type: date

Distribute On Required if you use a Specific Date Distribution Type.

Date on which to distribute revenue.

The date must be in YYYY-MM-DD format.

Type: date

Distribute Amount Required if you use a Specific Date Distribution Type.

Amount to distribute on specified recognition date.

Type: decimal

Distribute Percentage

Required if you use a Specific Date Distribution Type for either: 

  • Specific Date: delta percent total
  • Specific Date: delta percent undistributed

Percentage of the total recognition amount or total undistributed to distribute.

Type: decimal

<Accounting Period>

At least one Accounting Period is required if you use a manual Distribution Type

Accounting periods into which you want to distribute revenue. You can add any number of columns for accounting periods.

Enter the amount of revenue to distribute into the accounting period.

To prevent the possibility of over-distributing revenue, you can configure the following accounting rule to No:

Allow a Revenue Schedule to have negative amount in Open-Ended Accounting Period

See Configure Accounting Rules for more information about this rule.

Type: decimal

Response file columns

The following table describes the columns added to the response file.

Column Description

Success

  • Returns Y if the record was successful.
  • Returns N if the record failed.
  • Remains blank if the record was not processed.

Revenue Event Number

Number associated with the revenue event.

Error Message

Displays a brief description of the error if the record failed.