Salesforce Docs Portal

Paylocity Connector Objects

note: This feature is a Beta Service. A customer may opt to try a Beta Service in its sole discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided at Agreements and Terms. If you have questions or feedback about this Beta Service, contact the Data 360 Connector team at datacloud-connectors-beta@salesforce.com.

Objects Supported

Name Description
AdditionalRates Add/update additional rates
CompanyCodes Get All Company Codes
CustomFields Get All Custom Fields
DirectDeposit Get All Direct Deposit
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
EmployeePunchDetails Get employee punch details.
Employees Get all employee info
InputTimeEntry 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
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.
PrimaryStateTax Add/update primary state tax
SensitiveData Gets employee sensitive data information directly from Web Pay.

AdditionalRates

Name Type ReadOnly References FilterOnly Description
EmployeeId [KEY] String True Employees.EmployeeId No Id of the Employee.
CostCenter1 String False No 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 No 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 No 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 No Required. Valid values are HOUR or WEEK.
Rate Decimal False No Required. Enter dollar amount that corresponds to the Per selection.
RateCode String False No Required. If populated, must match one of the system coded values available in the Additional Rates Rate Code drop down.
ChangeReason String False No Not required. If populated, must match one of the system coded values available in the Additional Rates Change Reason drop down.
EffectiveDate Date False No Required. Common formats include MM-DD-CCYY, CCYY-MM-DD.
EndCheckDate Date False No 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 No Not required.
Job String False No Not required. If populated, must match one of the system coded values available in the Additional Rates Job drop down.
Shift String False No Not required. If populated, must match one of the system coded values available in the Additional Rates Shift drop down.
CompanyId String True No Id of the Company.

Return to Top

CompanyCodes

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

Return to Top

CustomFields

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

Return to Top

DirectDeposit

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

Return to Top

Earnings

Name Type ReadOnly References FilterOnly Description
EmployeeId [KEY] String True Employees.EmployeeId No Id of the Employee.
PaidTowardsGoal Decimal False No Amount already paid to employee toward goal. Decimal(12,2)
MiscellaneousInfo String False No Information to print on the check stub if agency is set up for this earning.
EffectiveDate Date False No 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 No Cost Center associated with earning. Must match Company setup.
CostCenter2 String False No Cost Center associated with earning. Must match Company setup.
CostCenter3 String False No Cost Center associated with earning. Must match Company setup.
AnnualMaximum Decimal False No 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 No Used for ACA. If not entered, defaulted to Company earning setup.
Rate Decimal False No Rate is used in conjunction with the hoursOrUnits field. Decimal(12,2)
Frequency String False No Needed if earning is applied differently from the payroll frequency (one time earning for example).
EndDate Date False No Stop date of an earning. Common formats are MM-DD-CCYY, CCYY-MM-DD.
HoursOrUnits Decimal False No 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 No Earning code. Must match Company setup.
RateCode String False No Rate Code applies to additional pay rates entered for an employee. Must match Company setup.
Goal Decimal False No Dollar amount. The employee earning will stop when the goal amount is reached. Decimal(12,2)
CalculationCode String False No 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 No Start date of an earning based on payroll calendar. Common formats are MM-DD-CCYY, CCYY-MM-DD.
PayPeriodMaximum Decimal False No Maximum amount of the earning on a single paycheck. Decimal(12,2)
JobCode String False No Job code associated with earnings. Must match Company setup.
Amount Decimal False No Value that matches CalculationCode to add to gross wages. For percentage (%), enter whole number (10 = 10%). Decimal(12,2)
Agency String False No Third-party agency associated with earning. Must match Company setup.
PayPeriodMinimum Decimal False No Minimum amount of the earning on a single paycheck. Decimal(12,2)
CompanyId String True No Id of the Company.

Return to Top

EmergencyContacts

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

Return to Top

EmployeeBenefitSetup

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

Return to Top

EmployeeDetails

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

Return to Top

EmployeePunchDetails

Name Type ReadOnly References FilterOnly Description
EmployeeId [KEY] String False Employees.EmployeeId No Id of the Employee.
SegmentsPunchId [KEY] String False No A unique identifier assigned to each punch or time entry, ensuring that each entry is distinct, traceable, and easily referenced for tracking purposes.
CompanyId String False No The Paylocity Company ID. This is the unique value provided by Paylocity to each specific Payroll Entity.
BadgeNumber Integer False No The Time and Labor badge number.
RelativeStart Datetime False No The relative DateTime for the beginning of the WorkedShift in format yyyy-MM-ddThh:mm:ss.
RelativeEnd Datetime False No The relative DateTime for the end of the WorkedShift in format yyyy-MM-ddThh:mm:ss.
SegmentsOrigin String False No The associated origin of the time entry.
SegmentsDate Date False No Date the worked shift segment took place. In the case of over night shifts, this is the date these worked hours apply to in payroll and can play a role in some overtime calculations.
SegmentsPunchType String False No The type of punch recorded indicating whether it was recorded for categories such as work, lunch break etc.
SegmentsRelativeStart Datetime False No Relative DateTime of the beginning of this segment after payroll policy rules are applied. Null if the segment began with a missed punch.
SegmentsRelativeEnd Datetime False No Relative DateTime of the end of this segment after payroll policy rules are applied. Null if the segment ended with a missed punch.
SegmentsRelativeOriginalStart Datetime False No Relative DateTimeOffset of the beginning of this segment before payroll policy rules are applied. Null if the segment began with a missed punch.
SegmentsRelativeOriginalEnd Datetime False No Relative DateTime of the end of this segment before payroll policy rules are applied. Null if the segment ended with a missed punch.
SegmentsDurationHours Double False No The total hours worked by the employee for a particular punch or time entry, reflecting the duration of their work.
SegmentsEarnings Double False No The total earnings accrued by the employee for the specific punch or time entry, including wages, bonuses, or additional compensation.
SegmentsCostCenters String False No List of cost centers, at most one per cost center level, that this segment of the worked shift is allocated to.
TestFlag Boolean False Yes A Boolean value that, when set to

Return to Top

Employees

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

Return to Top

InputTimeEntry

Name Type ReadOnly References FilterOnly Description
EmployeeId String False No Id of the Employee
Det String False No Identifies the type of record being imported. Use E for earning, D for deduction, or A for accrual balances.
DetCode String False No The earning or benefit code. This must be a code currently defined for the company.
Hours Double False No The number of hours worked by the employee or the used accrual hours.
Amount Integer False No 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 No The employee's pay rate. If no rate is entered, the system will use the employee's base rate.
RateCode String False No 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 No Use this field to enter an override value for the first level cost center charged by the employee.
CostCenter2 String False No Use this field to enter an override value for the second level cost center charged by the employee.
CostCenter3 String False No 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 No This field is used to enter an override company defined job code to be charged by the employee.
Shift String False No This field is used to enter an override company defined shift code to be charged by the employee.
BeginDate String False No Begin Date associated with this line item.
EndDate String False No End Date associated with this line item.
WorkersCompCode String False No The company defined workers comp code for the work performed by the employee.
TCode1 String False No 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 No 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 No 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 No Not used unless directed by service bureau (Do not use).
Sequence String False No Use this field to indicate multiple checks.
CheckType String False No Use this field to indicate an override Check Type.
CheckNumber String False No 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.

Return to Top

LocalTaxes

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

Return to Top

NonPrimaryStateTax

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

Return to Top

PayStatementsdetails

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

Return to Top

PayStatementssummary

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

Return to Top

PrimaryStateTax

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

Return to Top

SensitiveData

Name Type ReadOnly References FilterOnly Description
EmployeeId [KEY] String False Employees.EmployeeId No Id of the Employee.
CompanyId String False No Id of the Company.
Disability String False No Description of employee's disability or accommodation.
DisabilityClassifications String False No Indicates the type of disability.
HasDisability String False No Indicates if the employee has a disability. Values include:0 = No, 1 = Yes or 2 = Prefer not to say.
Ethnicity String False No Employee's legal ethnicity or race.
EthnicRacialIdentities String False No Employee's preferred or chosen ethnicity or race.
DisplayPronouns String False No 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 No Employee's preferred or chosen gender identification. Values include:0 = No, 1 = Yes or 2 = Prefer not to say.
IdentifyAsLegalGender String False No Employee's self-identification of legal gender.
LegalGender String False No Employee's legal gender.
Pronouns String False No Employee's preferred or chosen pronouns.
SexualOrientation String False No Employee's self-identification of sexual orientation.
IsVeteran String False No Indicates if the employee is a veteran. Values include:0 = No, 1 = Yes or 2 = Prefer not to say.
Veteran String False No Employee's Veteran Notes.

Return to Top