Sign in

v1

latestOpenAPI 3.0.02026-07-24102143224.1 KB
Contracts

Update contract performance obligation

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

Path parameters

idstring required
Example:123e4567-e89b-12d3-a456-426614174000

Contract Id

pobIdstring required
Example:123e4567-e89b-12d3-a456-426614174000

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

serviceStartDatestring

Service start date

serviceEndDatestring

Service end date

considerationType'FIXED' | 'VARIABLE'

Consideration type

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

Recognition pattern

Example request

{
  "name": "Enterprise License",
  "erpClassId": "123e4567-e89b-12d3-a456-426614174000",
  "itemId": "123e4567-e89b-12d3-a456-426614174000",
  "serviceStartDate": "2024-01-01",
  "serviceEndDate": "2024-12-31",
  "considerationType": "FIXED",
  "recognitionPattern": "STRAIGHT_LINE"
}

Response

Performance obligation updated successfully

successboolean required

Boolean with true=success, false=failure

messagestring required

Plain-text description of the result

Example response

{
  "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",
    "eventTypeId": "123e4567-e89b-12d3-a456-426614174000",
    "eventTypeName": "Tow Completion",
    "recognizedRevenue": [
      {
        "timeframe": "2024-01",
        "total": "1000.50"
      }
    ],
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z"
  }
}