v1

latestOpenAPI 3.0.02026-07-24102143224.1 KB

Contracts

List contract performance obligations

get/v3/contracts/{id}/performance-obligations

Path parameters

idstring required

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

Contract Id

Query parameters

billingTermGroupIdstring

Optional billing term group ID to filter results

pagenumber required

Page Number

limitnumber required

Number of items to return

filterstring

Format: field:rule:value — comma-separated for multiple filters.

Fields: createdAt (datetime): eq, neq, gt, gte, lt, lte updatedAt (datetime): eq, neq, gt, gte, lt, lte

Date-only values (YYYY-MM-DD) match the full UTC day.

Example: filter=createdAt:gte:2026-01-01

Response

Performance obligations with recognized revenue for the contract

successboolean required

Boolean with true=success, false=failure

messagestring required

Plain-text description of the result

Example response

{
  "payload": {
    "data": [
      {
        "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"
      }
    ]
  }
}