Skip to main content

Company Tree

Base URL: https://api.covasoft.net/entitymanager

Endpoints​

EndpointDescription
GET v1/Companies({CompanyId})/Tree?roleDepth={roleDepth}This Call gets the Company Tree including Locations
GET v1/Companies({CompanyId})/LocationsThis 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​

NameDescriptionTypeAdditional information
CompanyIdCompany Id from your onboarding packageintegerRequired
roleDepthOptional parmater to get Location levelstringDefault value is Location

Body Parameters​

None.

Response Information​

Resource Description​

Returns the Company Tree including Locations

CompanyTreeReturn

NameDescriptionTypeAdditional information
NodesCollection of CompanyTreeReturnNone.
IdintegerNone.
NamestringNone.
DisplayNamestringNone.
DescriptionstringNone.
RolestringNone.
ClientEntityIdintegerNone.
VersionintegerNone.

Response Formats​

application/json

Sample not available.

text/json

Sample not available.

Models​

CompanyTreeReturn
NameDescriptionTypeAdditional information
NodesCollection of CompanyTreeReturnNone.
IdintegerNone.
NamestringNone.
DisplayNamestringNone.
DescriptionstringNone.
RolestringNone.
ClientEntityIdintegerNone.
VersionintegerNone.

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​

NameDescriptionTypeAdditional information
CompanyIdCompany Id from your onboarding packageintegerRequired

Body Parameters​

None.

Response Information​

Resource Description​

Location Details from the Company Tree

Collection of CompanyLocationDetailsReturn

NameDescriptionTypeAdditional information
LocationStatusstringNone.
LocationTypestringNone.
LocationSubTypestringNone.
AddressAddressNone.
StorePhoneNumbersCollection of StorePhoneNumberNone.
AreastringNone.
StoreHoursStoreHoursNone.
GeographystringNone.
TimeZoneTimeZoneNone.
IdintegerNone.
NamestringNone.
DisplayNamestringNone.
DescriptionstringNone.
RolesCollection of RoleNone.
RolestringNone.
SortNamestringNone.
RelationshipsCollection of RelationshipNone.
VersionintegerNone.
CreatedUtcdateNone.
LastModifiedUtcdateNone.
TypeIdintegerNone.

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
NameDescriptionTypeAdditional information
AddressLine1stringNone.
AddressLine2stringNone.
CitystringNone.
StateNamestringNone.
CountryNamestringNone.
ZipintegerNone.
Idglobally unique identifierNone.
CustomerIdglobally unique identifierNone.
AddressTypeId1- None, 2- Home, 3- Shipping, 4- Office, 5- OtherintegerNone.
AddressTypestringNone.
DefaultbooleanNone.
DoNotContactbooleanNone.
CountryCodestringNone.
CountrystringNone.
LocalitystringNone.
StateCodestringNone.
StatestringNone.
PostalCodestringNone.
PostOfficeBoxNumberstringNone.
StreetAddress1stringNone.
NotesstringNone.
StreetAddress2stringNone.
VersionintegerNone.
AttentionTostringNone.
PhonestringNone.
EmailstringNone.
StoreHours
NameDescriptionTypeAdditional information
MondayStoreHoursDayNone.
TuesdayStoreHoursDayNone.
WednesdayStoreHoursDayNone.
ThursdayStoreHoursDayNone.
FridayStoreHoursDayNone.
SaturdayStoreHoursDayNone.
SundayStoreHoursDayNone.
Relationship
NameDescriptionTypeAdditional information
IdintegerNone.
DefinitionintegerNone.
SourceintegerNone.
DestinationintegerNone.
CreatedUtcdateNone.
VersionintegerNone.
StoreHoursDay
NameDescriptionTypeAdditional information
OpenOpenNone.
CloseCloseNone.
Close
NameDescriptionTypeAdditional information
HourintegerNone.
MinuteintegerNone.