v1

latestOpenAPI 3.0.02026-07-24102143224.1 KB

Contracts

List deleted contracts

get/v3/contracts/deleted

Query parameters

pagenumber required

Page Number

limitnumber required

Number of items to return

filterstring

Format: field:rule:value — comma-separated for multiple filters.

Fields: name (string): eq, neq, like, nlike, in, nin, isnull, isnotnull externalIds.externalId (string): eq, neq, like, nlike, in, nin, isnull, isnotnull externalIds.sourceType (string): eq, neq, like, nlike, in, nin, isnull, isnotnull source (string): eq, neq, like, nlike, in, nin, isnull, isnotnull status (string): eq, neq, like, nlike, in, nin, isnull, isnotnull customerId (uuid): eq, neq, in, nin, isnull, isnotnull createdAt (datetime): eq, neq, gt, gte, lt, lte lastUpdatedAt (datetime): eq, neq, gt, gte, lt, lte deletedAt (datetime): eq, neq, gt, gte, lt, lte, isnull, isnotnull

Date-only values (YYYY-MM-DD) match the full UTC day.

Example: filter=name:eq:value

Response

Get all deleted Contracts by filter, sorted by deletedAt desc

successboolean required

Boolean with true=success, false=failure

messagestring required

Plain-text description of the result

Example response

{
  "payload": {
    "data": [
      {
        "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"
      }
    ]
  }
}