Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Tabs Contracts API

The Contracts API from Tabs — 17 operation(s) for contracts.

Tabs Contracts API is one of 23 APIs that Tabs publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Contracts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 24 operations across 17 paths, and defines 34 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, https://integrators.prod.api.tabsplatform.com.

24 operations 17 paths 34 schemas 3 DELETE8 GET6 PATCH7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://integrators.prod.api.tabsplatform.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Tabs Contracts API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (custom-header). By default, every request must be authenticated.

Paths & Operations 24

Across 17 paths, the API surfaces 24 operations — 3 DELETE, 8 GET, 6 PATCH, 7 POST. Each is listed below with its method, path, parameters, and response codes.

Contracts 24
GET
/v3/contracts
List contracts
IntegratorsApiContractsv3Controller_getContracts 3 params → 200
POST
/v3/contracts
Create contract
IntegratorsApiContractsv3Controller_createContract body → 201400500
GET
/v3/contracts/{id}
Get contract by ID
IntegratorsApiContractsv3Controller_getContractById 1 param → 200400404
PATCH
/v3/contracts/{id}
Update contract
IntegratorsApiContractsv3Controller_updateContract 1 param body → 200404500
POST
/v3/contracts/{id}/file
Upload contract file
IntegratorsApiContractsv3Controller_uploadContractFile 2 params body → 200
GET
/v3/contracts/{id}/file
Download contract file
IntegratorsApiContractsv3Controller_getContractFile 1 param → 200500
POST
/v3/contracts/{id}/obligations
Create contract obligation
IntegratorsApiContractsv3Controller_createObligation 1 param body → 201400
GET
/v3/contracts/{id}/obligations/{obligationId}
Get contract obligation by ID
IntegratorsApiContractsv3Controller_getObligation 2 params → 200404
DELETE
/v3/contracts/{id}/obligations/{obligationId}
Delete contract obligation
IntegratorsApiContractsv3Controller_deleteObligation 2 params → 200400500
POST
/v3/contracts/{id}/actions
Perform contract action
IntegratorsApiContractsv3Controller_contractActions 1 param body → 200400
PATCH
/v3/contracts/{id}/obligation/{obligationId}
Update contract obligation
IntegratorsApiContractsv3Controller_updateObligation 2 params body → 200404500
POST
/v3/contracts/{id}/obligation/{obligationId}/custom-revenue
Upsert obligation custom revenue
IntegratorsApiContractsv3Controller_upsertCustomRevenue 2 params body → 200400404500
GET
/v3/contracts/{id}/billing-term-groups
List contract billing term groups
IntegratorsApiContractsv3Controller_getBillingTermGroups 4 params → 200400404500
DELETE
/v3/contracts/{id}/billing-term-groups/{groupId}
Delete contract billing term group
IntegratorsApiContractsv3Controller_deleteBillingTermGroup 2 params → 200400404500
GET
/v3/contracts/{id}/performance-obligations
List contract performance obligations
IntegratorsApiContractsv3Controller_getPerformanceObligationsWithRevenue 5 params → 200400404500
POST
/v3/contracts/{id}/performance-obligations
Bulk save contract performance obligations
IntegratorsApiContractsv3Controller_batchSavePobsForContract 1 param body → 200400404500
PATCH
/v3/contracts/{id}/performance-obligations/{pobId}
Update contract performance obligation
IntegratorsApiContractsv3Controller_updatePerformanceObligation 2 params body → 200400404500
GET
/v3/contracts/{id}/billing-terms
List contract billing terms
IntegratorsApiContractsv3Controller_getBillingTerms 4 params → 200404500
POST
/v3/contracts/{id}/billing-terms
Create contract billing term
IntegratorsApiContractsv3Controller_createBillingTerm 1 param body → 201400404500
PATCH
/v3/contracts/{id}/billing-terms/{billingTermId}
Update contract billing term
IntegratorsApiContractsv3Controller_patchBillingTerm 2 params body → 200400404500
DELETE
/v3/contracts/{id}/billing-terms/{billingTermId}
Delete contract billing term
IntegratorsApiContractsv3Controller_deleteBillingTerm 2 params → 200404409500
PATCH
/v3.1/contracts/{id}/obligation/{obligationId}
Update contract obligation
IntegratorsApiContractsV31Controller_updateObligation 2 params body → 200404500
GET
/v3/contracts/deleted
List deleted contracts
IntegratorsApiContractsv3Controller_getDeletedContracts 3 params → 200
PATCH
/v3/contracts/{id}/billing-term-groups/{groupId}/event-type
Change event type for selected billing terms and POBs in a group
IntegratorsApiContractsv3Controller_changeBillingTermGroupEventType 2 params body → 200400404409500

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are GetBillingTermItemDto (27 properties), PerformanceObligationDetailResponseDto (23 properties), BillingTermResponseDto (23 properties), CreateBillingTermDto (22 properties). Each schema is shown below with its type and property counts.

GetBillingTermItemDto
object
27 properties 27 required
BillingScheduleDto
object
22 properties 12 required
ChangeBillingTermGroupEventTypeResponseDto
object
3 properties 3 required
BatchSavePobsForContractDto
object
4 properties 4 required
ContractScopedUpdatePobDto
object
12 properties 1 required
ExternalIdSourceType
string
DiscountDto
object
3 properties
CreateContractV3Dto
object
5 properties 2 required
RecognizedRevenueAtomResponseDto
object
2 properties 2 required
ContractsV3Dto
object
13 properties 5 required
RecognizedRevenueDto
object
3 properties 3 required
UpdateContractV3Dto
object
4 properties
RevenueScheduleDto
object
2 properties 1 required
UpdatePerformanceObligationForContractDto
object
7 properties
ExternalIdDto
object
3 properties
ContractActionDto
object
1 property 1 required
BillingTermGroupDto
object
6 properties 6 required
IntegratorsApiError
object
3 properties 2 required
UpdateObligationDto
object
18 properties
PricingTierDto
object
4 properties 4 required
CreateObligationDto
object
6 properties 3 required
PaginatedResponseDTO
object
ObligationDto
object
9 properties 6 required
CreateBillingScheduleDto
object
21 properties 10 required
PatchBillingTermDto
object
19 properties
ChangeBillingTermGroupEventTypeDto
object
3 properties 3 required
IntegratorsApiResponse
object
4 properties 4 required
PerformanceObligationDetailResponseDto
object
23 properties 23 required
ContractScopedCreatePobDto
object
11 properties 3 required
BatchSavePerformanceObligationsResponseDto
object
1 property
SeatBasedObligationConfigDto
object
4 properties 4 required
CreateBillingTermDto
object
22 properties 10 required
BillingTermResponseDto
object
23 properties 13 required
CustomRevenue
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tabs-contracts-api-openapi.yml Raw ↑

Other APIs Tabs publishes across the network.

Tabs Billing Terms API
Tabs Categories API
Tabs Classes (QBO only) API
Tabs Commitments API
Tabs Credit Memos API
Tabs Custom Fields API
Tabs Customers API
Tabs Departments API
Tabs Events API
Tabs Health API
Tabs Invoices API
Tabs Items API