Employee Groups
- Get Employee Group Object Definition
- Query and List Employee Groups
- Query and List Employee Groups (Legacy)
- Get Employee Group
- Get Employee Group by ID
An employee group categories employee dimension records, mainly for the purpose of structuring financial reporting.
Get Employee Group Object Definition
lookup
List all the fields and relationships for the employee group object:
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use EMPLOYEEGROUP |
Query and List Employee Groups
query
List the record number, description, and ID for each employee group:
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use EMPLOYEEGROUP |
filter | Optional | object | Filter expression to limit the response to only objects that match the expression. Check the value of a single field using operators such as equalto/like, or multiple fields using and/or. Query fields on related objects using the dot operator (for example, VENDOR.CREDITLIMIT on APBILL). |
select | Required | sequence | The names of the fields that you want included in the response, and an optional aggregate function such as count or sum . Returning all fields is not supported. |
orderby | Optional | object | Provide an order element with a field name and choose an ascending or descending sort order, for example: <order> |
options | Optional | object | Query options:
|
pagesize | Optional | integer | Maximum number of matching objects to return in the response, between 1 and 2000 items (Default: 100 ) |
offset | Optional | integer | Point at which to start indexing into records (Default: 0 ) |
Query and List Employee Groups (Legacy)
readByQuery
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use EMPLOYEEGROUP |
fields | Optional | string | Comma-separated list of fields on the object to list. For best performance and predictability, limit the number of fields. To return all fields, omit the element or provide * for the value. |
query | Required | string | SQL-like query based on fields on the object. The following operators are supported: < , > , >= , <= , = , like , not like , in , not in , IS NOT NULL , IS NULL , AND , OR . Illegal XML characters must be properly encoded, and single quotes must be escaped with backslashes ('Jane\'s Deli' ). Joins are not supported. |
pagesize | Optional | integer | Custom page size between 1 and 1000 items (Default: 100 ) |
Get Employee Group
read
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use EMPLOYEEGROUP |
keys | Required | string | Comma-separated list of group RECORDNO to get |
fields | Optional | string | Comma-separated list of fields on the object to get. To return all fields, omit the element or provide * for the value.For best performance and predictability, limit the number of fields. |
returnFormat | Optional | string | Data format for the response body:
|
Get Employee Group by ID
readByName
Parameters
Name | Required | Type | Description |
---|---|---|---|
object | Required | string | Use EMPLOYEEGROUP |
keys | Required | string | Comma-separated list of group ID to get |
fields | Optional | string | Comma-separated list of fields on the object to get. To return all fields, omit the element or provide * for the value.For best performance and predictability, limit the number of fields. |
returnFormat | Optional | string | Data format for the response body:
|