Knowledge Center

Knowledge Center > API > REST API > REST API Reference > Revenue Items > Get revenue items by revenue schedule

Get revenue items by revenue schedule

This REST API reference describes how to get the details for each revenue items in a revenue schedule by specifying the revenue schedule number. Request and response field descriptions and sample code are provided.

Request

  • Production: GET https://api.zuora.com/rest/v1/revenue-items/revenue-schedules/{rs-number}
  • API Sandbox: GET https://apisandbox-api.zuora.com/rest/v1/revenue-items/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. The revenue schedule number is always prefixed with "RS", for example, "RS-00000001".

Request body

PageSize

optional

Must be an integer. A maximum number of 300 pages can be returned in a response. Any value greater than 300 is treated as 300.

Response

This response includes details of a revenue items associated revenue schedule of the requested revenue schedule number (rs-number). If the revenue schedule number is not valid, an empty list will be returned.

revenueItems

Revenue items are listed in ascending order by the accounting period start date.

accountingPeriodName

Name of the accounting period. The open-ended accounting period is named Open-Ended

isAccountingPeriodClosed

 Indicates if the accounting period is closed or open. 

amount

The amount of the revenue item.

currency

The type of currency used. 

accountingPeriodStartDate

The accounting period start date.

accountingPeriodEndDate

The accounting period end date. The accounting period end date of the open-ended accounting period is null.

recognizedRevenueAccountingCodeType

The type associated with the recognized revenue accounting code, such as Sales Revenue or Sales Discount. Required only when overrideChargeAccountingCodes is true. Otherwise this value is ignored.

recognizedRevenueAccountingCode

The accounting code for recognized revenue, such as Monthly Recurring Charges or Overage Charges. Required only when overrideChargeAccountingCodes is true. Otherwise the value is ignored.

deferredRevenueAccountingCodeType

The type associated with the deferred revenue accounting code, such as Deferred Revenue. Required only when overrideChargeAccountingCodes is true. Otherwise this value is ignored.

deferredRevenueAccountingCode

The accounting code for deferred revenue, such as Monthly Recurring Liability. Required only when overrideChargeAccountingCodes is true. Otherwise this value is ignored.

nextPage

Provides hyperlinks to view the next pages.

revenueItemListURL

The list of revenue Items.

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:

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

JSON response:

 
{
   "revenueItems": [
   {
      "accountingPeriodName": "Oct'2013",
      "isAccountingPeriodClosed": false,
      "amount": 50,
      "currency": "USD",
      "accountingPeriodStartDate": "2013-10-01",
      "accountingPeriodEndDate": "2013-10-31",
      "recognizedRevenueAccountingCodeType": null,
      "recognizedRevenueAccountingCode": null,
      "deferredRevenueAccountingCodeType": null,
      "deferredRevenueAccountingCode": null
      }
   ],
"success": true
}

 

Last modified
07:28, 9 Oct 2015

Tags

Classifications

(not set)