Cmdlets for Paylocity

Build 24.0.9060

Establishing a Connection

With the CData Cmdlets users can install a data module, set the connection properties, and start scripting. This section provides examples of using our Paylocity Cmdlets with native PowerShell cmdlets, like the CSV import and export cmdlets.

Installing and Connecting

If you have PSGet, installing the cmdlets can be accomplished from the PowerShell Gallery with the following command. You can also obtain a setup from the CData site. 

Install-Module PaylocityCmdlets

The following line is then added to your profile, loading the cmdlets on the next session: 

Import-Module PaylocityCmdlets;

You can then use the Connect-Paylocity cmdlet to create a connection object that can be passed to other cmdlets: 

$conn = Connect-Paylocity -InitiateOauth "GETANDREFRESH" -OAuthClientID "YourClientId" -OAuthClientSecret "YourClientSecret" -RSAPublicKey "YourRSAPubKey" -Key "YourKey" -IV "YourIV"

Connecting to Paylocity

Paylocity provides two ways to connect: via the Pay Entry API, and via the standard Paylocity API.

Before you connect, set these properties (if applicable):

  • If you are using a Sandbox account, set UseSandbox to true; otherwise, false.
  • If IncludeCustomFields is true, set CustomFieldsCategory to the Customfields category. The default value for this property is PayrollAndHR.

For sites that have opted-in to encryption:

  • Set only one of the following encryption properties:
    • Key: The AES symmetric key (base 64 encoded) is encrypted with the Paylocity Public Key. This key is used to encrypt Paylocity content. Paylocity decrypts the AES key using RSA decryption.
      Used if the IV value is not provided.
    • IV: The AES IV (base 64 encoded) used when encrypting Paylocity. If no Key value is provided, IV is generated internally.
  • If RSA encryption is enabled in your Paylocity account, set RSAPublicKey to the RSA Key associated with your Paylocity. (This property is required for executing Insert and Update statements.) If the feature is disabled, it is not required.

The Pay Entry API

The Pay Entry API is an extremely limited connection that enables users to automatically submit payroll information for individual employees, and little else. Due to the extremely limited nature of what is offered by the Pay Entry API, it does not have a seaparate schema. However, it can be enabled via the UsePayEntryAPI connection property.

The Pay Entry API is completely separate from the rest of the Paylocity API. It uses a separate Client ID and Secret, and must be explicitly requested from Paylocity for access to be granted for an account.

Note that when setting UsePayEntryAPI to true, you may only use the following stored procedures:

Attempts to use other features of the product will result in an error.

Also, the OAuthAccessToken you obtain for use with the Pay Entry API must be stored separately. This often requires you to set a different OAuthSettingsLocation when using this connection property.

Authenticating to Paylocity

Paylocity supports OAuth authentication for all connections to data, from either Pay Entry API or the standard Payloticity API. To enable this authentication from all OAuth flows, you must set AuthScheme to OAuth, and you must create a custom OAuth application.

The following subsections describe how to authenticate to Paylocity from the three most common authentication flows. For information about how to create a custom OAuth application, see Creating a Custom OAuth Application. For a complete list of connection string properties available in Paylocity, see Connection.

Desktop Applications

To authenticate with the credentials for a custom OAuth application, you must get and refresh the OAuth access token. After you do that, you are ready to connect.

Get and refresh the OAuth access token:

  • InitiateOAuth = GETANDREFRESH. Used to automatically get and refresh the OAuthAccessToken.
  • OAuthClientId = the client Id assigned when you registered your application.
  • OAuthClientSecret = the client secret that was assigned when you registered your application.
  • CallbackURL = the redirect URI that was defined when you registered your application.

When you connect, the cmdlet opens Paylocity's OAuth endpoint in your default browser. Log in and grant permissions to the application.

When the access token expires, the cmdlet refreshes it automatically.

Automatic refresh of the OAuth access token:

To have the cmdlet automatically refresh the OAuth access token, do the following:

  1. Before connecting to data for the first time, set the following connection parameters:
    • InitiateOAuth = REFRESH.
    • OAuthClientId = the client Id in your application settings.
    • OAuthClientSecret = the client secret in your application settings.
    • OAuthAccessToken = the access token returned by GetOAuthAccessToken.
    • OAuthSettingsLocation = the path where you want the cmdlet to save the OAuth values, which persist across connections.
  2. On subsequent data connections, set the following:
    • InitiateOAuth
    • OAuthSettingsLocation

Manual refresh of the OAuth access token:

The only value needed to manually refresh the OAuth access token is the OAuth refresh token.

  1. To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
  2. Set the following connection properties:
    • OAuthClientId = the Client Id in your application settings.
    • OAuthClientSecret = the Client Secret in your application settings.

  3. Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
  4. After the new tokens have been retrieved, set the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken. This opens a new connection.

Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Headless Machines

If you need to log in to a resource that resides on a headless machine, you must authenticate on another device that has an internet browser. You can do this in either of the following ways:

  • Option 1: Obtain the OAuthVerifier value.
  • Option 2: Install the cmdlet on a machine with an internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow.

After you execute either Option 1 or Option 2, configure the driver to automatically refresh the access token on the headless machine.

Option 1: Obtaining and Exchanging a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL. Do the following:

  1. Authenticate from the machine with an internet browser, and obtain the OAuthVerifier connection property.

    Set the following properties:

    • InitiateOAuth = OFF.
    • OAuthClientId = the client Id assigned when you registered your application.
    • OAuthClientSecret = the client secret assigned when you registered your application.

  2. Retrieve the CallbackURL you established when you registered your custom OAuth application. (See Creating a Custom OAuth Application.) Paste this URL into a new browser tab.

  3. Log in and grant permissions to the cmdlet. The OAuth application redirects you the redirect URI, with a parameter called code appended. Note the value of this parameter; you will need it later, to configure the OAuthVerifier connection property.

  4. Exchange the OAuth verifier code for OAuth refresh and access tokens. On the headless machine, set the following connection properties to obtain the OAuth authentication values:

    • InitiateOAuth = REFRESH.
    • OAuthVerifier = the noted verifier code (the value of the code parameter in the redirect URI).
    • OAuthSettingsLocation = persist the encrypted OAuth authentication values to the specified file.
    • OAuthClientId = the client Id in your custom OAuth application settings.
    • OAuthClientSecret = the client secret in the custom OAuth application settings.

  5. Test the connection to generate the OAuth settings file.

  6. After you re-set the following properties, you are ready to connect:

    • InitiateOAuth = REFRESH.
    • OAuthSettingsLocation = the file containing the encrypted OAuth authentication values. To enable the automatic refreshing of the access token, be sure that this file gives read and write permissions to the cmdlet.
    • OAuthClientId = the client Id assigned when you registered your application.
    • OAuthClientSecret = the client secret assigned when you registered your application.

Option 2: Transferring OAuth Settings

Prior to connecting on a headless machine, you must install and create a connection with the driver on a device that supports an internet browser. Set the connection properties as described above in "Desktop Applications".

After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the path specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.

Test the connection to generate the OAuth settings file, then copy the OAuth settings file to your headless machine.

To connect to data via the headless machine, set the following connection properties:

  • InitiateOAuth = REFRESH
  • OAuthSettingsLocation = the path to the OAuth settings file you copied from the machine with the browser. To enable automatic refreshing of the access token, ensure that this file gives read and write permissions to the cmdlet.
  • OAuthClientId = the client Id assigned when you registered your custom OAuth application.
  • OAuthClientSecret = the client secret assigned when you registered your custom OAuth application.

Retrieving Data

The Select-Paylocity cmdlet provides a native PowerShell interface for retrieving data: 

$results = Select-Paylocity -Connection $conn -Table "Employee" -Columns @("FirstName, LastName") -Where "EmployeeId='1234'"
The Invoke-Paylocity cmdlet provides an SQL interface. This cmdlet can be used to execute an SQL query via the Query parameter.

Piping Cmdlet Output

The cmdlets return row objects to the pipeline one row at a time. The following line exports results to a CSV file: 

Select-Paylocity -Connection $conn -Table Employee -Where "EmployeeId = '1234'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myEmployeeData.csv -NoTypeInformation

You will notice that we piped the results from Select-Paylocity into a Select-Object cmdlet and excluded some properties before piping them into an Export-CSV cmdlet. We do this because the CData Cmdlets append Connection, Table, and Columns information onto each row object in the result set, and we do not necessarily want that information in our CSV file.

However, this makes it easy to pipe the output of one cmdlet to another. The following is an example of converting a result set to JSON: 

 
PS C:\> $conn  = Connect-Paylocity -InitiateOauth "GETANDREFRESH" -OAuthClientID "YourClientId" -OAuthClientSecret "YourClientSecret" -RSAPublicKey "YourRSAPubKey" -Key "YourKey" -IV "YourIV"
PS C:\> $row = Select-Paylocity -Connection $conn -Table "Employee" -Columns (FirstName, LastName) -Where "EmployeeId = '1234'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Employee",
  "Columns":  [

  ],
  "FirstName":  "MyFirstName",
  "LastName":  "MyLastName"
}

Deleting Data

The following line deletes any records that match the criteria: 

Select-Paylocity -Connection $conn -Table Employee -Where "EmployeeId = '1234'" | Remove-Paylocity

Modifying Data

The cmdlets make data transformation easy as well as data cleansing. The following example loads data from a CSV file into Paylocity, checking first whether a record already exists and needs to be updated instead of inserted. 

Import-Csv -Path C:\MyEmployeeUpdates.csv | %{
  $record = Select-Paylocity -Connection $conn -Table Employee -Where ("EmployeeId = `'"+$_.EmployeeId+"`'")
  if($record){
    Update-Paylocity -Connection $conn -Table Employee -Columns @("FirstName","LastName") -Values @($_.FirstName, $_.LastName) -Where "EmployeeId  = `'$_.EmployeeId`'"
  }else{
    Add-Paylocity -Connection $conn -Table Employee -Columns @("FirstName","LastName") -Values @($_.FirstName, $_.LastName)
  }
}

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060