Distribute revenue on a specific date

Legacy API Reference

Distribute revenue on a specific date

Request

Distributes revenue on a specific recognition date. Request and response field descriptions and sample code are provided.

Path

rs-numberstringrequired

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

Accept-Encodingstring

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-Encodingstring

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.

Authorizationstring

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

Zuora-Track-Idstring, <= 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-Idsstring

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.

Bodyapplication/jsonrequired

amountstring, (decimal)

The revenue schedule amount, which is the sum of all revenue items. This field cannot be null and must be formatted based on the currency, such as JPY 30 or USD 30.15. Test out the currency to ensure you are using the proper formatting otherwise, the response will fail and this error message is returned: Allocation amount with wrong decimal places.

Example:"1000.00"

distributeOnstring, (date)required

The recognition date on which to distribute revenue for milestone-based recognition.

Type: date in yyyy-mm-dd format.

Example:"2016-02-03"

distributionTypestringrequired

How to distribute the revenue for milestone-based recognition.

Enum:"specific date (delta fixed amount)""specific date (delta percent total)""specific date (delta percent undistributed)"

Example:"specific date (delta fixed amount)"

eventTypestring

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"

Example:"Revenue Distributed"

eventTypeSystemIdstring

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.

Example:"RevenueDistributed__z"

notesstring

Additional information about this record.

Example:"service delivered and accepted by customer"

percentagestring, (decimal)

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

Required if distributionType is either:

specific date (delta percent total)
specific date (delta percent undistributed)

property name*anyadditional property

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.

{
  "amount": "1000.00",
  "distributeOn": "2016-02-03",
  "distributionType": "specific date (delta fixed amount)",
  "eventType": "Revenue Distributed",
  "eventTypeSystemId": "RevenueDistributed__z",
  "notes": "service delivered and accepted by customer"
}

Responses

Headers

Content-Encodingstring

This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.

Note that only the following MIME types support gzipped responses:

application/json
application/xml
text/html
text/csv
text/plain

RateLimit-Limitstring

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

RateLimit-Remainingnumber

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetnumber

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Zuora-Request-Idstring, = 36 characters

The Zuora internal identifier of the API call. You cannot control the value of this header.

Zuora-Track-Idstring, <= 64 characters

A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.

Bodyapplication/json

revenueEventNumberstring

The revenue event number created when a revenue event occurs.

successboolean

Returns true if the request was processed successfully.

Response

{
  "revenueEventNumber": "RE-00000326",
  "success": true
}