Overview
This POST API allows fetching contract header level utilization details from GEP SMART.
URL Format: https://<Instance>/SmartBulkInterfaceAPI/api/Contract/GetContractUtilizationDetails
Request
[
“string”
]
Response
[
{
"documentNumber": “string”,
"contractLimit": null,
"utilizedValue": 0.0,
"contractValue": 0.0,
"contractBaseCurrencyValue": 0.0,
"contractBaseCurrencyType": “string”,
"contractCurrency": “string”,
"contractRemainingValue": 0.0,
"documentStatus": 71,
"discountDetails": [
{
"documentCode": 0,
"discountDetailId": 0,
"discountDescription": “string”,
"discountConfigurationId": 0,
"rowNumber": 0,
"lineNumber": 1,
"discountName": “string”,
"discountCriteriaId": 0,
"isDiscount": false,
"utilizationStartDate": null,
"utilizationEndDate": null,
"utilizationValue": 0.000000,
"applicationStartDate": "2020-04-07T00:00:00",
"applicationEndDate": "2020-04-07T00:00:00",
"isDeleted": false,
"inActive": false,
"isCopied": false,
"tierInfos": [
{
"discountTierId": 0,
"discountDetailId": 0,
"fromValue": 10.000000,
"toValue": 20.000000,
"percentageValue": 0.000000,
"isCopied": false,
"isDeleted": false
}
],
"currencyCode": “string”,
"calculateDiscountValue": 0.0,
"calculateDiscountPercentage": 0.0,
"contractTotalDiscount": 0.000000,
"contractTotalSurcharge": 0.000000
}
]
}
]
Examples
Examples
Success Scenario – Request
[
"2021.000732",
"2020.002373"
]
Success Scenario – Response
[
{
"documentNumber": "2020.002373",
"contractLimit": null,
"utilizedValue": 0.0,
"contractValue": 0.0,
"contractBaseCurrencyValue": 0.0,
"contractBaseCurrencyType": "",
"contractCurrency": "USD",
"contractRemainingValue": 0.0,
"documentStatus": 71,
"discountDetails": [
{
"documentCode": 108272,
"discountDetailId": 6,
"discountDescription": "test",
"discountConfigurationId": 3,
"rowNumber": 0,
"lineNumber": 1,
"discountName": "99oo",
"discountCriteriaId": 2,
"isDiscount": false,
"utilizationStartDate": null,
"utilizationEndDate": null,
"utilizationValue": 0.000000,
"applicationStartDate": "2020-04-07T00:00:00",
"applicationEndDate": "2020-04-07T00:00:00",
"isDeleted": false,
"inActive": false,
"isCopied": false,
"tierInfos": [
{
"discountTierId": 1,
"discountDetailId": 6,
"fromValue": 10.000000,
"toValue": 20.000000,
"percentageValue": 0.110000,
"isCopied": false,
"isDeleted": false
},
{
"discountTierId": 2,
"discountDetailId": 6,
"fromValue": 100.000000,
"toValue": 240.000000,
"percentageValue": 0.110000,
"isCopied": false,
"isDeleted": false
},
{
"discountTierId": 9,
"discountDetailId": 6,
"fromValue": 10.000000,
"toValue": 20.000000,
"percentageValue": 20.000000,
"isCopied": false,
"isDeleted": false
},
{
"discountTierId": 15,
"discountDetailId": 6,
"fromValue": 10.000000,
"toValue": 20.000000,
"percentageValue": 20.000000,
"isCopied": false,
"isDeleted": false
}
],
"currencyCode": "USD",
"calculateDiscountValue": 0.0,
"calculateDiscountPercentage": 0.0,
"contractTotalDiscount": 0.000000,
"contractTotalSurcharge": 0.000000
},
{
"documentCode": 108272,
"discountDetailId": 18,
"discountDescription": "asdf",
"discountConfigurationId": 2,
"rowNumber": 0,
"lineNumber": 9,
"discountName": "testaa",
"discountCriteriaId": 3,
"isDiscount": false,
"utilizationStartDate": "2020-03-19T00:00:00",
"utilizationEndDate": "2020-10-03T00:00:00",
"utilizationValue": 0.000000,
"applicationStartDate": "2020-03-18T00:00:00",
"applicationEndDate": "2020-10-03T00:00:00",
"isDeleted": false,
"inActive": false,
"isCopied": false,
"tierInfos": [
{
"discountTierId": 16,
"discountDetailId": 18,
"fromValue": 10.000000,
"toValue": 20.000000,
"percentageValue": 20.000000,
"isCopied": false,
"isDeleted": false
},
{
"discountTierId": 10,
"discountDetailId": 18,
"fromValue": 10.000000,
"toValue": 20.000000,
"percentageValue": 20.000000,
"isCopied": false,
"isDeleted": false
},
{
"discountTierId": 21,
"discountDetailId": 18,
"fromValue": 10.000000,
"toValue": 20.000000,
"percentageValue": 20.000000,
"isCopied": false,
"isDeleted": false
},
{
"discountTierId": 22,
"discountDetailId": 18,
"fromValue": 30.000000,
"toValue": 40.000000,
"percentageValue": 2.000000,
"isCopied": false,
"isDeleted": false
}
],
"currencyCode": "USD",
"calculateDiscountValue": 0.0,
"calculateDiscountPercentage": 0.0,
"contractTotalDiscount": 0.000000,
"contractTotalSurcharge": 0.000000
},
{
"documentCode": 108272,
"discountDetailId": 19,
"discountDescription": "asdfff",
"discountConfigurationId": 3,
"rowNumber": 0,
"lineNumber": 10,
"discountName": "99oo",
"discountCriteriaId": 2,
"isDiscount": false,
"utilizationStartDate": null,
"utilizationEndDate": null,
"utilizationValue": 0.000000,
"applicationStartDate": "2020-03-20T00:00:00",
"applicationEndDate": "2020-10-03T00:00:00",
"isDeleted": false,
"inActive": false,
"isCopied": false,
"tierInfos": [
{
"discountTierId": 11,
"discountDetailId": 19,
"fromValue": 10.000000,
"toValue": 20.000000,
"percentageValue": 20.000000,
"isCopied": false,
"isDeleted": false
},
{
"discountTierId": 17,
"discountDetailId": 19,
"fromValue": 10.000000,
"toValue": 20.000000,
"percentageValue": 20.000000,
"isCopied": false,
"isDeleted": false
}
],
"currencyCode": "USD",
"calculateDiscountValue": 0.0,
"calculateDiscountPercentage": 0.0,
"contractTotalDiscount": 0.000000,
"contractTotalSurcharge": 0.000000
},
{
"documentCode": 108272,
"discountDetailId": 20,
"discountDescription": "asdfsdf",
"discountConfigurationId": 3,
"rowNumber": 0,
"lineNumber": 11,
"discountName": "99oo",
"discountCriteriaId": 2,
"isDiscount": false,
"utilizationStartDate": null,
"utilizationEndDate": null,
"utilizationValue": 0.000000,
"applicationStartDate": "2020-03-18T00:00:00",
"applicationEndDate": "2020-10-02T00:00:00",
"isDeleted": false,
"inActive": false,
"isCopied": false,
"tierInfos": [
{
"discountTierId": 18,
"discountDetailId": 20,
"fromValue": 10.000000,
"toValue": 20.000000,
"percentageValue": 20.000000,
"isCopied": false,
"isDeleted": false
},
{
"discountTierId": 12,
"discountDetailId": 20,
"fromValue": 10.000000,
"toValue": 20.000000,
"percentageValue": 20.000000,
"isCopied": false,
"isDeleted": false
}
],
"currencyCode": "USD",
"calculateDiscountValue": 0.0,
"calculateDiscountPercentage": 0.0,
"contractTotalDiscount": 0.000000,
"contractTotalSurcharge": 0.000000
},
{
"documentCode": 108272,
"discountDetailId": 27,
"discountDescription": "",
"discountConfigurationId": 1,
"rowNumber": 0,
"lineNumber": 14,
"discountName": "tetwwaaasfd",
"discountCriteriaId": 2,
"isDiscount": true,
"utilizationStartDate": null,
"utilizationEndDate": null,
"utilizationValue": 0.000000,
"applicationStartDate": "2020-03-18T00:00:00",
"applicationEndDate": "2020-10-03T00:00:00",
"isDeleted": false,
"inActive": false,
"isCopied": false,
"tierInfos": [
{
"discountTierId": 13,
"discountDetailId": 27,
"fromValue": 10.000000,
"toValue": 20.000000,
"percentageValue": 20.000000,
"isCopied": false,
"isDeleted": false
},
{
"discountTierId": 19,
"discountDetailId": 27,
"fromValue": 10.000000,
"toValue": 20.000000,
"percentageValue": 20.000000,
"isCopied": false,
"isDeleted": false
}
],
"currencyCode": "USD",
"calculateDiscountValue": 0.0,
"calculateDiscountPercentage": 0.0,
"contractTotalDiscount": 0.000000,
"contractTotalSurcharge": 0.000000
},
{
"documentCode": 108272,
"discountDetailId": 28,
"discountDescription": "",
"discountConfigurationId": 1,
"rowNumber": 0,
"lineNumber": 15,
"discountName": "tetwwaaasfd",
"discountCriteriaId": 2,
"isDiscount": true,
"utilizationStartDate": null,
"utilizationEndDate": null,
"utilizationValue": 0.000000,
"applicationStartDate": "2020-03-18T00:00:00",
"applicationEndDate": "2020-10-03T00:00:00",
"isDeleted": false,
"inActive": false,
"isCopied": false,
"tierInfos": [
{
"discountTierId": 20,
"discountDetailId": 28,
"fromValue": 10.000000,
"toValue": 20.000000,
"percentageValue": 20.000000,
"isCopied": false,
"isDeleted": false
},
{
"discountTierId": 14,
"discountDetailId": 28,
"fromValue": 10.000000,
"toValue": 20.000000,
"percentageValue": 20.000000,
"isCopied": false,
"isDeleted": false
}
],
"currencyCode": "USD",
"calculateDiscountValue": 0.0,
"calculateDiscountPercentage": 0.0,
"contractTotalDiscount": 0.000000,
"contractTotalSurcharge": 0.000000
},
{
"documentCode": 108272,
"discountDetailId": 29,
"discountDescription": "hhh",
"discountConfigurationId": 3,
"rowNumber": 0,
"lineNumber": 16,
"discountName": "99oo",
"discountCriteriaId": 2,
"isDiscount": false,
"utilizationStartDate": null,
"utilizationEndDate": null,
"utilizationValue": 0.000000,
"applicationStartDate": "2020-03-18T00:00:00",
"applicationEndDate": "2020-10-03T00:00:00",
"isDeleted": false,
"inActive": false,
"isCopied": false,
"tierInfos": [],
"currencyCode": "USD",
"calculateDiscountValue": 0.0,
"calculateDiscountPercentage": 0.0,
"contractTotalDiscount": 0.000000,
"contractTotalSurcharge": 0.000000
},
{
"documentCode": 108272,
"discountDetailId": 30,
"discountDescription": "",
"discountConfigurationId": 1,
"rowNumber": 0,
"lineNumber": 17,
"discountName": "tetwwaaasfd",
"discountCriteriaId": 2,
"isDiscount": true,
"utilizationStartDate": null,
"utilizationEndDate": null,
"utilizationValue": 0.000000,
"applicationStartDate": "2020-03-18T00:00:00",
"applicationEndDate": "2020-10-03T00:00:00",
"isDeleted": false,
"inActive": false,
"isCopied": false,
"tierInfos": [],
"currencyCode": "USD",
"calculateDiscountValue": 0.0,
"calculateDiscountPercentage": 0.0,
"contractTotalDiscount": 0.000000,
"contractTotalSurcharge": 0.000000
},
{
"documentCode": 108272,
"discountDetailId": 31,
"discountDescription": "",
"discountConfigurationId": 1,
"rowNumber": 0,
"lineNumber": 18,
"discountName": "tetwwaaasfd",
"discountCriteriaId": 2,
"isDiscount": true,
"utilizationStartDate": null,
"utilizationEndDate": null,
"utilizationValue": 0.000000,
"applicationStartDate": "2020-03-18T00:00:00",
"applicationEndDate": "2020-10-03T00:00:00",
"isDeleted": false,
"inActive": false,
"isCopied": false,
"tierInfos": [],
"currencyCode": "USD",
"calculateDiscountValue": 0.0,
"calculateDiscountPercentage": 0.0,
"contractTotalDiscount": 0.000000,
"contractTotalSurcharge": 0.000000
},
{
"documentCode": 108272,
"discountDetailId": 32,
"discountDescription": "878787",
"discountConfigurationId": 3,
"rowNumber": 0,
"lineNumber": 19,
"discountName": "99oo",
"discountCriteriaId": 2,
"isDiscount": false,
"utilizationStartDate": null,
"utilizationEndDate": null,
"utilizationValue": 0.000000,
"applicationStartDate": "2020-03-22T00:00:00",
"applicationEndDate": "2020-10-01T00:00:00",
"isDeleted": false,
"inActive": false,
"isCopied": false,
"tierInfos": [],
"currencyCode": "USD",
"calculateDiscountValue": 0.0,
"calculateDiscountPercentage": 0.0,
"contractTotalDiscount": 0.000000,
"contractTotalSurcharge": 0.000000
}
]
}
]
Data Elements
|
ContractUtilizationDetails |
|||||
|
Property |
Required? |
Data type |
Description |
Validations / Exceptions |
|
|
DocumentNumber |
|
String |
|
|
|
|
ContractLimit |
|
Double |
|
|
|
|
UtilizedValue |
|
Double |
|
|
|
|
ContractValue |
|
Double |
|
|
|
|
ContractBaseCurrencyValue |
|
Double |
|
|
|
|
ContractBaseCurrencyType |
|
String |
|
|
|
|
ContractCurrency |
|
String |
|
|
|
|
ContractRemainingValue |
|
Double |
|
|
|
|
DocumentStatus |
|
Enum |
|
|
|
|
DiscountDetails |
|
List of ContractDiscountDetail object |
|
|
|
|
ContractDiscountDetail |
|||||
|
Property |
Required? |
Data type |
Description |
Validations / Exceptions |
|
|
DocumentCode |
|
Long |
|
|
|
|
DiscountDetailId |
|
Long |
|
|
|
|
DiscountDescription |
|
String |
|
|
|
|
DiscountConfigurationId |
|
Integer |
|
|
|
|
RowNumber |
|
Integer |
|
|
|
|
LineNumber |
|
Integer |
|
|
|
|
DiscountName |
|
String |
|
|
|
|
DiscountCriteriaId |
|
Integer |
|
|
|
|
IsDiscount |
|
Boolean |
|
|
|
|
UtilizationStartDate |
|
DateTime |
|
|
|
|
UtilizationEndDate |
|
DateTime |
|
|
|
|
UtilizationValue |
|
Decimal |
|
|
|
|
ApplicationStartDate |
|
DateTime |
|
|
|
|
ApplicationEndDate |
|
DateTime |
|
|
|
|
IsDeleted |
|
Boolean |
|
|
|
|
InActive |
|
Boolean |
|
|
|
|
IsCopied |
|
Boolean |
|
|
|
|
TierInfos |
|
List of ContractDiscountTierInfo object |
|
|
|
|
CurrencyCode |
|
String |
|
|
|
|
CalculateDiscountValue |
|
Decimal |
|
|
|
|
CalculateDiscountPercentage |
|
Decimal |
|
|
|
|
ContractTotalDiscount |
|
Decimal |
|
|
|
|
ContractTotalSurcharge |
|
Decimal |
|
|
|
|
ContractDiscountTierInfo |
|||||
|
Property |
Required? |
Data type |
Description |
Validations / Exceptions |
|
|
DiscountTierId |
|
Long |
|
|
|
|
DiscountDetailId |
|
Long |
|
|
|
|
FromValue |
|
Decimal |
|
|
|
|
ToValue |
|
Decimal |
|
|
|
|
PercentageValue |
|
Decimal |
|
|
|
|
IsCopied |
|
Boolean |
|
|
|
|
IsDeleted |
|
Boolean |
|
|
|