Change event type for selected billing terms and POBs in a group

PATCH

https://integrators.prod.api.tabsplatform.com/v3/contracts/:id/billing-term-groups/:groupId/event-type

PATCH

/v3/contracts/:id/billing-term-groups/:groupId/event-type

$ curl -X PATCH https://integrators.prod.api.tabsplatform.com/v3/contracts/123e4567-e89b-12d3-a456-426614174000/billing-term-groups/123e4567-e89b-12d3-a456-426614174000/event-type \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "billingTermIds": [
>     "a1b2c3d4-e5f6-7890-ab12-cdef34567890"
>   ],
>   "performanceObligationIds": [
>     "b2c3d4e5-f678-90ab-12cd-ef34567890ab"
>   ],
>   "toEventTypeId": "c3d4e5f6-7890-ab12-cdef-34567890abcd"
> }'

1 {
2   "payload": {
3     "message": "Updated event type for 1 billing term(s) and 1 performance obligation(s) in group 123e4567-e89b-12d3-a456-426614174000",
4     "updatedBillingTermIds": [
5       "a1b2c3d4-e5f6-7890-ab12-cdef34567890"
6     ],
7     "updatedPerformanceObligationIds": [
8       "b2c3d4e5-f678-90ab-12cd-ef34567890ab"
9     ]
10   },
11   "success": true,
12   "message": "Event type update successful",
13   "error": {
14     "code": 0,
15     "message": "",
16     "details": {}
17   }
18 }

Authentication

Authorizationstring

API Key authentication via header

Path parameters

idstringRequired

Contract Id

groupIdstringRequired

Billing Term Group Id

Request

This endpoint expects an object.

billingTermIdslist of stringsRequired

IDs of the billing terms (within the group) whose event type should be set to toEventTypeId. Pick exactly the rows to change — in a many-to-many group the others are left untouched. May be empty when only performance obligations are being changed.

performanceObligationIdslist of stringsRequired

IDs of the performance obligations (within the group) whose event type should be set to toEventTypeId. May be empty when only billing terms are being changed.

toEventTypeIdstringRequiredformat: "uuid"

The event type to assign to the selected billing terms and performance obligations. Must belong to the merchant.

Response

Event type changed for the selected billing terms and performance obligations within the group; any rows not listed in the request are left untouched. The change is applied atomically and is only accepted if the group’s event types stay in sync afterward.

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

409

Conflict Error

500

Internal Server Error