This REST API reference describes how to retrieve the details of a charge revenue summary by specifying the charge revenue summary number. Request and response field descriptions and sample code are provided.
GET https://api.zuora.com/rest/v1/charge-revenue-summaries/{crs-number}GET https://apisandbox-api.zuora.com/rest/v1/charge-revenue-summaries/{crs-number}The Accept request header is optional. Only JSON is returned.
| crs-number | required | path | The charge revenue summary number. |
| 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. 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. |
This response retrieves all revenue items associated with a charge revenue summary by specifying the charge revenue summary number.
| number | The charge revenue summary number. | ||||||||||||
| recognitionRuleName | The name of the recognition rule. | ||||||||||||
| 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 | ||||||||||||
| undistributedUnrecognizedRevenue | Revenue in the open-ended accounting period. | ||||||||||||
| recognizedRevenue | The revenue that was distributed in a closed accounting period. | ||||||||||||
| unrecognizedRevenue | Revenue distributed in all open accounting periods, which includes the open-ended accounting period. | ||||||||||||
| currency | The type of currency used. | ||||||||||||
| notes | Additional information about this record. | ||||||||||||
| accountId | An account ID. | ||||||||||||
| subscriptionId | The original subscription ID. | ||||||||||||
| subscriptionChargeId | The original subscription charge ID. | ||||||||||||
| productChargeId | Unique product rate plan charge ID. | ||||||||||||
| revenueItems | Revenue items are listed in ascending order by the accounting period start date.
| ||||||||||||
| success | Returns | ||||||||||||
| processId | The internal process ID used to assist Zuora support. Returned only if success is | ||||||||||||
| reasons | Information describing the reason for the result. Returned only if success is
| ||||||||||||
HTTP/JSON request:
GET https://api.zuora.com/rest/v1/charge-revenue-summaries/CRS-00000001/
JSON response:
{
"number": "CRS-00000001",
"recognitionRuleName": "Recognize upon invoicing",
"amount": 660,
"undistributedUnrecognizedRevenue": 565,
"recognizedRevenue": 0,
"unrecognizedRevenue": 660,
"currency": "USD",
"notes": null,
"accountId": "2c92c0f8439770960143b2141f5a555e",
"subscriptionId": "2c92c0f943977b4f0143b23487999327",
"subscriptionChargeId": "2c92c0f943977b4f0143b11187ed432e",
"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
}