Paycor v2

Provides integration with Paycor human resources and payroll data through its v1 and v2 APIs. Use templates for data queries, mutations, reports, document downloads and file imports.

Revision History

0.0.0.2 - Provides template-driven Paycor operations, OAuth authentication and document transfers.

Connection

Property Type Description
Environment Enum Sandbox or Production. Defaults to Sandbox; credentials and legal-entity activation are environment-specific.
Client ID String Application OAuth client identifier.
Client Secret Masked Application OAuth client secret.
Subscription Key Masked API subscription key for the selected environment.
Scopes String Space-separated application scopes. offline_access is added for refresh tokens.
Access Token Masked OAuth access token.
Refresh Token Masked OAuth refresh token.
Code Verifier Masked Managed PKCE verifier; do not edit during authorization.
OAuth State Masked Managed authorization state; do not edit during authorization.
Timeout (seconds) Integer Maximum duration of one HTTP request. Defaults to 30.

Setup Notes

  1. Create a Paycor developer application with the required data access and subscription key.
  2. Have a Paycor administrator activate access to the required legal entities.
  3. Register the Flowgear callback URI as an approved OAuth return URL.
  4. Set the environment and credentials, then connect your account. Existing tokens from the activation flow can also be supplied.
  5. Run on a Cloud Cluster and select the appropriate v1 or v2 operation template.

Methods

Select a Method and its template to populate the operation and its supported fields.

Query

Reads records with automatic continuation, including supported POST searches.

Parameter Type Description
Connection Connection Paycor Connection profile.
OperationId String Operation identifier populated by the selected template.
Options Object Route and query values required by the selected operation.
Items Object Single structured search request for a POST read; not a stream.
Return Type Description
Response Array Provider records without added mutation status fields.

Post

Executes a selected POST operation, including creation and named actions.

Parameter Type Description
Connection Connection Paycor Connection profile.
OperationId String Operation identifier populated by the selected template.
Options Object Route and query values required by the selected operation.
Items Array Structured request records where a body is required. Supported bulk operations apply their documented batch limits.
Return Type Description
Response Array Provider results with Flowgear.IsSuccess, Flowgear.Message, and a detached copy of the input in Flowgear.Request.

Update

Executes a selected PUT or PATCH operation.

Parameter Type Description
Connection Connection Paycor Connection profile.
OperationId String Operation identifier populated by the selected template.
Options Object Route and query values required by the selected operation.
Items Array Structured request records where a body is required. Supported bulk operations apply their documented batch limits.
Return Type Description
Response Array Provider results with Flowgear.IsSuccess, Flowgear.Message, and a detached copy of the input in Flowgear.Request.

Delete

Executes an explicitly selected DELETE operation.

Parameter Type Description
Connection Connection Paycor Connection profile.
OperationId String Operation identifier populated by the selected template.
Options Object Route and query values required by the selected operation.
Items Array Structured request records where a body is required. Supported bulk operations apply their documented batch limits.
Return Type Description
Response Array Provider results with Flowgear.IsSuccess, Flowgear.Message, and a detached copy of the input in Flowgear.Request.

Download

Downloads a document or report.

Parameter Type Description
Connection Connection Paycor Connection profile.
OperationId String Operation identifier populated by the selected template.
Options Object Route and query values required by the selected operation.
Items Object Single request body where required by the selected download.
Return Type Description
Content Stream Readable document stream. The consumer must dispose it when finished.

Upload

Imports a readable file through a configured Paycor import map.

Parameter Type Description
Connection Connection Paycor Connection profile.
OperationId String Operation identifier populated by the selected template.
Options Object Route and query values required by the selected operation.
Content Stream Required readable file content. Ownership remains with the caller.
FileName String Multipart filename. Defaults to import.csv.
MapName String Optional Paycor import map name.
Return Type Description
Response Object Provider results with Flowgear.IsSuccess, Flowgear.Message, and a detached copy of the input in Flowgear.Request.

Usage Notes

  • Query returns provider records without paging envelopes or mutation metadata. The first page is read during invocation; subsequent pages are read as output is consumed.
  • Post, Update and Delete execute the first item or batch during invocation. Later handled per-item failures return unsuccessful rows. Check Flowgear.IsSuccess before dependent work.
  • An accepted asynchronous write acknowledges submission, not completion. Partial labor-code imports and unsuccessful pay-period unlock acknowledgements are reported as failures.
  • Bodyless mutations can run once without connected Items; an empty connected stream produces no writes. Selected bulk templates control batching.
  • The Node refreshes and retries once after an unauthorized resource response. Other provider failures, including rate limits, are not automatically retried. Access and rotated refresh tokens are persisted together.
  • Downloaded streams must be consumed and disposed. Upload keeps the supplied stream open for its owner.

Known Issues

  • Access depends on application scopes, activated legal entities and the selected environment.