Sign in

v1

latestOpenAPI 3.0.02026-07-24102143224.1 KB
Contracts

Get contract obligation by ID

get/v3/contracts/{id}/obligations/{obligationId}

Path parameters

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

Contract Id

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

Obligation Id

Response

The obligation

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",
    "contractId": "123e4567-e89b-12d3-a456-426614174000",
    "serviceStartDate": "2024-01-01",
    "serviceEndDate": "2024-01-01",
    "categoryId": "123e4567-e89b-12d3-a456-426614174000",
    "billingSchedule": {
      "name": "Line Item Name",
      "description": "Line Item Description",
      "startDate": "2024-01-01",
      "endDate": "2024-01-01",
      "duration": 1,
      "invoiceDateStrategy": "FIRST_OF_PERIOD",
      "isRecurring": true,
      "includeInArr": true,
      "interval": "MONTH",
      "intervalFrequency": 1,
      "netPaymentTerms": 1,
      "quantity": 1,
      "billingType": "UNIT",
      "pricingType": "SIMPLE",
      "eventTypeId": "123e4567-e89b-12d3-a456-426614174000",
      "itemId": "123e4567-e89b-12d3-a456-426614174000",
      "productId": "123e4567-e89b-12d3-a456-426614174000",
      "invoiceType": "INVOICE",
      "pricing": [
        {
          "tier": 1,
          "amount": 100,
          "amountType": "PER_ITEM",
          "tierMinimum": 0
        }
      ],
      "classId": "123e4567-e89b-12d3-a456-426614174000",
      "departmentId": "123e4567-e89b-12d3-a456-426614174000",
      "projectId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "revenueSchedule": {
      "categoryId": "123e4567-e89b-12d3-a456-426614174000",
      "recognizedRevenue": [
        {
          "timeframe": "2024-01",
          "total": 1000
        }
      ]
    },
    "discount": {
      "type": "PERCENTAGE",
      "amount": "10",
      "note": "Early payment discount"
    }
  }
}