PartyDetails CompanyManagement

Name	Description	Introduced In
getInfo	This API retrieves company and related company details from ODMS.	2021.07
updateInfo	This API creates or updates company and related company details in ODMS.	2021.07
getAddress	This API retrieves company and related company address from ODMS.	2021.07
UpdateInfoAddress	This API creates or updates company and related company address in ODMS.	2021.07

getInfo

Description:

This API retrieves company and related company details from ODMS.

Method:

POST

URL:

{BASE URL}/services/data/v1/PartyDetailsCompanyManagement/operations/Company/getInfo

Security Level:

Authenticated App User

Header Request:

X-Kony-Authorization
X-Kony-ReportingParams

Body Request:

Parameters

ApplicantType

Specifies the type of application.

{
	"ApplicantType": "Applicant"
}

Response:


{
"CompanyInfo":
	{
		"CompanyName":"ABC",
		"CompanyType":"Pvt Ltd",
		"IndustryType":"Health",
		"SubIndustryType":"DCE",
		"CountryIncoporation":"Finland",
		"Years":"20",
		"EmployeeCount":"500",
		"RegistrationNumber":"1234567",
		"RegistrationDate":"1990-01-01",
		"RegistrationNumber":"1234",
		"RegistrationDate":"10/10/1990",
		"AnnualRevenue":"15000",
		"paidCapital":"11000",
		"BankAccount": [{
		"Bankname":"ABC bank",
		"BankBranch":"Bank Branch"
		}],
	},
"httpStatusCode":200,
"opstatus":0
}

Error Code(s):

Error Code: 73200
Error Message: Object update failed

Service Flow:

Integration Services

Backend Services

OnBoardingJavaServices - getCompanyInfo

createEntityItem

Storage Name: ODMS

updateEntityItem

Storage Name: ODMS

updateInfo

Description:

This API creates or updates company and related company details in ODMS.

Method:

POST

URL:

{BASE URL}/services/data/v1/PartyDetailsCompanyManagement/operations/Company/updateInfo

Security Level:

Authenticated App User

Header Request:

X-Kony-Authorization
X-Kony-ReportingParams

Body Request:

Parameters

CompanyName

Specifies the company name.

CompanyType

Specifies the type of the company.

BranchReference

Specifies the reference number for the branch.

ApplicantType

Specifies the type of application.

SectionProgress

Specifies the progress made by the user to the current section (InProgress/Done).

AcceptanceStatus

Specifies the status of acceptance.

RegistrationDate

Specifies the date of Registration.

CountryIncorporation

Specifies the Incorporation Country name.

BusinessYears

Specifies the years of bussiness.

EmployeeCount

Specifies the total employees in the company.

IndustryType

Specifies the type of industry.

SubIndustryType

Specifies the sub industry type.

RegistrationNumber

Specifies the company registration number.

AnnualRevenue

Specifies the annual revenue in millions.

paidCapital

Specifies the capital amount in millions.

TaxIdNumber

Specifies the Taxation number.

Classification

Specifies the type of classification.

{
	"CompanyName": "ABC",
	"CompanyType": "ABCD",
	"BranchReference": "GB0010001",
	"ApplicantType": "Company",
	"SectionProgress": "Done",
	"ConsentIdentifier": "Create_PersonalInfo_Consent",
	"AcceptanceStatus": "Yes",
	"RegistrationDate": "",
	"CountryIncorporation": "India",
	"BusinessYears": "20",
	"EmployeeCount": "200",
	"IndustryType": "ACD",
	"SubIndustryType": "COrp",
	"RegistrationNumber": "123456",
	"AnnualRevenue": "100",
	"paidCapital": "10",
	"TaxIdNumber": "",
	"Classification": "Company"
}

Response:


{
	"opstatus": 0,
	"ID": "ABXDAF",
	"httpStatusCode": 200		
}

Error Code(s):

Error Code: 75602
Error Message: Create prospect profile failed.

Service Flow:

Integration Services

Backend Services

OnBoardingJavaServices - createCompanyInfo

createEntityItem

Storage Name: ODMS

updateEntityItem

Storage Name: ODMS

getAddress

Description:

This API retrieves company and related company address from ODMS.

Method:

POST

URL:

/services/data/v1/PartyDetailsCompanyManagement/operations/Company/getAddress

Security Level:

Authenticated App User

Header Request:

X-Kony-Authorization
X-Kony-ReportingParams

Body Request:

Parameters

ApplicantType

Specifies the type of application.

{
	"ApplicantType": "Applicant"
}

Response:


{
	"Address": [
		{
			"SameAsCompanyAddress": "false",
			"IsRelatedCompany": "false",
			"index": "RCA1",
			"City": "Los Angeles",
			"ContactPerson": "",
			"AddressLine2": "",
			"AddressLine1": "21 Menlo Avenue",
			"State": "US-CA",
			"Zipcode": "90007",
			"Country": "US",
			"ContactEmail": "",
			"ContactNumber": "",
			"ID": "60c74b65ce4978385f4894a1",
			"ContactCode": ""
		},
		{
			"SameAsCompanyAddress": "false",
			"IsRelatedCompany": "false",
			"index": "CA1",
			"City": "Los Angeles",
			"ContactPerson": "",
			"AddressLine2": "",
			"AddressLine1": "21 Menlo Avenue",
			"State": "US-CA",
			"Zipcode": "90007",
			"Country": "US",
			"ContactEmail": "",
			"ContactNumber": "",
			"ID": "60c74b5cce4978385f48949f",
			"ContactCode": ""
		}
	],
	"opstatus": 0,
	"httpStatusCode": 0
}

Error Code(s):

Error Code:
Error Message:

Service Flow:

Integration Services	Backend Services
OnBoardingJavaServices - GetCompanyAddress	createEntityItem
OnBoardingJavaServices - GetCompanyAddress	updateEntityItem

UpdateInfoAddress

Description:

This API creates or updates company and related company address in ODMS.

Method:

POST

URL:

{BASE URL}/services/data/v1/PartyDetailsCompanyManagement/operations/Company/UpdateInfoAddress

Security Level:

Authenticated App User

Header Request:

X-Kony-Authorization
X-Kony-ReportingParams

Body Request:

Parameters

index

Specifies the unique ID of the product.

AddressLine2

Specifies the Address of the company.

AddressLine1

Specifies the Address of the company.

Zipcode

Specifies Zipcode of the location.

Country

Specifies the country of the company.

City

Specifies city name.

ContactPerson

Specifies contact person name.

ContactEmail

Specifies contact person email.

ContactNumber

Specifies country code of person.

ContactCode

Specifies person mobile number.

ApplicantType

Specifies type of application.

{
	"CompanyInfoAddress":[
		{
		"index":"CA1",
		"AddressLine2":"",
		"AddressLine1":"temenos",
		"State":"IN-TN",
		"Zipcode":"600001",
		"Country":"IN",
		"City":"chennai",
		"ContactPerson":"andfj",
		"ContactEmail":"jndnjf@dnf.com",
		"ContactNumber":"+91",
		"ContactCode":"7418529635",
		"SameAsCompanyAddress":"false",
		"IsRelatedCompany":"false",
		"ApplicantType":"Company",
		"SectionProgress":"Done",
		"ConsentIdentifier":"Create_AddressInfo_Consent",
		"AcceptanceStatus":"Yes"
		},
		{
		"index":"CA2",
		"AddressType":"Correspondence",
		"AddressLine2":"",
		"AddressLine1":"adbfhjbad",
		"State":"IN-TN",
		"Zipcode":"600001",
		"Country":"IN",
		"City":"chennai",
		"ContactPerson":"jnsdfjjk",
		"ContactEmail":"akjjdb@dfjbjd.com",
		"ContactNumber":"+91",
		"ContactCode":"7418529635",
		"SameAsCompanyAddress":"false",
		"IsRelatedCompany":"false",
		"ApplicantType":"Company",
		"SectionProgress":"Done",
		"ConsentIdentifier":"Create_AddressInfo_Consent",
		"AcceptanceStatus":"Yes"
		}
	]
}

Response:


{
	"opstatus": 0,
	"ID": "ABXDAF",
	"httpStatusCode": 200		
}

Error Code(s):

Error Code: 73200
Error Message: Object update failed

Service Flow:

Integration Services

Backend Services

OnBoardingJavaServices - UpdateCompanyAddress

createEntityItem

Storage Name: ODMS

updateEntityItem

Storage Name: ODMS

Field Name

Application/Table name

Dark Mode

Expand/ Collapse

In this topic

Products

Ecosystem

Technology

Other Product documentation

PartyDetails CompanyManagement