Distribute revenue in a recognition period

Distributes revenue by specifying the recognition start and end dates. Request and response field descriptions and sample code are provided.

Request
path Parameters
rs-number
required
string

Revenue schedule number. Specify the revenue schedule whose revenue you want to distribute.

The revenue schedule number is always prefixed with "RS", for example, "RS-00000001".

header Parameters
Accept-Encoding
string

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encoding
string

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Authorization
string

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Zuora-Track-Id
string <= 64 characters

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Entity-Ids
string

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Request Body schema: application/json
required
distributionType
string

How you want to distribute the revenue.

  • Daily Distribution: Distributes revenue evenly across each day between the recognitionStart and recognitionEnd dates.
  • Monthly Distribution (Back Load): Back loads the revenue so you distribute the monthly amount in the partial month in the end only.
  • Monthly Distribution (Front Load): Front loads the revenue so you distribute the monthly amount in the partial month in the beginning only.
  • Monthly Distribution (Proration by Days): Splits the revenue amount between the two partial months.

Note: To use any of the Monthly Distribution options, you must have the "Monthly recognition over time" model enabled in Settings > Finance > Manage Revenue Recognition Models in the Zuora UI.

Enum: "Daily Distribution" "Monthly Distribution (Back Load)" "Monthly Distribution (Front Load)" "Monthly Distribution (Proration by Days)"
eventType
string

Label of the revenue event type. Revenue event type labels can be duplicated. You can configure your revenue event type labels by navigating to Settings > Finance > Configure Revenue Event Types in the Zuora UI.

Note that Credit Memo Posted and Debit Memo Posted are only available if you enable the Invoice Settlement feature.

Enum: "Invoice Posted" "Invoice Item Adjustment Created" "Invoice Canceled" "Invoice Item Adjustment Canceled" "Revenue Distributed" "Credit Memo Posted" "Debit Memo Posted"
eventTypeSystemId
string

System ID of the revenue event type. Each eventType has a unique system ID. You can configure your revenue event type system IDs by navigating to Settings > Finance > Configure Revenue Event Types in the Zuora UI.

notes
string

Additional information about this record.

recognitionEnd
required
string <date>

The end date of a recognition period in yyyy-mm-dd format.

The maximum difference between the recognitionStart and recognitionEnd date fields is equal to 250 multiplied by the length of an accounting period.

recognitionStart
required
string <date>

The start date of a recognition period in yyyy-mm-dd format.

If there is a closed accounting period between the recognitionStart and recognitionEnd dates, the revenue that would be placed in the closed accounting period is instead placed in the next open accounting period.

property name*
additional property
any

Custom fields of the Revenue Event object. The name of each custom field has the form customField__c. Custom field names are case sensitive. See Manage Custom Fields for more information.

Responses
200
put/v1/revenue-schedules/{rs-number}/distribute-revenue-with-date-range
Request samples
application/json
{
  • "distributionType": "Daily distribution",
  • "eventType": "Revenue Distributed",
  • "eventTypeSystemId": "RevenueDistributed__z",
  • "notes": "manual distribute revenue by usage",
  • "recognitionEnd": "2015-12-31",
  • "recognitionStart": "2015-12-1"
}
Response samples
application/json
{
  • "revenueEventNumber": "RE-00000326",
  • "success": true
}