Knowledge Center

Knowledge Center > API > REST API > REST API Reference > Revenue Schedules > Delete revenue schedule

Delete revenue schedule

This REST API reference describes how to delete a revenue schedule by specifying its revenue schedule number.

Prerequisites

You must have the Delete Custom Revenue Schedule Z-Finance permission.

Request

  • Production: DELETE https://api.zuora.com/rest/v1/revenue-schedules/{rs-number}
  • API Sandbox: DELETE https://apisandbox-api.zuora.com/rest/v1/revenue-schedules/{rs-number}

Request header

The Accept request header is optional. Only JSON is returned.

Request parameters

rs-number

required

path

Revenue schedule number of the revenue schedule you want to delete, for example, RS-00000256.

To be deleted, the revenue schedule:

  • Must be using a custom unlimited recognition rule.
  • Cannot have any revenue in a closed accounting period.
  • Cannot be included in a summary journal entry.
  • Cannot have a revenue schedule date in a closed accounting period.

Response

success

Returns true if the request is successful. Otherwise, returns false.

processId

The internal process ID used to assist Zuora support. Returned only if success is false.

reasons

Information describing the reason for the result. Returned only if success is false.

code

An eight-digit numeric error code.

message

A description of the error.

Example

HTTP/JSON request:

DELETE https://api.zuora.com/rest/v1/revenue-schedules/RS-00000001

JSON response:

{
"success": true
}
Last modified
07:39, 9 Oct 2015

Tags

Classifications

(not set)