List contract performance obligations

GET

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

GET

/v3/contracts/:id/performance-obligations

$ curl -G https://integrators.prod.api.tabsplatform.com/v3/contracts/123e4567-e89b-12d3-a456-426614174000/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         "billingTermGroupId": "123e4567-e89b-12d3-a456-426614174000",
8         "billingTermGroupName": "Towing Services",
9         "itemId": "123e4567-e89b-12d3-a456-426614174000",
10         "itemName": "Enterprise License",
11         "erpClassId": "123e4567-e89b-12d3-a456-426614174000",
12         "erpClassName": "Software Revenue",
13         "category": "SaaS",
14         "productId": "123e4567-e89b-12d3-a456-426614174000",
15         "productName": "Enterprise Plan",
16         "serviceStartDate": "2024-01-01",
17         "serviceEndDate": "2024-12-31",
18         "transactionPrice": "1000.50",
19         "billingTermIds": [
20           "123e4567-e89b-12d3-a456-426614174000"
21         ],
22         "considerationType": "FIXED",
23         "recognitionPattern": "STRAIGHT_LINE",
24         "eventTypeId": "123e4567-e89b-12d3-a456-426614174000",
25         "eventTypeName": "Tow Completion",
26         "hasSentInvoice": true,
27         "recognizedRevenue": [
28           {
29             "timeframe": "2024-01",
30             "total": "1000.50"
31           }
32         ],
33         "createdAt": "2024-01-01T00:00:00.000Z",
34         "updatedAt": "2024-01-01T00:00:00.000Z"
35       }
36     ],
37     "limit": 1.1,
38     "totalItems": 1.1,
39     "currentPage": 1.1,
40     "totalTransactionPrice": 1.1
41   },
42   "success": true,
43   "message": "string",
44   "error": {
45     "code": 1.1,
46     "message": "string",
47     "details": {}
48   }
49 }

Authentication

Authorizationstring

API Key authentication via header

Path parameters

idstringRequired

Contract Id

Query parameters

billingTermGroupIdstringOptional

Optional billing term group ID to filter results

pagedoubleRequiredDefaults to 1

Page Number

limitdoubleRequiredDefaults to 50

Number of items to return

filterstringOptional

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

Fields: 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=createdAt:gte:2026-01-01

Response

Performance obligations with recognized revenue for the contract

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

404

Not Found Error

500

Internal Server Error