Performance Obligations

GET /accounting/performance-obligations

Group: Accounting › Performance Obligations · Operation ID: performanceObligations

Returns a list of performance obligations. Each entry is a header. The full record, with standalone selling price ranges, comes from GET accounting/performance-obligations/:id or POST accounting/performance-obligations/search.

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`.

Query surface

id — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
performanceObligationNumber — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
effectiveStartDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
effectiveEndDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
allocationStartDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
isAllocationExcluded — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
isNetAccounting — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
defaultAmortizationMethod — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
standaloneSellingPriceRangeType — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
revenueSchedulingTemplateName — 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, performanceObligationNumber, name, effectiveStartDate, effectiveEndDate, allocationStartDate, isAllocationExcluded, isNetAccounting, defaultAmortizationMethod, standaloneSellingPriceRangeType, revenueSchedulingTemplateName, lastModifiedDate
Selectable: id, performanceObligationNumber, name, description, effectiveStartDate, effectiveEndDate, allocationStartDate, isAllocationExcluded, isNetAccounting, defaultAmortizationMethod, standaloneSellingPriceRangeType, revenueSchedulingTemplateName, lastModifiedDate

Response

200 Success

Under data, an array of performanceObligationsRow:

Field	Type	Required	Description
`id`	string	no	The unique identifier for the performance obligation.
`performanceObligationNumber`	string or null	no	The performance obligation number. Absent while none has been assigned.
`name`	string	no	The display name of the performance obligation, as it appears on revenue contracts and schedules.
`description`	string or null	no	A free-form description of what the obligation covers. Absent when none is set.
`effectiveStartDate`	string (date)	no	The first date this obligation is in effect. Format YYYY-MM-DD.
`effectiveEndDate`	string (date) or null	no	The last date this obligation is in effect. Format YYYY-MM-DD. Absent when the obligation is open-ended.
`allocationStartDate`	string (date) or null	no	The date from which revenue for this obligation takes part in allocation. Format YYYY-MM-DD. Absent when none is set.
`isAllocationExcluded`	boolean	no	Whether the revenue contract lines of this obligation are left out of fair-value allocation.
`isNetAccounting`	boolean	no	Whether the obligation is accounted net rather than gross.
`defaultAmortizationMethod`	string or null	no	The default amortization method used when scheduling this obligation's revenue. Possible values: 'exactDays', 'pointInTime', 'straightLineProRateFirstLast', 'straightLine', 'usageBased'.
`standaloneSellingPriceRangeType`	string or null	no	How the obligation's standalone selling price ranges are expressed. Possible values: 'percentage', 'amount'.
`revenueSchedulingTemplateName`	string or null	no	The name of the revenue scheduling template that schedules this obligation's revenue.
`lastModifiedDate`	string (date-time)	no	The date and time the performance obligation last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Statuses

400 — Invalid request or business failure
401 — Missing or invalid access token
403 — Not authorized
404 — Not found
429 — Too many requests
500 — Internal server error