Fetch the corporate enrichment data
get
/service/v1/corporateinformation/enrichment
This API fetches corporate enrichment data based on given parameters
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
-
adHoc: string
delivery type for adhoc
-
corporateCode: string
filter by corporate code/id
-
dayOfWeek: string
day of week for pickup or delivery
-
filterType: string
filter type for pickup, delivery or both
-
frequency: string
frequency for pickup or delivery
-
levelOfEnrichment: string
Level of Enrichment
-
pkpDlvryFor: string
pickup or delivery for cheque, cash or both
-
pkpDlvryHldy: string
pickup or delivery on holiday (Y or N)
-
pkpDlvryLocation: string
location for pickup or delivery
-
pkpDlvryPoint: string
pickup or delivery point code to filter
-
productCategory: string
Product Category
-
productCode: string
Product Code
-
timeSlot: string
time slot for pickup or delivery
Header Parameters
-
appId(required): string
appId
-
branchCode(required): string
branchCode
-
userId(required): string
userId
Response
Supported Media Types
- application/json
- application/xml
200 Response
Returns message of succes or failure. If success, returns the enrichment data of the corporate.
Root Schema : ObcmTmCorpEnrchStupMstrWrapperDTO
Type:
object
Collection of Corporate Enrichment Setup master Data.
Show Source
-
corporateEnrichmentData:
object ObcmTmCorpEnrchStupMstrDTO
-
errors:
array errors
Error List Corporate Enrichment Setup master Data
-
responseCode:
string
ResponseCode used for Corporate Enrichment Setup master Data
Nested Schema : GenericDto-allOf[0]
Type:
object
Nested Schema : ObcmTmCorpEnrchStupMstrDTO-allOf[1]
Type:
Show Source
object
-
corporateCode:
string
Corporate code used for corporate enrichmentData
-
corporateName:
string
Corporate name used for corporate enrichmentData
-
counterPartyInfoManTxn:
string
Counter party information used for corporate enrichmentData
-
courierSrvcType:
string
Courier service type used for corporate enrichmentData
-
drawerInfoManTxn:
string
Dwawer information used for corporate enrichmentData
-
ObcmTmCorpEnrchDlvryDetailsDTO:
array ObcmTmCorpEnrchDlvryDetailsDTO
List of Corporate Enrichment delivery details
-
ObcmTmCorpEnrchInfoProdMasterDTO:
array ObcmTmCorpEnrchInfoProdMasterDTO
List of Corporate Enrichment Information Product Master
-
ObcmTmCorpEnrchPckupDetailsDTO:
array ObcmTmCorpEnrchPckupDetailsDTO
List of Corporate Enrichment pickup details
-
ObcmTmCorpEnrchPoolStupDetailsDTO:
array ObcmTmCorpEnrchPoolStupDetailsDTO
List of Corporate Enrichment pool setup details
-
ObcmTmCorpEnrchProdEnrchDetailsDTO:
array ObcmTmCorpEnrchProdEnrchDetailsDTO
List of Corporate Enrichment product details
Nested Schema : ObcmTmCorpEnrchDlvryDetailsDTO
Type:
array
List of Corporate Enrichment delivery details
Show Source
-
Array of:
object ObcmTmCorpEnrchDlvryDetailsDTO
Corporate Enrichment Delivery Details Data
Nested Schema : ObcmTmCorpEnrchInfoProdMasterDTO
Type:
array
List of Corporate Enrichment Information Product Master
Show Source
-
Array of:
object ObcmTmCorpEnrchInfoProdMasterDTO
Corporate Enrichment Information Product Master Data
Nested Schema : ObcmTmCorpEnrchPckupDetailsDTO
Type:
array
List of Corporate Enrichment pickup details
Show Source
-
Array of:
object ObcmTmCorpEnrchPckupDetailsDTO
Corporate Enrichment PickUp details Data
Nested Schema : ObcmTmCorpEnrchPoolStupDetailsDTO
Type:
array
List of Corporate Enrichment pool setup details
Show Source
-
Array of:
object ObcmTmCorpEnrchPoolStupDetailsDTO
Corporate Enrichment Pool Setup Details Data
Nested Schema : ObcmTmCorpEnrchProdEnrchDetailsDTO
Type:
array
List of Corporate Enrichment product details
Show Source
-
Array of:
object ObcmTmCorpEnrchProdEnrchDetailsDTO
Corporate Enrichment Information Product Details
Nested Schema : ObcmTmCorpEnrchDlvryDetailsDTO
Type:
object
Corporate Enrichment Delivery Details Data
Show Source
-
addln1:
string
Address Line 1 used for corporate enrichment delivery details data
-
addln2:
string
Address Line 2 used for corporate enrichment delivery details data
-
addln3:
string
Address Line 3 used for corporate enrichment delivery details data
-
addln4:
string
Address Line 4 used for corporate enrichment delivery details data
-
agrmntDate:
string
Arragment used for corporate enrichment delivery details data
-
cntctPerson:
string
Contact Person used for corporate enrichment delivery details data
-
cntryCode:
string
Country Code used for corporate enrichment delivery details data
-
cntryName:
string
Country name used for corporate enrichment delivery details data
-
courierCode:
string
CourierCode used for corporate enrichment delivery details data
-
courierCodeDesc:
string
CourierCodeDesc used for corporate enrichment delivery details data
-
dayOfWeek:
string
DayOfWeek used for corporate enrichment delivery details data
-
dlvryCode:
string
Delivery Code used for corporate enrichment delivery details data
-
dlvryDesc:
string
Delivery Desc used for corporate enrichment delivery details data
-
dlvryOnHldys:
string
DeliveryOnHldys used for corporate enrichment delivery details data
-
dlvrySlot:
string
Delivery Slot used for corporate enrichment delivery details data
-
dlvryType:
string
Delivery Type used for corporate enrichment delivery details data
-
fax:
number
Faxx number used for corporate enrichment delivery details data
-
freq:
string
Frequency used for corporate enrichment delivery details data
-
locationCode:
string
LocationCode used for corporate enrichment delivery details data
-
locationDesc:
string
LocationDesc used for corporate enrichment delivery details data
-
postalCode:
number
PostalCode used for corporate enrichment delivery details data
-
prEmailId:
string
Pre EmailId used for corporate enrichment delivery details data
-
prPhoneNo:
number
Pre PhoneNo used for corporate enrichment delivery details data
-
scEmailId:
string
Source EmailId used for corporate enrichment delivery details data
-
scPhoneNo:
number
Source PhoneNo used for corporate enrichment delivery details data
Nested Schema : ObcmTmCorpEnrchInfoProdMasterDTO
Type:
object
Corporate Enrichment Information Product Master Data
Show Source
-
productCategory:
string
Product category used for corporate enrichment information Product Details
-
productCode:
string
Product code used for corporate enrichment information product master data
-
productDesc:
string
Product description used for corporate enrichment information product master data
-
status:
string
Status used for SUCCESS/FAILURE response
Nested Schema : ObcmTmCorpEnrchPckupDetailsDTO
Type:
object
Corporate Enrichment PickUp details Data
Show Source
-
addln1:
string
Address line 1 used corporate enrichment pickUp details response
-
addln2:
string
Address line 2 used corporate enrichment pickUp details response
-
addln3:
string
Address line 3 used corporate enrichment pickUp details response
-
addln4:
string
Address line 4 used corporate enrichment pickUp details response
-
agrmntDate:
string
Arragment date used corporate enrichment pickUp details response
-
chqRtnAddln1:
string
Cheque return Address line 1 used corporate enrichment pickUp details
-
chqRtnAddln2:
string
Cheque return Address line 2 used corporate enrichment pickUp details
-
chqRtnAddln3:
string
Cheque return Address line 3 used corporate enrichment pickUp details
-
chqRtnAddln4:
string
Cheque return Address line 4 used corporate enrichment pickUp details
-
cntctPerson:
string
Contact person used corporate enrichment pickUp details
-
cntryCode:
string
Country code used corporate enrichment pickUp details response
-
cntryName:
string
Country name used corporate enrichment pickUp details response
-
courierCode:
string
Courier Code used corporate enrichment pickUp details response
-
courierCodeDesc:
string
CourierCode Description used corporate enrichment pickUp details response
-
dayOfWeek:
string
DayOfWeek used corporate enrichment pickUp details response
-
fax:
number
Fax number used corporate enrichment pickUp details response
-
freq:
string
Frequency used corporate enrichment pickUp details response
-
locationCode:
string
LocationCode used corporate enrichment pickUp details response
-
locationDesc:
string
LocationDesc used corporate enrichment pickUp details response
-
pickupCode:
string
PickupCode used corporate enrichment pickUp details response
-
pickupFor:
string
PickupFor used corporate enrichment pickUp details response
-
pickupOnHldys:
string
PickupOnHldys used corporate enrichment pickUp details response
-
pickupPt:
string
Pickup point used corporate enrichment pickUp details response
-
pickupSlot:
string
PickupSlot used corporate enrichment pickUp details
-
pickupType:
string
PickupType used corporate enrichment pickUp details
-
postalCode:
number
PostalCode used corporate enrichment pickUp details
-
prEmailId:
string
Pre EmailId used corporate enrichment pickUp details
-
prPhoneNo:
number
Pre PhoneNo used corporate enrichment pickUp details
-
retrnDispatch:
string
Return Dispatch used corporate enrichment pickUp details
-
scEmailId:
string
Source EmailId used corporate enrichment pickUp details
-
scPhoneNo:
number
Source PhoneNo used corporate enrichment pickUp details
Nested Schema : ObcmTmCorpEnrchPoolStupDetailsDTO
Type:
object
Corporate Enrichment Pool Setup Details Data
Show Source
-
cdtConsolidationLvl:
string
Credit Consolidation Level 1 used for corporate enrichment pool setup details
-
divCode:
string
Division Code used for corporate enrichment pool setup details
-
divDesc:
string
Division description used for corporate enrichment pool setup details
-
locCode:
string
Location code used for corporate enrichment pool setup details
-
locDesc:
string
Location description used for corporate enrichment pool setup details
-
percentage:
number
Percentage used for corporate enrichment pool setup details
-
percentagePooling:
string
Percentage pooling used for corporate enrichment pool setup details
-
pooAccDesc:
string
Pooling account description used for corporate enrichment pool setup details
-
pooAccNo:
string
Pooling account number used for corporate enrichment pool setup details
-
poolingLvl:
string
Pooling level used for corporate enrichment pool setup details
-
prodCategory:
string
Product Category used for corporate enrichment pool setup details
Nested Schema : ObcmTmCorpEnrchProdEnrchDetailsDTO
Type:
object
Corporate Enrichment Information Product Details
Show Source
-
dataType:
string
Data Type used for corporate enrichment information Product Details
-
enrchLabel:
string
Enrich Label used for corporate enrichment information Product Details
-
fieldLength:
string
Field length used for corporate enrichment information Product Details
-
lvlOfEnrch:
string
Level of enrichment used for corporate enrichment information Product Details
-
minValue:
integer
Minimum Of value used for used for corporate enrichment information Product Details
-
orderingNo:
integer
Product's ordering number
-
productCategory:
string
Product category used for corporate enrichment information Product Details
-
productCode:
string
Product code used for corporate enrichment information Product Details
-
productDesc:
string
Product description used for corporate enrichment information Product Details
-
validations:
string
Validations used for corporate enrichment information Product Details
Nested Schema : ErrorDto
Type:
Show Source
object
-
errorCode:
string
Error Code
-
errorDesc:
string
Error Desc
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
405 Response
Invalid input
500 Response
Internal error