PaySpace

PaySpace is a payroll and workforce-management platform used to work with payroll and company-related records through the PaySpace API surface.

The Flowgear PaySpace Node lets you run supported query, create, update, and delete operations by using the embedded OpenAPI definition and template-selected operation IDs in a Workflow. Query responses stay provider-shaped, while create, update, and delete responses add the standard Flowgear result object inside Response.Flowgear.

Revision History

0.1.3.1 - Preserved inherited fields in designer templates when OpenAPI schemas use constraints-only allOf overlays.
0.1.3.0 - Populated templates from full OpenAPI samples so request echoes mirror Items or bodyless Options.
0.1.2.0 - Split operations into Query, Create, Update, and Delete methods.
0.1.1.0 - Added sanitized mutation request echoes under Flowgear.Request.
0.1.0.1 - Removed query paging controls from templates and kept continuation paging inside the Node.
0.1.0.0 - Completed the V2 overhaul with eager first-request startup and lazy continuation.
0.0.0.23 - Aligned the V2 connector contract and public help article.
0.0.0.9 - Initial release.
0.0.0.14 - Improved error message handling.

Connection

The Connection stores the PaySpace API endpoint details, credentials, and token settings used for template generation and execution.

Property	Type	Description
API Base URL	String	The base URL for PaySpace API calls. The default is https://api.payspace.com.
Auth Base URL	String	The base URL for PaySpace authentication. The default is https://identity.payspace.com.
Client ID	String	The client ID issued by PaySpace.
Client Secret	Masked	The client secret issued by PaySpace.
Grant Type	PaySpaceGrantType	The scope requested when authenticating.
Company ID	String	The company identifier used to populate PaySpace paths.
Timeout (seconds)	Integer	The timeout applied to token and API calls.
Ignore Duplicate Path Errors	Boolean	When true, duplicate path signature errors are ignored while parsing the OpenAPI document.
Access Token	Masked	The access token returned by PaySpace authentication.

Setup Notes

1. Request the PaySpace API credentials from your PaySpace account manager.
2. Confirm the required API scope with PaySpace, and then select the appropriate Grant Type.
3. Configure the Connection, and then test it so Flowgear can request an Access Token.
4. Set Company ID when your templates or operations need a default company context.

Methods

The PaySpace Node exposes separate Methods for query, create, update, and delete operations.

Query

Executes read-only operations defined in the embedded OpenAPI specification.

Parameter	Type	Description
Connection	Connection	The PaySpace Connection that contains credentials and token settings.
OperationId	String	The operation identifier selected from the PaySpace templates.
Options	Object	Optional route, query, or header values applied to the request.

Return	Type	Description
Response	Array	The response items returned by the PaySpace operation. Query responses do not add Flowgear mutation defaults.

Create

Creates PaySpace resources with the selected OpenAPI template.

Parameter	Type	Description
Connection	Connection	The PaySpace Connection that contains credentials and token settings.
OperationId	String	The operation identifier selected from the PaySpace templates.
Options	Object	Optional route, query, or header values applied to the request.
Items	Array	Optional request body items sent to the selected operation.

Return	Type	Description
Response	Array	The response items returned by the PaySpace operation. Each response item includes Flowgear.IsSuccess, Flowgear.Message, and Flowgear.Request inside Response.Flowgear.

Update

Updates PaySpace resources with the selected OpenAPI template.

Parameter	Type	Description
Connection	Connection	The PaySpace Connection that contains credentials and token settings.
OperationId	String	The operation identifier selected from the PaySpace templates.
Options	Object	Optional route, query, or header values applied to the request.
Items	Array	Optional request body items sent to the selected operation.

Return	Type	Description
Response	Array	The response items returned by the PaySpace operation. Each response item includes Flowgear.IsSuccess, Flowgear.Message, and Flowgear.Request inside Response.Flowgear.

Delete

Deletes PaySpace resources by using the selected OpenAPI template.

Parameter	Type	Description
Connection	Connection	The PaySpace Connection that contains credentials and token settings.
OperationId	String	The operation identifier selected from the PaySpace templates.
Options	Object	Optional route, query, or header values applied to the request.

Return	Type	Description
Response	Array	The response items returned by the PaySpace operation. Each response item includes Flowgear.IsSuccess, Flowgear.Message, and Flowgear.Request inside Response.Flowgear.

Usage Notes

• Use the template picker to select the correct OperationId for Query, Create, Update, or Delete.
• Query templates omit $top, $skip, and $count. Stale saved values are ignored so the Node can manage paging consistently.
• Create and Update copy the current Items object into Flowgear.Request. Bodyless operations, including Delete, copy Options instead. Nested Content values are excluded.
• Query completes the first PaySpace page while the Node invoke is awaited. Additional pages are fetched only as the Workflow consumes the response stream.
• Create and Update complete the first input item while the Node invoke is awaited. Later items are consumed lazily, and an empty connected input sends no provider request. Delete completes its provider request while the invoke is awaited.
• When a query returns no items, the Node emits no rows instead of a synthetic empty record.
• PaySpace value envelopes are unwrapped when possible so downstream Steps receive predictable objects.