- Retrieve a revenue schedule by invoice item ID
Retrieves the details of a revenue schedule by specifying the invoice item ID.
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.
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 (').
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.
- https://rest.zuora.comhttps://rest.zuora.com/v1/revenue-schedules/invoice-items/{invoice-item-id}
curl -i -X GET \
'https://rest.zuora.com/v1/revenue-schedules/invoice-items/{invoice-item-id}' \
-H 'Accept-Encoding: string' \
-H 'Authorization: string' \
-H 'Content-Encoding: string' \
-H 'Zuora-Entity-Ids: string' \
-H 'Zuora-Track-Id: string'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/jsonapplication/xmltext/htmltext/csvtext/plain
The request limit quota for the time window closest to exhaustion. See rate limits for more information.
The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.
The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.
The Zuora internal identifier of the API call. You cannot control the value of this header.
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.
The date and time when the record was created, in yyyy-mm-dd hh:mm:ss format.
The linked transaction ID for billing transactions. This field is used for all rules except for the custom unlimited or manual recognition rule models. If using the custom unlimited rule model, then the field value must be null. If the field is not null, then the referenceId field must be null.
The number for the linked invoice item or invoice item adjustment transaction. This field is used for all rules except for the custom unlimited or manual recognition rule models. If using the custom unlimited or manual recognition rule models, then the field value is null.
The type of linked transaction for billing transactions, which can be invoice item or invoice item adjustment. This field is used for all rules except for the custom unlimited or manual recognition rule models.
Revenue schedule number. The revenue schedule number is always prefixed with "RS", for example, "RS-00000001".
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.
Revenue items are listed in ascending order by the accounting period start date.
The effective date of the revenue schedule. For example, the revenue schedule date for bookings-based revenue recognition is typically set to the order date or contract date.
The date cannot be in a closed accounting period. The date must be in yyyy-mm-dd format.
Revenue distributed in all open accounting periods, which includes the open-ended accounting period.
The date and time when the revenue automation start date was set, in yyyy-mm-dd hh:mm:ss formst.
Custom fields of the Revenue Schedule object. The name of each custom field has the form customField__c. Custom field names are case sensitive. See Manage Custom Fields for more information.
{ "number": "RS-00000290", "recognitionRuleName": "Recognize upon invoicing", "amount": 50, "undistributedUnrecognizedRevenue": 50, "recognizedRevenue": 0, "unrecognizedRevenue": 50, "currency": "USD", "notes": null, "createdOn": "2014-01-21 13:59:25", "updatedOn": "2014-01-21 13:59:25", "accountId": "2c92c0f8439770960143b2141f5a584e", "subscriptionId": "2c92c0f943977b4f0143b23487994327", "subscriptionChargeId": "2c92c0f943977b4f0143b23487ed432e", "linkedTransactionId": "2c92c094439782460143b62c2ee60f59", "linkedTransactionType": "InvoiceItem", "referenceId": null, "revenueScheduleDate": "2014-01-21", "revenueItems": [ { … } ], "success": true }