Overview
This node integrates with the PaySpace API to manage company-related data within the PaySpace payroll and HR system. It allows users to perform various operations on company entities, such as retrieving metadata or accessing specific company information by ID. This node is useful for automating interactions with PaySpace's company data, enabling workflows that require up-to-date company details or metadata retrieval.
Practical examples include:
- Fetching company metadata to understand available fields and structure.
- Retrieving detailed information about a specific company using its Company ID.
- Automating company data synchronization between PaySpace and other systems.
Properties
| Name | Meaning |
|---|---|
| Environment | Selects which PaySpace environment to query: Staging (test environment) or Production (live environment). |
| Company ID | The unique identifier of the company in PaySpace to query or operate on. |
| Endpoint Collection Name or ID | Collection of endpoints related to the operation; choose from predefined collections or specify an ID via expression. |
| Endpoint Name or ID | Specific endpoint related to the operation; choose from the list or specify an ID via expression. |
| Api Request | The specific API request related to the operation and endpoint; options are dynamically loaded based on selected operation and endpoint. |
| Add Params | Boolean flag indicating whether to add optional additional query parameters to the API request. |
| Additional Fields | Optional collection of query parameters to refine the API request, including: - Order By: Specifies sorting order. - Top: Limits number of items returned. - Skip: Number of items to exclude. - Count: Return only count. - Select: Return specified fields only. - Filter: OData filter expression. - componentCodes: Comma-separated list of component codes. - altLanguage: Retrieve payslip components in alternative language. |
Note: Many properties like "Effective Date", "ID", "UserWorkflowStepId", "Category", "Period", "Frequency", and "Body (Raw)" exist but are not relevant for the "company" operation and thus omitted here.
Output
The node outputs JSON data representing the response from the PaySpace API for the requested company operation. The structure depends on the specific API endpoint called but generally includes company details or metadata.
- The
jsonoutput field contains the parsed JSON response from PaySpace. - No binary data output is indicated for the "company" operation.
Dependencies
- Requires an API key credential for authentication with PaySpace.
- Uses OAuth2 token-based authentication, obtaining a bearer token from PaySpace identity service URLs depending on the environment (staging or production).
- Relies on external HTTP requests made via Axios library.
- Supports dynamic loading of endpoint collections and endpoints based on the operation.
Troubleshooting
- Invalid Operation Error: If an unsupported operation or API request is selected, the node throws "Invalid Operation". Ensure the correct operation and API request are chosen.
- Authentication Failures: Errors during token retrieval may occur if credentials are incorrect or expired. Verify API key credentials and permissions.
- API Rate Limits or Network Issues: Standard HTTP errors may arise due to network problems or API rate limits. Implement retry logic or check network connectivity.
- Missing Required Parameters: Some API calls require mandatory parameters like Company ID. Ensure all required inputs are provided.
- Incorrect Endpoint or Collection Selection: Selecting incompatible endpoint collections or endpoints for the "company" operation can cause errors. Use the provided dropdowns or valid expressions.