POST api/CommodityApi/InsertContract
Request Information
URI Parameters
None.
Body Parameters
ApiParamOfObjectAndContract| Name | Description | Type | Additional information |
|---|---|---|---|
| AuthKey | AuthenticationKey |
Required |
|
| Criteria | Object |
Required |
|
| Data | Contract |
Required |
Request Formats
application/json, text/json
Sample:
{
"AuthKey": {
"WebServiceKey": "sample string 1",
"CompanyID": 1,
"AppSource": "sample string 2",
"AppSourceTeam": "sample string 3"
},
"Criteria": {},
"Data": {
"ContractHeaderList": [
{
"PremiseID": "sample string 1",
"ContractCategory": "sample string 2",
"ContractStartDate": "2025-10-28T18:58:58.96419-04:00",
"ContractEndtDate": "2025-10-28T18:58:58.96419-04:00",
"ID": 1,
"ContractID": "sample string 3",
"CompanyID": 1,
"CustomerID": "sample string 4",
"RefID": "sample string 5",
"IsActive": true,
"UpdatedBy": "sample string 6",
"UpdatedDate": "2025-10-28T18:58:58.96419-04:00",
"CreatedBy": "sample string 7",
"CreatedDate": "2025-10-28T18:58:58.96419-04:00"
},
{
"PremiseID": "sample string 1",
"ContractCategory": "sample string 2",
"ContractStartDate": "2025-10-28T18:58:58.96419-04:00",
"ContractEndtDate": "2025-10-28T18:58:58.96419-04:00",
"ID": 1,
"ContractID": "sample string 3",
"CompanyID": 1,
"CustomerID": "sample string 4",
"RefID": "sample string 5",
"IsActive": true,
"UpdatedBy": "sample string 6",
"UpdatedDate": "2025-10-28T18:58:58.96419-04:00",
"CreatedBy": "sample string 7",
"CreatedDate": "2025-10-28T18:58:58.96419-04:00"
}
],
"ContractDetailsList": [
{
"ChargeDesc": "sample string 1",
"ChargeType": "sample string 2",
"MinQty": 1.0,
"MaxQty": 1.0,
"RATE": 1.0,
"INDEX": "sample string 3",
"ID": 1,
"ContractID": "sample string 4",
"CompanyID": 1,
"CustomerID": "sample string 5",
"RefID": "sample string 6",
"IsActive": true,
"UpdatedBy": "sample string 7",
"UpdatedDate": "2025-10-28T18:58:58.96419-04:00",
"CreatedBy": "sample string 8",
"CreatedDate": "2025-10-28T18:58:58.96419-04:00"
},
{
"ChargeDesc": "sample string 1",
"ChargeType": "sample string 2",
"MinQty": 1.0,
"MaxQty": 1.0,
"RATE": 1.0,
"INDEX": "sample string 3",
"ID": 1,
"ContractID": "sample string 4",
"CompanyID": 1,
"CustomerID": "sample string 5",
"RefID": "sample string 6",
"IsActive": true,
"UpdatedBy": "sample string 7",
"UpdatedDate": "2025-10-28T18:58:58.96419-04:00",
"CreatedBy": "sample string 8",
"CreatedDate": "2025-10-28T18:58:58.96419-04:00"
}
],
"ContractIndexList": [
{
"INDEX": "sample string 1",
"INDEXType": "sample string 2",
"IndexStart": "2025-10-28T18:58:58.9798166-04:00",
"IndexEnd": "2025-10-28T18:58:58.9798166-04:00",
"RATE": 1.0,
"ID": 1,
"ContractID": "sample string 3",
"CompanyID": 1,
"CustomerID": "sample string 4",
"RefID": "sample string 5",
"IsActive": true,
"UpdatedBy": "sample string 6",
"UpdatedDate": "2025-10-28T18:58:58.9798166-04:00",
"CreatedBy": "sample string 7",
"CreatedDate": "2025-10-28T18:58:58.9798166-04:00"
},
{
"INDEX": "sample string 1",
"INDEXType": "sample string 2",
"IndexStart": "2025-10-28T18:58:58.9798166-04:00",
"IndexEnd": "2025-10-28T18:58:58.9798166-04:00",
"RATE": 1.0,
"ID": 1,
"ContractID": "sample string 3",
"CompanyID": 1,
"CustomerID": "sample string 4",
"RefID": "sample string 5",
"IsActive": true,
"UpdatedBy": "sample string 6",
"UpdatedDate": "2025-10-28T18:58:58.9798166-04:00",
"CreatedBy": "sample string 7",
"CreatedDate": "2025-10-28T18:58:58.9798166-04:00"
}
]
}
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ApiOutputCommonOfContract| Name | Description | Type | Additional information |
|---|---|---|---|
| ResponseCode | string |
None. |
|
| ResponseMessage | string |
None. |
|
| Data | Contract |
None. |
Response Formats
application/json, text/json
Sample:
{
"ResponseCode": "sample string 1",
"ResponseMessage": "sample string 2",
"Data": {
"ContractHeaderList": [
{
"PremiseID": "sample string 1",
"ContractCategory": "sample string 2",
"ContractStartDate": "2025-10-28T18:58:58.9954347-04:00",
"ContractEndtDate": "2025-10-28T18:58:58.9954347-04:00",
"ID": 1,
"ContractID": "sample string 3",
"CompanyID": 1,
"CustomerID": "sample string 4",
"RefID": "sample string 5",
"IsActive": true,
"UpdatedBy": "sample string 6",
"UpdatedDate": "2025-10-28T18:58:58.9954347-04:00",
"CreatedBy": "sample string 7",
"CreatedDate": "2025-10-28T18:58:58.9954347-04:00"
},
{
"PremiseID": "sample string 1",
"ContractCategory": "sample string 2",
"ContractStartDate": "2025-10-28T18:58:58.9954347-04:00",
"ContractEndtDate": "2025-10-28T18:58:58.9954347-04:00",
"ID": 1,
"ContractID": "sample string 3",
"CompanyID": 1,
"CustomerID": "sample string 4",
"RefID": "sample string 5",
"IsActive": true,
"UpdatedBy": "sample string 6",
"UpdatedDate": "2025-10-28T18:58:58.9954347-04:00",
"CreatedBy": "sample string 7",
"CreatedDate": "2025-10-28T18:58:58.9954347-04:00"
}
],
"ContractDetailsList": [
{
"ChargeDesc": "sample string 1",
"ChargeType": "sample string 2",
"MinQty": 1.0,
"MaxQty": 1.0,
"RATE": 1.0,
"INDEX": "sample string 3",
"ID": 1,
"ContractID": "sample string 4",
"CompanyID": 1,
"CustomerID": "sample string 5",
"RefID": "sample string 6",
"IsActive": true,
"UpdatedBy": "sample string 7",
"UpdatedDate": "2025-10-28T18:58:58.9954347-04:00",
"CreatedBy": "sample string 8",
"CreatedDate": "2025-10-28T18:58:58.9954347-04:00"
},
{
"ChargeDesc": "sample string 1",
"ChargeType": "sample string 2",
"MinQty": 1.0,
"MaxQty": 1.0,
"RATE": 1.0,
"INDEX": "sample string 3",
"ID": 1,
"ContractID": "sample string 4",
"CompanyID": 1,
"CustomerID": "sample string 5",
"RefID": "sample string 6",
"IsActive": true,
"UpdatedBy": "sample string 7",
"UpdatedDate": "2025-10-28T18:58:58.9954347-04:00",
"CreatedBy": "sample string 8",
"CreatedDate": "2025-10-28T18:58:58.9954347-04:00"
}
],
"ContractIndexList": [
{
"INDEX": "sample string 1",
"INDEXType": "sample string 2",
"IndexStart": "2025-10-28T18:58:58.9954347-04:00",
"IndexEnd": "2025-10-28T18:58:58.9954347-04:00",
"RATE": 1.0,
"ID": 1,
"ContractID": "sample string 3",
"CompanyID": 1,
"CustomerID": "sample string 4",
"RefID": "sample string 5",
"IsActive": true,
"UpdatedBy": "sample string 6",
"UpdatedDate": "2025-10-28T18:58:58.9954347-04:00",
"CreatedBy": "sample string 7",
"CreatedDate": "2025-10-28T18:58:58.9954347-04:00"
},
{
"INDEX": "sample string 1",
"INDEXType": "sample string 2",
"IndexStart": "2025-10-28T18:58:58.9954347-04:00",
"IndexEnd": "2025-10-28T18:58:58.9954347-04:00",
"RATE": 1.0,
"ID": 1,
"ContractID": "sample string 3",
"CompanyID": 1,
"CustomerID": "sample string 4",
"RefID": "sample string 5",
"IsActive": true,
"UpdatedBy": "sample string 6",
"UpdatedDate": "2025-10-28T18:58:58.9954347-04:00",
"CreatedBy": "sample string 7",
"CreatedDate": "2025-10-28T18:58:58.9954347-04:00"
}
]
}
}