Get contract obligation by ID

GET

https://integrators.prod.api.tabsplatform.com/v3/contracts/:id/obligations/:obligationId

GET

/v3/contracts/:id/obligations/:obligationId

$ curl https://integrators.prod.api.tabsplatform.com/v3/contracts/123e4567-e89b-12d3-a456-426614174000/obligations/123e4567-e89b-12d3-a456-426614174000 \
>      -H "Authorization: <apiKey>"

1 {
2   "payload": {
3     "id": "123e4567-e89b-12d3-a456-426614174000",
4     "contractId": "123e4567-e89b-12d3-a456-426614174000",
5     "serviceStartDate": "2024-01-01",
6     "serviceEndDate": "2024-01-01",
7     "categoryId": "123e4567-e89b-12d3-a456-426614174000",
8     "billingSchedule": {
9       "name": "Line Item Name",
10       "description": "Line Item Description",
11       "startDate": "2024-01-01",
12       "endDate": "2024-01-01",
13       "duration": 1,
14       "isArrears": false,
15       "invoiceDateStrategy": "FIRST_OF_PERIOD",
16       "isRecurring": true,
17       "includeInArr": true,
18       "interval": "MONTH",
19       "intervalFrequency": 1,
20       "netPaymentTerms": 1,
21       "quantity": 1,
22       "billingType": "UNIT",
23       "pricingType": "SIMPLE",
24       "eventTypeId": "123e4567-e89b-12d3-a456-426614174000",
25       "eventTypeName": "API Calls",
26       "itemId": "123e4567-e89b-12d3-a456-426614174000",
27       "productId": "123e4567-e89b-12d3-a456-426614174000",
28       "invoiceType": "INVOICE",
29       "pricing": [
30         {
31           "tier": 1,
32           "amount": 100,
33           "amountType": "PER_ITEM",
34           "tierMinimum": 0
35         }
36       ],
37       "classId": "123e4567-e89b-12d3-a456-426614174000",
38       "departmentId": "123e4567-e89b-12d3-a456-426614174000",
39       "projectId": "123e4567-e89b-12d3-a456-426614174000"
40     },
41     "revenueSchedule": {
42       "categoryId": "123e4567-e89b-12d3-a456-426614174000",
43       "recognizedRevenue": [
44         {
45           "timeframe": "2024-01",
46           "total": 1000,
47           "booksClosed": false
48         }
49       ]
50     },
51     "discount": {
52       "type": "FIXED",
53       "amount": "5.00"
54     },
55     "seatConfig": {
56       "isMovingMinimum": false,
57       "minQuantity": 0,
58       "defaultProrationPolicy": "NONE",
59       "defaultTrueUpTiming": "IMMEDIATE"
60     }
61   },
62   "success": true,
63   "message": "string",
64   "error": {
65     "code": 1.1,
66     "message": "string",
67     "details": {}
68   }
69 }

Authentication

Authorizationstring

API Key authentication via header

Path parameters

idstringRequired

Contract Id

obligationIdstringRequired

Obligation Id

Response

The obligation

payloadobject

Response payload, will be empty when success is false

successboolean

Boolean with true=success, false=failure

messagestring

Plain-text description of the result

errorobject

json element with any error messages or warnings

Errors

404

Not Found Error