POST public-api/contracts/update
This method updates the header info of one or more existing contracts. This does not affect the assets associated with the contract. The existing contract is retrieved by calling one of the search APIs. Requires Edit Contract permission. Contracts are matched by contract number and must be active; a contract number that matches no active contract is reported as not found in that record's result. Notes and attachment associations supplied on the contract header are applied as part of the update. Accepts a maximum of 500 contracts at a time.
Request Information
URI Parameters
None.
Body Parameters
Collection of ContractModelHeaderInfo| Name | Description | Type | Additional information |
|---|---|---|---|
| ContractNumber | string |
None. |
|
| Description | string |
None. |
|
| Cost | decimal number |
None. |
|
| BeginDate | date |
None. |
|
| EndDate | date |
None. |
|
| IsSoftwareContract | boolean |
None. |
|
| LicenseCount | integer |
None. |
|
| Notes | Collection of NoteInfo |
None. |
|
| VendorNumber | string |
None. |
|
| CustomFields | Collection of DcfValueInfo |
None. |
|
| HasAttachment | boolean |
None. |
|
| AttachmentsToAdd | Collection of string |
None. |
|
| AttachmentsToDelete | Collection of string |
None. |
|
| AttachmentNames | Collection of Pair of string [key] and string [value] |
None. |
Request Formats
application/json
[
{
"ContractNumber": "sample string 1",
"Description": "sample string 2",
"Cost": 1.0,
"BeginDate": "2026-11-05T21:57:33.8645159+00:00",
"EndDate": "2026-11-05T21:57:33.8645159+00:00",
"IsSoftwareContract": true,
"LicenseCount": 1,
"Notes": [
{
"NoteText": "sample string 1",
"NoteDate": "2026-11-05T21:57:33.8645159+00:00",
"UserLogon": "sample string 2"
},
{
"NoteText": "sample string 1",
"NoteDate": "2026-11-05T21:57:33.8645159+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:33.8645159+00:00",
"DcfValueRecordStatus": 0
},
{
"ImportRowNumber": 1,
"DcfLabel": "sample string 2",
"DCFDataType": 1,
"DcfTextValue": "sample string 3",
"DcfNumberValue": 1.0,
"DcfDateValue": "2026-11-05T21:57:33.8645159+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:33.8645159+00:00",
"EndDate": "2026-11-05T21:57:33.8645159+00:00",
"IsSoftwareContract": true,
"LicenseCount": 1,
"Notes": [
{
"NoteText": "sample string 1",
"NoteDate": "2026-11-05T21:57:33.8645159+00:00",
"UserLogon": "sample string 2"
},
{
"NoteText": "sample string 1",
"NoteDate": "2026-11-05T21:57:33.8645159+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:33.8645159+00:00",
"DcfValueRecordStatus": 0
},
{
"ImportRowNumber": 1,
"DcfLabel": "sample string 2",
"DCFDataType": 1,
"DcfTextValue": "sample string 3",
"DcfNumberValue": 1.0,
"DcfDateValue": "2026-11-05T21:57:33.8645159+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"
}
]
}
]
Response Information
Resource Description
WaspResultOfResults| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Results |
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
{
"Data": {
"ResultList": [
{
"ResultCode": 0,
"Message": "sample string 1",
"HttpStatusCode": 200,
"FieldName": "sample string 2"
},
{
"ResultCode": 0,
"Message": "sample string 1",
"HttpStatusCode": 200,
"FieldName": "sample string 2"
}
],
"SuccessfullResults": 1,
"TotalResults": 2,
"ErrorCount": 0
},
"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
}