Create contract obligation

POST

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

POST

/v3.1/contracts/:id/obligations

curl -X POST https://integrators.prod.api.tabsplatform.com/v3.1/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
      }
    ]
  }
}'

{
  "payload": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "contractId": "123e4567-e89b-12d3-a456-426614174000",
    "serviceStartDate": "2024-01-01",
    "serviceEndDate": "2024-01-01",
    "billingSchedule": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Line Item Name",
      "startDate": "2024-01-01",
      "endDate": "2024-01-01",
      "isRecurring": true,
      "interval": "MONTH",
      "intervalFrequency": 1,
      "netPaymentTerms": 1,
      "quantity": 1,
      "billingType": "UNIT",
      "pricingType": "SIMPLE",
      "eventTypeName": "API Calls",
      "invoiceType": "INVOICE",
      "pricing": [
        {
          "tier": 1,
          "amount": 100,
          "amountType": "PER_ITEM",
          "tierMinimum": 0
        }
      ],
      "description": "Line Item Description",
      "duration": 1,
      "invoiceDateStrategy": "FIRST_OF_PERIOD",
      "invoiceDateOffsetDays": 5,
      "includeInArr": true,
      "eventTypeId": "123e4567-e89b-12d3-a456-426614174000",
      "itemId": "123e4567-e89b-12d3-a456-426614174000",
      "productId": "123e4567-e89b-12d3-a456-426614174000",
      "classId": "123e4567-e89b-12d3-a456-426614174000",
      "departmentId": "123e4567-e89b-12d3-a456-426614174000",
      "projectId": "123e4567-e89b-12d3-a456-426614174000",
      "isArrears": false
    },
    "revenueSchedule": {
      "recognizedRevenue": [
        {
          "timeframe": "2024-01",
          "total": 1000,
          "booksClosed": false
        }
      ],
      "categoryId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "jobId": "wf-8f3c1e20-…",
    "statusEndpoint": "/v3/jobs/wf-8f3c1e20-…",
    "categoryId": "123e4567-e89b-12d3-a456-426614174000",
    "discount": {
      "type": "FIXED",
      "amount": "5.00"
    },
    "seatConfig": {
      "isMovingMinimum": false,
      "minQuantity": 0,
      "defaultProrationPolicy": "NONE",
      "defaultTrueUpTiming": "IMMEDIATE"
    }
  },
  "success": true,
  "message": "string",
  "error": {
    "code": 1.1,
    "message": "string",
    "errorCode": "string",
    "details": {}
  }
}

Returns 202 once the change is saved. Invoices are regenerated asynchronously: poll statusEndpoint until the job completes. jobId is null when the change named no billing terms, so no regeneration was queued; statusEndpoint then points at the customer’s invoice-generation status.

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, and the invoice regeneration job

payloadobject

Response payload, will be empty when success is false

successboolean

Boolean with true=success, false=failure

messagestring

Plain-text description of the result

errorobjectOptional

json element with any error messages or warnings

Errors

400

Bad Request Error

404

Not Found Error