contracts

Update contract performance obligation

patch/v3/contracts/{id}/performance-obligations/{pobId}

Request

  • Base URL: https://integrators.prod.api.tabsplatform.com
  • URL: https://integrators.prod.api.tabsplatform.com/v3/contracts/{id}/performance-obligations/{pobId}
  • Auth: API key in header Authorization

Path parameters

idstring required

Contract Id

pobIdstring required

Performance Obligation Id

Request body

namestring

The name of the performance obligation

erpClassIdstring nullable

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

itemIdstring nullable

The ID of the integration item

categorystring

The revenue category name. An empty string clears it.

serviceStartDatestring

Service start date

serviceEndDatestring

Service end date

considerationType'FIXED' | 'VARIABLE'

Consideration type

recognitionPattern'STRAIGHT_LINE' | 'RECOGNIZE_AS_CONSUMED' | 'RECOGNIZE_AS_BILLED'

Recognition pattern

Response

Performance obligation updated successfully. Includes warnings when the update changed fields the request did not set (for example, service dates after switching to Recognize as billed).

successboolean required

Boolean with true=success, false=failure

messagestring required

Plain-text description of the result

Changes

No recorded changes to this operation across all 1 revision of this API.