Vendor and Bank (Search & Match) APIs
Vendor Search
Get Vendor list information based on search parameters.
We have to provide user to search vendor by id, name, city, postal code & country. We need to provide pagination support fields like start Page, page size. Here, vendor name and city name will search using like and remaining all are exact match. As suggested by business we need to add tax Id, VAT and status flag as exact match.
API
URI : /vendors
Method Type : GET headers: API-Version=1.1
Request
{
"vendorName": "ZENER MARITIME SOLUTIONS",
"cityName": "Banglore",
"postalCode": "560042",
"iso2CountryCode": "IN",
"searchTerm": "ZENER",
"searchTerm2": "MAER"
"taxIdentifier": "",
"vat": "",
"status": "A"
}
Response
[
{
"vendorCode": "1050095",
"vendorName": "ZENER MARITIME SOLUTIONS",
"searchTerm": "ZENER MARITIME",
"customerCode": "IN83427624",
"taxJurnalCode": "0100108700", # Needs to be changed
"partyOrdId": "823447621", # Needs to be changed
"vendorExternalSystemIdentifiers": [
{
"externalSystemName": "SCV",
"externalSystemReference": "41002734061"
}
],
"vendorAddress": {
"cityName": "Banglore",
"postalCode": "560042",
"streetName": "MOUNT KAILASH 3RD FLOOR 33 5",
"apartmentOrFloor": "265",
"subArea": "SDN_US_DOT",
"poBoxNumber": "42245",
"districtName": "KARNATAKA",
"subdivision": "Pyrenees-Orientales",
"addressLine2": "MEANEE AVENUE ROAD ULSOOR",
"addressLine3": "MOUNT KAILASH",
"country": {
"iso2CountryCode": "IN", #RowId
"countryName": "India"
},
"region": {
"regionCode": "2209103",
"regionName": "KARNATAKA"
}
},
"bankDetails": {
"bankBranchCode": "SBIN0004047",
"bankBranchName": "KARNAL",
"country": {
"iso2CountryCode": "IN", #RowId
"countryName": "India"
},
"sanctionCode": "6415",
"swiftCode": "SBININBB"
}
}
]
Vendor Match
Find the list of duplicate vendor list information based on search parameters.
We have to provide user to find duplicate vendor by vendor name, pobox number ,city name, sub area, postal code & country. We need to provide pagination support fields like start Page, page size. Match logic is based on Exact match of country,region,city and fuzzy on vendor name. Need to define the match score for match criteria.
API
URI : /vendors/duplicate
Method Type : POST headers: API-Version=1.1
Request
{
"vendorName": "ZENER MARITIME SOLUTIONS",
"cityName": "Bengaluru",
"postalCode": "560042",
"streetName": "MOUNT KAILASH",
"apartmentOrFloor": "265",
"subArea": "SDN_US_DOT",
"countryName": "India"
}
Response
[
{
"vendorCode": "1050095",
"vendorName": "ZENER MARITIME SOLUTIONS",
"searchTerm": "ZENER MARITIME",
"customerCode": "IN83427624",
"taxJurnalCode": "0100108700", # Needs to be changed
"partyOrdId": "823447621", # Needs to be changed
"vendorExternalSystemIdentifiers": [
{
"externalSystemName": "SCV",
"externalSystemReference": "41002734061"
}
],
"vendorAddress": {
"cityName": "Banglore",
"postalCode": "560042",
"streetName": "MOUNT KAILASH 3RD FLOOR 33 5",
"apartmentOrFloor": "265",
"subArea": "SDN_US_DOT",
"poBoxNumber": "42245",
"districtName": "KARNATAKA",
"subdivision": "Pyrenees-Orientales",
"addressLine2": "MEANEE AVENUE ROAD ULSOOR",
"addressLine3": "MOUNT KAILASH",
"country": {
"iso2CountryCode": "IN", #RowId
"countryName": "India"
},
"region": {
"regionCode": "2209103",
"regionName": "KARNATAKA"
}
},
"bankDetails": {
"bankBranchCode": "SBIN0004047",
"bankBranchName": "KARNAL",
"country": {
"iso2CountryCode": "IN", #RowId
"countryName": "India"
},
"sanctionCode": "6415",
"swiftCode": "SBININBB"
}
}
]
Bank Search
Get Bank details list based on search parameters.
We have to provide user to search bank branch key, branch name, bank country, bank name, postal code & city name. We need to provide pagination support fields like start Page, page size. Here, search on bank name, branch name and city name using like and then exact match on bank key and postal code
API
URI : /bank
Method Type : GET headers: API-Version=1.1
Request
{
"bankBranchCode": "SBIN0004047",
"bankBranchName": "KARNAL",
"cityName": "Banglore",
"postalCode": "560042",
"bankName": "SBI",
"iso2CountryCode": "IN"
}
Response
While searching the bank , currently we will get Bank details only.
[
{
"vendorCode": "1050095",
"vendorName": "ZENER MARITIME SOLUTIONS",
"searchTerm": "ZENER MARITIME",
"customerCode": "IN83427624",
"taxJurnalCode": "0100108700", # Needs to be changed
"partyOrdId": "823447621", # Needs to be changed
"vendorExternalSystemIdentifiers": [
{
"externalSystemName": "SCV",
"externalSystemReference": "41002734061"
}
],
"vendorAddress": {
"cityName": "Banglore",
"postalCode": "560042",
"streetName": "MOUNT KAILASH 3RD FLOOR 33 5",
"apartmentOrFloor": "265",
"subArea": "SDN_US_DOT",
"poBoxNumber": "42245",
"districtName": "KARNATAKA",
"subdivision": "Pyrenees-Orientales",
"addressLine2": "MEANEE AVENUE ROAD ULSOOR",
"addressLine3": "MOUNT KAILASH",
"country": {
"iso2CountryCode": "IN", #RowId
"countryName": "India"
},
"region": {
"regionCode": "2209103",
"regionName": "KARNATAKA"
}
},
"bankDetails": {
"bankBranchCode": "SBIN0004047",
"bankBranchName": "KARNAL",
"country": {
"iso2CountryCode": "IN", #RowId
"countryName": "India"
},
"sanctionCode": "6415",
"swiftCode": "SBININBB"
}
}
]