Adding a Connection to Paylocity

To add a connection to Paylocity:

1. In the application console, navigate to the Connections page.
2. At the Add Connections panel, select the icon for the connection you want to add.
3. If the Paylocity icon is not available, click the Add More icon to download and install the Paylocity connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

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:

• CreatePayEntryImportBatch
• MergePayEntryImportBatch
• Input_TimeEntry
• available OAuth 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.

Automatic refresh of the OAuth access token:

To have the Sync App 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 Sync App 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.

This section details a selection of advanced features of the Paylocity Sync App.

User Defined Views

The Sync App allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to Paylocity and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

Logging

See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Client SSL Certificates

The Paylocity Sync App also supports setting client certificates. Set the following to connect using a client certificate.

• SSLClientCert: The name of the certificate store for the client certificate.
• SSLClientCertType: The type of key store containing the TLS/SSL client certificate.
• SSLClientCertPassword: The password for the TLS/SSL client certificate.
• SSLClientCertSubject: The subject of the TLS/SSL client certificate.

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Overview

This section shows the available API objects and provides more information on executing SQL to Paylocity APIs.

Key Features

• The Sync App models Paylocity entities like documents, folders, and groups as relational views, allowing you to write SQL to query Paylocity data.
• Stored procedures allow you to execute operations to Paylocity.
• Live connectivity to these objects means any changes to your Paylocity account are immediately reflected when using the Sync App.

Tables

Tables describes the available tables. Tables are statically defined to model resources such as Earnings, LocalTaxes, and EmployeeDetails.

Views

Views describes the available views. Views are statically defined to model resources such as Employees, CompanyCodes, and CustomFields.

Stored Procedures

Stored Procedures are function-like interfaces to Paylocity. Stored procedures allow you to execute operations to Paylocity, including downloading documents and moving envelopes.

The Sync App models the data in Paylocity as a list of tables in a relational database that can be queried using standard SQL statements.

Paylocity Connector for CData Sync Tables

Name	Description
AdditionalRates	Add/update additional rates
Earnings	Get All Earnings. Delete Earning by Earning Code and Start Date. Add/Update Earning. Get Earnings by Earning Code. Get Earning by Earning Code and Start Date
EmergencyContacts	Add/update emergency contacts
EmployeeBenefitSetup	Add/update employee's benefit setup
EmployeeDetails	Add new employee. Get employee. Update employee
Input_TimeEntry	To create the csv content for the CreatePayEntryImportBatch.TimeEntry using this as a TEMP Table. When the connection to Paylocity is closed, all tables names started with Input are cleared.
LocalTaxes	Get local taxes by tax code. Get all local taxes. Add new local tax. Delete local tax by tax code
NonPrimaryStateTax	Add/update non-primary state tax
PrimaryStateTax	Add/update primary state tax
SensitiveData	Gets employee sensitive data information directly from Web Pay.

Add/update additional rates

Table Specific Information

Select

The Sync App will use the Paylocity API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• EmployeeId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM AdditionalRates WHERE EmployeeId = '123'

Insert

Following is an example of how to inserting into AdditionalRates table. For example:

INSERT INTO AdditionalRates (employeeid, Shift, Job, CostCenter1, CostCenter2, CostCenter3,  EffectiveDate, ChangeReason, RateCode, Rate, RatePer, RateNotes) VALUES ('123', '1', '0000123', '100', '101', '100', '2021-02-09', 'Cost of Living Increase', 'CN', 500, 'week', 'NewRate')

Update

Following is an example of how to Update a AdditionalRates table:

UPDATE AdditionalRates SET CostCenter1 = '100', ratecode = 'CN', rate = 100, rateper = 'hour' WHERE employeeId = '123'

Columns

Name	Type	ReadOnly	References	Description
EmployeeId [KEY]	String	True	Employees.EmployeeId	Id of the Employee.
CostCenter1	String	False		Not required. Valid values must match one of the system coded cost centers available in the Additional Rates Cost Center level 1 drop down. This cell must be in a text format.
CostCenter2	String	False		Not required. Valid values must match one of the system coded cost centers available in the Additional Rates Cost Center level 2 drop down. This cell must be in a text format.
CostCenter3	String	False		Not required. Valid values must match one of the system coded cost centers available in the Additional Rates Cost Center level 3 drop down. This cell must be in a text format.
RatePer	String	False		Required. Valid values are HOUR or WEEK.
Rate	Decimal	False		Required. Enter dollar amount that corresponds to the Per selection.
RateCode	String	False		Required. If populated, must match one of the system coded values available in the Additional Rates Rate Code drop down.
ChangeReason	String	False		Not required. If populated, must match one of the system coded values available in the Additional Rates Change Reason drop down.
EffectiveDate	Date	False		Required. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.
EndCheckDate	Date	False		Not required. Must match one of the system coded check dates available in the Additional Rates End Check Date drop down. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.
RateNotes	String	False		Not required.
Job	String	False		Not required. If populated, must match one of the system coded values available in the Additional Rates Job drop down.
Shift	String	False		Not required. If populated, must match one of the system coded values available in the Additional Rates Shift drop down.
CompanyId	String	True		Id of the Company.

Get All Earnings. Delete Earning by Earning Code and Start Date. Add/Update Earning. Get Earnings by Earning Code. Get Earning by Earning Code and Start Date

Table Specific Information

Select

The Sync App will use the Paylocity API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• EmployeeId supports the '=' comparison.
• EarningCode supports the '=' comparison.
• StartDate supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM Earnings WHERE EmployeeId = '123'

SELECT * FROM Earnings WHERE EmployeeId = '123' AND EarningCode = '1098'

SELECT * FROM Earnings WHERE EmployeeId = '123' AND EarningCode = '1098' AND StartDate = '2019-04-01'

Insert

Following is an example of how to inserting into Earnings table. For example:

INSERT INTO Earnings (EmployeeId, EarningCode, StartDate) VALUES ('999621027', '1098', '2020-02-10')

Update

Following is an example of how to update a Earnings table:

UPDATE Earnings SET EarningCode = '1098', StartDate = '2020-02-09' WHERE employeeId = '999621027'

Delete

Following is an example of how to delete earnings in the Earnings table:

DELETE FROM Earnings WHERE employeeId = '123' AND EarningCode = '1' AND StartDate = '2021-01-01'

Columns

Name	Type	ReadOnly	References	Description
EmployeeId [KEY]	String	True	Employees.EmployeeId	Id of the Employee.
PaidTowardsGoal	Decimal	False		Amount already paid to employee toward goal. Decimal(12,2)
MiscellaneousInfo	String	False		Information to print on the check stub if agency is set up for this earning.
EffectiveDate	Date	False		Date earning is active. Defaulted to run date or check date based on Company setup. Common formats are MM-DD-CCYY, CCYY-MM-DD.
CostCenter1	String	False		Cost Center associated with earning. Must match Company setup.
CostCenter2	String	False		Cost Center associated with earning. Must match Company setup.
CostCenter3	String	False		Cost Center associated with earning. Must match Company setup.
AnnualMaximum	Decimal	False		Year to Date dollar amount not to be exceeded for an earning in the calendar year. Used only with company driven maximums. Decimal(12,2)
IsSelfInsured	Bool	False		Used for ACA. If not entered, defaulted to Company earning setup.
Rate	Decimal	False		Rate is used in conjunction with the hoursOrUnits field. Decimal(12,2)
Frequency	String	False		Needed if earning is applied differently from the payroll frequency (one time earning for example).
EndDate	Date	False		Stop date of an earning. Common formats are MM-DD-CCYY, CCYY-MM-DD.
HoursOrUnits	Decimal	False		The value is used in conjunction with the Rate field. When entering Group Term Life Insurance (GTL), it should contain the full amount of the group term life insurance policy. Decimal(12,2)
EarningCode	String	False		Earning code. Must match Company setup.
RateCode	String	False		Rate Code applies to additional pay rates entered for an employee. Must match Company setup.
Goal	Decimal	False		Dollar amount. The employee earning will stop when the goal amount is reached. Decimal(12,2)
CalculationCode	String	False		Defines how earnings are calculated. Common values are *% (percentage of gross), flat (flat dollar amount)*. Defaulted to the Company setup calcCode for earning.
StartDate	Date	False		Start date of an earning based on payroll calendar. Common formats are MM-DD-CCYY, CCYY-MM-DD.
PayPeriodMaximum	Decimal	False		Maximum amount of the earning on a single paycheck. Decimal(12,2)
JobCode	String	False		Job code associated with earnings. Must match Company setup.
Amount	Decimal	False		Value that matches CalculationCode to add to gross wages. For percentage (%), enter whole number (10 = 10%). Decimal(12,2)
Agency	String	False		Third-party agency associated with earning. Must match Company setup.
PayPeriodMinimum	Decimal	False		Minimum amount of the earning on a single paycheck. Decimal(12,2)
CompanyId	String	True		Id of the Company.

Add/update emergency contacts

Table Specific Information

Select

The Sync App will use the Paylocity API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• EmployeeId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM EmergencyContacts WHERE EmployeeId = '123'

Insert

Following is an example of how to inserting into EmergencyContacts table. For example:

INSERT INTO EmergencyContacts (EmployeeId, firstName, lastName, primaryPhone, priority, relationship, MobilePhone, Zip, Notes, Address1, City, County) VALUES ('123', 'firstName', 'lastName', 'M', 'P', 'Brother', 9876543210, 75791, 'Test Notes', 'Address Line1', 'NY', 'USA')

Update

Following is an example of how to Update a EmergencyContacts table:

UPDATE EmergencyContacts SET WorkPhone = '9876543210', firstName = 'firstName', lastName = 'lastName', primaryPhone = 'W', priority = 'S', relationship = 'brother' WHERE employeeId = '999621027'

Columns

Name	Type	ReadOnly	References	Description
EmployeeId [KEY]	String	True	Employees.EmployeeId	Id of the Employee.
FirstName	String	False		Required. Contact first name.
LastName	String	False		Required. Contact last name.
MobilePhone	String	False		Contact Mobile Phone.Valid phone format *(###) #######* or *######-####* or *### ### ####* or *##########* or, if international, starts with *+#*, only spaces and digits allowed.
Zip	String	False		Postal code. If U.S. address, must be a valid zip code.
Priority	String	False		Required. Contact priority. Valid values are *P* (Primary) or *S* (Secondary).
Notes	String	False		Notes.
Address1	String	False		1st address line.
Pager	String	False		Valid phone format *(###) #######* or *######-####* or *### ### ####* or *##########* or, if international, starts with *+#*, only spaces and digits allowed.
WorkPhone	String	False		Contact Work Phone. Valid phone format *(###) #######* or *######-####* or *### ### ####* or *##########* or, if international, starts with *+#*, only spaces and digits allowed.
PrimaryPhone	String	False		Required. Contact primary phone type. Must match Company setup. Valid values are H (Home), M (Mobile), P (Pager), W (Work)
Address2	String	False		2nd address line.
HomePhone	String	False		Contact Home Phone. Valid phone format *(###) #######* or *######-####* or *### ### ####* or *##########* or, if international, starts with *+#*, only spaces and digits allowed.
WorkExtension	String	False		Work Extension.
SyncEmployeeInfo	Bool	False		Valid values are *true* or *false*.
City	String	False		City.
Country	String	False		County.
Relationship	String	False		Required. Contact relationship. Must match Company setup. Common values are Spouse, Mother, Father.
County	String	False		Country. Must be a valid 3 character country code. Common values are *USA* (United States), *CAN* (Canada).
Email	String	False		Contact email. Must be valid email address format.
State	String	False		State or Province. If U.S. address, must be valid 2 character state code. Common values are *IL* (Illinois), *CA* (California).
CompanyId	String	True		Id of the Company.

Add/update employee's benefit setup

Table Specific Information

Select

The Sync App will use the Paylocity API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• EmployeeId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM EmployeeBenefitSetup WHERE EmployeeId = '123'

Insert

Following is an example of how to inserting into EmployeeBenefitSetup table. For example:

INSERT INTO EmployeeBenefitSetup (EmployeeId, BenefitSalary, BenefitClass, BenefitSalaryEffectiveDate, BenefitClassEffectiveDate) VALUES ('123', '250', 'FULL', '2021-02-10', '2021-02-10')

Update

Following is an example of how to Update a EmployeeBenefitSetup table:

UPDATE EmployeeBenefitSetup SET BenefitSalary = '250', BenefitClass = 'FULL', BenefitClassEffectiveDate = '2021-02-10', BenefitSalaryEffectiveDate = '2021-02-10' WHERE EmployeeId = '123'

Columns

Name	Type	ReadOnly	References	Description
EmployeeId [KEY]	String	True	Employees.EmployeeId	Id of the Employee.
BenefitSalary	Decimal	False		Salary used to configure benefits.Decimal(12,2)
BenefitClass	String	False		Benefit Class code. Values are configured in Web Pay Company > Setup > Benefits > Classes.
BenefitSalaryEffectiveDate	Date	False		Date when Benefit Salary takes effect. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.
DoNotApplyAdministrativePeriod	Bool	False		Applicable only for HR Enhanced clients and Benefit Classes with ACA Employment Type of Full Time.
IsMeasureAcaEligibility	Bool	False		Only valid for HR Enhanced clients and Benefit Classes that are ACA Employment Type of Full Time.
BenefitClassEffectiveDate	Date	False		Date when Benefit Class takes effect. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.
CompanyId	String	True		Id of the Company.

Add new employee. Get employee. Update employee

Table Specific Information

Select

The Sync App will use the Paylocity API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• EmployeeId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM Employee WHERE EmployeeId = '123'

Insert

Following is an example of how to inserting into Employee table with aggregate column(Optional). For example:

INSERT INTO AdditionalRates#TEMP (Shift, Job, CostCenter1, CostCenter2, CostCenter3,  EffectiveDate, ChangeReason, RateCode, Rate, RatePer, RateNotes) VALUES ( '1', '0000123', '100', '101', '100', '2021-02-09', 'Cost of Living Increase', 'CN', 500, 'week', 'NewRate')

INSERT INTO Employee (FirstName, LastName, MiddleName, Gender, MaritalStatus, PreferredName, PriorLastName, Salutation, Currency, BirthDate, CompanyFEIN, CompanyName, DepartmentPositionChangeReason, DepartmentPositionCostCenter1, DepartmentPositionCostCenter2, DepartmentPositionCostCenter3, DepartmentPositionEffectiveDate, DepartmentPositionEmployeeType, DepartmentPositionIsMinimumWageExempt, DepartmentPositionIsOvertimeExempt, DepartmentPositionIsSupervisorReviewer, DepartmentPositionIsUnionDuesCollected, DepartmentPositionIsUnionInitiationCollected, DepartmentPositionJobTitle, FederalTaxAmount, FederalTaxExemptions, FederalTaxFilingStatus, FederalTaxPercentage, FederalTaxTaxCalculationCode, FederalTaxW4FormYear, HomeAddressAddress1, HomeAddressAddress2, HomeAddressCity, HomeAddressCountry, HomeAddressEmailAddress, HomeAddressMobilePhone, HomeAddressPhone, HomeAddressPostalCode, HomeAddressState, NonPrimaryStateTaxFilingStatus, NonPrimaryStateTaxHigherRate, NonPrimaryStateTaxOtherIncomeAmount, NonPrimaryStateTaxReciprocityCode, NonPrimaryStateTaxtaxCode, PrimaryPayRateAnnualSalary, PrimaryPayRateBaseRate, PrimaryPayRateChangeReason, PrimaryPayRateDefaultHours, PrimaryPayRateEffectiveDate, PrimaryPayRatePayFrequency, PrimaryPayRatePayType, PrimaryStateTaxAmount, PrimaryStateTaxExemptions, PrimaryStateTaxExemptions2, PrimaryStateTaxPercentage, PrimaryStateTaxFilingStatus, PrimaryStateTaxTaxCalculationCode, PrimaryStateTaxTaxCode, PrimaryStateTaxW4FormYear, StatusAdjustedSeniorityDate, StatusChangeReason, StatusEffectiveDate, StatusEmployeeStatus, StatusHireDate, StatusIsEligibleForRehire, TaxSetupSuiState, TaxSetupTaxForm, WorkAddressAddress1, WorkAddressCity, WorkAddressCountry, WorkAddressMobilePhone, WorkAddressPostalCode, WorkAddressState, suffix, IsSmoker, AdditionalRate) VALUES ('TestFirstName1', 'TestLastName', 'TestMiddleName', 'M', 'S', 'Test1', 'TestPrior', 'Mr', 'USD', '1985-11-01', '00-5554442', 'SusanW  Z2222 Clone', 'New Hire', '100', '101', '100', '2021-02-01', 'RFT', false, true, false, false, false, 'Clinical Psychologist', '1', '0', 'M', '1', 'AFAP', '2021', 'TestAddr1', 'TestAddr2', 'NewJordi', 'USA', '[email protected]', '(961)062-1234', '(588)148-1234', '75791', 'NY', 'M', 'false', 0, 'Both', 'NY', '1000', '100', 'New Hire', '8', '2021-02-01', 'M', 'Salary', '1', '0', '0', 5, 'S', 'AFAP', 'AZ', '2019', '2021-02-01', 'New Hire', '2021-02-01', 'A', '2021-02-01', true, 'NY', 'W2', '78FraleighStreet', 'RedHook', 'USA', '(276)369-1234', '12571', 'NY', 'Jr.', true, 'AdditionalRates#TEMP')

Update

Following is an example of how to Update a Employee table:

UPDATE Employee SET PriorLastName = 'PriorLastName', [CF_PayrollAndHR_Full Computer Access] = true WHERE EmployeeId = '123'

Columns

Name	Type	ReadOnly	References	Description
EmployeeId [KEY]	String	False		Leave blank to have Web Pay automatically assign the next available employee ID.
PreferredName	String	False		Employee preferred display name.
FirstName	String	False		Employee first name.
LastName	String	False		Employee last name.
MiddleName	String	False		Employee middle name.
WebTimeChargeRate	Decimal	False		Rate to be charged to third party for time worked by the employee. It is most commonly referenced in the Cost Center Charge, Cost Center Charge vs. Cost Reports, and the Customer Invoice time and attendance reports. Decimal (12,2)
WebTimeIsTimeLaborEnabled	Bool	False		If set to true, changes to employee data will be reflected in Web Time.
WebTimeBadgeNumber	String	False		Badge number usually issued for time and attendance system use.
WorkAddressCountry	String	False		Country.
WorkAddressAddress1	String	False		1st address line.
WorkAddressPager	String	False		Employee pager number.
WorkAddressState	String	False		State or province.
WorkAddressMailStop	String	False		Employee mail stop.
WorkAddressEmailAddress	String	False		Email.
WorkAddressCity	String	False		City.
WorkAddressPhoneExtension	String	False		Phone number extension.
WorkAddressLocation	String	False		Work Location name.
WorkAddressPostalCode	String	False		Postal code.
WorkAddressCounty	String	False		County.
WorkAddressAddress2	String	False		2nd address line.
WorkAddressMobilePhone	String	False		Mobile phone number.
WorkAddressPhone	String	False		Phone number.
Currency	String	False		Employee is paid in this currency.
EmergencyContacts	String	False		Add or update Emergency Contacts.
OwnerPercent	Decimal	False		Percentage of employee's ownership in the company, entered as a whole number. Decimal (12,2)
CustomTextFields	String	False		Up to 8 custom fields of text type value.
NonPrimaryStateTaxExemptions	Decimal	False		State tax exemptions value.Decimal (12,2)
NonPrimaryStateTaxOtherIncomeAmount	Decimal	False		Box 4(a) on form W4 (year 2020 or later): Other income amount. Decimal (12,2)
NonPrimaryStateTaxAmount	Decimal	False		State tax code.
NonPrimaryStateTaxDependentsAmount	Decimal	False		Box 3 on form W4 (year 2020 or later): Total dependents amount. Decimal (12,2)
NonPrimaryStateTaxDeductionsAmount	Decimal	False		Box 4(b) on form W4 (year 2020 or later): Deductions amount. Decimal (12,2)
NonPrimaryStateTaxTaxCalculationCode	String	False		Tax calculation code. Common values are *F* (Flat), *P* (Percentage), *FDFP* (Flat Dollar Amount plus Fixed Percentage).
NonPrimaryStateTaxPercentage	Decimal	False		State Tax percentage. Decimal (12,2)
NonPrimaryStateTaxW4FormYear	Int	False		The state W4 form year Integer
NonPrimaryStateTaxExemptions2	Decimal	False		State tax exemptions 2 value.Decimal (12,2)
NonPrimaryStateTaxFilingStatus	String	False		Employee state tax filing status. Common values are *S* (Single), *M* (Married).
NonPrimaryStateTaxHigherRate	Bool	False		Box 2(c) on form W4 (year 2020 or later): Multiple Jobs or Spouse Works. Boolean
NonPrimaryStateTaxTaxCode	String	False		State tax code.
NonPrimaryStateTaxReciprocityCode	String	False		Non-primary state tax reciprocity code.
NonPrimaryStateTaxSpecialCheckCalc	String	False		Supplemental check calculation code. Common values are *Blocked* (Taxes blocked on Supplemental checks), *Supp* (Use supplemental Tax Rate-Code).
DepartmentPositionPositionCode	String	False		Employee position code. Must match Company setup.
DepartmentPositionShift	String	False		Employee work shift.
DepartmentPositionCostCenter1	String	False		Employer defined location, like *branch, division, department*, etc. Must match Company setup.
DepartmentPositionIsSupervisorReviewer	Bool	False		Indicates if employee is a supervisor or reviewer.
DepartmentPositionIsUnionDuesCollected	Bool	False		Indicates if union dues are collected.
DepartmentPositionIsMinimumWageExempt	Bool	False		Indicates if employee is exempt from minimum wage.
DepartmentPositionUnionCode	String	False		Employee union code. Must match Company setup.
DepartmentPositionSupervisorCompanyNumber	String	False		Supervisor's company number. Defaults to employee company number.
DepartmentPositionJobTitle	String	False		Employee current job title.
DepartmentPositionUnionPosition	String	False		Employee union position. Must match Company setup.
DepartmentPositionCostCenter2	String	False		Employer defined location, like *branch, division, department*, etc. Must match Company setup.
DepartmentPositionIsOvertimeExempt	Bool	False		Indicates if employee is exempt from overtime.
DepartmentPositionEffectiveDate	Date	False		The date the position takes effect. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.
DepartmentPositionCostCenter3	String	False		Employer defined location, like *branch, division, department*, etc. Must match Company setup.
DepartmentPositionEqualEmploymentOpportunityClass	String	False		Values are configured in Company > Setup > HR > EEO Classes.
DepartmentPositionClockBadgeNumber	String	False		Employee clock badge number. Defaults to employeeId.
DepartmentPositionReviewerEmployeeId	String	False		Employee id of the reviewer.
DepartmentPositionTipped	String	False		Indicates if employee receives tips.
DepartmentPositionReviewerCompanyNumber	String	False		Company number of reviewer.
DepartmentPositionIsUnionInitiationCollected	Bool	False		Indicates if initiations fees are collected.
DepartmentPositionSupervisorEmployeeId	String	False		EmployeeId of the supervisor.
DepartmentPositionChangeReason	String	False		Employee department/position change reason. Must match Company setup.
DepartmentPositionEmployeeType	String	False		Employee current employment type. Common values *RFT (Regular Full Time), RPT (Regular Part Time), SNL (Seasonal), TFT (Temporary Full Time), TPT (Temporary Part Time)*.
DepartmentPositionWorkersCompensation	String	False		Employee worker compensation code. Must match Company setup.
DepartmentPositionUnionAffiliationDate	Date	False		Employee union affiliation effective date. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.
DepartmentPositionPayGroup	String	False		Employee pay group. Must match Company setup.
DisabilityDescription	String	False		Indicates if employee has disability status.
Ethnicity	String	False		Employee ethnicity.
AdditionalRate	String	False		Add Additional Rates.
CustomBooleanFields	String	False		Up to 8 custom fields of boolean (checkbox) type value.
AdditionalDirectDeposit	String	False		Add up to 19 direct deposit accounts in addition to the main direct deposit account. IMPORTANT: A direct deposit update will remove ALL existing main and additional direct deposit information in WebPay and replace with information provided on the request. GET API will not return direct deposit data.
CustomDropDownFields	String	False		Up to 8 custom fields of the dropdown type value.
CompanyFEIN	String	False		Company FEIN as defined in Web Pay, applicable with GET requests only.
Suffix	String	False		Employee name suffix. Common values are *Jr, Sr, II*.
MainDirectDepositNameOnAccount	String	False		Name on the bank account. Defaults to employee's name.
MainDirectDepositRoutingNumber	String	False		ABA Transit Routing Number, entered without dashes or spaces.
MainDirectDepositBlockSpecial	Bool	False		Indicates if direct deposit should be blocked when special check types such as Bonus are processed.
MainDirectDepositIsSkipPreNote	Bool	False		Indicates if account will not pre-note.
MainDirectDepositAccountNumber	String	False		Account number, entered without special characters and spaces.
MainDirectDepositAccountType	String	False		Account type. Valid values are *C* (Checking), *S* (Saving), *P* (Pay Card).
MainDirectDepositPreNoteDate	Date	False		Date to end the pre-note of the account. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.
WorkEligibilityIsSsnVerified	Bool	False		Indicates if employee SSN is verified.
WorkEligibilityForeignPassportNumber	String	False		Foreign Passport Number.
WorkEligibilityIsI9Verified	Bool	False		Indicates if employee I9 is verified.
WorkEligibilityAlienOrAdmissionDocumentNumber	String	False		Employee USCIS or Admission Number. Must be 7-10 characters and may begin with an 'A'
WorkEligibilityI9Notes	String	False		Notes regarding employee's i9.
WorkEligibilityVisaType	String	False		Employee Visa type. Must match one of the system coded values.
WorkEligibilityWorkAuthorization	String	False		Employee work authorization. Must match one of the system coded values.
WorkEligibilityI9DateVerified	String	False		Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.
WorkEligibilitySsnDateVerified	String	False		The date of employer verification of employee SSN. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.
WorkEligibilityCountryOfIssuance	String	False		If Foreign Passport number is provided, provide its country of issuance. Must match Paylocity setup.
WorkEligibilityAttestedDate	Date	False		The date the I-9 Verification form was attested by Employer or Authorized representative. Common formats are *MM-DD-CCYY, CCYY-MM-DD*.
WorkEligibilityI94AdmissionNumber	String	False		Form I-94 admission number. Must be 11 numeric characters
WorkEligibilityWorkUntil	String	False		End date of employee work eligibility. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.
WorkEligibilitySsnNotes	String	False		Notes regarding employee's SSN.
TaxSetupSitwExemptReason	String	False		Reason code for SITW exemption. Common values are *SE* (Statutory employee), *CR* (clergy/Religious).
TaxSetupSuiExemptReason	String	False		Reason code for SUI exemption. Common values are *SE* (Statutory employee), *CR* (clergy/Religious).
TaxSetupSuiState	String	False		Employee SUI (State Unemployment Insurance) state.
TaxSetupIsStatutory	Bool	False		Indicates if employee is statutory.
TaxSetupTaxDistributionCode1099R	String	False		Employee 1099R distribution code. Common values are *7* (Normal Distribution), *F* (Charitable Gift Annuity).
TaxSetupMedExemptReason	String	False		Reason code for Medicare exemption. Common values are *501* (5019c)(3) Organization), *IC* (Independent Contractor).
TaxSetupFutaExemptReason	String	False		Reason code for FUTA exemption. Common values are *501* (5019c)(3) Organization), *IC* (Independent Contractor).
TaxSetupSitwExemptNotes	String	False		Notes for SITW exemption.
TaxSetupMedExemptNotes	String	False		Notes for Medicare exemption.
TaxSetupSsExemptNotes	String	False		Notes for Social Security exemption.
TaxSetupIsEmployee943	Bool	False		Indicates if employee in agriculture or farming.
TaxSetupIsPension	Bool	False		Indicates if employee is eligible for pension.
TaxSetupSuiExemptNotes	String	False		Notes for SUI exemption.
TaxSetupFitwExemptNotes	String	False		Notes for FITW exemption.
TaxSetupFitwExemptReason	String	False		Reason code for FITW exemption. Common values are *SE* (Statutory employee), *CR* (clergy/Religious).
TaxSetupSsExemptReason	String	False		Reason code for Social Security exemption. Common values are *SE* (Statutory employee), *CR* (clergy/Religious).
TaxSetupTaxForm	String	False		Employee tax form for reporting income. Valid values are *W2, 1099M, 1099R*. Default is W2.
TaxSetupFutaExemptNotes	String	False		Notes for FUTA exemption.
CustomDateFields	String	False		Up to 8 custom fields of the date type value.
FederalTaxHigherRate	Bool	False		Box 2(c) on form W4 (year 2020 or later): Multiple Jobs or Spouse Works. Boolean
FederalTaxDependentsAmount	Decimal	False		Box 3 on form W4 (year 2020 or later): Total dependents amount. Decimal (12,2)
FederalTaxAmount	Decimal	False		Tax amount. Decimal (12,2)
FederalTaxTaxCalculationCode	String	False		Tax calculation code. Common values are *F* (Flat), *P* (Percentage), *FDFP* (Flat Dollar Amount plus Fixed Percentage).
FederalTaxDeductionsAmount	Decimal	False		Box 4(b) on form W4 (year 2020 or later): Deductions amount. Decimal (12,2)
FederalTaxFilingStatus	String	False		Employee federal filing status. Common values are *S* (Single), *M* (Married).
FederalTaxPercentage	Decimal	False		Tax percentage. Decimal (12,2)
FederalTaxOtherIncomeAmount	Decimal	False		Box 4(a) on form W4 (year 2020 or later): Other income amount. Decimal (12,2)
FederalTaxW4FormYear	Int	False		The federal W4 form year Integer
FederalTaxExemptions	Decimal	False		Federal tax exemptions value. Decimal (12,2)
MaritalStatus	String	False		Employee marital status. Common values *D (Divorced), M (Married), S (Single), W (Widowed)*.
Ssn	String	False		Employee social security number. Leave it blank if valid social security number not available.
BenefitSetupBenefitClassEffectiveDate	Date	False		Date when Benefit Class takes effect. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.
BenefitSetupBenefitClass	String	False		Benefit Class code. Values are configured in Web Pay Company > Setup > Benefits > Classes.
BenefitSetupBenefitSalaryEffectiveDate	Date	False		Date when Benefit Salary takes effect. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.
BenefitSetupBenefitSalary	Decimal	False		Salary used to configure benefits.Decimal(12,2)
BenefitSetupDoNotApplyAdministrativePeriod	Bool	False		Applicable only for HR Enhanced clients and Benefit Classes with ACA Employment Type of Full Time.
BenefitSetupIsMeasureAcaEligibility	Bool	False		Only valid for HR Enhanced clients and Benefit Classes that are ACA Employment Type of Full Time.
BirthDate	Date	False		Employee birthdate. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.
PrimaryStateTaxExemptions	Decimal	False		State tax exemptions value.Decimal (12,2)
PrimaryStateTaxFilingStatus	String	False		Employee state tax filing status. Common values are *S* (Single), *M* (Married).
PrimaryStateTaxAmount	Decimal	False		State tax code.
PrimaryStateTaxSpecialCheckCalc	String	False		Supplemental check calculation code. Common values are *Blocked* (Taxes blocked on Supplemental checks), *Supp* (Use supplemental Tax Rate-Code).
PrimaryStateTaxTaxCalculationCode	String	False		Tax calculation code. Common values are *F* (Flat), *P* (Percentage), *FDFP* (Flat Dollar Amount plus Fixed Percentage).
PrimaryStateTaxW4FormYear	Int	False		The state W4 form year Integer
PrimaryStateTaxHigherRate	Bool	False		Box 2(c) on form W4 (year 2020 or later): Multiple Jobs or Spouse Works. Boolean
PrimaryStateTaxPercentage	Decimal	False		State Tax percentage. Decimal (12,2)
PrimaryStateTaxTaxCode	String	False		State tax code.
PrimaryStateTaxExemptions2	Decimal	False		State tax exemptions 2 value.Decimal (12,2)
PrimaryStateTaxOtherIncomeAmount	Decimal	False		Box 4(a) on form W4 (year 2020 or later): Other income amount. Decimal (12,2)
PrimaryStateTaxDeductionsAmount	Decimal	False		Box 4(b) on form W4 (year 2020 or later): Deductions amount. Decimal (12,2)
PrimaryStateTaxDependentsAmount	Decimal	False		Box 3 on form W4 (year 2020 or later): Total dependents amount. Decimal (12,2)
LocalTax	String	False		Add, update, or delete local tax code, filing status, and exemptions including PA-PSD taxes.
Gender	String	False		Employee gender. Common values *M* (Male), *F* (Female).
StatusChangeReason	String	False		Employee status change reason. Must match Company setup.
StatusAdjustedSeniorityDate	Date	False		Adjusted seniority date. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.
StatusEffectiveDate	Date	False		Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.
StatusHireDate	Date	False		Employee hired date. Updates to hire date are not allowed and will be ignored. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.
StatusEmployeeStatus	String	False		Employee current work status. Common values are *A* (Active), *L* (Leave of Absence), *T* (Terminated).
StatusIsEligibleForRehire	Bool	False		Indicates if employee eligible for rehire.
StatusReHireDate	Date	False		Rehire date if employee is rehired. Updates to re-hire date are not allowed and will be ignored. Common formats are *MM-DD-CCYY, CCYY-MM-DD*.
HomeAddressMobilePhone	String	False		Mobile phone number.
HomeAddressAddress1	String	False		1st address line.
HomeAddressPostalCode	String	False		Postal code.
HomeAddressState	String	False		State or province.
HomeAddressCounty	String	False		County.
HomeAddressAddress2	String	False		2nd address line.
HomeAddressEmailAddress	String	False		Email.
HomeAddressPhone	String	False		Phone number.
HomeAddressCity	String	False		City.
HomeAddressCountry	String	False		Country.
PriorLastName	String	False		Prior last name if applicable.
VeteranDescription	String	False		Indicates if employee is a veteran.
IsSmoker	Bool	False		Indicates if employee is a smoker.
Salutation	String	False		Employee preferred salutation.
IsHighlyCompensated	Bool	False		Indicates if employee meets the highly compensated employee criteria.
CustomNumberFields	String	False		Up to 8 custom fields of numeric type value.
PrimaryPayRateSalary	Decimal	False		Employee gross salary per pay period used with payType Salary.Decimal (12,2)
PrimaryPayRateBeginCheckDate	Date	False		The date of the first check on which the new pay rate will appear. This value is only applicable when updating an existing employee. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.
PrimaryPayRatePayRateNote	String	False		Pay rate notes regarding employee.
PrimaryPayRateEffectiveDate	Date	False		The date the employee's pay rate takes effect. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.
PrimaryPayRatePayType	String	False		Employee pay type (rate code). Valid values are *Hourly* or *Salary*.
PrimaryPayRateDefaultHours	Decimal	False		Employee default hours consistently worked. If autoPayType is set to D, employee will be paid hourly base rate for the defaultHours. Decimal (12,2)
PrimaryPayRateAnnualSalary	Decimal	False		Employee annual salary.Decimal (12,2)
PrimaryPayRateChangeReason	String	False		Pay rate change reason.
PrimaryPayRatePayGrade	String	False		Employee pay grade. Must match Company setup.
PrimaryPayRateIsAutoPay	Bool	False		If set to *True*, employee will be paid automatically using deafultHours.
PrimaryPayRateBaseRate	Decimal	False		Employee base rate, used for Hourly employees. Decimal (12,2)
PrimaryPayRateRatePer	String	False		Employee base rate frequency used with payType Hourly. Common values are *Hour, Week*. Default is Hour.
PrimaryPayRatePayFrequency	String	False		Employee current pay frequency. Common values are *A (Annual), B (Bi-Weekly), D (Daily), M (Monthly), S (Semi-Monthly), Q (Quarterly), W (Weekly)*.
CompanyName	String	False		Company name as defined in Web Pay, applicable with GET requests only.
CompanyId	String	True		Id of the Company.

To create the csv content for the CreatePayEntryImportBatch.TimeEntry using this as a TEMP Table. When the connection to Paylocity is closed, all tables names started with Input are cleared.

Columns

Name	Type	ReadOnly	References	Description
EmployeeId	String	False		Id of the Employee
Det	String	False		Identifies the type of record being imported. Use E for earning, D for deduction, or A for accrual balances.
DetCode	String	False		The earning or benefit code. This must be a code currently defined for the company.
Hours	Double	False		The number of hours worked by the employee or the used accrual hours.
Amount	Integer	False		The dollar amount to pay the employee or the available accrual hours. If an amount is entered, any information entered in the hours, rate, and rateCode fields will be ignored.
TempRate	String	False		The employee's pay rate. If no rate is entered, the system will use the employee's base rate.
RateCode	String	False		The company defined rate code used for paying the employee. If a rate code is entered, the system will ignore the value in the rate field.
CostCenter1	String	False		Use this field to enter an override value for the first level cost center charged by the employee.
CostCenter2	String	False		Use this field to enter an override value for the second level cost center charged by the employee.
CostCenter3	String	False		Use this field to enter an override value for the third level cost center charged by the employee. If entering a value for CC3, also enter values for CC1 and CC2.
JobCode	String	False		This field is used to enter an override company defined job code to be charged by the employee.
Shift	String	False		This field is used to enter an override company defined shift code to be charged by the employee.
BeginDate	String	False		Begin Date associated with this line item.
EndDate	String	False		End Date associated with this line item.
WorkersCompCode	String	False		The company defined workers comp code for the work performed by the employee.
TCode1	String	False		Not used unless directed by service bureau (State override). When used the state override entered must be different than the employees home tax code setup otherwise this will result in blank check data.
TCode2	String	False		Not used unless directed by service bureau (Local 1 override). When used the state override entered must be different than the employees home tax code setup otherwise this will result in blank check data.
TCode3	String	False		Not used unless directed by service bureau (Local 2 override). When used the state override entered must be different than the employees home tax code setup otherwise this will result in blank check data.
TCode4	String	False		Not used unless directed by service bureau (Do not use).
Sequence	String	False		Use this field to indicate multiple checks.
CheckType	String	False		Use this field to indicate an override Check Type.
CheckNumber	String	False		Use this field to indicate an override check Number. It is only valid when Check Type is 'Manual'. Check number for regular checks is assigned during processing.

Get local taxes by tax code. Get all local taxes. Add new local tax. Delete local tax by tax code

Table Specific Information

Select

The Sync App will use the Paylocity API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• EmployeeId supports the '=' comparison.
• TaxCode supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM LocalTaxes WHERE EmployeeId = '123'

SELECT * FROM LocalTaxes WHERE EmployeeId = '123' AND TaxCode = 'AL-BIR1'

Insert

Following is an example of how to inserting into LocalTaxes table. For example:

INSERT INTO LocalTaxes (EmployeeId, TaxCode, FilingStatus) VALUES ('999621027', 'AL-BIR1', 'N/A')

Delete

Following is an example of how to Delete LocalTaxes from the table:

DELETE FROM LocalTaxes WHERE employeeId = '123' AND TaxCode = 'AL-BIR1'

Columns

Name	Type	ReadOnly	References	Description
EmployeeId [KEY]	String	True	Employees.EmployeeId	Id of the Employee.
Exemptions	Decimal	False		Local tax exemptions value.Decimal (12,2)
Exemptions2	Decimal	False		Local tax exemptions 2 value.Decimal (12,2)
FilingStatus	String	False		Employee local tax filing status. Must match specific local tax setup.
WorkPSD	String	False		Work location PSD. Must match Company setup.
ResidentPSD	String	False		Resident PSD (political subdivision code) applicable in PA. Must match Company setup.
TaxCode	String	False		Local tax code.
CompanyId	String	True		Id of the Company.

Add/update non-primary state tax

Table Specific Information

Select

The Sync App will use the Paylocity API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• EmployeeId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM NonPrimaryStateTax WHERE EmployeeId = '123'

Insert

Following is an example of how to inserting into Non-PrimaryStateTax table. For example:

INSERT INTO [NonPrimaryStateTax] (Employeeid, TaxCalculationCode, Amount, TaxCode, ReciprocityCode, FilingStatus, W4FormYear, Percentage, Exemptions) VALUES ('123', 'AFAP', 50, 'NY', 'Both', 'M', 2019, 1.5, 5)

Update

Following is an example of how to Update a Non-PrimaryStateTax table:

UPDATE [NonPrimaryStateTax] SET Percentage = 2.5, Exemptions = 10 WHERE employeeId = '123'

Columns

Name	Type	ReadOnly	References	Description
EmployeeId [KEY]	String	True	Employees.EmployeeId	Id of the Employee.
TaxCalculationCode	String	False		Tax calculation code. Common values are *F* (Flat), *P* (Percentage), *FDFP* (Flat Dollar Amount plus Fixed Percentage).
Amount	Decimal	False		State tax code.
TaxCode	String	False		State tax code.
DeductionsAmount	Decimal	False		Box 4(b) on form W4 (year 2020 or later): Deductions amount. Decimal (12,2)
Exemptions2	Decimal	False		State tax exemptions 2 value.Decimal (12,2)
HigherRate	Bool	False		Box 2(c) on form W4 (year 2020 or later): Multiple Jobs or Spouse Works. Boolean
OtherIncomeAmount	Decimal	False		Box 4(a) on form W4 (year 2020 or later): Other income amount. Decimal (12,2)
DependentsAmount	Decimal	False		Box 3 on form W4 (year 2020 or later): Total dependents amount. Decimal (12,2)
ReciprocityCode	String	False		Non-primary state tax reciprocity code.
FilingStatus	String	False		Employee state tax filing status. Common values are *S* (Single), *M* (Married).
SpecialCheckCalc	String	False		Supplemental check calculation code. Common values are *Blocked* (Taxes blocked on Supplemental checks), *Supp* (Use supplemental Tax Rate-Code).
W4FormYear	Int	False		The state W4 form year Integer
Percentage	Decimal	False		State Tax percentage. Decimal (12,2)
Exemptions	Decimal	False		State tax exemptions value.Decimal (12,2)
CompanyId	String	True		Id of the Company.

Add/update primary state tax

Table Specific Information

Select

The Sync App will use the Paylocity API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• EmployeeId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM PrimaryStateTax WHERE EmployeeId = '123'

Insert

Following is an example of how to inserting into PrimaryStateTax table. For example:

INSERT INTO PrimaryStateTax (Employeeid, FilingStatus, TaxCalculationCode, Exemptions, Exemptions2, Percentage, W4FormYear, TaxCode, Amount) VALUES ('999621027', 'MS', 'AFAP', 10, 15, 5, 2019, GA, 100)

Update

Following is an example of how to Update a PrimaryStateTax table:

UPDATE PrimaryStateTax SET Exemptions = 20, Amount = 125 WHERE employeeId = '123'

Columns

Name	Type	ReadOnly	References	Description
EmployeeId [KEY]	String	True	Employees.EmployeeId	Id of the Employee.
DeductionsAmount	Decimal	False		Box 4(b) on form W4 (year 2020 or later): Deductions amount. Decimal (12,2)
DependentsAmount	Decimal	False		Box 3 on form W4 (year 2020 or later): Total dependents amount. Decimal (12,2)
FilingStatus	String	False		Employee state tax filing status. Common values are *S* (Single), *M* (Married).
OtherIncomeAmount	Decimal	False		Box 4(a) on form W4 (year 2020 or later): Other income amount. Decimal (12,2)
TaxCalculationCode	String	False		Tax calculation code. Common values are *F* (Flat), *P* (Percentage), *FDFP* (Flat Dollar Amount plus Fixed Percentage).
Exemptions	Decimal	False		State tax exemptions value.Decimal (12,2)
Exemptions2	Decimal	False		State tax exemptions 2 value.Decimal (12,2)
HigherRate	Bool	False		Box 2(c) on form W4 (year 2020 or later): Multiple Jobs or Spouse Works. Boolean
Percentage	Decimal	False		State Tax percentage. Decimal (12,2)
W4FormYear	Int	False		The state W4 form year Integer
TaxCode	String	False		State tax code.
SpecialCheckCalc	String	False		Supplemental check calculation code. Common values are *Blocked* (Taxes blocked on Supplemental checks), *Supp* (Use supplemental Tax Rate-Code).
Amount	Decimal	False		State tax code.
CompanyId	String	True		Id of the Company.

Gets employee sensitive data information directly from Web Pay.

Table Specific Information

Select

The Sync App will use the Paylocity API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• EmployeeId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM SensitiveData WHERE EmployeeId = '1234'

Insert

Following is an example of how to Insert into SensitiveData table.

INSERT INTO SensitiveData (EmployeeId, Disability, DisabilityClassifications, HasDisability, IsVeteran) VALUES ('1234', 'ads', 'dawd, afsc', '1', '0')

Update

Following is an example of how to Update a SensitiveData table:

UPDATE SensitiveData SET Disability = 'ads', DisabilityClassifications = 'dawd,afsc', HasDisability = '1' WHERE EmployeeId = '1234'

Columns

Name	Type	ReadOnly	References	Description
EmployeeId [KEY]	String	False	Employees.EmployeeId	Id of the Employee.
CompanyId	String	False		Id of the Company.
Disability	String	False		Description of employee's disability or accommodation.
DisabilityClassifications	String	False		Indicates the type of disability.
HasDisability	String	False		Indicates if the employee has a disability. Values include:0 = No, 1 = Yes or 2 = Prefer not to say.
Ethnicity	String	False		Employee's legal ethnicity or race.
EthnicRacialIdentities	String	False		Employee's preferred or chosen ethnicity or race.
DisplayPronouns	String	False		Specifies whether employee's preferred pronouns will be displayed to co-workers in Community, Directory, etc. Values include:0 = No or 1 = Yes.
GenderIdentityDescription	String	False		Employee's preferred or chosen gender identification. Values include:0 = No, 1 = Yes or 2 = Prefer not to say.
IdentifyAsLegalGender	String	False		Employee's self-identification of legal gender.
LegalGender	String	False		Employee's legal gender.
Pronouns	String	False		Employee's preferred or chosen pronouns.
SexualOrientation	String	False		Employee's self-identification of sexual orientation.
IsVeteran	String	False		Indicates if the employee is a veteran. Values include:0 = No, 1 = Yes or 2 = Prefer not to say.
Veteran	String	False		Employee's Veteran Notes.

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

Paylocity Connector for CData Sync Views

Name	Description
CompanyCodes	Get All Company Codes
CustomFields	Get All Custom Fields
DirectDeposit	Get All Direct Deposit
Employees	Get all employee info
PayStatementsdetails	Get employee pay statement details data for the specified year.. Get employee pay statement details data for the specified year and check date.
PayStatementssummary	Get employee pay statement summary data for the specified year.. Get employee pay statement summary data for the specified year and check date.

Get All Company Codes

Table Specific Information

Select

The Sync App will use the Paylocity API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• codeResource supports the '=' comparison.

In the case of simple SELECTs, the CodeResource value will be considered as costCenter1. For example, the following queries are processed server side:

SELECT * FROM CompanyCodes WHERE codeResource = 'costCenter1'

Columns

Name	Type	References	Description
Code	String		Code.
Description	String		Description.
CodeResource	String		Type of Company Code. Common values costcenter1, costcenter2, costcenter3, deductions, earnings, taxes, paygrade, positions.
CompanyId	String		Id of the Company.

Get All Custom Fields

Table Specific Information

Select

The Sync App will use the Paylocity API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• category supports the '=' comparison.

In the case of simple SELECTs, the Category value will be considered as PayrollAndHR. For example, the following queries are processed server side:

SELECT * FROM CustomFields WHERE Category = 'PayrollAndHR'

Columns

Name	Type	References	Description
Category	String		The custom field category.
Label	String		The custom field label.
Values	String		A set of values that are applicable to the custom field.
Type	String		The custom field type.
IsRequired	Bool		Indicates whether the custom field is required.
DefaultValue	String		Specifies the default value of the custom field.
CompanyId	String		Id of the Company.

Get All Direct Deposit

Table Specific Information

Select

The Sync App will use the Paylocity API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• EmployeeId supports the '=' comparison.

For example, the following queries are processed server side:

SELECT * FROM DirectDeposit WHERE EmployeeId = '123'

Columns

Name	Type	References	Description
EmployeeId [KEY]	String	Employees.EmployeeId	Id of the Employee.
AdditionalDirectDeposit	String		Additional Direct Deposits that are not the main Direct Deposit.
MainDirectDepositRoutingNumber	String		ABA Transit Routing Number, entered without dashes or spaces.
MainDirectDepositNameOnAccount	String		Name on the bank account. Defaults to employee's name.
MainDirectDepositBlockSpecial	Bool		Indicates if direct deposit should be blocked when special check types such as Bonus are processed.
MainDirectDepositAccountNumber	String		Account number, entered without special characters and spaces.
MainDirectDepositIsSkipPreNote	Bool		Indicates if account will not pre-note.
MainDirectDepositAccountType	String		Account type. Valid values are *C* (Checking), *S* (Saving), *P* (Pay Card).
MainDirectDepositPreNoteDate	Date		Date to end the pre-note of the account. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.
CompanyId	String		Id of the Company.

Get all employee info

Table Specific Information

Select

The Paylocity does not support any column for filtering this table. All filters will be executed client side.

Columns

Name	Type	References	Description
EmployeeId [KEY]	String		Employee Id.
StatusCode	String		Employee current work status. Common values are *A* (Active), *L* (Leave of Absence), *T* (Terminated).
StatusTypeCode	String		Employee current work status type.
CompanyId	String		Id of the Company.

Get employee pay statement details data for the specified year.. Get employee pay statement details data for the specified year and check date.

Table Specific Information

Select

The Sync App will use the Paylocity API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• EmployeeId supports the '=' comparison.
• Year supports the '=' comparison.
• CheckDate supports the '=' comparison.

In the case of simple SELECT the Paylocity will return present and last year records. For example, the following queries are processed server side:

SELECT * FROM PayStatementsDetails WHERE EmployeeId = '24' AND Year = 2019

SELECT * FROM PayStatementsDetails WHERE EmployeeId = '24' AND Year = 2019 AND CheckDate = '2019-02-01'

Columns

Name	Type	References	Description
EmployeeId [KEY]	String	Employees.EmployeeId	Id of the Employee
CheckDate [KEY]	Date		The Check Date of pay statement details data
CompanyId [KEY]	String		Id of the Company
TransactionNumber	Int		The Transaction Number of pay statement details data
DetCode	String		The Det Code of pay statement details data
Det	String		The Det of pay statement details data
Hours	Decimal		The Hours of pay statement details data
Rate	Decimal		The Rate of pay statement details data
TransactionType	String		The Transaction type of pay statement details data
Year	Int		The The year for which to retrieve pay statement data
Amount	Decimal		The Amount of pay statement details data
DetType	String		Pay statement details related to specific deduction, earning or tax types.
EligibleCompensation	Decimal		The Eligible Compensation of pay statement details data

Get employee pay statement summary data for the specified year.. Get employee pay statement summary data for the specified year and check date.

Table Specific Information

Select

The Sync App will use the Paylocity API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

• EmployeeId supports the '=' comparison.
• Year supports the '=' comparison.
• CheckDate supports the '=' comparison.

In the case of simple SELECTs, the Paylocity will return records from the current and previous year.

For example, the following queries are processed server side:

SELECT * FROM PayStatementsSummary WHERE EmployeeId = '123' AND Year = 2019

SELECT * FROM PayStatementsSummary WHERE EmployeeId = '123' AND Year = 2019 AND CheckDate = '2019-02-01'

Columns

Name	Type	References	Description
EmployeeId [KEY]	String	Employees.EmployeeId	Id of the Employee
CheckDate [KEY]	Date		The Check Date of pay statement summary data
CompanyId [KEY]	String		Id of the Company
TransactionNumber	Int		The Transaction Number of pay statement summary data
BeginDate	Date		The Begin Date of pay statement summary data
AutoPay	Bool		The If AutoPay is enabled pay statement summary data
OvertimeDollars	Decimal		The Overtime Dollars of pay statement summary data
GrossPay	Decimal		The Gross Pay of pay statement summary data
NetPay	Decimal		The Net Pay of pay statement summary data
Hours	Decimal		The Hours of pay statement summary data
RegularHours	Decimal		The Regular Hours of pay statement summary data
Process	Int		The Process of pay statement summary data
CheckNumber	Int		The Check Number of pay statement summary data
WorkersCompCode	String		The Workers CompCode of pay statement summary data
NetCheck	Decimal		The Net Check of pay statement summary data
VoucherNumber	Int		The Voucher Number of pay statement summary data
DirectDepositAmount	Decimal		The Direct Deposit Amount of pay statement summary data
RegularDollars	Decimal		The Regular Dollars of pay statement summary data
Year	Int		The Year of pay statement summary data
OvertimeHours	Decimal		The Over timeHours of pay statement summary data
EndDate	Date		The EndDate of pay statement summary data

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Connection

---

Property	Description
CompanyId	The ID of the company file.
CustomFieldsCategory	The custom field category in the company.
UseSandbox	Set to true if you you are using sandbox account.
RSAPublicKey	Set this to the public key shared by Paylocity.
Key	The secret key for the symmetric algorithm.
IV	The initialization vector (IV).
UsePayEntryAPI	Set to true if you want to access the Pay Entry API. When this property is set to true, you should specify different location for OAuthSettingsFile.

OAuth

---

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.

SSL

---

Property	Description
SSLClientCert	The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).
SSLClientCertType	The type of key store containing the TLS/SSL client certificate.
SSLClientCertPassword	The password for the TLS/SSL client certificate.
SSLClientCertSubject	The subject of the TLS/SSL client certificate.
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

Firewall

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

Proxy

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging

---

Property	Description
LogModules	Core modules to be included in the log file.

Schema

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Miscellaneous

---

Property	Description
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other	These hidden properties are used only in specific use cases.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

This section provides a complete list of the Connection properties you can configure in the connection string for this provider.

---

Property	Description
CompanyId	The ID of the company file.
CustomFieldsCategory	The custom field category in the company.
UseSandbox	Set to true if you you are using sandbox account.
RSAPublicKey	Set this to the public key shared by Paylocity.
Key	The secret key for the symmetric algorithm.
IV	The initialization vector (IV).
UsePayEntryAPI	Set to true if you want to access the Pay Entry API. When this property is set to true, you should specify different location for OAuthSettingsFile.

The ID of the company file.

Remarks

The ID of the company file.

The custom field category in the company.

Remarks

Add comma separated values to set more than one custom fields category. The following is an example of a custom field category:

• PayrollAndHR

Set to true if you you are using sandbox account.

Remarks

Set to true if you you are using sandbox account.

Set this to the public key shared by Paylocity.

Remarks

Either enter the key value or complete path of the file. This is required for executing Insert and Update statements.

The secret key for the symmetric algorithm.

Remarks

The AES symmetric key(base 64 encoded) encrypted with the Paylocity Public Key. Paylocity will decrypt the AES key using RSA decryption and use it to decrypt the content. It is an optional property if the IV value is not provided. In this case, the driver will generate a key internally.

The initialization vector (IV).

Remarks

The AES IV (base 64 encoded) used when encrypting the content. If you have set the Key, this property is optional because the driver generates an IV internally.

Set to true if you want to access the Pay Entry API. When this property is set to true, you should specify different location for OAuthSettingsFile.

Remarks

Set to true if you want to access the Pay Entry API. When this property is set to true, you should specify different location for OAuthSettingsFile.

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

---

Property	Description
OAuthClientId	The client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecret	The client secret assigned when you register your application with an OAuth authorization server.

The client Id assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

The client secret assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

---

Property	Description
SSLClientCert	The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).
SSLClientCertType	The type of key store containing the TLS/SSL client certificate.
SSLClientCertPassword	The password for the TLS/SSL client certificate.
SSLClientCertSubject	The subject of the TLS/SSL client certificate.
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).

Remarks

The name of the certificate store for the client certificate.

The SSLClientCertType field specifies the type of the certificate store specified by SSLClientCert. If the store is password protected, specify the password in SSLClientCertPassword.

SSLClientCert is used in conjunction with the SSLClientCertSubject field in order to specify client certificates. If SSLClientCert has a value, and SSLClientCertSubject is set, a search for a certificate is initiated. See SSLClientCertSubject for more information.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.
SPC	Software publisher certificates.

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (for example, PKCS12 certificate store).

The type of key store containing the TLS/SSL client certificate.

Remarks

This property can take one of the following values:

USER - default	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note that this store type is not available in Java.
MACHINE	For Windows, this specifies that the certificate store is a machine store. Note that this store type is not available in Java.
PFXFILE	The certificate store is the name of a PFX (PKCS12) file containing certificates.
PFXBLOB	The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
JKSFILE	The certificate store is the name of a Java key store (JKS) file containing certificates. Note that this store type is only available in Java.
JKSBLOB	The certificate store is a string (base-64-encoded) representing a certificate store in JKS format. Note that this store type is only available in Java.
PEMKEY_FILE	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
PEMKEY_BLOB	The certificate store is a string (base64-encoded) that contains a private key and an optional certificate.
PUBLIC_KEY_FILE	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
PUBLIC_KEY_BLOB	The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.
SSHPUBLIC_KEY_FILE	The certificate store is the name of a file that contains an SSH-style public key.
SSHPUBLIC_KEY_BLOB	The certificate store is a string (base-64-encoded) that contains an SSH-style public key.
P7BFILE	The certificate store is the name of a PKCS7 file containing certificates.
PPKFILE	The certificate store is the name of a file that contains a PuTTY Private Key (PPK).
XMLFILE	The certificate store is the name of a file that contains a certificate in XML format.
XMLBLOB	The certificate store is a string that contains a certificate in XML format.

The password for the TLS/SSL client certificate.

Remarks

If the certificate store is of a type that requires a password, this property is used to specify that password to open the certificate store.

The subject of the TLS/SSL client certificate.

Remarks

When loading a certificate the subject is used to locate the certificate in the store.

If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks the first certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For example, "CN=www.server.com, OU=test, C=US, [email protected]". The common fields and their meanings are shown below.

Field	Meaning
CN	Common Name. This is commonly a host name like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

If a field value contains a comma, it must be quoted.

The certificate to be accepted from the server when connecting using TLS/SSL.

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

The protocol used by a proxy-based firewall.

Remarks

This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

Type	Default Port	Description
TUNNEL	80	When this is set, the Sync App opens a connection to Paylocity and traffic flows back and forth through the proxy.
SOCKS4	1080	When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5	1080	When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

The name or IP address of a proxy-based firewall.

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

The TCP port for a proxy-based firewall.

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

The user name to use to authenticate with a proxy-based firewall.

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

A password used to authenticate to a proxy-based firewall.

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

This indicates whether to use the system proxy settings or not.

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

The hostname or IP address of a proxy to route HTTP traffic through.

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

The TCP port the ProxyServer proxy is running on.

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

The authentication type to use to authenticate to the ProxyServer proxy.

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

• BASIC: The Sync App performs HTTP BASIC authentication.
• DIGEST: The Sync App performs HTTP DIGEST authentication.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• PROPRIETARY: The Sync App does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

A user name to be used to authenticate to the ProxyServer proxy.

Remarks

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain
domain\user

A password to be used to authenticate to the ProxyServer proxy.

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

The SSL type to use when connecting to the ProxyServer proxy.

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:

AUTO	Default setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

---

Property	Description
LogModules	Core modules to be included in the log file.

Core modules to be included in the log file.

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Remarks

The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\\CData\\Paylocity Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:

Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Linux	~/.config

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

---

Property	Description
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other	These hidden properties are used only in specific use cases.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Remarks

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

These hidden properties are used only in specific use cases.

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT	Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

This property indicates whether or not to include pseudo columns as columns to the table.

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

The value in seconds until the timeout error is thrown, canceling the operation.

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the Sync App throws an exception.

A filepath pointing to the JSON configuration file containing your custom views.

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
	"MyView": {
		"query": "SELECT * FROM Employee WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json

Note that the specified path is not embedded in quotation marks.