Import Paylocity Data into Microsoft Power Query

The API Server, when paired with the ADO.NET Provider for Paylocity (or any of 200+ other ADO.NET Providers), enables you to use Web services to connect to and query Paylocity data. This article details how to import an OData feed of Paylocity data into Microsoft Power Query.

Set Up the API Server

Follow the steps below to begin producing secure Paylocity OData services:

Deploy

The API Server runs on your own server. On Windows, you can deploy using the stand-alone server or IIS. On a Java servlet container, drop in the API Server WAR file. See the help documentation for more information and how-tos.

The API Server is also easy to deploy on Microsoft Azure, Amazon EC2, and Heroku.

Connect to Paylocity

After you deploy the API Server and the ADO.NET Provider for Paylocity, provide authentication values and other connection properties needed to connect to Paylocity by clicking Settings -> Connections and adding a new connection in the API Server administration console.

Set the following to establish a connection to Paylocity:

• RSAPublicKey: Set this to the RSA Key associated with your Paylocity, if the RSA Encryption is enabled in the Paylocity account.

  This property is required for executing Insert and Update statements, and it is not required if the feature is disabled.

• UseSandbox: Set to true if you are using sandbox account.
• CustomFieldsCategory: Set this to the Customfields category. This is required when IncludeCustomFields is set to true. The default value for this property is PayrollAndHR.
• Key: The AES symmetric key(base 64 encoded) encrypted with the Paylocity Public Key. It is the key used to encrypt the content.

  Paylocity will decrypt the AES key using RSA decryption.
  It is an optional property if the IV value not provided, The driver will generate a key internally.

• IV: The AES IV (base 64 encoded) used when encrypting the content. It is an optional property if the Key value not provided, The driver will generate an IV internally.

Connect Using OAuth Authentication

You must use OAuth to authenticate with Paylocity. OAuth requires the authenticating user to interact with Paylocity using the browser. For more information, refer to the OAuth section in the Help documentation.

The Pay Entry API

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. The Pay Entry API allows you 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, we have elected not to give it a separate schema, but it may be enabled via the UsePayEntryAPI connection property.

Please be aware that when setting UsePayEntryAPI to true, you may only use the CreatePayEntryImportBatch & MergePayEntryImportBatchgtable stored procedures, the InputTimeEntry table, and the OAuth stored procedures. Attempts to use other features of the product will result in an error. You must also store your OAuthAccessToken separately, which often means setting a different OAuthSettingsLocation when using this connection property.

You can then choose the Paylocity entities you want to allow the API Server access to by clicking Settings -> Resources.

Authorize API Server Users

After determining the OData services you want to produce, authorize users by clicking Settings -> Users. The API Server uses authtoken-based authentication and supports the major authentication schemes. Access can also be restricted based on IP address; by default, only connections to the local machine are allowed. You can authenticate as well as encrypt connections with SSL.

Connect to Paylocity Data from Power Query

Follow the steps below to import tables that can be refreshed on demand:

1. Configure the API Server to use a version of the OData protocol that is recognized by Power Query. In the API Server administration console, click Settings -> Server and change the value of the Default Version property to 3.0.

2. From the ribbon in Excel, click Power Query -> From Other Data Sources -> From OData Feed, and enter the OData URL:

   https://your-server:8032/api.rsc

3. In the next step of the wizard, define authentication credentials and set privacy levels. Select Basic authentication and enter the credentials for a user authorized to make requests. Specify the Username field and enter the user's authtoken in the Password field.

   To change the authentication scheme that Power Query will use, click Power Query -> Data Source Settings. Select the OData feed from the list and then click Edit Credential. Select the privacy level from the menu on the Data Source Settings page.

   

4. You can now access Paylocity data in Power Query. In the Navigator expand the node for the OData feed, right-click a table, and click Edit to open the Query Editor. This will display the table data.