Knowledge Center

Knowledge Center > API > REST API > REST API Reference > Revenue Schedules > Update revenue schedule basic information

Update revenue schedule basic information

This REST API reference describes how to get basic information of a revenue schedule by specifying the revenue schedule number. Request and response field descriptions and sample code are provided.

Request

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

Request header

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

Request parameters

rs-number

required

path

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

Request body

referenceId

optional

Reference ID is used only in the custom unlimited rule to create a revenue schedule. In this scenario, the revenue schedule is not linked to an invoice item or invoice item adjustment.

Use this field only when the revenue schedule is not linked to an invoice item or invoice item adjustment, such as for revenue schedules based on the Custom - Unlimited recognition model.  

notes

optional

Additional information about this record.

cf_txtn__c

optional

One or more optional custom fields, where n is the maximum number of custom fields allowed.

cf_pkn__c

optional

One or more optional custom fields, where n is the maximum number of custom fields allowed. 

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:

PUT https://api.zuora.com/rest/v1/revenue-schedules/RS-00000001/basic-information

JSON request:

{
   "notes": "change recognition term",
   "referenceId": "Reference ID",
   "cf_phases__c": "Phase 1"
}

JSON response:

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

Tags

Classifications

(not set)