List performance obligations

GET

https://integrators.prod.api.tabsplatform.com/v3/performance-obligations

GET

/v3/performance-obligations

$ curl -G https://integrators.prod.api.tabsplatform.com/v3/performance-obligations \
>      -H "Authorization: <apiKey>" \
>      -d page=1 \
>      -d limit=50

1 {
2   "payload": {
3     "data": [
4       {
5         "id": "123e4567-e89b-12d3-a456-426614174000",
6         "name": "Annual Subscription",
7         "contractId": "123e4567-e89b-12d3-a456-426614174000",
8         "billingTermGroupId": "123e4567-e89b-12d3-a456-426614174000",
9         "billingTermGroupName": "Towing Services",
10         "itemId": "123e4567-e89b-12d3-a456-426614174000",
11         "itemName": "Enterprise License",
12         "erpClassId": "123e4567-e89b-12d3-a456-426614174000",
13         "erpClassName": "Software Revenue",
14         "category": "SaaS",
15         "considerationType": "FIXED",
16         "recognitionPattern": "STRAIGHT_LINE",
17         "eventTypeId": "123e4567-e89b-12d3-a456-426614174000",
18         "eventTypeName": "Tow Completion",
19         "productId": "123e4567-e89b-12d3-a456-426614174000",
20         "productName": "Enterprise Plan",
21         "serviceStartDate": "2024-01-01",
22         "serviceEndDate": "2024-12-31",
23         "transactionPrice": "1000.50",
24         "recognizedRevenue": [
25           {
26             "timeframe": "2024-01",
27             "total": "1000.50"
28           }
29         ],
30         "createdAt": "2024-01-01T00:00:00.000Z",
31         "updatedAt": "2024-01-01T00:00:00.000Z"
32       }
33     ],
34     "limit": 1.1,
35     "totalItems": 1.1,
36     "currentPage": 1.1
37   },
38   "success": true,
39   "message": "string",
40   "error": {
41     "code": 1.1,
42     "message": "string",
43     "details": {}
44   }
45 }

Authentication

Authorizationstring

API Key authentication via header

Query parameters

pagedoubleRequiredDefaults to 1

Page Number

limitdoubleRequiredDefaults to 50

Number of items to return

filterstringOptional

Format: field:rule:value — comma-separated for multiple filters.

Fields: contractId (uuid): eq, neq, in, nin, isnull, isnotnull customerId (uuid): eq, neq, in, nin, isnull, isnotnull serviceStartDate (datetime): eq, neq, gt, gte, lt, lte serviceEndDate (datetime): eq, neq, gt, gte, lt, lte billingTermGroupId (uuid): eq, neq, in, nin, isnull, isnotnull createdAt (datetime): eq, neq, gt, gte, lt, lte updatedAt (datetime): eq, neq, gt, gte, lt, lte

Date-only values (YYYY-MM-DD) match the full UTC day.

Example: filter=contractId:eq:00000000-0000-0000-0000-000000000001

Format: field:rule:value — comma-separated for multiple filters. Fields: contractId (uuid): eq, neq, in, nin, isnull, isnotnull customerId (uuid): eq, neq, in, nin, isnull, isnotnull serviceStartDate (datetime): eq, neq, gt, gte, lt, lte serviceEndDate (datetime): eq, neq, gt, gte, lt, lte billingTermGroupId (uuid): eq, neq, in, nin, isnull, isnotnull createdAt (datetime): eq, neq, gt, gte, lt, lte updatedAt (datetime): eq, neq, gt, gte, lt, lte Date-only values (YYYY-MM-DD) match the full UTC day. Example: filter=contractId:eq:00000000-0000-0000-0000-000000000001

Response

Get all performance obligations by filter

payloadobject

Response payload, will be empty when success is false

successboolean

Boolean with true=success, false=failure

messagestring

Plain-text description of the result

errorobject

json element with any error messages or warnings

Errors

400

Bad Request Error