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 retrieve various types of job-related data. Specifically, for the Hour Tag resource and the Get Cost Code Progress operation, it fetches detailed progress information about cost codes associated with a specific job within a defined date range.

This is useful in construction or project management scenarios where tracking the financial progress of different cost codes (budget categories) against a job is critical. For example, a project manager can use this node to monitor how much budget has been spent on labor, materials, or equipment over time, helping to ensure projects stay on track financially.

Properties

Name Meaning
Job ID The unique identifier of the job for which cost code progress is requested.
Start Date The start date of the period for which to retrieve cost code progress data.
End Date The end date of the period for which to retrieve cost code progress data.

Output

The node outputs JSON data representing the cost code progress results for the specified job and date range. The structure is an array under the results property returned by the API, containing detailed progress metrics per cost code.

The output JSON typically includes fields such as cost code identifiers, progress percentages, amounts spent, and other relevant financial tracking data related to the job's cost codes.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the HCSS Heavy Job API.
  • The node makes HTTP requests to the HCSS API endpoints, specifically:
    • POST request to /costCode/progress/advancedRequest with parameters: jobId, startDate, and endDate.
  • Proper configuration of the API credentials in n8n is necessary for successful authentication and data retrieval.

Troubleshooting

  • Common issues:
    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect or non-existent Job ID may result in empty or error responses.
    • Date range errors (e.g., start date after end date) might cause the API to reject the request.
  • Error messages:
    • Authentication errors typically indicate invalid client ID, secret, or scope.
    • API errors may return messages about invalid parameters or no data found.
  • Resolutions:
    • Verify that the API credentials are correctly set up and tested in n8n.
    • Double-check the Job ID and date inputs for correctness.
    • Ensure the date format matches expected ISO 8601 strings.

Links and References

Discussion