Create a revenue schedule for a debit memo item (distribute by date range)

Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information.

Creates a revenue schedule for a debit memo item, and automatically distribute the revenue by specifying the recognition start and end dates.

Request
path Parameters
dmi-id
required
string

The unique ID of a debit memo item. You can get the debit memo item ID from the response of Get debit memo items.

header Parameters
Idempotency-Key
string <= 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-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.

notes
string [ 0 .. 2000 ] characters

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.

object (RevenueEvent)

Must specify at least one of eventType or eventTypeSystemId.

property name*
additional property
any

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.

Responses
200
post/v1/revenue-schedules/debit-memo-items/{dmi-id}/distribute-revenue-with-date-range
Request samples
application/json
{
  • "distributionType": "daily distribution",
  • "notes": "notes",
  • "recognitionEnd": "2016-12-31",
  • "recognitionStart": "2016-01-01",
  • "revenueEvent": {
    }
}
Response samples
application/json
{
  • "success": true,
  • "revenueScheduleNumber": "RS-00000119"
}