Overview
This node integrates with the PaySpace API to retrieve metadata and manage various aspects of a PaySpace account, primarily focused on employee and company data. The "Get Metadata" operation fetches the OData metadata document for a specified company environment, which describes the structure and available entities of the PaySpace API for that company.
Common scenarios where this node is beneficial include:
- Automatically retrieving the API metadata to understand available endpoints and data models.
- Using metadata to dynamically build queries or validate data structures before making further API calls.
- Integrating PaySpace data into workflows for HR, payroll, or employee management automation.
Practical example:
- A user wants to fetch the metadata for their production environment company to explore available employee-related endpoints and fields before building custom queries or reports.
Properties
| Name | Meaning |
|---|---|
| Environment | Selects the target environment to query: "Staging" or "Production". |
| Company ID | Numeric identifier of the company whose metadata is being requested. |
| Api Request | (Not used in "Get Metadata" operation) |
| Effective Date | (Shown only for certain APIs, not relevant here) |
| Employee Number | (Shown only for certain APIs, not relevant here) |
| ID | (Shown only for certain APIs, not relevant here) |
| UserWorkflowStepId | (Shown only for certain APIs, not relevant here) |
| Category | (Shown only for certain APIs, not relevant here) |
| Period | (Shown only for certain APIs, not relevant here) |
| Frequency | (Shown only for certain APIs, not relevant here) |
| Body (Raw) | (Shown only for certain APIs, not relevant here) |
| Add Params | Boolean flag to add additional query parameters (not applicable for Get Metadata) |
| Additional Fields | Optional collection of query parameters such as orderBy, top, skip, count, select, filter, etc. (not applicable for Get Metadata) |
| This node is still in beta | Informational notice about the node's development status. |
For the "Get Metadata" operation specifically, only Environment and Company ID are relevant input properties.
Output
The output JSON contains the raw metadata XML or JSON document retrieved from the PaySpace OData service for the specified company. This metadata describes the entity sets, types, and relationships available in the API for that company environment.
The output structure is:
{
"json": {
// OData metadata content describing the API schema for the company
}
}
No binary data is output by this operation.
Dependencies
- Requires an API key credential with client ID and client secret to authenticate against PaySpace identity service.
- Uses OAuth2 token retrieval via the PaySpace identity endpoint depending on the selected environment (staging or production).
- Makes HTTP requests to the PaySpace OData API endpoints.
- Requires n8n credentials configured with the necessary API authentication details.
Troubleshooting
- Invalid Operation Error: If the operation parameter is incorrect or unsupported, the node throws "Invalid Operation". Ensure "Get Metadata" is selected.
- Authentication Failures: Errors during token retrieval may occur if client credentials are invalid or missing. Verify API key credentials and permissions.
- Network or Endpoint Errors: If the company ID or environment URL is incorrect, the request to fetch metadata will fail. Confirm the company ID and environment selection.
- Empty or Malformed Metadata: If the metadata response is empty or malformed, check the company's API configuration or contact PaySpace support.
Links and References
- PaySpace Developer Portal
- OData Protocol Overview
- n8n Expressions Documentation (for dynamic property values)