Get Revenue Scheduling Template
GET /accounting/revenue-scheduling-templates/{id}
Group: Accounting › Revenue Scheduling Templates · Operation ID: getRevenueSchedulingTemplate
Returns the revenue scheduling template with the given identifier. Use the template's id, not its revenueSchedulingTemplateNumber.
Open in the interactive reference
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
Api-Version |
header | "v1" |
yes | The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1. |
id |
path | string | yes | The unique identifier for the revenue scheduling template to return. |
Response
200 Success
Under data (getRevenueSchedulingTemplateOutput):
| Field | Type | Required | Description |
|---|---|---|---|
id |
string | yes | The unique identifier for the revenue scheduling template. |
revenueSchedulingTemplateNumber |
string | no | The template number, unique within the tenant, for example 'RST-0007'. Absent while none has been assigned. |
revenueSchedulingTemplateName |
string | yes | The name of the revenue scheduling template. |
revenueRecognitionPattern |
string | yes | How revenue is recognized under this template. Possible values: 'upfront', 'overTime', 'asDelivered', 'asConsumed'. |
revenueSchedulingEvent |
string | yes | The event that creates a revenue plan under this template. Possible values: 'revenueArrangementCreation', 'uponInvoicing', 'uponUsageConsumption', 'manualRelease', 'uponInvoicingPercentInvoiced', 'uponInvoicingFullAmount', 'serviceActivation'. |
amortizationMethod |
string | no | How the scheduled amount is spread over the plan's periods. Possible values: 'exactDays', 'pointInTime', 'straightLineProRateFirstLast', 'straightLine', 'usageBased'. Absent when the recognition pattern does not spread revenue over time. |
lastModifiedDate |
string (date-time) | yes | The date and time the revenue scheduling template last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. |
Errors
| Code | Status |
|---|---|
NOT_FOUND |
400 |
Statuses
400— Invalid request or business failure. Codes: NOT_FOUND401— Missing or invalid access token403— Not authorized404— Not found429— Too many requests500— Internal server error