Bulk save contract performance obligations

POST

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

POST

/v3/contracts/:id/performance-obligations

$ curl -X POST https://integrators.prod.api.tabsplatform.com/v3/contracts/123e4567-e89b-12d3-a456-426614174000/performance-obligations \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "billingTermGroupId": "123e4567-e89b-12d3-a456-426614174000",
>   "toCreate": [
>     {
>       "serviceStartDate": "2024-07-01",
>       "serviceEndDate": "2024-12-31",
>       "transactionPrice": "1500.75"
>     }
>   ],
>   "toUpdate": [
>     {
>       "id": "987f6543-e21b-45d3-b789-123456789abc"
>     }
>   ],
>   "toDelete": [
>     "456e7890-a12b-34d5-c678-987654321def"
>   ]
> }'

1 {
2   "payload": {
3     "errors": [
4       {}
5     ]
6   },
7   "success": true,
8   "message": "Batch save operation completed successfully.",
9   "error": {
10     "code": 0,
11     "message": "",
12     "details": {}
13   }
14 }

Authentication

Authorizationstring

API Key authentication via header

Path parameters

idstringRequired

Contract Id

Request

Batch create, update, and delete performance obligations scoped to a billing term group

billingTermGroupIdstringRequired

Billing term group ID (BTG) that all operations are scoped to

toCreatelist of objectsRequired

Performance obligations to create within the billing term group

toUpdatelist of objectsRequired

Performance obligations to update (must belong to the billing term group)

toDeletelist of stringsRequired

Performance obligation IDs to delete

Response

Batch save completed 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