obligations

List obligations

get/v3/obligations

Request

  • Base URL: https://integrators.prod.api.tabsplatform.com
  • URL: https://integrators.prod.api.tabsplatform.com/v3/obligations
  • Auth: API key in header Authorization

Query parameters

pagenumber double required

Page Number

limitnumber double required

Number of items to return

filterstring

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

Fields: contractId (uuid): eq, neq, in, nin, isnull, isnotnull customerId (uuid): eq, neq, in, nin, isnull, isnotnull billingTermId (uuid): eq startDate (datetime): eq, neq, gt, gte, lt, lte endDate (datetime): eq, neq, gt, gte, lt, lte serviceStartDate (datetime): eq, neq, gt, gte, lt, lte serviceEndDate (datetime): eq, neq, gt, gte, lt, lte

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

Example: filter=contractId:eq:00000000-0000-0000-0000-000000000001

Response

Get all Obligations by filter

payloadV3ObligationsGetResponsesContentApplicationJsonSchemaPayload required

Response payload, will be empty when success is false

successboolean required

Boolean with true=success, false=failure

messagestring required

Plain-text description of the result

Changes

No recorded changes to this operation across all 1 revision of this API.