Create contract

POST

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

POST

/v3/contracts

$ curl -X POST https://integrators.prod.api.tabsplatform.com/v3/contracts \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "name": "Contract",
>   "customerId": "123e4567-e89b-12d3-a456-426614174000"
> }'

1 {
2   "id": "123e4567-e89b-12d3-a456-426614174000",
3   "fileName": "Contract.pdf",
4   "name": "Contract",
5   "status": "ACTIVE",
6   "customerId": "123e4567-e89b-12d3-a456-426614174000",
7   "documentClassifications": [
8     "ORDER_FORM",
9     "MSA"
10   ],
11   "customerName": "John Doe",
12   "createdAt": "2024-01-01T00:00:00.000Z",
13   "closeDate": "2024-01-01",
14   "lastUpdatedAt": "2024-01-01T00:00:00.000Z",
15   "deletedAt": "2024-01-01T00:00:00.000Z",
16   "externalIds": [
17     {
18       "externalId": "123e4567-e89b-12d3-a456-426614174000",
19       "sourceType": "NETSUITE"
20     }
21   ],
22   "source": "CRM",
23   "jobId": "wf-123e4567-e89b-12d3-a456-426614174000"
24 }

Authentication

Authorizationstring

API Key authentication via header

Request

This endpoint expects an object.

namestringRequired

Name of the Contract

customerIdstringRequired

customer identifier(UUID)

externalIdobjectOptional

External identification details, only used for Netsuite Sales Orders

closeDatestringOptional

Close date of the contract

shouldProcessbooleanOptionalDefaults to falseDeprecated

Deprecated: has no effect. Use shouldProcess query param on the file upload endpoint instead.

Response

Created contract

idstring

Unique identifier for the contract

fileNamestring

Name of the contract file

namestring

Display name of the contract

statusstring

Current status of the contract

customerIdstring

Identifier of the customer associated with this contract

documentClassificationslist of enums or null

Stored document classifications of the contract file. Null when no classification data is available; currently only fetching a contract by ID returns classification data.

customerNamestringOptional

Name of the customer associated with this contract

createdAtdatetimeOptional

Timestamp when the contract was created

closeDatestringOptional

Close date of the contract

lastUpdatedAtstringOptional

Timestamp when the contract was last updated

deletedAtdatetimeOptional

Timestamp when the contract was deleted. Null for live contracts; populated on the deleted-contracts endpoint.

externalIdslist of objectsOptional

External IDs and external source types of the contract

sourceenumOptional

The source of the contract

jobIdstringOptional

The workflow job ID for the contract processing

Errors

400

Bad Request Error

500

Internal Server Error