Skip to content
Legacy API Reference
/
/
List all details of a cha...

List all details of a charge revenue summary

Request

Retrieves the details of a charge revenue summary by specifying the charge revenue summary number. The response includes all revenue items associated with the charge revenue summary.

Path
crs-numberstringrequired

The charge revenue summary number.

Headers
Accept-Encodingstring

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encodingstring

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Authorizationstring

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Zuora-Track-Idstring, <= 64 characters

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Entity-Idsstring

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

cURL
curl -i -X GET \
  'https://rest.zuora.com/v1/charge-revenue-summaries/{crs-number}' \
  -H 'Accept-Encoding: string' \
  -H 'Authorization: string' \
  -H 'Content-Encoding: string' \
  -H 'Zuora-Entity-Ids: string' \
  -H 'Zuora-Track-Id: string'

Responses

Headers
Content-Encodingstring

This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.

Note that only the following MIME types support gzipped responses:

  • application/json
  • application/xml
  • text/html
  • text/csv
  • text/plain
RateLimit-Limitstring

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

RateLimit-Remainingnumber

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetnumber

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Zuora-Request-Idstring, = 36 characters

The Zuora internal identifier of the API call. You cannot control the value of this header.

Zuora-Track-Idstring, <= 64 characters

A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.

Bodyapplication/json
accountIdstring

An account ID.

amountstring, (decimal)

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."

currencystring

The type of currency used.

notesstring

Additional information about this record.

numberstring

The charge revenue summary number.

recognitionRuleNamestring

The name of the recognition rule.

recognizedRevenuestring, (decimal)

The revenue that was distributed in a closed accounting period.

revenueItemsArray of objects(revenueItems)

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

subscriptionChargeIdstring

The original subscription charge ID.

subscriptionIdstring

The original subscription ID.

successboolean

Returns true if the request was processed successfully.

undistributedUnrecognizedRevenuestring, (decimal)

Revenue in the open-ended accounting period.

unrecognizedRevenuestring, (decimal)

Revenue distributed in all open accounting periods, which includes the open-ended accounting period.

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": [
    { … },
    { … },
    { … }
  ],
  "success": true
}