List revenue scheduling templates

Operation ID: revenueSchedulingTemplates

Group: Accounting › Revenue Scheduling Templates

Open in the interactive reference

GET /accounting/revenue-scheduling-templates

Read-only: Reads and returns; changes nothing.

Lists revenue scheduling templates. To filter by name, or by part of a name, use POST accounting/revenue-scheduling-templates/search.

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.

Query surface

Response

200 Success

Under data, an array of revenueSchedulingTemplatesRow:

Field Type Required Filter Sort Description
id string no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The unique identifier for the revenue scheduling template.
revenueSchedulingTemplateNumber string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The template number, unique within the tenant, for example 'RST-0007'. Absent while none has been assigned.
revenueSchedulingTemplateName string no no yes The name of the revenue scheduling template.
revenueRecognitionPattern string no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes How revenue is recognized under this template. Possible values: 'upfront', 'overTime', 'asDelivered', 'asConsumed'.
revenueSchedulingEvent string no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The event that creates a revenue plan under this template. Possible values: 'revenueArrangementCreation', 'uponInvoicing', 'uponUsageConsumption', 'manualRelease', 'uponInvoicingPercentInvoiced', 'uponInvoicingFullAmount', 'serviceActivation'.
amortizationMethod string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes 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 no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) 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"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "<nextCursor>"
  }
}

Statuses