Employee Awards

get_employee_awards

Get list of employee awards for the authenticated user's organization

Parameters

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

searchstring

Search term for award name

relationsArray<string>

Relations to include (e.g., ["employee"])

employeeIdstring<uuid>

Filter by employee ID

yearstring

Filter by award year

sortBystringnameyearcreatedAtupdatedAt

Sort awards by field

sortOrderstringASCDESCDESC

Sort order

get_employee_award

Get a specific employee award by ID

Parameters

idstring<uuid>required

The employee award ID

relationsArray<string>

Relations to include (e.g., ["employee"])

create_employee_award

Create a new employee award in the authenticated user's organization

Body

application/json
award_dataobjectrequired

The data for creating the employee award

Show child attributes
namestringrequired

The award name (required)

yearnumberrequired

The year (required)

employeeIdstringrequired

The employee ID (required)

[key: string]any

update_employee_award

Update an existing employee award

Parameters

idstring<uuid>required

The employee award ID

award_dataobjectrequired

The data for updating the employee award

delete_employee_award

Delete an employee award

Parameters

idstring<uuid>required

The employee award ID

get_employee_awards_by_employee

Get awards for a specific employee

Parameters

employeeIdstring<uuid>required

The employee ID

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

yearstring

Filter by award year

sortBystringnameyearcreatedAtyear

Sort awards by field

sortOrderstringASCDESCDESC

Sort order

get_employee_awards_by_year

Get employee awards for a specific year

Parameters

yearstringrequired

The award year

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

employeeIdstring<uuid>

Filter by employee ID

relationsArray<string>

Relations to include

sortBystringnamecreatedAtemployeename

Sort awards by field

sortOrderstringASCDESCASC

Sort order

get_employee_awards_count

Get employee awards count in the authenticated user's organization

Parameters

employeeIdstring<uuid>

Filter by employee ID

yearstring

Filter by award year

searchstring

Search term for award name

get_employee_awards_statistics

Get employee awards statistics for the authenticated user's organization

Parameters

employeeIdstring<uuid>

Filter by specific employee ID

yearstring

Filter by award year

startDatestring

Start date for statistics (ISO format)

endDatestring

End date for statistics (ISO format)

groupBystringemployeeyearmonth

Group statistics by field

bulk_create_employee_awards

Create multiple employee awards in bulk for the authenticated user's organization

Body

application/json
awardsArray<object>required

Array of employee award data to create

Show child attributes

Employee award data

namestringrequired

The award name (required)

yearnumberrequired

The year (required)

employeeIdstringrequired

The employee ID (required)

[key: string]any

bulk_update_employee_awards

Update multiple employee awards in bulk

Body

application/json
awardsArray<object>required

Array of employee award updates

Show child attributes
idstring<uuid>required

The employee award ID

dataobjectrequired

The data to update

Show child attributes
[key: string]any

bulk_delete_employee_awards

Delete multiple employee awards in bulk

Parameters

idsArray<string>required

Array of employee award IDs to delete

Copyright © 2023-Present Ever Co. LTD.Docs by Sourcey