Company Tree
Base URL: https://api.covasoft.net/entitymanager
Endpoints
| Endpoint | Description |
|---|---|
GET v1/Companies({CompanyId})/Tree?roleDepth={roleDepth} | This Call gets the Company Tree including Locations |
GET v1/Companies({CompanyId})/Locations | This Call gets Location Details from the Company Tree |
GET v1/Companies({CompanyId})/Tree?roleDepth={roleDepth}
This Call gets the Company Tree including Locations
Base URL:
https://api.covasoft.net/entitymanager
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| CompanyId | Company Id from your onboarding package | integer | Required |
| roleDepth | Optional parmater to get Location level | string | Default value is Location |
Body Parameters
None.
Response Information
Resource Description
Returns the Company Tree including Locations
CompanyTreeReturn
| Name | Description | Type | Additional information |
|---|---|---|---|
| Nodes | Collection of CompanyTreeReturn | None. | |
| Id | integer | None. | |
| Name | string | None. | |
| DisplayName | string | None. | |
| Description | string | None. | |
| Role | string | None. | |
| ClientEntityId | integer | None. | |
| Version | integer | None. |
Response Formats
application/json
Sample not available.
text/json
Sample not available.
Models
CompanyTreeReturn
| Name | Description | Type | Additional information |
|---|---|---|---|
| Nodes | Collection of CompanyTreeReturn | None. | |
| Id | integer | None. | |
| Name | string | None. | |
| DisplayName | string | None. | |
| Description | string | None. | |
| Role | string | None. | |
| ClientEntityId | integer | None. | |
| Version | integer | None. |
GET v1/Companies({CompanyId})/Locations
This Call gets Location Details from the Company Tree
Base URL:
https://api.covasoft.net/entitymanager
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| CompanyId | Company Id from your onboarding package | integer | Required |
Body Parameters
None.
Response Information
Resource Description
Location Details from the Company Tree
Collection of CompanyLocationDetailsReturn
| Name | Description | Type | Additional information |
|---|---|---|---|
| LocationStatus | string | None. | |
| LocationType | string | None. | |
| LocationSubType | string | None. | |
| Address | Address | None. | |
| StorePhoneNumbers | Collection of StorePhoneNumber | None. | |
| Area | string | None. | |
| StoreHours | StoreHours | None. | |
| Geography | string | None. | |
| TimeZone | TimeZone | None. | |
| Id | integer | None. | |
| Name | string | None. | |
| DisplayName | string | None. | |
| Description | string | None. | |
| Roles | Collection of Role | None. | |
| Role | string | None. | |
| SortName | string | None. | |
| Relationships | Collection of Relationship | None. | |
| Version | integer | None. | |
| CreatedUtc | date | None. | |
| LastModifiedUtc | date | None. | |
| TypeId | integer | None. |
Response Formats
application/json, text/json
[
{
"LocationStatus": "sample string 1",
"LocationType": "sample string 2",
"LocationSubType": "sample string 3",
"Address": {
"AddressLine1": "sample string 1",
"AddressLine2": "sample string 2",
"City": "sample string 3",
"StateName": "sample string 4",
"CountryName": "sample string 5",
"Zip": 1,
"Id": "353af74d-6bc4-4df4-8b5a-9de63dda7ad1",
"CustomerId": "26f938b0-ae83-47dc-a322-090666a77298",
"AddressTypeId": 8,
"AddressType": "sample string 9",
"Default": true,
"DoNotContact": true,
"CountryCode": "sample string 12",
"Country": "sample string 13",
"Locality": "sample string 14",
"StateCode": "sample string 15",
"State": "sample string 16",
"PostalCode": "sample string 17",
"PostOfficeBoxNumber": "sample string 18",
"StreetAddress1": "sample string 19",
"Notes": "sample string 20",
"StreetAddress2": "sample string 21",
"Version": 22,
"AttentionTo": "sample string 23",
"Phone": "sample string 24",
"Email": "sample string 25"
},
"StorePhoneNumbers": [
{
"Description": "sample string 1",
"Number": "sample string 2",
"Extension": "sample string 3"
},
{
"Description": "sample string 1",
"Number": "sample string 2",
"Extension": "sample string 3"
}
],
"Area": "sample string 4",
"StoreHours": {
"Monday": {
"Open": {
"Hour": 1,
"Minute": 2
},
"Close": {
"Hour": 1,
"Minute": 2
}
},
"Tuesday": {
"Open": {
"Hour": 1,
"Minute": 2
},
"Close": {
"Hour": 1,
"Minute": 2
}
},
"Wednesday": {
"Open": {
"Hour": 1,
"Minute": 2
},
"Close": {
"Hour": 1,
"Minute": 2
}
},
"Thursday": {
"Open": {
"Hour": 1,
"Minute": 2
},
"Close": {
"Hour": 1,
"Minute": 2
}
},
"Friday": {
"Open": {
"Hour": 1,
"Minute": 2
},
"Close": {
"Hour": 1,
"Minute": 2
}
},
"Saturday": {
"Open": {
"Hour": 1,
"Minute": 2
},
"Close": {
"Hour": 1,
"Minute": 2
}
},
"Sunday": {
"Open": {
"Hour": 1,
"Minute": 2
},
"Close": {
"Hour": 1,
"Minute": 2
}
}
},
"Geography": "sample string 5",
"TimeZone": {
"Id": "sample string 1",
"DaylightSavingTimeEnabled": true
},
"Id": 6,
"Name": "sample string 7",
"DisplayName": "sample string 8",
"Description": "sample string 9",
"Roles": [
{
"Name": "sample string 1"
},
{
"Name": "sample string 1"
}
],
"Role": "sample string 10",
"SortName": "sample string 11",
"Relationships": [
{
"Id": 1,
"Definition": 2,
"Source": 3,
"Destination": 4,
"CreatedUtc": "2026-10-02T17:18:05.9499494+00:00",
"Version": 6
},
{
"Id": 1,
"Definition": 2,
"Source": 3,
"Destination": 4,
"CreatedUtc": "2026-10-02T17:18:05.9499494+00:00",
"Version": 6
}
],
"Version": 12,
"CreatedUtc": "2026-10-02T17:18:05.9499494+00:00",
"LastModifiedUtc": "2026-10-02T17:18:05.9499494+00:00",
"TypeId": 15
},
{
"LocationStatus": "sample string 1",
"LocationType": "sample string 2",
"LocationSubType": "sample string 3",
"Address": {
"AddressLine1": "sample string 1",
"AddressLine2": "sample string 2",
"City": "sample string 3",
"StateName": "sample string 4",
"CountryName": "sample string 5",
"Zip": 1,
"Id": "353af74d-6bc4-4df4-8b5a-9de63dda7ad1",
"CustomerId": "26f938b0-ae83-47dc-a322-090666a77298",
"AddressTypeId": 8,
"AddressType": "sample string 9",
"Default": true,
"DoNotContact": true,
"CountryCode": "sample string 12",
"Country": "sample string 13",
"Locality": "sample string 14",
"StateCode": "sample string 15",
"State": "sample string 16",
"PostalCode": "sample string 17",
"PostOfficeBoxNumber": "sample string 18",
"StreetAddress1": "sample string 19",
"Notes": "sample string 20",
"StreetAddress2": "sample string 21",
"Version": 22,
"AttentionTo": "sample string 23",
"Phone": "sample string 24",
"Email": "sample string 25"
},
"StorePhoneNumbers": [
{
"Description": "sample string 1",
"Number": "sample string 2",
"Extension": "sample string 3"
},
{
"Description": "sample string 1",
"Number": "sample string 2",
"Extension": "sample string 3"
}
],
"Area": "sample string 4",
"StoreHours": {
"Monday": {
"Open": {
"Hour": 1,
"Minute": 2
},
"Close": {
"Hour": 1,
"Minute": 2
}
},
"Tuesday": {
"Open": {
"Hour": 1,
"Minute": 2
},
"Close": {
"Hour": 1,
"Minute": 2
}
},
"Wednesday": {
"Open": {
"Hour": 1,
"Minute": 2
},
"Close": {
"Hour": 1,
"Minute": 2
}
},
"Thursday": {
"Open": {
"Hour": 1,
"Minute": 2
},
"Close": {
"Hour": 1,
"Minute": 2
}
},
"Friday": {
"Open": {
"Hour": 1,
"Minute": 2
},
"Close": {
"Hour": 1,
"Minute": 2
}
},
"Saturday": {
"Open": {
"Hour": 1,
"Minute": 2
},
"Close": {
"Hour": 1,
"Minute": 2
}
},
"Sunday": {
"Open": {
"Hour": 1,
"Minute": 2
},
"Close": {
"Hour": 1,
"Minute": 2
}
}
},
"Geography": "sample string 5",
"TimeZone": {
"Id": "sample string 1",
"DaylightSavingTimeEnabled": true
},
"Id": 6,
"Name": "sample string 7",
"DisplayName": "sample string 8",
"Description": "sample string 9",
"Roles": [
{
"Name": "sample string 1"
},
{
"Name": "sample string 1"
}
],
"Role": "sample string 10",
"SortName": "sample string 11",
"Relationships": [
{
"Id": 1,
"Definition": 2,
"Source": 3,
"Destination": 4,
"CreatedUtc": "2026-10-02T17:18:05.9499494+00:00",
"Version": 6
},
{
"Id": 1,
"Definition": 2,
"Source": 3,
"Destination": 4,
"CreatedUtc": "2026-10-02T17:18:05.9499494+00:00",
"Version": 6
}
],
"Version": 12,
"CreatedUtc": "2026-10-02T17:18:05.9499494+00:00",
"LastModifiedUtc": "2026-10-02T17:18:05.9499494+00:00",
"TypeId": 15
}
]
Models
Address
| Name | Description | Type | Additional information |
|---|---|---|---|
| AddressLine1 | string | None. | |
| AddressLine2 | string | None. | |
| City | string | None. | |
| StateName | string | None. | |
| CountryName | string | None. | |
| Zip | integer | None. | |
| Id | globally unique identifier | None. | |
| CustomerId | globally unique identifier | None. | |
| AddressTypeId | 1- None, 2- Home, 3- Shipping, 4- Office, 5- Other | integer | None. |
| AddressType | string | None. | |
| Default | boolean | None. | |
| DoNotContact | boolean | None. | |
| CountryCode | string | None. | |
| Country | string | None. | |
| Locality | string | None. | |
| StateCode | string | None. | |
| State | string | None. | |
| PostalCode | string | None. | |
| PostOfficeBoxNumber | string | None. | |
| StreetAddress1 | string | None. | |
| Notes | string | None. | |
| StreetAddress2 | string | None. | |
| Version | integer | None. | |
| AttentionTo | string | None. | |
| Phone | string | None. | |
| string | None. |
StoreHours
| Name | Description | Type | Additional information |
|---|---|---|---|
| Monday | StoreHoursDay | None. | |
| Tuesday | StoreHoursDay | None. | |
| Wednesday | StoreHoursDay | None. | |
| Thursday | StoreHoursDay | None. | |
| Friday | StoreHoursDay | None. | |
| Saturday | StoreHoursDay | None. | |
| Sunday | StoreHoursDay | None. |
Relationship
| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer | None. | |
| Definition | integer | None. | |
| Source | integer | None. | |
| Destination | integer | None. | |
| CreatedUtc | date | None. | |
| Version | integer | None. |
StoreHoursDay
| Name | Description | Type | Additional information |
|---|---|---|---|
| Open | Open | None. | |
| Close | Close | None. |
Close
| Name | Description | Type | Additional information |
|---|---|---|---|
| Hour | integer | None. | |
| Minute | integer | None. |