PaySpace v2

Provides integration with PaySpace, a payroll and workforce-management platform, so you can work with payroll and company-related records through the PaySpace API.

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.0.0.9 - Initial release.
0.0.0.14 - Improved error message handling.
0.0.0.23 - Maintenance release.
0.1.0.0 - Query now retrieves the first page before returning and loads later pages as the Workflow consumes rows.
0.1.0.1 - Removed query paging controls from templates and kept continuation paging inside the Node.
0.1.1.0 - Added sanitized mutation request echoes under Flowgear.Request.
0.1.2.0 - Split operations into Query, Create, Update, and Delete methods.
0.1.3.0 - Populated templates from full OpenAPI samples so request echoes mirror Items or bodyless Options.
0.1.3.1 - Preserved inherited fields in designer templates when OpenAPI schemas use constraints-only allOf overlays.
0.1.3.3 - Maintenance release.

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 Enum The scope requested when authenticating: FullAccess, ReadOnly, Update, or Create. The default is FullAccess.
Company ID String The company identifier used to populate PaySpace paths.
Timeout (seconds) Integer The timeout applied to token and API calls. The default is 30.
Ignore Duplicate Path Errors Boolean When true, duplicate path signature errors are ignored while parsing the OpenAPI document. The default is false.
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 retrieves the first PaySpace page before returning. Additional pages are retrieved only as the Workflow consumes the response stream.
  • Create and Update send the first input item before returning. Later items are sent as the Workflow consumes the response stream, and an empty connected input sends no provider request. Delete sends its provider request before returning.
  • 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.