Knowledge Center

Knowledge Center > API > REST API > REST API Reference > Revenue Items > Get revenue items by charge revenue summary number

Get revenue items by charge revenue summary number

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

Request

  • Production: GET https://api.zuora.com/rest/v1/revenue-items/charge-revenue-summaries/{crs-number}
  • API Sandbox: GET https://apisandbox-api.zuora.com/rest/v1/revenue-items/charge-revenue-summaries/{crs-number}

Request header

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

Request parameters

crs-number

required

path

The charge revenue summary number.

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 retrieves all revenue items associated with a charge revenue summary by specifying the charge revenue summary number. If the charge revenue summary number is invalid, 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 revenue schedule amount, which is the sum of all revenue items. This field cannot be null and must be formatted based on the currency, such as JPY 30 or USD 30.15. Test out the currency to ensure you are using the proper formatting otherwise, the response will fail and this error message is returned:  "Allocation amount with wrong decimal places."

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.

nextPage

Provides hyperlinks to view the next pages.

revenueItemsListURL

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:

HTTP/JSON request:

GET https://api.zuora.com/rest/v1/revenue-items/charge-revenue-summaries/CRS-00000001

JSON response:


{
   "revenueItems": [
      {
         "accountingPeriodName": "Sep'2013",
         "isAccountingPeriodClosed": false,
         "amount": 35,
         "currency": "USD",
         "accountingPeriodStartDate": "2013-09-01",
         "accountingPeriodEndDate": "2013-09-30"
         },
      {
         "accountingPeriodName": "Oct'2013",
         "isAccountingPeriodClosed": false,
         "amount": 50,
         "currency": "USD",
         "accountingPeriodStartDate": "2013-10-01",
         "accountingPeriodEndDate": "2013-10-31"
         },
      {
         "accountingPeriodName": "Open-Ended",
         "isAccountingPeriodClosed": false,
         "amount": 150,
         "currency": "USD",
         "accountingPeriodStartDate": "2013-12-11",
         "accountingPeriodEndDate": null
      }
   ],
"success": true
}

Last modified
07:07, 9 Oct 2015

Tags

Classifications

(not set)