Update contract performance obligation

PATCH

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

PATCH

/v3/contracts/:id/performance-obligations/:pobId

$ curl -X PATCH https://integrators.prod.api.tabsplatform.com/v3/contracts/123e4567-e89b-12d3-a456-426614174000/performance-obligations/123e4567-e89b-12d3-a456-426614174000 \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

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

Authentication

Authorizationstring

API Key authentication via header

Path parameters

idstringRequired

Contract Id

pobIdstringRequired

Performance Obligation Id

Request

Fields to update on the performance obligation

namestringOptional<=255 characters

The name of the performance obligation

erpClassIdstring or nullOptional

The ID of the integration / ERP class (integration class) for this performance obligation

itemIdstring or nullOptional

The ID of the integration item

serviceStartDatestringOptional

Service start date

serviceEndDatestringOptional

Service end date

considerationTypeenumOptional

Consideration type

recognitionPatternenumOptional

Recognition pattern

Response

Performance obligation updated successfully

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