This GET API is used to get the Pricebook details based on
URL Format: https://<Instance>/SmartInterfaceAPI/api/Contract/PriceBookDetails
Query Parameter:
ContractNumber=ABC123 [ex: `ContractNumber=ABC123]
{
"data": {
"objCatalogDetailsModel": {
"catalogNumber": "CAT-2021-07656",
"contractNumber": "CTR-00005566",
"parentContractNumber": "",
"startDate": "2021-05-24T00:00:00",
"endDate": "2023-05-23T00:00:00",
"lstOrgEntity": [
{
"entityCode": "M010",
"isDefault": false,
"entityType": "Plant",
"lobEntityCode": "408974"
},
{
"entityCode": "M017",
"isDefault": false,
"entityType": "Plant",
"lobEntityCode": "408974"
}
]
},
"lstCatalogItem": [
{
"lineNumber": 1,
"buyerItemNumber": "50990001",
"shortDescription": "RESPIRATOR,70070314425",
"description": "RESPIRATOR,70070314425",
"unspsc": "7002179050005424",
"isActive": true,
"itemSpecification": "TYPE:-</br>DIMENSION SIZE:-</br>MATERIAL:-</br>APPLICATION:-</br>MANUFACTURER NAME:3M</br>MANUFACTURER PART NUMBER:70070314425</br>MODEL NUMBER:5103</br>LOW MAINTENANCE RESPIRATOR-5X03 HALF FACEPIECE</br>70-0703-1442-5",
"minimumOrderQuantity": 0.0,
"maximumOrderQuantity": 0.0,
"manufacturer": "",
"manufacturerPartNumber": "",
"manufacturerModelNumber": "",
"gtin": "",
"banding": 0,
"relatedKeywords": "",
"itemType": "Material",
"itemExtendedType": "Material",
"category": "18151700P",
"lstOrgEntities": [
],
"lstCatalogItemPriceDetails": [
{
"effectivePrice": 100.000000,
"percentage": 0.000000,
"serialNumber": 123321,
"objOrgEntity": {
"entityCode": "M017",
"isDefault": false,
"entityType": "Plant",
"lobEntityCode": "30-200"
},
"startDate": "2021-05-24T00:00:00",
"endDate": null,
"lowestUOM": "PC",
"quantity": 10.000000
}
],
"lstCatalogStandardFields": [
{
"contractedQuantity": 0.0,
"utilizedQuantity": 0.000000,
"flexiblePricedItem": false,
"stD_PRNumber": "",
"stD_PRLineNumber": ""
}
],
"lstCatalogItemPartner": [
{
"leadTime": 3,
"isActive": true,
"isTaxExempt": false,
"supplierItemNumber": "50990001 - 33",
"startDate": "2021-05-24T00:00:00",
"endDate": null,
"lstCatalogItemPartnerUOM": [
{
"uom": "PC",
"unitPrice": 120.000000,
"currencyCode": "MYR",
"isDefault": true
}
]
}
],
"lstCustomQuestionResponse": [
{
"question": "How are you today?",
"answer": "NA"
}
]
}
]
},
"statusCode": "200",
"errorDetails": [
],
"successDetails": [
]
}
Success Scenario – Request
?ContractNumber=ABC123
Success Scenario – Response
{
"data": {
"objCatalogDetailsModel": {
"catalogNumber": "CAT-2021-07656",
"contractNumber": "CTR-00005566",
"parentContractNumber": "",
"startDate": "2021-05-24T00:00:00",
"endDate": "2023-05-23T00:00:00",
"lstOrgEntity": [
{
"entityCode": "M010",
"isDefault": false,
"entityType": "Plant",
"lobEntityCode": "408974"
},
{
"entityCode": "M017",
"isDefault": false,
"entityType": "Plant",
"lobEntityCode": "408974"
}
]
},
"lstCatalogItem": [
{
"lineNumber": 1,
"buyerItemNumber": "50990001",
"shortDescription": "RESPIRATOR,70070314425",
"description": "RESPIRATOR,70070314425",
"unspsc": "7002179050005424",
"isActive": true,
"itemSpecification": "TYPE:-</br>DIMENSION SIZE:-</br>MATERIAL:-</br>APPLICATION:-</br>MANUFACTURER NAME:3M</br>MANUFACTURER PART NUMBER:70070314425</br>MODEL NUMBER:5103</br>LOW MAINTENANCE RESPIRATOR-5X03 HALF FACEPIECE</br>70-0703-1442-5",
"minimumOrderQuantity": 0.0,
"maximumOrderQuantity": 0.0,
"manufacturer": "",
"manufacturerPartNumber": "",
"manufacturerModelNumber": "",
"gtin": "",
"banding": 0,
"relatedKeywords": "",
"itemType": "Material",
"itemExtendedType": "Material",
"category": "18151700P",
"lstOrgEntities": [],
"lstCatalogItemPriceDetails": [
{
"effectivePrice": 100.000000,
"percentage": 0.000000,
"serialNumber": 123321,
"objOrgEntity": {
"entityCode": "M017",
"isDefault": false,
"entityType": "Plant",
"lobEntityCode": "30-200"
},
"startDate": "2021-05-24T00:00:00",
"endDate": null,
"lowestUOM": "PC",
"quantity": 10.000000
}
],
"lstCatalogStandardFields": [
{
"contractedQuantity": 0.0,
"utilizedQuantity": 0.000000,
"flexiblePricedItem": false,
"stD_PRNumber": "",
"stD_PRLineNumber": ""
}
],
"lstCatalogItemPartner": [
{
"leadTime": 3,
"isActive": true,
"isTaxExempt": false,
"supplierItemNumber": "50990001 - 33",
"startDate": "2021-05-24T00:00:00",
"endDate": null,
"lstCatalogItemPartnerUOM": [
{
"uom": "PC",
"unitPrice": 120.000000,
"currencyCode": "MYR",
"isDefault": true
}
]
}
],
"lstCustomQuestionResponse": [
{
"question": "How are you today?",
"answer": "NA"
}
]
}
]
},
"statusCode": "200",
"errorDetails": [],
"successDetails": []
}
| PriceBookDetails | ||||
|
Property |
Required? |
Data type |
Description |
Validations / Exceptions |
|
objCatalogDetailsModel |
No |
PriceBookCatalogDetails object |
|
|
|
lstCatalogItem |
No |
List of PriceBookCatalogItem object |
|
|
| PriceBookCatalogDetails | ||||
|
Property |
Required? |
Data type |
Description |
Validations / Exceptions |
|
CatalogNumber |
No |
String |
|
|
|
ContractNumber |
No |
String |
|
|
|
ParentContractNumber |
No |
String |
|
|
|
StartDate |
No |
DateTime |
|
|
|
EndDate |
No |
DateTime |
|
|
|
lstOrgEntity |
No |
List of PriceBookOrgEntity object |
|
|
| PriceBookOrgEntity | ||||
|
Property |
Required? |
Data type |
Description |
Validations / Exceptions |
|
CatalogItemId |
No |
String |
|
|
|
EntityCode |
No |
String |
|
|
|
IsDefault |
No |
boolean |
|
|
|
EntityType |
No |
String |
|
|
|
LOBEntityCode |
No |
String |
|
|
| PriceBookCatalogItem [lstCatalogItem – List of PriceBookCatalogItem] | ||||
|
Property |
Required? |
Data type |
Description |
Validations / Exceptions |
|
CatalogItemId |
No |
String |
|
|
|
LineNumber |
No |
String |
|
|
|
BuyerItemNumber |
No |
String |
|
|
|
ShortDescription |
No |
String |
|
|
|
Description |
No |
String |
|
|
|
UNSPSC |
No |
String |
|
|
|
IsActive |
No |
Boolean |
|
|
|
ItemSpecification |
No |
String |
|
|
|
MinimumOrderQuantity |
No |
Nullable Decimal |
|
|
|
MaximumOrderQuantity |
No |
Nullable Decimal |
|
|
|
Manufacturer |
No |
String |
|
|
|
ManufacturerPartNumber |
No |
String |
|
|
|
ManufacturerModelNumber |
No |
String |
|
|
|
GTIN |
No |
String |
|
|
|
Banding |
No |
Nullable Int |
|
|
|
RelatedKeywords |
No |
String |
|
|
|
ItemType |
No |
String |
|
|
|
ItemExtendedType |
No |
String |
|
|
|
Category |
No |
String |
|
|
|
lstOrgEntities |
No |
List of PriceBookOrgEntity |
|
|
|
lstCatalogItemPriceDetails |
No |
List of CatalogItemPriceDetails |
|
|
|
lstCatalogStandardFields |
No |
List of CatalogStandardFields |
|
|
|
lstCatalogItemPartner |
No |
List of PriceBookCatalogItemPartner |
|
|
|
lstCustomQuestionResponse |
No | List of PriceBookOuestionResponse | ||
| CatalogItemPriceDetails [lstCatalogItemPriceDetails List of CatalogItemPriceDetails] | ||||
|
Property |
Required? |
Data type |
Description |
Validations / Exceptions |
|
CatalogItemId |
No |
Long |
|
|
|
EffectivePrice |
No |
Decimal |
|
|
|
Percentage |
No |
Decimal |
|
|
|
SerialNumber |
No |
Long |
|
|
|
objOrgEntity |
No |
Object of PriceBookOrgEntity |
|
|
|
StartDate |
No |
Nullable DateTime |
|
|
|
EndDate |
No |
Nullable DateTime |
|
|
|
LowestUOM |
No |
String |
|
|
|
Quantity |
No |
Nullable Decimal |
|
|
| CatalogStandardFields | ||||
|
Property |
Required? |
Data type |
Description |
Validations / Exceptions |
|
CatalogItemId |
No |
Long |
|
|
|
ContractedQuantity |
No |
Int |
|
|
|
UtilizedQuantity |
No |
Decimal |
|
|
| PriceBookCatalogItemPartner | ||||
|
Property |
Required? |
Data type |
Description |
Validations / Exceptions |
|
CatalogItemId |
No |
Long |
|
|
|
LeadTime |
No |
Nullable Int |
|
|
|
IsActive |
No |
Boolean |
|
|
|
IsTaxExempt |
No |
Boolean |
|
|
|
SupplierItemNumber |
No |
String |
|
|
|
StartDate |
No |
Nullable DateTime |
|
|
|
EndDate |
No |
Nullable DateTime |
|
|
|
lstCatalogItemPartnerUOM |
No |
List of PriceBookCatalogItemPartnerUOM |
|
|
| PriceBookCatalogItemPartnerUOM [lstCatalogItemPartnerUOM List of PriceBookCatalogItemPartnerUOM] | ||||
|
Property |
Required? |
Data type |
Description |
Validations / Exceptions |
|
CatalogItemId |
No |
String |
|
|
|
UOM |
No |
String |
|
|
|
UnitPrice |
|
|
|
|
|
CurrencyCode |
|
|
|
|
|
IsDefault |
|
|
|
|
| PriceBookOuestionResponse [lstCustomQuestionResponse List of PriceBookOuestionResponse] | ||||
|
Property |
Required? |
Data type |
Description |
Validations / Exceptions |
|
Question |
No |
String |
|
|
|
Answer |
No |
String |
|
|