Actions8
- Cost Code Progress Actions
- Employee Actions
- Hour Tag Actions
- Job Actions
- Pay Item Actions
- Time Card Actions
Pay Item → Get Pay Items
AI-generatedOverview
This node operation retrieves pay items from the HCSS Heavy Job API. It is useful for scenarios where users need to fetch payroll-related data for jobs, such as pay item details for reporting or integration with payroll systems. For example, a user can fetch all pay items for a specific job or limit the results to a certain number for pagination purposes.
Use Case Examples
- Fetch all pay items for a given job ID to generate payroll reports.
- Retrieve a limited number of pay items with filters like cursor and isDeleted status for incremental data processing.
Properties
| Name | Meaning |
|---|---|
| Return All | Whether to return all results or only up to a given limit. |
| Limit | Maximum number of results to return when Return All is false. |
| Request Fields | Additional filters for the request, including Cursor for pagination, Job ID to specify the job, and Is Deleted to filter by deletion status. |
Output
JSON
results- Array of pay item objects returned from the API, containing pay item details.
Dependencies
- HCSS Heavy Job API with an API key credential for authentication
Troubleshooting
- Ensure the Job ID is provided in the request fields; otherwise, the API may return an error or empty results.
- If the API returns no results, check the isDeleted filter and cursor values to ensure they are correct for the desired data.
- Authentication errors may occur if the API credentials are missing or invalid; verify the API key and client credentials.
Links
- HCSS Heavy Job API Documentation - Official API documentation for understanding endpoints and parameters related to pay items.