HCSS Heavy Job icon

HCSS Heavy Job

Read, update, write and delete data from HCSS Heavy Job API

Actions7

Overview

This node integrates with the HCSS Heavy Job API to manage employee data, specifically allowing you to update existing employee records. It is useful in scenarios where you need to keep employee information current within your business unit, such as updating contact details, job roles, salary information, or employment status.

Practical examples include:

  • Updating an employee’s phone number or email address after a change.
  • Changing the department or supervisor assignment for organizational restructuring.
  • Marking an employee as inactive or discontinued when they leave the company.
  • Adjusting payroll-related fields like salary, pay class, or tax code.

Properties

Name Meaning
Employee ID The unique identifier of the employee to update (required).
Code The employee's code used for identification (required).
Business Unit Code Name or ID The business unit associated with the employee; can be selected from a list or specified by ID (required).
Additional Fields A collection of optional fields to update various employee attributes:
- Accounting Code Unique identifier for accounting and financial reporting purposes.
- Accounting Template Name Name of the accounting template for standardized financial processing.
- Address Primary street or mailing address.
- City City name for the primary address location.
- Company Name of the company or organization the employee belongs to.
- Cost Type Classification of cost category for budgeting and expense tracking.
- Crew Work crew or team assignment identifier.
- Default Equipment Primary equipment or tools assigned to the employee.
- Department Organizational department or business unit assignment.
- Division Company division or major business segment classification.
- Earn Code Payroll earning code categorizing types of compensation.
- Email Primary email address for business communication.
- First Name Employee's first or given name.
- General Ledger Account General ledger account number for financial record keeping.
- Is Active Boolean indicating if the employee record is currently active.
- Is Discontinued Boolean indicating if the employee has been discontinued or terminated.
- Is Foreman Boolean indicating if the employee holds a foreman or supervisory role.
- Is Salaried Boolean indicating if the employee is salaried versus hourly paid.
- Last Name Employee's last or family name.
- Mobile Phone Mobile or cell phone number for direct contact.
- Pay Class Pay classification or grade level determining compensation structure.
- Phone Primary phone number for business or personal contact.
- Salary Annual salary amount or compensation rate.
- State State or province for the primary address location.
- Supervisor Name or identifier of the employee's direct supervisor or manager.
- Tax Code Tax classification code used for payroll tax calculations.
- Type Employee type classification (e.g., full-time, part-time, contractor).
- Union Code Union membership code or identifier for collective bargaining purposes.

Output

The node outputs JSON data representing the updated employee record as returned by the HCSS Heavy Job API. This typically includes all employee fields after the update operation, reflecting the new state of the employee data.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the HCSS Heavy Job API.
  • The node uses the HCSS Heavy Job API endpoints to perform updates.
  • The "Business Unit Code Name or ID" property loads options dynamically via an API call to fetch available business units.
  • Proper configuration of the API credentials and network access to the HCSS API endpoint is necessary.

Troubleshooting

  • Missing Required Fields: Ensure that "Employee ID", "Code", and "Business Unit Code Name or ID" are provided; otherwise, the API will reject the request.
  • Invalid Credentials: Authentication failures will occur if the API key or token is invalid or expired. Verify and update credentials accordingly.
  • API Errors: If the API returns errors (e.g., invalid field values, unauthorized access), check the error message for details and correct input data or permissions.
  • Network Issues: Connectivity problems to the HCSS API endpoint can cause timeouts or failures. Confirm network settings and firewall rules allow outbound requests.
  • Option Loading Failures: If the business unit list fails to load, verify API connectivity and credentials since this list is fetched dynamically.

Links and References

Discussion