Retrieve a revenue scheduling template

Operation ID: getRevenueSchedulingTemplate

Group: Accounting › Revenue Scheduling Templates

Open in the interactive reference

GET /accounting/revenue-scheduling-templates/{id}

Read-only: Reads and returns; changes nothing.

Retrieves a revenue scheduling template. Use the revenue scheduling template's id, not its revenueSchedulingTemplateNumber.

Parameters

Name In Type Required Description
Api-Version header string · 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 of the revenue scheduling template you want to retrieve.

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 date-time yes The date and time the revenue scheduling template last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. 
{
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "revenueSchedulingTemplateNumber": "<revenueSchedulingTemplateNumber>",
    "revenueSchedulingTemplateName": "<revenueSchedulingTemplateName>",
    "revenueRecognitionPattern": "<revenueRecognitionPattern>",
    "revenueSchedulingEvent": "<revenueSchedulingEvent>",
    "amortizationMethod": "<amortizationMethod>",
    "lastModifiedDate": "2026-01-15T09:30:00.000Z"
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Errors

Code Status
NOT_FOUND 400

Statuses