';

Business Hierarchy

You are here:
Estimated Reading Time: 2 Minutes

Business Hierarchy

This API will allow user to get details of all the companies created for him on IRIS Topaz. Along with company details user will get access control information also.

Request Parameters

The input parameters will be supported in the API request are as below:

  • X-Auth-Token: A authentication token that needs to passed in all subsequent requests
  • Root Company ID: The unique identifier (corresponds to the root Business) of a company in IRIS TOPAZ system that authorizes the user’s subsequent requests.
  • Content-Type: “application/json” needs to be passed
Response Parameters

The API will respond with an enveloped response with a collection of results object. The response information is as below:

  • Status: Success/Failure
  • Company Details – CompanyId, Parent Company Id, Company Type (BUSINESS/LEGAL/FILING/POB), child company details and role (0 or 1)
URL https://esp.api.irisgst.com/company/businesshierarchy?companyId={{companyId}}
Method GET
Headers

Content-Type:application/json

X-Auth-Token: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJwcmthbWJsZUBtYWlsaW5hdG9yLmNvbSIsImF1ZGlmNlIjoid2ViIiwiY3JlYXRlZCI6MTUyMDI2NjU2MzYzOSwiZXhwIjoxNTIwODcxMzYCJW5hbnQiOiJkZXYifQ.-NdGYNyUV7jpBdTvDbv3cuUMPFnl1sl4prLFIKsXVohe4Xmdg4ng3eC6wndLhFNlIgC8jkjuBO7KtJKfd3g

companyId:10

Body

Response

(SUCCESS)

{

“status”: “SUCCESS”,

“errorList”: null,

“message”: null,

“fieldErrors”: null,

“errors”: null,

“response”: {

“pincode”: null,

“website”: null,

“address”: null,

“role”: “1”,

“immediateParent”: null,

“city”: null,

“entityType”: “BUSINESS”,

“address1”: null,

“companyName”: “Root Business”,

“gstin”: null,

“userName”: null,

“parentCompanyId”: “0”,

“companyId”: 10,

“password”: null,

“taxpayerType”: null,

“phone”: null,

“roleName”: “Admin”,

 

“rootCompanyId”: “10”,

“state”: null,

“childCompanies”: [

{

“pincode”: null,

“website”: null,

“address”: null,

“role”: “1”,

“immediateParent”: null,

“city”: null,

“entityType”: “FILING”,

“address1”: null,

“companyName”: “ABC Filing Child”,

“gstin”: null,

“userName”: null,

“parentCompanyId”: “10”,

“companyId”: 11,

“password”: null,

“taxpayerType”: null,

“phone”: null,

“roleName”: “Admin”,

 

“rootCompanyId”: “10”,

“state”: null,

“childCompanies”: [

{

“pincode”: null,

“website”: null,

“address”: null,

“role”: “1”,

“immediateParent”: null,

“city”: null,

“entityType”: “POB”,

“address1”: null,

“companyName”: “ABC_400005”,

“gstin”: null,

“userName”: null,

“parentCompanyId”: “11”,

“companyId”: 12,

“password”: null,

“taxpayerType”: null,

“phone”: null,

“roleName”: “Admin”,

 

“rootCompanyId”: “10”,

“state”: null,

“childCompanies”: [],

“pan”: null,

“fax”: null,

“email”: null

},

{

“pincode”: null,

“website”: null,

“address”: null,

“role”: “1”,

“immediateParent”: null,

“city”: null,

“entityType”: “POB”,

“address1”: null,

“companyName”: “ABC_231222”,

“gstin”: null,

“userName”: null,

“parentCompanyId”: “11”,

“companyId”: 13,

“password”: null,

“taxpayerType”: null,

“phone”: null,

“roleName”: “Admin”,

 

“rootCompanyId”: “10”,

“state”: null,

“childCompanies”: [],

“pan”: null,

“fax”: null,

“email”: null

}

],

“pan”: null,

“fax”: null,

“email”: null

},

{

“pincode”: null,

“website”: null,

“address”: null,

“role”: “1”,

“immediateParent”: null,

“city”: null,

“entityType”: “FILING”,

“address1”: null,

“companyName”: “ABC Filing Child 2”,

“gstin”: null,

“userName”: null,

“parentCompanyId”: “10”,

“companyId”: 15,

“password”: null,

“taxpayerType”: null,

“phone”: null,

“roleName”: “Admin”,

 

“rootCompanyId”: “2393”,

“state”: null,

“childCompanies”: [

{

“pincode”: null,

“website”: null,

“address”: null,

“role”: “1”,

“immediateParent”: null,

“city”: null,

“entityType”: “POB”,

“address1”: null,

“companyName”: “ABCD_231222”,

“gstin”: null,

“userName”: null,

“parentCompanyId”: “15”,

“companyId”: 16,

“password”: null,

“taxpayerType”: null,

“phone”: null,

“roleName”: “Admin”,

 

“rootCompanyId”: “10”,

“state”: null,

“childCompanies”: [],

“pan”: null,

“fax”: null,

“email”: null

}

],

“pan”: null,

“fax”: null,

“email”: null

}

],

“pan”: null,

“fax”: null,

“email”: null

}

}

Response

(FAILURE)

{

“status”: “FAILURE”,

“errorList”: null,

“message”: “Unauthorized user”,

“fieldErrors”: null,

“errors”: null,

“response”: null

}