Skip to content
Legacy API Reference
/
/
Create a revenue schedule...

Create a revenue schedule for an invoice item (manual distribution)

Request

Creates a revenue schedule for an Invoice Item and manually distribute the revenue.

Path
invoice-item-idstringrequired

ID of the Invoice Item, for example, e20b07fd416dcfcf0141c81164fd0a75. If the specified Invoice Item is already associated with a revenue schedule, the call will fail.

Headers
Idempotency-Keystring, <= 255 characters

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

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
notesstring

Additional information about this record.

Character Limit: 2,000

revenueDistributionsArray of objects(revenueDistributions)

An array of revenue distributions. Represents how you want to distribute revenue for this revenue schedule. You can distribute revenue into a maximum of 250 accounting periods with one revenue schedule.

The sum of new Amounts must equal the the Charge Amount of the specified Invoice Item.

Example:
[
  {
    "accountingPeriodName": "Jan '16",
    "newAmount": "20"
  },
  {
    "accountingPeriodName": "Open-Ended",
    "newAmount": "30"
  }
]
revenueEventobject(RevenueEvent)

Represents a change to a revenue schedule, such as posting an invoice or distributing revenue.

You must specify the eventType or the eventTypeSystemID, or both. If you have configured more than one revenue event type with the same label, you must specify the eventTypeSystemId.

Example:
{
  "eventType": "Revenue Distributed",
  "eventTypeSystemId": "RevenueDistributed__z",
  "notes": "My notes"
}
property name*anyadditional property

Custom fields of the Revenue Schedule 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.

{
  "revenueDistributions": [
    { … },
    { … }
  ],
  "revenueEvent": {
    "eventType": "Revenue Distributed",
    "eventTypeSystemId": "RevenueDistributed__z",
    "notes": "My notes"
  }
}

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
revenueScheduleNumberstring

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

successboolean

Returns true if the request was processed successfully.

Response
{
  "revenueScheduleNumber": "RS-00000002",
  "success": true
}