Contracts
Upload contract file
post/v3/contracts/{id}/file
Request
- Base URLhttps://integrators.prod.api.tabsplatform.com
- AuthAPI key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
idstring required
Example:123e4567-e89b-12d3-a456-426614174000
Contract Id
Query parameters
shouldProcessboolean
Whether to trigger contract processing after file upload. Defaults to true.
Request body multipart/form-data
Response
Contract file was replaced successfully
Example response
{
"payload": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"fileName": "Contract.pdf",
"name": "Contract",
"status": "ACTIVE",
"customerId": "123e4567-e89b-12d3-a456-426614174000",
"customerName": "John Doe",
"createdAt": "2024-01-01T00:00:00.000Z",
"closeDate": "2024-01-01",
"lastUpdatedAt": "2024-01-01T00:00:00.000Z",
"deletedAt": "2024-01-01T00:00:00.000Z",
"externalIds": [
{
"externalId": "123e4567-e89b-12d3-a456-426614174000",
"sourceType": "NETSUITE"
}
],
"jobId": "wf-123e4567-e89b-12d3-a456-426614174000"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.