POST public-api/contracts/getcontractsbynumber

This method returns existing contracts by number, ordered by contract number. The contract notes are not populated; use the V2 form of this method to retrieve them. Requires Allow Contract permission. Only active contracts are returned, and a submitted number that matches no active contract is simply absent from the returned list. An empty request list returns an empty list. Note: This is a Post API to avoid limitations inherent to passing parameters on the URL.

Request Information

URI Parameters

None.

Body Parameters

Collection of string

Request Formats

application/json

Sample:

[
  "sample string 1",
  "sample string 2"
]

Response Information

Resource Description

WaspResultOfListOfContractModelHeaderInfo

Name	Type	Additional information
Data	Collection of ContractModelHeaderInfo	None.
Messages	Collection of WtResult	None.
BatchNumber	integer	None.
HasError	boolean	None.
HasHttpError	boolean	None.
HasMessage	boolean	None.
HasSuccessWithMoreDataRemaining	boolean	None.
TotalRecordsLongCount	integer	None.

Response Formats

application/json

Sample:

{
  "Data": [
    {
      "ContractNumber": "sample string 1",
      "Description": "sample string 2",
      "Cost": 1.0,
      "BeginDate": "2026-11-05T21:57:36.5129207+00:00",
      "EndDate": "2026-11-05T21:57:36.5129207+00:00",
      "IsSoftwareContract": true,
      "LicenseCount": 1,
      "Notes": [
        {
          "NoteText": "sample string 1",
          "NoteDate": "2026-11-05T21:57:36.5129207+00:00",
          "UserLogon": "sample string 2"
        },
        {
          "NoteText": "sample string 1",
          "NoteDate": "2026-11-05T21:57:36.5129207+00:00",
          "UserLogon": "sample string 2"
        }
      ],
      "VendorNumber": "sample string 4",
      "CustomFields": [
        {
          "ImportRowNumber": 1,
          "DcfLabel": "sample string 2",
          "DCFDataType": 1,
          "DcfTextValue": "sample string 3",
          "DcfNumberValue": 1.0,
          "DcfDateValue": "2026-11-05T21:57:36.5129207+00:00",
          "DcfValueRecordStatus": 0
        },
        {
          "ImportRowNumber": 1,
          "DcfLabel": "sample string 2",
          "DCFDataType": 1,
          "DcfTextValue": "sample string 3",
          "DcfNumberValue": 1.0,
          "DcfDateValue": "2026-11-05T21:57:36.5129207+00:00",
          "DcfValueRecordStatus": 0
        }
      ],
      "HasAttachment": true,
      "AttachmentsToAdd": [
        "sample string 1",
        "sample string 2"
      ],
      "AttachmentsToDelete": [
        "sample string 1",
        "sample string 2"
      ],
      "AttachmentNames": [
        {
          "Key": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Key": "sample string 1",
          "Value": "sample string 2"
        }
      ]
    },
    {
      "ContractNumber": "sample string 1",
      "Description": "sample string 2",
      "Cost": 1.0,
      "BeginDate": "2026-11-05T21:57:36.5129207+00:00",
      "EndDate": "2026-11-05T21:57:36.5129207+00:00",
      "IsSoftwareContract": true,
      "LicenseCount": 1,
      "Notes": [
        {
          "NoteText": "sample string 1",
          "NoteDate": "2026-11-05T21:57:36.5129207+00:00",
          "UserLogon": "sample string 2"
        },
        {
          "NoteText": "sample string 1",
          "NoteDate": "2026-11-05T21:57:36.5129207+00:00",
          "UserLogon": "sample string 2"
        }
      ],
      "VendorNumber": "sample string 4",
      "CustomFields": [
        {
          "ImportRowNumber": 1,
          "DcfLabel": "sample string 2",
          "DCFDataType": 1,
          "DcfTextValue": "sample string 3",
          "DcfNumberValue": 1.0,
          "DcfDateValue": "2026-11-05T21:57:36.5129207+00:00",
          "DcfValueRecordStatus": 0
        },
        {
          "ImportRowNumber": 1,
          "DcfLabel": "sample string 2",
          "DCFDataType": 1,
          "DcfTextValue": "sample string 3",
          "DcfNumberValue": 1.0,
          "DcfDateValue": "2026-11-05T21:57:36.5129207+00:00",
          "DcfValueRecordStatus": 0
        }
      ],
      "HasAttachment": true,
      "AttachmentsToAdd": [
        "sample string 1",
        "sample string 2"
      ],
      "AttachmentsToDelete": [
        "sample string 1",
        "sample string 2"
      ],
      "AttachmentNames": [
        {
          "Key": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Key": "sample string 1",
          "Value": "sample string 2"
        }
      ]
    }
  ],
  "Messages": [
    {
      "ResultCode": 0,
      "Message": "sample string 1",
      "HttpStatusCode": 200,
      "FieldName": "sample string 2"
    },
    {
      "ResultCode": 0,
      "Message": "sample string 1",
      "HttpStatusCode": 200,
      "FieldName": "sample string 2"
    }
  ],
  "BatchNumber": 1,
  "HasError": false,
  "HasHttpError": false,
  "HasMessage": true,
  "HasSuccessWithMoreDataRemaining": false,
  "TotalRecordsLongCount": 1
}