このページでは、CData Cloud でのPaylocity への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。

Paylocity への接続

接続の確立 は、CData Cloud にデータベースを作成するためのPaylocity への認証方法と必要な接続プロパティの設定方法について示します。

CData Cloud サービスからデータにアクセス

利用可能な標準サービスを経由してPaylocity からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。

Database タブで対応するアイコンを選択して、Paylocity に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。

Paylocity への接続

Paylocity は、Pay Entry API 経由と標準のPaylocity API 経由の2つの接続方法を提供します。

接続する前に、次のプロパティを設定します（該当する場合）。

• サンドボックスアカウントを使用する場合はUseSandbox をtrue に設定し、そうでない場合はfalse に設定します。
• IncludeCustomFields がtrue の場合、CustomFieldsCategory をCustomfields カテゴリに設定します。 デフォルト値はPayrollAndHR です。

暗号化をオプトインしているサイトの場合：

• 次の暗号化プロパティのいずれか1つだけを設定してください。
  • Key：Paylocity の公開鍵で暗号化されたAES 共通鍵（base 64 エンコード）。この鍵はPaylocity コンテンツの暗号化に使用されます。Paylocity はRSA 復号化を使用してAES 鍵を復号化します。
    IV 値が指定されていない場合に使用されます。
  • IV：Paylocity を暗号化するときに使用するAES IV（base 64 エンコード）。Key 値が提供されない場合は、IV は内部的に生成されます。
• Paylocity アカウントでRSA 暗号化が有効になっている場合は、RSAPublicKey をPaylocity に関連付けられたRSA キーに設定します。 （このプロパティは、Insert およびUpdate ステートメントを実行する場合は必須です。）この機能が無効になっている場合は必須ではありません。

Pay Entry API

Pay Entry API は、個々の従業員の給与情報を自動的に提出することを可能にする、極めて限定的な接続であり、それ以外のことはほとんどできません。Pay Entry API で提供されるものは極めて限定されているため、独立したスキーマはありません。しかし、UsePayEntryAPI 接続プロパティで有効にすることができます。

Pay Entry API はPaylocity API の他の部分と完全に分離されています。個別のクライアントID とシークレットを使用し、アカウントへのアクセスを許可するにはPaylocity から明示的にリクエストする必要があります。

UsePayEntryAPI をtrue に設定する場合は、以下のストアドプロシージャのみ利用できることに注意してください。

• CreatePayEntryImportBatch
• MergePayEntryImportBatch
• Input_TimeEntry
• 利用可能なOAuth ストアドプロシージャ

製品のその他の機能を使用しようとするとエラーが発生します。

また、Pay Entry API で使用するために取得したOAuthAccessToken は、別途保存する必要があります。このため、この接続プロパティを使用する際には、別のOAuthSettingsLocation の設定が必要になることがよくあります。

Paylocity への認証

Paylocity は、Pay Entry API または標準のPayloticity API からのデータへのすべての接続でOAuth 認証をサポートします。この認証を有効にするには、すべてのOAuth フローでAuthScheme をOAuth に設定し、カスタムOAuth アプリケーションを作成する必要があります。

以下のサブセクションでは、3つの最も一般的な認証フローでのPaylocity への認証について詳しく説明します。 カスタムOAuth アプリケーションの作成については、カスタムOAuth アプリケーションの作成 を参照してください。 Paylocity で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。

OAuth アクセストークンの自動リフレッシュ：

Cloud がOAuth アクセストークンを自動的にリフレッシュするようにするには、次のように設定します。

1. はじめてデータに接続する前に、次の接続プロパティを設定します。
   • InitiateOAuth = REFRESH。
   • OAuthClientId = アプリケーション設定のクライアントId。
   • OAuthClientSecret = アプリケーション設定のクライアントシークレット。
   • OAuthAccessToken = GetOAuthAccessToken によって返されたアクセストークン。
   • OAuthSettingsLocation = Cloud がOAuth 値を保存する場所のパス。これは接続間で維持されます。
2. その後のデータ接続では、以下を設定します。
   • InitiateOAuth
   • OAuthSettingsLocation

OAuth アクセストークンの手動リフレッシュ：

OAuth アクセストークンを手動でリフレッシュするために必要な唯一の値は、OAuth リフレッシュトークンです。

1. ExpiresIn 期間（GetOAuthAccessToken が返す）が経過した後にOAuthAccessToken を手動でリフレッシュするには、RefreshOAuthAccessToken ストアドプロシージャを呼び出します。
2. 次の接続プロパティを設定します。
   • OAuthClientId = アプリケーション設定のクライアントId。
   • OAuthClientSecret = アプリケーション設定のクライアントシークレット。

3. RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを設定します。
4. 新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定します。これで新規接続が開かれます。

OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。

SSL 設定のカスタマイズ

デフォルトでは、Cloud はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。

別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。

クライアントSSL 証明書

Paylocity Cloud はクライアント証明書の設定もサポートしています。次を設定すれば、クライアント証明書を使って接続できます。

• SSLClientCert：クライアント証明書のための証明書ストア名。
• SSLClientCertType：TLS / SSL クライアント証明書を格納するキーストアの種類。
• SSLClientCertPassword：TLS / SSL クライアント証明書のパスワード。
• SSLClientCertSubject：TLS / SSL クライアント証明書のサブジェクト。

Firewall またはProxy 経由の接続

HTTP プロキシ

Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。

さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。

その他のプロキシ

次のプロパティを設定します。

• プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
• 接続をトンネルするには、FirewallType をTUNNEL に設定します。
• 認証するには、FirewallUser とFirewallPassword を設定します。
• SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

概要

このセクションでは、利用可能なAPI オブジェクトを示し、Paylocity API へのSQL の実行について詳しく説明します。

主要機能

• Cloud はドキュメント、フォルダ、およびグループなどのPaylocity エンティティをリレーショナルビューとしてモデル化し、SQL を記述してPaylocity データをクエリできるようにします。
• ストアドプロシージャを使用するとPaylocity の操作を実行できます。
• これらのオブジェクトへのライブ接続により、Cloud を使用するとPaylocity アカウントへのあらゆる変更が即座に反映されます。

テーブル

テーブル では、利用可能なテーブルを説明します。テーブルは、Earnings、LocalTaxes、およびEmployeeDetails などを静的にモデル化するように定義されています。

ビュー

ビュー では、利用可能なビューを説明します。ビューは、Employees、CompanyCodes、およびCustomFields などのリソースを静的にモデル化するように定義されています。

ストアドプロシージャ

ストアドプロシージャ は、Paylocity のファンクションライクなインターフェースです。ストアドプロシージャを使用すると、オブジェクトのダウンロードやエンベロープの移動など、Paylocity の操作を実行できます。

Cloud はPaylocity のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

CData Cloud - Paylocity テーブル

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.

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

CData Cloud - Paylocity ビュー

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

ストアドプロシージャはファンクションライクなインターフェースで、Paylocity の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにPaylocity から関連するレスポンスデータを返します。

CData Cloud - Paylocity ストアドプロシージャ

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 使用できる値は次のとおりです。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

このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。

スキーマテーブル

以下のテーブルは、Paylocity のデータベースメタデータを返します。

• sys_catalogs：利用可能なデータベースをリスト。
• sys_schemas：利用可能なスキーマをリスト。
• sys_tables：利用可能なテーブルおよびビューをリスト。
• sys_tablecolumns：利用可能なテーブルおよびビューのカラムについて説明。
• sys_procedures：利用可能なストアドプロシージャについて説明。
• sys_procedureparameters：ストアドプロシージャパラメータについて説明。
• sys_keycolumns：主キーおよび外部キーについて説明。
• sys_indexes：利用可能なインデックスについて説明。

データソーステーブル

以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。

• sys_connection_props：利用可能な接続プロパティについての情報を返す。
• sys_sqlinfo：Cloud がデータソースにオフロードできるSELECT クエリについて説明。

クエリ情報テーブル

次のテーブルは、データ変更クエリのクエリ統計を返します。

• sys_identity：バッチ処理または単一の更新に関する情報を返す。

利用可能なデータベースをリストします。

次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。

SELECT * FROM sys_catalogs

Columns

Name	Type	Description
CatalogName	String	データベース名。

利用可能なスキーマをリストします。

次のクエリは、すべての利用可能なスキーマを取得します。

          SELECT * FROM sys_schemas
          

Columns

Name	Type	Description
CatalogName	String	データベース名。
SchemaName	String	スキーマ名。

利用可能なテーブルをリストします。

次のクエリは、利用可能なテーブルおよびビューを取得します。

          SELECT * FROM sys_tables
          

Columns

Name	Type	Description
CatalogName	String	テーブルまたはビューを含むデータベース。
SchemaName	String	テーブルまたはビューを含むスキーマ。
TableName	String	テーブル名またはビュー名。
TableType	String	テーブルの種類（テーブルまたはビュー）。
Description	String	テーブルまたはビューの説明。
IsUpdateable	Boolean	テーブルが更新可能かどうか。

利用可能なテーブルおよびビューのカラムについて説明します。

次のクエリは、Employee テーブルのカラムとデータ型を返します。

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

Columns

Name	Type	Description
CatalogName	String	テーブルまたはビューを含むデータベースの名前。
SchemaName	String	テーブルまたはビューを含むスキーマ。
TableName	String	カラムを含むテーブルまたはビューの名前。
ColumnName	String	カラム名。
DataTypeName	String	データ型の名前。
DataType	Int32	データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
Length	Int32	カラムのストレージサイズ。
DisplaySize	Int32	指定されたカラムの通常の最大幅（文字数）。
NumericPrecision	Int32	数値データの最大桁数。文字データおよび日時データの場合は、カラムの長さ（文字数）。
NumericScale	Int32	カラムのスケール（小数点以下の桁数）。
IsNullable	Boolean	カラムがNull を含められるかどうか。
Description	String	カラムの簡単な説明。
Ordinal	Int32	カラムのシーケンスナンバー。
IsAutoIncrement	String	カラムに固定増分値が割り当てられるかどうか。
IsGeneratedColumn	String	生成されたカラムであるかどうか。
IsHidden	Boolean	カラムが非表示かどうか。
IsArray	Boolean	カラムが配列かどうか。
IsReadOnly	Boolean	カラムが読み取り専用かどうか。
IsKey	Boolean	sys_tablecolumns から返されたフィールドがテーブルの主キーであるかどうか。

利用可能なストアドプロシージャをリストします。

次のクエリは、利用可能なストアドプロシージャを取得します。

          SELECT * FROM sys_procedures
          

Columns

Name	Type	Description
CatalogName	String	ストアドプロシージャを含むデータベース。
SchemaName	String	ストアドプロシージャを含むスキーマ。
ProcedureName	String	ストアドプロシージャの名前。
Description	String	ストアドプロシージャの説明。
ProcedureType	String	PROCEDURE やFUNCTION などのプロシージャのタイプ。

ストアドプロシージャパラメータについて説明します。

次のクエリは、CreateSchema ストアドプロシージャのすべての入力パラメータについての情報を返します。

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

Columns

Name	Type	Description
CatalogName	String	ストアドプロシージャを含むデータベースの名前。
SchemaName	String	ストアドプロシージャを含むスキーマの名前。
ProcedureName	String	パラメータを含むストアドプロシージャの名前。
ColumnName	String	ストアドプロシージャパラメータの名前。
Direction	Int32	パラメータのタイプに対応する整数値：input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。
DataTypeName	String	データ型の名前。
DataType	Int32	データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
Length	Int32	文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。
NumericPrecision	Int32	数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ（文字数）。
NumericScale	Int32	数値データの小数点以下の桁数。
IsNullable	Boolean	パラメータがNull を含められるかどうか。
IsRequired	Boolean	プロシージャの実行にパラメータが必要かどうか。
IsArray	Boolean	パラメータが配列かどうか。
Description	String	パラメータの説明。
Ordinal	Int32	パラメータのインデックス。

主キーおよび外部キーについて説明します。

次のクエリは、Employee テーブルの主キーを取得します。

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

Columns

Name	Type	Description
CatalogName	String	キーを含むデータベースの名前。
SchemaName	String	キーを含むスキーマの名前。
TableName	String	キーを含むテーブルの名前。
ColumnName	String	キーカラムの名前
IsKey	Boolean	カラムがTableName フィールドで参照されるテーブル内の主キーかどうか。
IsForeignKey	Boolean	カラムがTableName フィールドで参照される外部キーかどうか。
PrimaryKeyName	String	主キーの名前。
ForeignKeyName	String	外部キーの名前。
ReferencedCatalogName	String	主キーを含むデータベース。
ReferencedSchemaName	String	主キーを含むスキーマ。
ReferencedTableName	String	主キーを含むテーブル。
ReferencedColumnName	String	主キーのカラム名。

外部キーについて説明します。

次のクエリは、他のテーブルを参照するすべての外部キーを取得します。

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

カラム

名前	タイプ	説明
CatalogName	String	キーを含むデータベースの名前。
SchemaName	String	キーを含むスキーマの名前。
TableName	String	キーを含むテーブルの名前。
ColumnName	String	キーカラムの名前
PrimaryKeyName	String	主キーの名前。
ForeignKeyName	String	外部キーの名前。
ReferencedCatalogName	String	主キーを含むデータベース。
ReferencedSchemaName	String	主キーを含むスキーマ。
ReferencedTableName	String	主キーを含むテーブル。
ReferencedColumnName	String	主キーのカラム名。
ForeignKeyType	String	外部キーがインポート（他のテーブルを指す）キーかエクスポート（他のテーブルから参照される）キーかを指定します。

主キーについて説明します。

次のクエリは、すべてのテーブルとビューから主キーを取得します。

         SELECT * FROM sys_primarykeys
          

Columns

Name	Type	Description
CatalogName	String	キーを含むデータベースの名前。
SchemaName	String	キーを含むスキーマの名前。
TableName	String	キーを含むテーブルの名前。
ColumnName	String	キーカラムの名前。
KeySeq	String	主キーのシーケンス番号。
KeyName	String	主キーの名前。

利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。

次のクエリは、主キーでないすべてのインデックスを取得します。

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name	Type	Description
CatalogName	String	インデックスを含むデータベースの名前。
SchemaName	String	インデックスを含むスキーマの名前。
TableName	String	インデックスを含むテーブルの名前。
IndexName	String	インデックス名。
ColumnName	String	インデックスに関連付けられたカラムの名前。
IsUnique	Boolean	インデックスが固有の場合はTrue。そうでない場合はFalse。
IsPrimary	Boolean	インデックスが主キーの場合はTrue。そうでない場合はFalse。
Type	Int16	インデックスタイプに対応する整数値：statistic (0)、clustered (1)、hashed (2)、またはother (3)。
SortOrder	String	並べ替え順序：A が昇順、D が降順。
OrdinalPosition	Int16	インデックスのカラムのシーケンスナンバー。

利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。

このテーブルをクエリする際は、config 接続文字列を使用する必要があります。

jdbc:cdata:paylocity:config:

この接続文字列を使用すると、有効な接続がなくてもこのテーブルをクエリできます。

次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name	Type	Description
Name	String	接続プロパティ名。
ShortDescription	String	簡単な説明。
Type	String	接続プロパティのデータ型。
Default	String	明示的に設定されていない場合のデフォルト値。
Values	String	可能な値のカンマ区切りリスト。別な値が指定されていると、検証エラーがスローされます。
Value	String	設定した値またはあらかじめ設定されたデフォルト。
Required	Boolean	プロパティが接続に必要かどうか。
Category	String	接続プロパティのカテゴリ。
IsSessionProperty	String	プロパティが、現在の接続に関する情報を保存するために使用されるセッションプロパティかどうか。
Sensitivity	String	プロパティの機密度。これは、プロパティがロギングおよび認証フォームで難読化されているかどうかを通知します。
PropertyName	String	キャメルケースの短縮形の接続プロパティ名。
Ordinal	Int32	パラメータのインデックス。
CatOrdinal	Int32	パラメータカテゴリのインデックス。
Hierarchy	String	このプロパティと一緒に設定する必要がある、関連のある依存プロパティを表示します。
Visible	Boolean	プロパティが接続UI に表示されるかどうかを通知します。
ETC	String	プロパティに関するその他のさまざまな情報。

Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。

SQL 構文の詳細については、SQL 準拠 を参照してください。

データソースのSELECT 機能

以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。

名前	説明	有効な値
AGGREGATE_FUNCTIONS	サポートされている集計関数。	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	COUNT 関数がサポートされているかどうか。	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	識別子をエスケープするための開始文字。	[
IDENTIFIER_QUOTE_CLOSE_CHAR	識別子をエスケープするための終了文字。	]
SUPPORTED_OPERATORS	サポートされているSQL 演算子。	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	GROUP BY がサポートされているかどうか。サポートされている場合、どのレベルでサポートされているか。	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	サポートされている外部結合の種類。	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	外部結合がサポートされているかどうか。	YES, NO
SUBQUERIES	サブクエリがサポートされているかどうか。サポートされていれば、どのレベルでサポートされているか。	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
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	サポートされている数値関数。	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	サポートされている日付および時刻関数。	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	レプリケーション中にスキップされたテーブルを示します。
REPLICATION_TIMECHECK_COLUMNS	レプリケーション中に更新判断のカラムとして使用するかどうかを、（指定された順に）チェックするカラムのリストを含む文字列の配列。
IDENTIFIER_PATTERN	識別子としてどの文字列が有効かを示す文字列値。
SUPPORT_TRANSACTION	プロバイダーが、コミットやロールバックなどのトランザクションをサポートしているかどうかを示します。	YES, NO
DIALECT	使用するSQL ダイアレクトを示します。
KEY_PROPERTIES	Uniform データベースを特定するプロパティを示します。
SUPPORTS_MULTIPLE_SCHEMAS	プロバイダー用に複数のスキームが存在するかどうかを示します。	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	プロバイダー用に複数のカタログが存在するかどうかを示します。	YES, NO
DATASYNCVERSION	このドライバーにアクセスするために必要な、CData Sync のバージョン。	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	このドライバーのCData Sync カテゴリ。	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	API で提供されている以上の、追加SQL 機能がサポートされているかどうか。	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	バッチ操作がサポートされているかどうか。	YES, NO
SQL_CAP	このドライバーでサポートされているすべてのSQL 機能。	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	使用したいcacheOptions を指定する文字列値。
ENABLE_EF_ADVANCED_QUERY	ドライバーがEntity Framework の高度なクエリをサポートしているかどうかを示します。サポートしていなければ、クエリはクライアントサイドで処理されます。	YES, NO
PSEUDO_COLUMNS	利用可能な疑似カラムを示す文字列の配列。
MERGE_ALWAYS	値がtrue であれば、CData Sync 内でMerge Model が強制的に実行されます。	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	レプリケート開始日時を返すSELECT クエリ。
REPLICATION_MIN_FUNCTION	サーバーサイドでmin を実行するために使用する式名を、プロバイダーが指定できるようになります。
REPLICATION_START_DATE	レプリケート開始日を、プロバイダーが指定できるようになります。
REPLICATION_MAX_DATE_QUERY	レプリケート終了日時を返すSELECT クエリ。
REPLICATION_MAX_FUNCTION	サーバーサイドでmax を実行するために使用する式名を、プロバイダーが指定できるようになります。
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	初回のレプリケートで、レプリケートをチャンクに分割しないテーブルのリスト。
CHECKCACHE_USE_PARENTID	CheckCache 構文を親キーカラムに対して実行するかどうかを示します。	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	スキーマファイルの生成に使用できる、ストアドプロシージャを示します。

次のクエリは、WHERE 句で使用できる演算子を取得します。

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデル セクションを参照してください。

Columns

Name	Type	Description
NAME	String	SQL 構文のコンポーネント、またはサーバー上で処理できる機能。
VALUE	String	サポートされるSQL またはSQL 構文の詳細。

試行された変更に関する情報を返します。

次のクエリは、バッチ処理で変更された行のId を取得します。

         SELECT * FROM sys_identity
          

Columns

Name	Type	Description
Id	String	データ変更処理から返された、データベース生成Id。
Batch	String	バッチの識別子。1 は単一処理。
Operation	String	バッチ内の処理の結果：INSERTED、UPDATED、またはDELETED。
Message	String	SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

Connection

---

プロパティ	説明
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

---

プロパティ	説明
OAuthClientId	OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecret	OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

SSL

---

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

Logging

---

プロパティ	説明
Verbosity	ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。

Schema

---

プロパティ	説明
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

Miscellaneous

---

プロパティ	説明
MaxRows	クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。

このセクションでは、本プロバイダーの接続文字列で設定可能なConnection プロパティの全リストを提供します。

---

プロパティ	説明
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.

データ型

string

デフォルト値

""

解説

The ID of the company file.

The custom field category in the company.

データ型

string

デフォルト値

"PayrollAndHR"

解説

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.

データ型

bool

デフォルト値

false

解説

Set to true if you you are using sandbox account.

Set this to the public key shared by Paylocity.

データ型

string

デフォルト値

""

解説

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.

データ型

string

デフォルト値

""

解説

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

データ型

string

デフォルト値

""

解説

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.

データ型

bool

デフォルト値

false

解説

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 プロパティの全リストを提供します。

---

プロパティ	説明
OAuthClientId	OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
OAuthClientSecret	OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。

データ型

string

デフォルト値

""

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。

OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。

データ型

string

デフォルト値

""

解説

OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。

---

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

データ型

string

デフォルト値

""

解説

TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります：

説明	例
フルPEM 証明書（例では省略されています）	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。	C:\cert.cer
公開鍵（例では省略されています）	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
MD5 Thumbprint （hex 値はスペースおよびコロン区切り）	ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint （hex 値はスペースおよびコロン区切り）	34a929226ae0819f2ec14b4a3d904f801cbb150d

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。

---

プロパティ	説明
Verbosity	ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。

ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。

データ型

string

デフォルト値

"1"

解説

Verbosity レベルは、Cloud がLogfile にどの程度の詳細さで記載するかを決定します。1 から5 までのVerbosity レベルがサポートされています。より詳しい説明は、ログ ページに記載されています。

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。

---

プロパティ	説明
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

データ型

string

デフォルト値

""

解説

スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。

---

プロパティ	説明
MaxRows	クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。

クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。

データ型

int

デフォルト値

-1

解説

クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。

このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。

データ型

string

デフォルト値

""

解説

Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。

タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。

データ型

int

デフォルト値

60

解説

Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。

Timeout の有効期限が切れても処理が完了していない場合は、Cloud は例外をスローします。