Create contract obligation

POST

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

POST

/v3/contracts/:id/obligations

$ curl -X POST https://integrators.prod.api.tabsplatform.com/v3/contracts/123e4567-e89b-12d3-a456-426614174000/obligations \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "serviceStartDate": "2024-01-01",
>   "serviceEndDate": "2024-01-01",
>   "billingSchedule": {
>     "startDate": "2024-01-01",
>     "isRecurring": true,
>     "interval": "MONTH",
>     "intervalFrequency": 1,
>     "netPaymentTerms": 1,
>     "quantity": 1,
>     "billingType": "UNIT",
>     "pricingType": "SIMPLE",
>     "invoiceType": "INVOICE",
>     "pricing": [
>       {
>         "tier": 1,
>         "amount": 100,
>         "amountType": "PER_ITEM",
>         "tierMinimum": 0
>       }
>     ]
>   }
> }'

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

Authentication

Authorizationstring

API Key authentication via header

Path parameters

idstringRequired

Contract Id

Request

This endpoint expects an object.

serviceStartDatestringRequired

Revenue Start Date

serviceEndDatestringRequired

Revenue End Date

billingScheduleobjectRequired

Billing Schedule

categoryIdstringOptional

Category Id

discountobjectOptional

Discount configuration. Examples: { type: ‘FIXED’, amount: ‘5.00’ } for a $5.00 fixed discount, or { type: ‘PERCENTAGE’, amount: ‘0.10’ } for a 10% percentage discount

seatConfigobjectOptional

Seat-based obligation configuration

Response

The obligation

idstring

Obligation Id

contractIdstring

Contract Id

serviceStartDatestring

Revenue Start Date

serviceEndDatestring

Revenue End Date

billingScheduleobject

Billing Schedule

revenueScheduleobject

Revenue Schedule