v1

latestOpenAPI 3.0.02026-07-24102143224.1 KB

Contracts

Create contract

post/v3/contracts

Request body

namestring required

Name of the Contract

customerIdstring required

customer identifier(UUID)

shouldProcessboolean

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

closeDatestring

Close date of the contract

Example request

{
  "name": "Contract",
  "customerId": "123e4567-e89b-12d3-a456-426614174000",
  "externalId": {
    "externalId": "123e4567-e89b-12d3-a456-426614174000",
    "metadata": {
      "orderId": "1234567890"
    }
  },
  "closeDate": "2024-01-01"
}

Response

Created contract

idstring required

Unique identifier for the contract

fileNamestring required

Name of the contract file

namestring required

Display name of the contract

statusstring required

Current status of the contract

customerIdstring required

Identifier of the customer associated with this contract

customerNamestring

Name of the customer associated with this contract

createdAtstring date-time

Timestamp when the contract was created

closeDatestring

Close date of the contract

lastUpdatedAtstring

Timestamp when the contract was last updated

deletedAtstring date-time

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

The source of the contract

jobIdstring

The workflow job ID for the contract processing

Example response

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