POST public-api/contracts/getcontractsbynumberV2
This method returns existing contracts, including their notes, by contract number, ordered by contract number. Each contract's notes are returned newest first. 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, and a request that matches no active contract returns a record-not-found message. 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 stringRequest Formats
application/json
Sample:
[ "sample string 1", "sample string 2" ]
Response Information
Resource Description
WaspResultOfListOfContractModelHeaderInfo| Name | Description | 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:37.1225251+00:00",
"EndDate": "2026-11-05T21:57:37.1225251+00:00",
"IsSoftwareContract": true,
"LicenseCount": 1,
"Notes": [
{
"NoteText": "sample string 1",
"NoteDate": "2026-11-05T21:57:37.1225251+00:00",
"UserLogon": "sample string 2"
},
{
"NoteText": "sample string 1",
"NoteDate": "2026-11-05T21:57:37.1225251+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:37.1225251+00:00",
"DcfValueRecordStatus": 0
},
{
"ImportRowNumber": 1,
"DcfLabel": "sample string 2",
"DCFDataType": 1,
"DcfTextValue": "sample string 3",
"DcfNumberValue": 1.0,
"DcfDateValue": "2026-11-05T21:57:37.1225251+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:37.1225251+00:00",
"EndDate": "2026-11-05T21:57:37.1225251+00:00",
"IsSoftwareContract": true,
"LicenseCount": 1,
"Notes": [
{
"NoteText": "sample string 1",
"NoteDate": "2026-11-05T21:57:37.1225251+00:00",
"UserLogon": "sample string 2"
},
{
"NoteText": "sample string 1",
"NoteDate": "2026-11-05T21:57:37.1225251+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:37.1225251+00:00",
"DcfValueRecordStatus": 0
},
{
"ImportRowNumber": 1,
"DcfLabel": "sample string 2",
"DCFDataType": 1,
"DcfTextValue": "sample string 3",
"DcfNumberValue": 1.0,
"DcfDateValue": "2026-11-05T21:57:37.1225251+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
}