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"
}'

{
  "payload": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "fileName": "Contract.pdf",
    "name": "Contract",
    "status": "ACTIVE",
    "customerId": "123e4567-e89b-12d3-a456-426614174000",
    "documentClassifications": [
      "ORDER_FORM",
      "MSA"
    ],
    "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"
      }
    ],
    "source": "CRM",
    "jobId": "wf-123e4567-e89b-12d3-a456-426614174000"
  },
  "success": true,
  "message": "string",
  "error": {
    "code": 1.1,
    "message": "string",
    "details": {}
  }
}

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

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

500

Internal Server Error