Revenue Scheduling Templates

GET /accounting/revenue-scheduling-templates

Group: Accounting › Revenue Scheduling Templates · Operation ID: revenueSchedulingTemplates

Returns a list of revenue scheduling templates. To match on name, use POST accounting/revenue-scheduling-templates/search.

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 — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
revenueSchedulingTemplateNumber — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
revenueRecognitionPattern — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
revenueSchedulingEvent — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
amortizationMethod — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
lastModifiedDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
Orderable: id, revenueSchedulingTemplateNumber, revenueSchedulingTemplateName, revenueRecognitionPattern, revenueSchedulingEvent, amortizationMethod, lastModifiedDate
Selectable: id, revenueSchedulingTemplateNumber, revenueSchedulingTemplateName, revenueRecognitionPattern, revenueSchedulingEvent, amortizationMethod, lastModifiedDate

200 Success

Under data, an array of revenueSchedulingTemplatesRow:

Field	Type	Required	Description
`id`	string	no	The unique identifier for the revenue scheduling template.
`revenueSchedulingTemplateNumber`	string or null	no	The template number, unique within the tenant, for example 'RST-0007'. Absent while none has been assigned.
`revenueSchedulingTemplateName`	string	no	The name of the revenue scheduling template.
`revenueRecognitionPattern`	string	no	How revenue is recognized under this template. Possible values: 'upfront', 'overTime', 'asDelivered', 'asConsumed'.
`revenueSchedulingEvent`	string	no	The event that creates a revenue plan under this template. Possible values: 'revenueArrangementCreation', 'uponInvoicing', 'uponUsageConsumption', 'manualRelease', 'uponInvoicingPercentInvoiced', 'uponInvoicingFullAmount', 'serviceActivation'.
`amortizationMethod`	string or null	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)	no	The date and time the revenue scheduling template last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.