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 '{}'

{
  "payload": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Annual Subscription",
    "billingTermGroupId": "123e4567-e89b-12d3-a456-426614174000",
    "billingTermGroupName": "Towing Services",
    "itemId": "123e4567-e89b-12d3-a456-426614174000",
    "itemName": "Enterprise License",
    "erpClassId": "123e4567-e89b-12d3-a456-426614174000",
    "erpClassName": "Software Revenue",
    "category": "SaaS",
    "productId": "123e4567-e89b-12d3-a456-426614174000",
    "productName": "Enterprise Plan",
    "serviceStartDate": "2024-01-01",
    "serviceEndDate": "2024-12-31",
    "transactionPrice": "1000.50",
    "billingTermIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "considerationType": "FIXED",
    "recognitionPattern": "STRAIGHT_LINE",
    "catchUpOption": "FIRST_OPEN_MONTH",
    "eventTypeId": "123e4567-e89b-12d3-a456-426614174000",
    "eventTypeName": "Tow Completion",
    "hasSentInvoice": true,
    "recognizedRevenue": [
      {
        "timeframe": "2024-01",
        "total": "1000.50"
      }
    ],
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z"
  },
  "success": true,
  "message": "string",
  "error": {
    "code": 1.1,
    "message": "string",
    "errorCode": "string",
    "details": {}
  }
}

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<=2500 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

categorystringOptional<=255 characters

The revenue category name. An empty string clears it.

serviceStartDatestringOptional

Service start date

serviceEndDatestringOptional

Service end date

considerationTypeenumOptional

Consideration type

Allowed values:

recognitionPatternenumOptional

Recognition pattern

Allowed values:

catchUpOptionenumOptional

Where revenue calculated for months that are already closed is recognized: FIRST_OPEN_MONTH adds it to the first open month, LAST_MONTH adds it to the last month, and STRAIGHT_LINE_REMAINDER spreads it evenly across the open months. Omit to keep the stored value. Changing it recalculates revenue.

Allowed values:

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).

payloadobject

Response payload, will be empty when success is false

successboolean

Boolean with true=success, false=failure

messagestring

Plain-text description of the result

errorobjectOptional

json element with any error messages or warnings

Errors

400

Bad Request Error

404

Not Found Error

500

Internal Server Error