v1

latestOpenAPI 3.0.02026-07-24102143224.1 KB

Contracts

Get contract by ID

get/v3/contracts/{id}

Path parameters

idstring required

Example:123e4567-e89b-12d3-a456-426614174000

Contract Id

Response

The contract

successboolean required

Boolean with true=success, false=failure

messagestring required

Plain-text description of the result

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