Vendor and Bank Retrieve APIs

Vendor retrieve allows users to get the complete details of a vendor and Bank retrieve allows users to get the complete details of a bank.

1. Vendor retrieve service
2. Bank retrieve service

API Endpoints

Vendor Retrieve endpoint :

Get Vendor details based on the vendor code. The current vendor will fetch based on vendor code and name.

API

URI : /vendors/{vendor-id}

Method Type : GET headers: API-Version=1.1

Request

Vendor Id is provided in URI itself.

Response

{
	"vendorNumber": "4252106",
	"organizationName": "GEETHA TECHNOLOGY SOLUTIONS PRIVATE LIMITED",
	"vendorAccountGroup": "ZEXV",
	"searchTerm1": "GEETHA TECHNOLOGY",
	"searchTerm2": "GEETHA TEC",
	"duplicateWarning": false,
	"vendorStatus": {
		"statusCode": "A",
		"statusName": "Active"
	},
	"communicationDetails": {
		"teleCommunicationDetails": [
			{
				"communicationNumberType": "TEL",
				"preferred": true,
				"country": {
					"isoCountryCode": "IN",
					"countryName": "India"
				},
				"internationalDialingCode": "91",
				"number": "788628080",
				"notes": null
			},
			{
				"communicationNumberType": "MOB",
				"preferred": false,
				"country": {
					"isoCountryCode": "IN",
					"countryName": "India"
				},
				"internationalDialingCode": "91",
				"number": "9710613344",
				"notes": null
			}
		],
		"electronicCommunicationDetails": [
			{
				"communicationNumberType": "EMAIL",
				"preferred": true,
				"electronicAddress": "bhuvana.j@cliqhr.com",
				"notes": null
			}
		]
	},
	"vendorAddress": {
		"streetName": "F/48, TNHB Flats, No.180",
        "apartmentOrFloor": "7TH PLAZA",
        "postalCode": "517408",
        "poBoxNumber": "PO 123",
        "addressLine2": "LUZ Church Road Mylapore",
        "addressLine3": null,
        "subArea": "CHITTOOR",
        "cityName": "PALAMANER",
        "country": {
			"countryCode": "IN",
			"countryName": "India"
		},
        "districtName": "Chittoor district",
        "region": {
          "regionCode": "AP",
          "regionName": "ANDHRAPRADESH"
        }
	},
	"vendorExtendedInformation": {
        "invoiceISOLanguageCodePreference": "EN",
        "prefCommunication": "3"
    },
	"vendorAuditData": {
		"creationDate": "2023-12-27T15:00:44.053+00:00",
		"creationUser": "babita.shah@maersk.com",
		"lastUpdateDate": "2023-12-28T06:57:58.025+00:00",
		"lastUpdateUser": "aehra.a@maersk.com",
		"sourceSystem": "PRTL"
	}
}

Bank Retrieve endpoint :

Get Bank details based on the bank key.

API

URI : /bank/{bank-key}

Method Type : GET headers: API-Version=1.1

Request

Bank key is provided in URI itself.

Response

{
	"bankKey": "HDFC0000158",
	"bankName": "HDFC BANK LTD",
	"bankBranchName": "PALAMANER",
	"searchTerm1": "PLMR",
	"searchTerm2": null,
	"duplicateWarning": null,
	"bankStatus": {
		"statusCode": "A",
		"statusName": "Active"
	},
	"communicationDetails": {
		"teleCommunicationDetails": [
			{
				"communicationNumberType": "TEL",
				"preferred": true,
				"country": {
					"isoCountryCode": "IN",
					"countryName": "India"
				},
				"internationalDialingCode": "91",
				"number": "788628080",
				"notes": null
			},
			{
				"communicationNumberType": "MOB",
				"preferred": false,
				"country": {
					"isoCountryCode": "IN",
					"countryName": "India"
				},
				"internationalDialingCode": "91",
				"number": "9710613344",
				"notes": null
			}
		],
		"electronicCommunicationDetails": [
			{
				"communicationNumberType": "EMAIL",
				"preferred": true,
				"electronicAddress": "bhuvana.j@cliqhr.com",
				"notes": null
			}
		]
	},
	"bankAddress": {
		"streetName": "F/48, TNHB Flats, No.180",
		"apartmentOrFloor": "7TH PLAZA",
		"postalCode": "517408",
		"poBoxNumber": "PO 123",
		"addressLine2": "LUZ Church Road Mylapore",
		"addressLine3": null,
		"subArea": "CHITTOOR",
		"cityName": "PALAMANER",
		"country": {
			"countryCode": "IN",
			"countryName": "India"
		},
		"districtName": "Chittoor district",
		"region": {
			"regionCode": "AP",
			"regionName": "ANDHRAPRADESH"
		}
	},
	"bankExtendedInformation": {
		"invoiceISOLanguageCodePreference": "EN"
	},
	"bankAuditData": {
		"creationDate": "2023-12-27T15:00:44.053+00:00",
		"creationUser": "babita.shah@maersk.com",
		"lastUpdateDate": "2023-12-28T06:57:58.025+00:00",
		"lastUpdateUser": "aehra.a@maersk.com",
		"sourceSystem": "PRTL"
	},
	"swiftCode": "HDFCINBB"
}