This page provides a guide to Establishing a Connection to Paylocity in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to Paylocity

Establishing a Connection shows how to authenticate to Paylocity and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from Paylocity through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Connect to Paylocity by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

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 Cloud 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 Cloud 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.

Customizing the SSL Configuration

By default, the Cloud attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Client SSL Certificates

The Paylocity Cloud 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 authenticate to an HTTP proxy, set the following:

• ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
• ProxyPort: the TCP port that the proxy server is running on.
• ProxyAuthScheme: the authentication method the Cloud uses when authenticating to the proxy server.
• ProxyUser: the username of a user account registered with the proxy server.
• ProxyPassword: the password associated with the ProxyUser.

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 Cloud 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 Cloud.

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 Cloud models the data in Paylocity as a list of tables in a relational database that can be queried using standard SQL statements.

CData Cloud - Paylocity 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 Cloud 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 Cloud.

• 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 Cloud 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 Cloud.

• 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 Cloud 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 Cloud.

• 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 Cloud 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 Cloud.

• 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 Cloud 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 Cloud.

• 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 Cloud 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 Cloud.

• 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 Cloud 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 Cloud.

• 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 Cloud 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 Cloud.

• 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 Cloud 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 Cloud.

• 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.

CData Cloud - Paylocity 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 Cloud 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 Cloud.

• 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 Cloud 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 Cloud.

• 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 Cloud 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 Cloud.

• 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 Cloud 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 Cloud.

• 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 Cloud 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 Cloud.

• 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

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Paylocity.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Paylocity, along with an indication of whether the procedure succeeded or failed.

CData Cloud - Paylocity Stored Procedures

Name	Description
CreatePayEntryImportBatch	Create or merge Pay Entry Time Tracking Batch.
MergePayEntryImportBatch	This is used to create or merge a batch when the Pay Entry Import Status is halted at TimeClockValidationPendingAcknowledgement.
OnBoardingEmployee	Onboarding API sends employee data into Paylocity Onboarding to help ensure an easy and accurate hiring process for subsequent completion into Web Pay.

Create or merge Pay Entry Time Tracking Batch.

Stored Procedures Specific Information

In order to insert into CreatePayEntryImportBatch, you must submit the TimeEntry details and a Pay Period. The TimeEntry details may be submitted via a Temp table by first inserting to the Input_TimeEntry input only table. The Pay Period may be specified by setting the PayPeriodBeginDate, PayPeriodEndDate, and CheckDate. Alternatively, the CalendarId may be specified. For example:

INSERT INTO Input_TimeEntry (EmployeeId, Det, DetCode, Hours, Amount, BeginDate, EndDate) VALUES (999623635, 'E', 'REG', 40.00, 30, '2021-08-08', '2021-08-14')
INSERT INTO Input_TimeEntry (EmployeeId, Det, DetCode, Hours, Amount, BeginDate, EndDate) VALUES (999623636, 'E', 'REG', 40.00, 25, '2021-08-08', '2021-08-14')

EXECUTE CreatePayEntryImportBatch TimeEntry = 'Input_TimeEntry#TEMP', AutoAcknowledge = 'true', BatchName = 'Test', PayPeriodBeginDate = '2021-08-15', PayPeriodEndDate = '2021-08-21', CheckDate = '2021-08-27'

To fetch the processed data information, use the below query.

SELECT * FROM LastResultInfo#TEMP

Input

Name	Type	Required	Description
TimeEntry	String	True	The CSV Time Import Data. This can be submitted by inserting to the Input_TimeEntry input only table.
AutoAcknowledge	Boolean	False	Use true to auto acknowledge any errors or warnings for the import, false to not auto acknowledge
BatchName	String	False	The name of the batch.
MergeBatchId	String	False	The Id of the batch to be merged.
CalendarId	String	False	The Calendar Id for the check date.
PayPeriodBeginDate	String	False	The Pay Period Begin Date in YYYY-MM-DD format.
PayPeriodEndDate	String	False	The Pay Period End Date in YYYY-MM-DD format.
CheckDate	String	False	The Pay Period Check Date in YYYY-MM-DD format.

Result Set Columns

Name	Type	Description
TimeImportFileTrackingId	String	The Id of the time import file tracking.
Status	String	Status of the Time Import Batch.
BatchId	String	The Id of the Batch.

This is used to create or merge a batch when the Pay Entry Import Status is halted at TimeClockValidationPendingAcknowledgement.

Stored Procedures Specific Information

TimeImportFileTrackingId is required to execute this procedure. The TimeImportFileTrackingId will be generated as the response of CreatePayEntryImportBatch Stored Procedure.

For example:

EXECUTE MergePayEntryImportBatch TimeImportFileTrackingId = 'e84b3808-4477-423a-89bf-e32f58c0e685'

Input

Name	Type	Required	Description
TimeImportFileTrackingId	String	True	Id of the Time Import File Tracking.

Result Set Columns

Name	Type	Description
Message	String	Message of the create or merge batch operation.

Onboarding API sends employee data into Paylocity Onboarding to help ensure an easy and accurate hiring process for subsequent completion into Web Pay.

Stored Procedures Specific Information

Paylocity allows multiple columns to be used in the Exec query. These columns can typically be used with only = comparison. FirstName and LastName params are required to execute this procedure. For example:

EXECUTE OnBoardingEmployee FirstName = 'EmpFirstName', LastName = 'EmpLastName', BaseRate = 350.0, CostCenter1 = '100', DefaultHours = '9', EmployeeStatus = 'A', MaritalStatus = 'S'

Input

Name	Type	Required	Description
FirstName	String	True	Employee first name
LastName	String	True	Employee last name.
EmployeeId	String	False	Employee Id (optional)
Address1	String	False	Employee home 1st address line.
Address2	String	False	Employee home 2nd address line.
AutoPayType	String	False	N- employee won't automatically receive a salary or hours during payroll, D - employee will be automatically paid in defaultHours during payroll, S - employee will be automatically paid Salary amount during payroll The allowed values are N, D, S.
BaseRate	Decimal	False	Employee home 2nd address line.
City	String	False	Employee home city.
CostCenter1	String	False	Employer defined location, like *branch, division, department, etc.* Must match Company setup.
CostCenter2	String	False	Employer defined location, like *branch, division, department, etc.* Must match Company setup.
CostCenter3	String	False	Employer defined location, like *branch, division, department, etc.* Must match Company setup.
DefaultHours	Decimal	False	Employee default hours consistently worked. If autoPayType is set to D, employee will be paid hourly base rate for the defaultHours
EmployeeStatus	String	False	Employee current work status. Common values are *A (Active), L (Leave of Absence), T (Terminated)*.
EmploymentType	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)*.
FederalFilingStatus	String	False	Employee federal filing status. Common values *M (Married), S (Single)*.
Sex	String	False	Employee gender. Common values *M (Male), F (Female)*.
HireDate	Date	False	Employee hired date. Common formats are MM-DD-CCYY, CCYY-MM-DD
HomePhone	String	False	Employee gender. Common values *M (Male), F (Female)*.
MaritalStatus	String	False	Employee marital status. Common values *D (Divorced), M (Married), S (Single), W (Widowed)*.
PersonalMobilePhone	String	False	Employee personal mobile phone number.
PayFrequency	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)*.
PersonalEmailAddress	String	False	Employee personal email address.
PayType	String	False	Employee pay type. Valid values are *Hourly or Salary*.
RatePer	String	False	Employee base rate frequency used with payType Hourly. Common values are *Hour or Week*. Default is Hour.
Salary	Decimal	False	Employee gross salary per pay period used with payType Salary.
State	String	False	Employee home state.
Ssn	String	False	Employee social security number. Leave it blank if valid social security number not available.
StateFilingStatus	String	False	Employee state filing status. Common values are *M (Married), S (Single)*.
SuiState	String	False	Employee SUI (State Unemployment Insurance) state.
TaxForm	String	False	Employee tax form for reporting income. Valid values are *W2, 1099M, 1099R*. Default is W2.
TaxState	String	False	Employee primary tax state.
UserName	String	False	Required. Employer assigned username to log into Onboarding. Duplicate usernames are not allowed. Must be between 3 and 20 characters and cannot have special characters other than . (period) and _ (underscore)
WorkEmailAddress	String	False	Employee work email.
Zip	String	False	Employee home zip code.

Result Set Columns

Name	Type	Description
Status	String	Stored Procedure Execution Status

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Paylocity:

• sys_catalogs: Lists the available databases.
• sys_schemas: Lists the available schemas.
• sys_tables: Lists the available tables and views.
• sys_tablecolumns: Describes the columns of the available tables and views.
• sys_procedures: Describes the available stored procedures.
• sys_procedureparameters: Describes stored procedure parameters.
• sys_keycolumns: Describes the primary and foreign keys.
• sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

• sys_connection_props: Returns information on the available connection properties.
• sys_sqlinfo: Describes the SELECT queries that the Cloud can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

• sys_identity: Returns information about batch operations or single updates.

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns

Name	Type	Description
CatalogName	String	The database name.

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas
          

Columns

Name	Type	Description
CatalogName	String	The database name.
SchemaName	String	The schema name.

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables
          

Columns

Name	Type	Description
CatalogName	String	The database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view.
TableType	String	The table type (table or view).
Description	String	A description of the table or view.
IsUpdateable	Boolean	Whether the table can be updated.

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Employee table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Employee' 

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view containing the column.
ColumnName	String	The column name.
DataTypeName	String	The data type name.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The storage size of the column.
DisplaySize	Int32	The designated column's normal maximum width in characters.
NumericPrecision	Int32	The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The column scale or number of digits to the right of the decimal point.
IsNullable	Boolean	Whether the column can contain null.
Description	String	A brief description of the column.
Ordinal	Int32	The sequence number of the column.
IsAutoIncrement	String	Whether the column value is assigned in fixed increments.
IsGeneratedColumn	String	Whether the column is generated.
IsHidden	Boolean	Whether the column is hidden.
IsArray	Boolean	Whether the column is an array.
IsReadOnly	Boolean	Whether the column is read-only.
IsKey	Boolean	Indicates whether a field returned from sys_tablecolumns is the primary key of the table.

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures
          

Columns

Name	Type	Description
CatalogName	String	The database containing the stored procedure.
SchemaName	String	The schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure.
Description	String	A description of the stored procedure.
ProcedureType	String	The type of the procedure, such as PROCEDURE or FUNCTION.

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the CreateSchema stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='CreateSchema' AND Direction=1 OR Direction=2

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the stored procedure.
SchemaName	String	The name of the schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure containing the parameter.
ColumnName	String	The name of the stored procedure parameter.
Direction	Int32	An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataTypeName	String	The name of the data type.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The number of digits to the right of the decimal point in numeric data.
IsNullable	Boolean	Whether the parameter can contain null.
IsRequired	Boolean	Whether the parameter is required for execution of the procedure.
IsArray	Boolean	Whether the parameter is an array.
Description	String	The description of the parameter.
Ordinal	Int32	The index of the parameter.

Describes the primary and foreign keys.

The following query retrieves the primary key for the Employee table:

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Employee' 
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
IsKey	Boolean	Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey	Boolean	Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.
ForeignKeyType	String	Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
KeySeq	String	The sequence number of the primary key.
KeyName	String	The name of the primary key.

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the index.
SchemaName	String	The name of the schema containing the index.
TableName	String	The name of the table containing the index.
IndexName	String	The index name.
ColumnName	String	The name of the column associated with the index.
IsUnique	Boolean	True if the index is unique. False otherwise.
IsPrimary	Boolean	True if the index is a primary key. False otherwise.
Type	Int16	An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder	String	The sort order: A for ascending or D for descending.
OrdinalPosition	Int16	The sequence number of the column in the index.

Returns information on the available connection properties and those set in the connection string.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name	Type	Description
Name	String	The name of the connection property.
ShortDescription	String	A brief description.
Type	String	The data type of the connection property.
Default	String	The default value if one is not explicitly set.
Values	String	A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value	String	The value you set or a preconfigured default.
Required	Boolean	Whether the property is required to connect.
Category	String	The category of the connection property.
IsSessionProperty	String	Whether the property is a session property, used to save information about the current connection.
Sensitivity	String	The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName	String	A camel-cased truncated form of the connection property name.
Ordinal	Int32	The index of the parameter.
CatOrdinal	Int32	The index of the parameter category.
Hierarchy	String	Shows dependent properties associated that need to be set alongside this one.
Visible	Boolean	Informs whether the property is visible in the connection UI.
ETC	String	Various miscellaneous information about the property.

Describes the SELECT query processing that the Cloud can offload to the data source.

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

Name	Description	Possible Values
AGGREGATE_FUNCTIONS	Supported aggregation functions.	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	Whether COUNT function is supported.	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	The opening character used to escape an identifier.	[
IDENTIFIER_QUOTE_CLOSE_CHAR	The closing character used to escape an identifier.	]
SUPPORTED_OPERATORS	A list of supported SQL operators.	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	Whether GROUP BY is supported, and, if so, the degree of support.	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	The supported varieties of outer joins supported.	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	Whether outer joins are supported.	YES, NO
SUBQUERIES	Whether subqueries are supported, and, if so, the degree of support.	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	Supported string functions.	LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS	Supported numeric functions.	ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS	Supported date/time functions.	NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES	Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS	A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN	String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION	Indicates if the provider supports transactions such as commit and rollback.	YES, NO
DIALECT	Indicates the SQL dialect to use.
KEY_PROPERTIES	Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS	Indicates if multiple schemas may exist for the provider.	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	Indicates if multiple catalogs may exist for the provider.	YES, NO
DATASYNCVERSION	The CData Data Sync version needed to access this driver.	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	The CData Data Sync category of this driver.	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	Whether enhanced SQL functionality beyond what is offered by the API is supported.	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	Whether batch operations are supported.	YES, NO
SQL_CAP	All supported SQL capabilities for this driver.	SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS	A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY	Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.	YES, NO
PSEUDO_COLUMNS	A string array indicating the available pseudo columns.
MERGE_ALWAYS	If the value is true, The Merge Mode is forcibly executed in Data Sync.	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION	Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE	Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY	A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION	Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID	Indicates whether the CheckCache statement should be done against the parent key column.	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns

Name	Type	Description
NAME	String	A component of SQL syntax, or a capability that can be processed on the server.
VALUE	String	Detail on the supported SQL or SQL syntax.

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

         SELECT * FROM sys_identity
          

Columns

Name	Type	Description
Id	String	The database-generated Id returned from a data modification operation.
Batch	String	An identifier for the batch. 1 for a single operation.
Operation	String	The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message	String	SUCCESS or an error message if the update in the batch failed.

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

Name	Type	Description
Product	String	The name of the product.
Version	String	The version number of the product.
Datasource	String	The name of the datasource the product connects to.
NodeId	String	The unique identifier of the machine where the product is installed.
HelpURL	String	The URL to the product's help documentation.
License	String	The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
Location	String	The file path location where the product's library is stored.
Environment	String	The version of the environment or rumtine the product is currently running under.
DataSyncVersion	String	The tier of CData Sync required to use this connector.
DataSyncCategory	String	The category of CData Sync functionality (e.g., Source, Destination).

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	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

SSL

---

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Logging

---

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Schema

---

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Miscellaneous

---

Property	Description
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

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.

Data Type

string

Default Value

""

Remarks

The ID of the company file.

The custom field category in the company.

Data Type

string

Default Value

"PayrollAndHR"

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.

Data Type

bool

Default Value

false

Remarks

Set to true if you you are using sandbox account.

Set this to the public key shared by Paylocity.

Data Type

string

Default Value

""

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.

Data Type

string

Default Value

""

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).

Data Type

string

Default Value

""

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.

Data Type

bool

Default Value

false

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	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.

Data Type

string

Default Value

""

Remarks

OAuthClientId is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

Data Type

string

Default Value

""

Remarks

OAuthClientSecret is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

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

---

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

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

Data Type

string

Default Value

""

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 Logging properties you can configure in the connection string for this provider.

---

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Data Type

string

Default Value

"1"

Remarks

This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.

The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.

When combined with the LogModules property, Verbosity can refine logging to specific categories of information.

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

---

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Data Type

string

Default Value

""

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

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

---

Property	Description
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

Specifies the maximum rows returned for queries without aggregation or GROUP BY.

Data Type

int

Default Value

-1

Remarks

This property sets an upper limit on the number of rows the Cloud returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

Data Type

string

Default Value

""

Remarks

This property allows you to define which pseudocolumns the Cloud exposes as table columns.

To specify individual pseudocolumns, use the following format: "Table1=Column1;Table1=Column2;Table2=Column3"

To include all pseudocolumns for all tables use: "*=*"

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

Data Type

int

Default Value

60

Remarks

This property controls the maximum time, in seconds, that the Cloud waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Cloud cancels the operation and throws an exception.

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.