Employee groups

Organize employees into employee groups to simplify reporting. Create employee groups that are specific to your business, then assign an employee group to each employee.

List employee groups

get/objects/company-config/employee-group

Returns up to 100 employee groups from the collection with a key, ID, and link for each group. This operation is mostly for use in testing; use the query service to find employee groups that meet certain criteria and specify the properties that are returned.

SecurityOAuth2

Responses

200

OK

400

Bad Request

Request samples

Response samples

200
400

application/json

{"ia::result": [{"key": "1",
"id": "1",
"href": "/objects/company-config/employee-group/1"
},
{"key": "3",
"id": "3",
"href": "/objects/company-config/employee-group/3"
},
{"key": "5",
"id": "5",
"href": "/objects/company-config/employee-group/5"
}
],
"ia::meta": {"totalCount": 3,
"start": 1,
"pageSize": 100,
"next": null,
"previous": null
}
}

Create an employee group

post/objects/company-config/employee-group

Creates a new employee group.

SecurityOAuth2

Request

Request Body schema: application/json
required

Creates a new employee group.

id

required

string

Unique identifier for the employee group. Employee group IDs cannot be changed.

Example: "MGR"

name

required

string

Name for the employee group.

Example: "Sr. Managers"

description

string or null

Description for the employee group.

Example: "Managers G10 and above"

groupType

string

Default: "all"

The group type and related fields determine which employees are included in the group. For reports that use employees in rows or columns, these fields also determine the column headings and row headings that will appear, and the order in which they will be listed.

specific - Specify the employees to include and their order in the groupMembers array. You can optionally filter the array with the memberFilter settings.
all - All employees that match the memberFilter criteria.

Enum: "all" "specific"

Example: "specific"

object

One or more filters to select the employees to include in the employee group. Can be used in addition to the groupMembers array to filter from a selected list of employees.

object

string

Object type to filter on. Must match the type of object contained in the group, such as company-config/department or company-config/employee.

Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object)

Filters to select the records to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select records in which status is equal to "active".

Example: [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}]

Array

Any of:

Field value must be equal to this specified value.

object

The field name and value to be compared with object values.

Example: {"status":"active"}

filterExpression

string

Default: "and"

Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.

Shortcuts:

and by itself means that all conditions must be true.
or by itself means that at least one condition must be true.

Example: "(1 and 2) or 3"

Array of objects <= 1 items

Sort order for the results that match the filters when the group is displayed in reports. The entry consists of a field name to sort by and whether it should be sorted in ascending or descending order.

Example: [{"id":"asc"}]

Array (<= 1 items)

property name*

additional property

string

Enum: "asc" "desc"

size

integer

The maximum number of records that match the filters to include in the group when it is displayed in reports.

Example: 100

Array of objects

Members of the employee group and their sort order. Only applicable when groupType is set to specific.

Array

key	string System-assigned key for the employee. Example: "1"
id	string Unique identifier for the employee. Example: "jsmith"

isDimensionStructure

boolean

Default: false

Indicates whether a dimension structure is created from the group. If true, the group can be added to the rows or columns of a financial report.

Example: false

Responses

201

Created

400

Bad Request

Request samples

application/json

{"id": "E 01",
"name": "my top 01 employee",
"description": "my top 01 employee",
"groupType": "all",
"memberFilter": {"object": "company-config/employee",
"filterExpression": "and",
"filters": [{"$eq": {"id": 8
}
}
],
"orderBy": [{"id": "asc"
}
]
}
}

Response samples

201
400

application/json

{"ia::result": {"key": "21",
"id": "E 01",
"href": "/objects/company-config/employee-group/19"
},
"ia::meta": {"totalCount": 1,
"totalSuccess": 1,
"totalError": 0
}
}

Get an employee group

get/objects/company-config/employee-group/{key}

Returns detailed information for a specified employee group.

SecurityOAuth2

Request

path Parameters

key

required

string

System-assigned unique key for the employee group.

Example: 33

Responses

200

OK

400

Bad Request

Request samples

Response samples

200
400

application/json

{"ia::result": {"key": "23",
"id": "MGR",
"href": "/objects/company-config/employee-group/23",
"name": "Sr. Managers",
"description": "Managers G10 and above",
"groupType": "specific",
"isDimensionStructure": false,
"memberFilter": {"object": "company-config/employee",
"filterExpression": "and",
"filters": [{"$in": {"status": "inactive"
}
}
],
"orderBy": [{"status": "asc"
}
]
},
"groupMembers": [{"key": "1",
"id": "jsmith",
"href": "/objects/company-config/employee/23",
"status": "active",
"employeeContact": {"key": "973",
"id": "Thomas, Glenn",
"href": "/objects/company-config/contact/23"
}
}
],
"audit": {"createdDateTime": "2022-04-20T16:20:00Z",
"modifiedDateTime": "2022-04-20T16:20:00Z",
"createdBy": "1",
"modifiedBy": "95"
},
"entity": {"key": "46",
"id": "Western Region",
"name": "Western Region",
"href": "/objects/company-config/entity/46"
}
},
"ia::meta": {"totalCount": 1,
"totalSuccess": 1,
"totalError": 0
}
}

Update an employee group

patch/objects/company-config/employee-group/{key}

Updates an existing employee group by setting field values. Any fields not provided remain unchanged.

SecurityOAuth2

Request

path Parameters

key

required

string

System-assigned unique key for the employee group.

Example: 33

Request Body schema: application/json

name

string

Name for the employee group.

Example: "Sr. Managers"

description

string or null

Description for the employee group.

Example: "Managers G10 and above"

groupType

string

Default: "all"

The group type and related fields determine which employees are included in the group. For reports that use employees in rows or columns, these fields also determine the column headings and row headings that will appear, and the order in which they will be listed.

specific - Specify the employees to include and their order in the groupMembers array. You can optionally filter the array with the memberFilter settings.
all - All employees that match the memberFilter criteria.

Enum: "all" "specific"

Example: "specific"

object

One or more filters to select the employees to include in the employee group. Can be used in addition to the groupMembers array to filter from a selected list of employees.

object

string

Object type to filter on. Must match the type of object contained in the group, such as company-config/department or company-config/employee.

Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object)

Filters to select the records to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select records in which status is equal to "active".

Example: [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}]

Array

Any of:

Field value must be equal to this specified value.

object

The field name and value to be compared with object values.

Example: {"status":"active"}

filterExpression

string

Default: "and"

Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.

Shortcuts:

and by itself means that all conditions must be true.
or by itself means that at least one condition must be true.

Example: "(1 and 2) or 3"

Array of objects <= 1 items

Sort order for the results that match the filters when the group is displayed in reports. The entry consists of a field name to sort by and whether it should be sorted in ascending or descending order.

Example: [{"id":"asc"}]

Array (<= 1 items)

property name*

additional property

string

Enum: "asc" "desc"

size

integer

The maximum number of records that match the filters to include in the group when it is displayed in reports.

Example: 100

Array of objects

Members of the employee group and their sort order. Only applicable when groupType is set to specific.

Array

key	string System-assigned key for the employee. Example: "1"
id	string Unique identifier for the employee. Example: "jsmith"

isDimensionStructure

boolean

Default: false

Indicates whether a dimension structure is created from the group. If true, the group can be added to the rows or columns of a financial report.

Example: false

Responses

200

OK

400

Bad Request

Request samples

application/json

{"description": "My Top 001 employee"
}

Response samples

200
400

application/json

{"ia::result": {"key": "7",
"id": "E 01",
"href": "/objects/company-config/employee-group/7"
},
"ia::meta": {"totalCount": 1,
"totalSuccess": 1,
"totalError": 0
}
}

Delete an employee group

delete/objects/company-config/employee-group/{key}

Deletes an employee group.

SecurityOAuth2

Request

path Parameters

key

required

string

System-assigned unique key for the employee group.

Example: 33

Responses

204

No Content

400

Bad Request

Request samples

Response samples

400

application/json

{"ia::result": {"ia::error": {"code": "invalidRequest",
"message": "A POST request requires a payload",
"errorId": "REST-1028",
"additionalInfo": {"messageId": "IA.REQUEST_REQUIRES_A_PAYLOAD",
"placeholders": {"OPERATION": "POST"
},
"propertySet": { }
},
"supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
}
},
"ia::meta": {"totalCount": 1,
"totalSuccess": 0,
"totalError": 1
}
}

Employee groups

List employee groups

Create an employee group

Request Body schema: application/jsonrequired

Get an employee group

path Parameters

Update an employee group

path Parameters

Request Body schema: application/json

Delete an employee group

path Parameters

Request Body schema: application/json
required