# Employees ## Adds a new employee - [POST /api/v1/portfolio/employees/add](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1add/post.md): Creates a new employee record within the current account context. Behavior: - Associates the employee with the current account - Applies validation and business rules before persistence - Logs the action as an employee creation event ## Removes an employee - [POST /api/v1/portfolio/employees/{employeeidentifier}/remove](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1%7Bemployeeidentifier%7D~1remove/post.md): Removes the specified employee from the current account. Behavior: - Validates employee association with the account - Applies business rules before removal - Logs the action as an employee removal event ## Gets employee details - [GET /api/v1/portfolio/employees/{employeeIdentifier}](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1%7Bemployeeidentifier%7D/get.md): Retrieves detailed information for the specified employee within the current account context. Behavior: - Validates employee association with the account - Returns complete employee profile information - Logs the action as an employee view event ## Updates an employee - [POST /api/v1/portfolio/employees/{employeeIdentifier}](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1%7Bemployeeidentifier%7D/post.md): Updates the details of the specified employee within the current account context. Behavior: - Validates employee association with the account - Applies business rules before updating - Persists the updated employee information - Logs the action as an employee update event ## Gets employee files - [POST /api/v1/portfolio/employees/{employeeIdentifier}/files](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1%7Bemployeeidentifier%7D~1files/post.md): Retrieves files associated with the specified employee within the current account. Behavior: - Validates employee access within the account - Applies filtering or paging based on the request model - Returns files linked to the employee - Logs the action as an employee file view event ## Assign employee location - [POST /api/v1/portfolio/employees/{employeeIdentifier}/location](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1%7Bemployeeidentifier%7D~1location/post.md): Assigns the specified employee to a location within the current account context. Behavior: - Validates employee and location within the account - Applies assignment rules and constraints - Updates the employee’s location details - Logs the action as an employee assignment event ## Unassigns employee location - [POST /api/v1/portfolio/employees/{employeeIdentifier}/location/deassign](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1%7Bemployeeidentifier%7D~1location~1deassign/post.md): Removes the location assignment for the specified employee within the current account context. Behavior: - Validates employee association with the account - Removes the current location assignment - Updates employee allocation status - Logs the action as an employee de-assignment event ## Terminates an employee - [POST /api/v1/portfolio/employees/{employeeIdentifier}/terminate](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1%7Bemployeeidentifier%7D~1terminate/post.md): Terminates the specified employee within the current account context based on the provided termination details. Behavior: - Validates employee association with the account - Applies termination date and related rules - Updates employee status to terminated - Prevents further active assignments if applicable - Logs the action as an employee termination event ## Activates an employee - [POST /api/v1/portfolio/employees/{employeeIdentifier}/activate](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1%7Bemployeeidentifier%7D~1activate/post.md): Restores the specified employee to an active status within the current account context. Behavior: - Validates employee association with the account - Changes employee status to active - Re-enables eligibility for assignments and operations - Logs the action as an employee activation event ## Relocates employee - [POST /api/v1/portfolio/employees/{employeeIdentifier}/location/move](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1%7Bemployeeidentifier%7D~1location~1move/post.md): Transfers the specified employee from their current location to another location within the current account context. Behavior: - Validates employee and target location within the account - Ensures the employee has an existing active assignment - Updates the employee’s location to the new assignment - Maintains historical move records if applicable - Logs the action as an employee move event ## Assign supervisor - [POST /api/v1/portfolio/employees/{employeeIdentifier}/assignsupervisor](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1%7Bemployeeidentifier%7D~1assignsupervisor/post.md): Associates the specified supervisor with the given employee within the current account context. Behavior: - Validates employee and supervisor within the account - Ensures supervisor eligibility and role constraints - Updates reporting hierarchy for the employee - Maintains hierarchy integrity rules if applicable - Logs the action as a supervisor assignment event ## Get employee summary - [POST /api/v1/portfolio/employees/summary](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1summary/post.md): Returns a consolidated summary of employee-related information for the current account context. Behavior: - Aggregates employee counts and statuses - Includes active, inactive, assigned, and unassigned employees - Provides key metrics for reporting or dashboard purposes - Logs the summary view action ## Update profile image - [POST /api/v1/portfolio/employees/{employeeIdentifier}/profileimage](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1%7Bemployeeidentifier%7D~1profileimage/post.md): Updates the employee's profile image within the current account context using the provided file identifier. Behavior: - Accepts a file identifier for the new profile image - Updates the employee's image in the account - Logs the image upload action - Returns file details of the uploaded image ## Create employee account - [POST /api/v1/portfolio/employees/{employeeIdentifier}/createuser](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1%7Bemployeeidentifier%7D~1createuser/post.md): Creates a system user account associated with the specified employee within the current account context. Behavior: - Retrieves employee details based on the employee identifier - Validates employee status before user creation - Maps employee information to user account fields - Assigns roles as provided in the request - Sets account activation and expiry dates - Creates the user in the identity management system when IsCreateUser is true - Returns existing employee details if IsCreateUser is false - Logs the action as a user creation event ## List employees - [POST /api/v1/portfolio/employees/all](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1all/post.md): Returns a filtered and/or paginated list of employees within the current account context. Behavior: - Applies filtering criteria from the request body - Supports pagination using the start query parameter - Retrieves employees associated with the account - Returns summarised employee view details - Logs the action as an employee list view event ## Get employee qualifications - [GET /api/v1/portfolio/employees/{employeeIdentifier}/qualifications](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1%7Bemployeeidentifier%7D~1qualifications/get.md): Returns the list of qualifications associated with the specified employee within the current account context. Behavior: - Validates employee association with the account - Retrieves all recorded qualifications for the employee - Returns qualification details including relevant metadata - Logs the action as an employee qualification view event ## Add employee qualification - [POST /api/v1/portfolio/employees/{employeeIdentifier}/qualifications/add](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1%7Bemployeeidentifier%7D~1qualifications~1add/post.md): Associates a new qualification with the specified employee within the current account context. Behavior: - Validates employee association with the account - Validates qualification details from the request body - Creates and links the qualification record to the employee - Returns the newly added qualification details - Logs the action as an employee qualification addition event ## Remove employee qualification - [POST /api/v1/portfolio/employees/{employeeIdentifier}/qualifications/{qualificationIdentifier}/remove](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1%7Bemployeeidentifier%7D~1qualifications~1%7Bqualificationidentifier%7D~1remove/post.md): Deletes the specified qualification associated with the given employee within the current account context. Behavior: - Validates employee and qualification association within the account - Ensures the qualification exists for the specified employee - Removes the qualification record - Returns the removed qualification details if applicable - Logs the action as an employee qualification removal event ## Convert to technician - [POST /api/v1/portfolio/employees/{employeeIdentifier}/createtechnician](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1%7Bemployeeidentifier%7D~1createtechnician/post.md): Updates the specified employee to the technician role within the current account context and associates the provided trades. Behavior: - Validates employee association with the account - Validates provided trade identifiers - Updates employee role to technician - Associates selected trades with the technician profile - Returns updated employee details - Logs the action as an employee role conversion event ## Get move history - [GET /api/v1/portfolio/employees/{employeeId}/moves](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1%7Bemployeeid%7D~1moves/get.md): Returns the historical record of location moves for the specified employee within the current account context. Behavior: - Validates employee association with the account - Retrieves chronological move history records - Includes previous and new location details for each move - Returns rollback-related information if applicable - Logs the action as an employee move history view event ## Rollback employee move - [POST /api/v1/portfolio/employees/{employeeId}/location/moves/current/rollback](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1%7Bemployeeid%7D~1location~1moves~1current~1rollback/post.md): Reverts the employee’s most recent location move within the current account context based on the provided rollback details. Behavior: - Validates employee association with the account - Ensures a current move exists that is eligible for rollback - Restores the employee to the previous location state - Updates move history accordingly - Returns updated rollback information - Logs the action as an employee move rollback event ## List employee basic details - [GET /api/v1/portfolio/employees/basic](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1basic/get.md): Returns a simplified list of employee details within the current account context. Behavior: - Retrieves all employees associated with the account - Returns essential employee information only - Excludes extended or detailed profile data - Logs the action as an employee basic details view event ## Updates multiple employees - [POST /api/v1/portfolio/employees/update](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1update/post.md): Applies bulk updates to multiple employees within the current account context based on the provided request data. Behavior: - Validates employee associations with the account - Processes update rules for multiple employee records - Applies changes according to the request model - Returns the updated employee details list - Logs the action as a multiple employee update event ## Cancels employee termination - [POST /api/v1/portfolio/employees/{employeeIdentifier}/cancelTermination](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1%7Bemployeeidentifier%7D~1canceltermination/post.md): Reverses the termination status of the specified employee within the current account context and restores the employee to an active state where applicable. Behavior: - Validates employee association with the account - Ensures the employee is currently in a terminated state - Reverts termination details and status - Restores eligibility for assignments and operations if applicable - Returns updated employee details - Logs the action as an employee termination cancellation event ## Update employee locations - [POST /api/v1/portfolio/employees/locations/update](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1locations~1update/post.md): Applies location updates to one or more employees within the current account context based on the provided request data. Behavior: - Validates employee associations with the account - Validates target location details - Updates location assignments for the specified employees - Ensures location rules and constraints are enforced - Logs the action as a bulk employee location update event ## List active employees - [POST /api/v1/portfolio/employees/active](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1active/post.md): Returns a filtered and/or paginated list of active employees within the current account context. Behavior: - Applies filtering criteria from the request body - Supports pagination using the start query parameter - Retrieves only employees with an active status - Returns summarised employee view details - Logs the action as an active employee list view event ## Get paginated employee details - [POST /api/v1/portfolio/employees/basic/list](https://zonedevelopersdocumentationv1.redocly.app/apis/employees/paths/~1api~1v1~1portfolio~1employees~1basic~1list/post.md): Returns a filtered and/or paginated list of basic employee details within the current account context. Behavior: - Applies filtering criteria from the request body - Supports pagination using the start query parameter - Retrieves essential employee information only - Excludes extended profile or detailed data - Returns summarised employee basic detail results - Logs the action as an employee basic details list view event