GET Setup/BusinessUnit
Get businessUnits from criteria
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| IncludeActive |
Include records where RecordState == RecordState.Active |
boolean |
None. |
| IncludeInactive |
Include records where RecordState == RecordState.Inactive |
boolean |
None. |
| IncludeDeleted |
Include records where RecordState == RecordState.Deleted |
boolean |
None. |
| IncludePayload |
Include all data (set to false to return partial data and get a faster result) |
boolean |
None. |
| Match |
When searching by string, include records based on match type |
MatchCriteriaStringType |
None. |
| OUID |
Filter by OUID |
integer |
None. |
| BusinessUnits |
Filter by BusinessUnit(s) |
Collection of integer |
None. |
| BUName |
Filter by BUName |
string |
None. |
| CreatedDateUtcMin |
Filter by CreatedDateUtcMin |
date |
None. |
| CreatedDateUtcMax |
Filter by CreatedDateUtcMax |
date |
None. |
| LastUpdatedDateUtcMin |
Filter by LastUpdatedDateUtcMin |
date |
None. |
| LastUpdatedDateUtcMax |
Filter by LastUpdatedDateUtcMax |
date |
None. |
| IncludeBusinessUnitSettings |
Includes Business Unit Settings |
boolean |
None. |
Body Parameters
None.
Response Information
Resource Description
List of BusinessUnitDTOs
Collection of BusinessUnitDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| BUID | integer |
None. |
|
| OUID | integer |
None. |
|
| BUName | string |
None. |
|
| GLCode | string |
None. |
|
| EventStartUtc |
Event Start Utc |
date |
None. |
| EventStopUtc |
Event Stop Utc |
date |
None. |
| EventNextStopUtc |
Event Next Stop Utc |
date |
None. |
| Comments | string |
None. |
|
| Props | Collection of Object |
None. |
|
| Addresses |
Addresses |
AddressesDTO |
None. |
| CommunicationMethods |
Communication methods |
CommunicationMethodsDTO |
None. |
| RecordState | RecordState |
None. |
|
| Created | AuditDataDTO |
None. |
|
| LastUpdated | AuditDataDTO |
None. |
|
| IsPartialData |
Only return partial data to speed up call (results cannot be used for add/update) |
boolean |
None. |
| Summary | string |
None. |
|
| OrganizationalUnitName |
Organizational Unit Name |
string |
None. |
| BusinessUnitStartDayOfWeek |
Business Unit Start Day of the Week for billing process and scheduling |
integer |
None. |
| TimeZone |
Business Unit TimeZone |
string |
None. |
| AlternativeGLCodes | Collection of AlternativeDTO |
None. |
|
| businessUnitSettingDTOs |
Business Unit Settings |
Collection of BusinessUnitSettingDTO |
None. |
| Type |
Business Unit Type |
BusinessUnitType |
None. |