Module paylocity
ballerinax/paylocity Ballerina library
1.5.1
Overview
This is a generated connector for Paylocity API v2 OpenAPI Specification.
Paylocity API provides the capability to perform human capital management and payroll management operations.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create Paylocity account
- Obtain tokens - Follow this guide
Clients
paylocity: Client
Isolated
This is a generated connector for Paylocity API v2 OpenAPI Specification. Paylocity Web Services API is an externally facing RESTful Internet protocol. The Paylocity API uses HTTP verbs and a RESTful endpoint structure. OAuth 2.0 is used as the API Authorization framework. Request and response payloads are formatted as JSON. Paylocity supports v1 and v2 versions of its API endpoints. v1, while supported, won't be enhanced with additional functionality. For direct link to v1 documentation, please click here. For additional resources regarding v1/v2 differences and conversion path, please contact webservices@paylocity.com. Paylocity will provide the secure client credentials and set up the scope (type of requests and allowed company numbers). You will receive the unique client id, secret, and Paylocity public key for the data encryption. The secret will expire in 365 days.
- Paylocity will send you an e-mail 10 days prior to the expiration date for the current secret. If not renewed, the second e-mail notification will be sent 5 days prior to secret's expiration. Each email will contain the code necessary to renew the client secret.
- You can obtain the new secret by calling API endpoint using your current not yet expired credentials and the code that was sent with the notification email. For details on API endpoint, please see Client Credentials section.
- Both the current secret value and the new secret value will be recognized during the transition period. After the current secret expires, you must use the new secret.
- If you were unable to renew the secret via API endpoint, you can still contact Service and they will email you new secret via secure email.
Constructor
Gets invoked to initialize the connector.
The connector initialization requires setting the API credentials.
Create Paylocity account and obtain tokens by following this guide.
init (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.paylocity.com/api" - URL of the target service
getAllCompanyCodesAndDescriptionsByResource
Isolated FunctionRemote Function
function getAllCompanyCodesAndDescriptionsByResource(string companyId, string codeResource) returns CompanyCodes[]|errorGet All Company Codes
Parameters
- companyId string - Company Id
- codeResource string - Type of Company Code. Common values costcenter1, costcenter2, costcenter3, deductions, earnings, taxes, paygrade, positions.
Return Type
- CompanyCodes[]|error - Successfully retrieved
getAllCustomFieldsByCategory
Isolated FunctionRemote Function
function getAllCustomFieldsByCategory(string companyId, string category) returns CustomFieldDefinition[]|errorGet All Custom Fields
Return Type
- CustomFieldDefinition[]|error - Successfully retrieved
addEmployee
Isolated FunctionRemote Function
function addEmployee(string companyId, Employee payload) returns EmployeeIdResponse[]|errorAdd new employee
Return Type
- EmployeeIdResponse[]|error - Successfully added
getAllEmployees
Isolated FunctionRemote Function
function getAllEmployees(string companyId, int? pagesize, int? pagenumber, boolean? includetotalcount) returns EmployeeInfo[]|errorGet all employees
Parameters
- companyId string - Company Id
- pagesize int? (default ()) - Number of records per page. Default value is 25.
- pagenumber int? (default ()) - Page number to retrieve; page numbers are 0-based (so to get the first page of results, pass pagenumber=0). Default value is 0.
- includetotalcount boolean? (default ()) - Whether to include the total record count in the header's X-Pcty-Total-Count property. Default value is true.
Return Type
- EmployeeInfo[]|error - Successfully Retrieved
getEmployee
Isolated FunctionRemote Function
Get employee
updateEmployee
Isolated FunctionRemote Function
function updateEmployee(string companyId, string employeeId, Employee payload) returns Response|errorUpdate employee
Parameters
- companyId string - Company Id
- employeeId string - Employee Id
- payload Employee - Employee Model
addOrUpdateAdditionalRates
Isolated FunctionRemote Function
function addOrUpdateAdditionalRates(string companyId, string employeeId, AdditionalRate payload) returns Response|errorAdd/update additional rates
Parameters
- companyId string - Company Id
- employeeId string - Employee Id
- payload AdditionalRate - Additional Rate Model
updateOrAddEmployeeBenefitSetup
Isolated FunctionRemote Function
function updateOrAddEmployeeBenefitSetup(string companyId, string employeeId, BenefitSetup payload) returns Response|errorAdd/update employee's benefit setup
Parameters
- companyId string - Company Id
- employeeId string - Employee Id
- payload BenefitSetup - BenefitSetup Model
getAllDirectDeposit
Isolated FunctionRemote Function
function getAllDirectDeposit(string companyId, string employeeId) returns DirectDeposit[]|errorGet All Direct Deposit
Return Type
- DirectDeposit[]|error - Successfully Retrieved
getAllEarnings
Isolated FunctionRemote Function
Get All Earnings
addOrUpdateAnEmployeeEarning
Isolated FunctionRemote Function
function addOrUpdateAnEmployeeEarning(string companyId, string employeeId, Earning payload) returns Response|errorAdd/Update Earning
Parameters
- companyId string - Company Id
- employeeId string - Employee Id
- payload Earning - Earning Model
getEarningsByEarningCode
Isolated FunctionRemote Function
function getEarningsByEarningCode(string companyId, string employeeId, string earningCode) returns Earning[]|errorGet Earnings by Earning Code
Parameters
- companyId string - Company Id
- employeeId string - Employee Id
- earningCode string - Earning Code
getEarningByEarningCodeAndStartDate
Isolated FunctionRemote Function
function getEarningByEarningCodeAndStartDate(string companyId, string employeeId, string earningCode, string startDate) returns Earning|errorGet Earning by Earning Code and Start Date
Parameters
- companyId string - Company Id
- employeeId string - Employee Id
- earningCode string - Earning Code
- startDate string - Start Date
deleteEarningByEarningCodeAndStartDate
Isolated FunctionRemote Function
function deleteEarningByEarningCodeAndStartDate(string companyId, string employeeId, string earningCode, string startDate) returns Response|errorDelete Earning by Earning Code and Start Date
Parameters
- companyId string - Company Id
- employeeId string - Employee Id
- earningCode string - Earning Code
- startDate string - Start Date
addOrUpdateEmergencyContacts
Isolated FunctionRemote Function
function addOrUpdateEmergencyContacts(string companyId, string employeeId, EmergencyContact payload) returns Response|errorAdd/update emergency contacts
Parameters
- companyId string - Company Id
- employeeId string - Employee Id
- payload EmergencyContact - Emergency Contact Model
getAllLocalTaxes
Isolated FunctionRemote Function
Get all local taxes
addLocalTax
Isolated FunctionRemote Function
Add new local tax
Parameters
- companyId string - Company Id
- employeeId string - Employee Id
- payload LocalTax - LocalTax Model
getLocalTaxByTaxCode
Isolated FunctionRemote Function
function getLocalTaxByTaxCode(string companyId, string employeeId, string taxCode) returns LocalTax[]|errorGet local taxes by tax code
deleteLocalTaxByTaxCode
Isolated FunctionRemote Function
function deleteLocalTaxByTaxCode(string companyId, string employeeId, string taxCode) returns Response|errorDelete local tax by tax code
addOrUpdateNonPrimaryStateTax
Isolated FunctionRemote Function
function addOrUpdateNonPrimaryStateTax(string companyId, string employeeId, NonPrimaryStateTax payload) returns Response|errorAdd/update non-primary state tax
Parameters
- companyId string - Company Id
- employeeId string - Employee Id
- payload NonPrimaryStateTax - Non-Primary State Tax Model
getsEmployeePayStatementDetailDataBasedOnTheSpecifiedYear
Isolated FunctionRemote Function
function getsEmployeePayStatementDetailDataBasedOnTheSpecifiedYear(string companyId, string employeeId, string year, int? pagesize, int? pagenumber, boolean? includetotalcount, string? dettypes) returns PayStatementDetails[]|errorGet employee pay statement details data for the specified year.
Parameters
- companyId string - Company Id
- employeeId string - Employee Id
- year string - The year for which to retrieve pay statement data
- pagesize int? (default ()) - Number of records per page. Default value is 25.
- pagenumber int? (default ()) - Page number to retrieve; page numbers are 0-based (so to get the first page of results, pass pagenumber=0). Default value is 0.
- includetotalcount boolean? (default ()) - Whether to include the total record count in the header's X-Pcty-Total-Count property. Default value is true.
- dettypes string? (default ()) - Retrieve pay statement details related to specific deduction, earning or tax types. Common values include 401k, Memo, Reg, OT, Cash Tips, FED and SITW.
Return Type
- PayStatementDetails[]|error - Successfully Retrieved
getsEmployeePayStatementDetailDataBasedOnTheSpecifiedYearAndCheckDate
Isolated FunctionRemote Function
function getsEmployeePayStatementDetailDataBasedOnTheSpecifiedYearAndCheckDate(string companyId, string employeeId, string year, string checkDate, int? pagesize, int? pagenumber, boolean? includetotalcount, string? dettypes) returns PayStatementDetails[]|errorGet employee pay statement details data for the specified year and check date.
Parameters
- companyId string - Company Id
- employeeId string - Employee Id
- year string - The year for which to retrieve pay statement data
- checkDate string - The check date for which to retrieve pay statement data
- pagesize int? (default ()) - Number of records per page. Default value is 25.
- pagenumber int? (default ()) - Page number to retrieve; page numbers are 0-based (so to get the first page of results, pass pagenumber=0). Default value is 0.
- includetotalcount boolean? (default ()) - Whether to include the total record count in the header's X-Pcty-Total-Count property. Default value is true.
- dettypes string? (default ()) - Retrieve pay statement details related to specific deduction, earning or tax types. Common values include 401k, Memo, Reg, OT, Cash Tips, FED and SITW.
Return Type
- PayStatementDetails[]|error - Successfully Retrieved
getsEmployeePayStatementSummaryDataBasedOnTheSpecifiedYear
Isolated FunctionRemote Function
function getsEmployeePayStatementSummaryDataBasedOnTheSpecifiedYear(string companyId, string employeeId, string year, int? pagesize, int? pagenumber, boolean? includetotalcount, string? dettypes) returns PayStatementSummary[]|errorGet employee pay statement summary data for the specified year.
Parameters
- companyId string - Company Id
- employeeId string - Employee Id
- year string - The year for which to retrieve pay statement data
- pagesize int? (default ()) - Number of records per page. Default value is 25.
- pagenumber int? (default ()) - Page number to retrieve; page numbers are 0-based (so to get the first page of results, pass pagenumber=0). Default value is 0.
- includetotalcount boolean? (default ()) - Whether to include the total record count in the header's X-Pcty-Total-Count property. Default value is true.
- dettypes string? (default ()) - Retrieve pay statement details related to specific deduction, earning or tax types. Common values include 401k, Memo, Reg, OT, Cash Tips, FED and SITW.
Return Type
- PayStatementSummary[]|error - Successfully Retrieved
getsEmployeePayStatementSummaryDataBasedOnTheSpecifiedYearAndCheckDate
Isolated FunctionRemote Function
function getsEmployeePayStatementSummaryDataBasedOnTheSpecifiedYearAndCheckDate(string companyId, string employeeId, string year, string checkDate, int? pagesize, int? pagenumber, boolean? includetotalcount, string? dettypes) returns PayStatementSummary[]|errorGet employee pay statement summary data for the specified year and check date.
Parameters
- companyId string - Company Id
- employeeId string - Employee Id
- year string - The year for which to retrieve pay statement data
- checkDate string - The check date for which to retrieve pay statement data
- pagesize int? (default ()) - Number of records per page. Default value is 25.
- pagenumber int? (default ()) - Page number to retrieve; page numbers are 0-based (so to get the first page of results, pass pagenumber=0). Default value is 0.
- includetotalcount boolean? (default ()) - Whether to include the total record count in the header's X-Pcty-Total-Count property. Default value is true.
- dettypes string? (default ()) - Retrieve pay statement details related to specific deduction, earning or tax types. Common values include 401k, Memo, Reg, OT, Cash Tips, FED and SITW.
Return Type
- PayStatementSummary[]|error - Successfully Retrieved
addOrUpdatePrimaryStateTax
Isolated FunctionRemote Function
function addOrUpdatePrimaryStateTax(string companyId, string employeeId, StateTax payload) returns Response|errorAdd/update primary state tax
Parameters
- companyId string - Company Id
- employeeId string - Employee Id
- payload StateTax - Primary State Tax Model
getCompanySpecificOpenApiDocumentation
Isolated FunctionRemote Function
function getCompanySpecificOpenApiDocumentation(string authorization, string companyId) returns Response|errorGet Company-Specific Open API Documentation
addClientSecret
Isolated FunctionRemote Function
function addClientSecret(AddClientSecret payload) returns ClientCredentialsResponse[]|errorObtain new client secret.
Parameters
- payload AddClientSecret - Add Client Secret Model
Return Type
- ClientCredentialsResponse[]|error - Successfully added
addNewEmployeeToWebLink
Isolated FunctionRemote Function
function addNewEmployeeToWebLink(string companyId, StagedEmployee payload) returns TrackingNumberResponse[]|errorAdd new employee to Web Link
Return Type
- TrackingNumberResponse[]|error - Successfully Added
Records
paylocity: AddClientSecret
The Add Client Secret Request Model
Fields
- code string - A value sent with the 'ACTION NEEDED: Web Link API Credentials Expiring Soon.' email notification.
paylocity: AdditionalRate
The additional pay rate model
Fields
- changeReason string? - Not required. If populated, must match one of the system coded values available in the Additional Rates Change Reason drop down.<br />
- costCenter1 string? - 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.<br />
- costCenter2 string? - 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.<br />
- costCenter3 string? - 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.<br />
- effectiveDate string? - Required. Common formats include MM-DD-CCYY, CCYY-MM-DD.<br />
- endCheckDate string? - 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.<br />
- job string? - Not required. If populated, must match one of the system coded values available in the Additional Rates Job drop down.<br />
- rate decimal? - Required. Enter dollar amount that corresponds to the Per selection.<br />
- rateCode string? - Required. If populated, must match one of the system coded values available in the Additional Rates Rate Code drop down.<br />
- rateNotes string? - Not required.<br />Max length: 4000<br />
- ratePer string? - Required. Valid values are HOUR or WEEK.<br />
- shift string? - Not required. If populated, must match one of the system coded values available in the Additional Rates Shift drop down.<br />
paylocity: BenefitSetup
The benefit setup model
Fields
- benefitClass string? - Benefit Class code. Values are configured in Web Pay Company > Setup > Benefits > Classes.<br />Max length: 30
- benefitClassEffectiveDate string? - Date when Benefit Class takes effect. Common formats include MM-DD-CCYY, CCYY-MM-DD.
- benefitSalary decimal? - Salary used to configure benefits.<br />Decimal(12,2)
- benefitSalaryEffectiveDate string? - Date when Benefit Salary takes effect. Common formats include MM-DD-CCYY, CCYY-MM-DD.
- doNotApplyAdministrativePeriod boolean? - Applicable only for HR Enhanced clients and Benefit Classes with ACA Employment Type of Full Time.
- isMeasureAcaEligibility boolean? - Only valid for HR Enhanced clients and Benefit Classes that are ACA Employment Type of Full Time.
paylocity: ClientCredentialsResponse
The Client Credentials Response Model
Fields
- clientSecret string? - The client's secret
- clientSecretExpirationDate string? - The client's secret expiration date
paylocity: ClientHttp1Settings
Closed record
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy ProxyConfig? - Proxy server related options
paylocity: CompanyCodes
The Company Codes model
Fields
- code string? - Code.<br /> Max length: 40
- description string? - Description. <br /> Max length: 150
paylocity: ConnectionConfig
Closed record
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth OAuth2ClientCredentialsGrantConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- poolConfig PoolConfiguration? - Configurations associated with request pooling
- cache CacheConfig? - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig? - Configurations associated with retrying
- responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket? - SSL/TLS-related options
- proxy ProxyConfig? - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
paylocity: CustomFieldDefinition
Fields
- category string? - The custom field category.
- defaultValue string? - Specifies the default value of the custom field.
- isRequired boolean? - Indicates whether the custom field is required.
- label string? - The custom field label.
- 'type string? - The custom field type.
- values CustomfielddefinitionValues[]? - A set of values that are applicable to the custom field.
paylocity: CustomfielddefinitionValues
Fields
- code string? - The custom field code.
- description string? - The custom field description.
paylocity: DirectDeposit
The Direct Deposit model
Fields
- additionalDirectDeposit DirectdepositAdditionaldirectdeposit[]? - Additional Direct Deposits that are not the main Direct Deposit.
- mainDirectDeposit DirectdepositMaindirectdeposit? - The main Direct Deposit account.
paylocity: DirectdepositAdditionaldirectdeposit
The additional direct deposit model
Fields
- accountNumber string? - Account number, entered without special characters and spaces. <br />Max length: 17<br />
- accountType string? - Account type. Valid values are C (Checking), S (Saving), P (Pay Card). <br />Max length: 1<br />
- amount decimal? - Amount value to be deposited to the account.<br />Decimal (12,2)<br />
- amountType string? - Amount type to indicate the context of the amount. Common values are F (FLAT), F- (Net Minus), P (Percent). <br /> Max length: 5<br />
- blockSpecial boolean? - Indicates if direct deposit should be blocked when special check types such as Bonus are processed.<br />
- isSkipPreNote boolean? - Indicates if account will not pre-note.<br />
- nameOnAccount string? - Name on the bank account. Defaults to employee's name. <br />Max length: 30<br />
- preNoteDate string? - Date to end the pre-note of the account. Common formats include MM-DD-CCYY, CCYY-MM-DD.<br />
- routingNumber string? - ABA Transit Routing Number, entered without dashes or spaces. <br />Max length: 9<br />
paylocity: DirectdepositMaindirectdeposit
The main Direct Deposit account.
Fields
- accountNumber string? - Account number, entered without special characters and spaces. <br />Max length: 17
- accountType string? - Account type. Valid values are C (Checking), S (Saving), P (Pay Card). <br />Max length: 1
- blockSpecial boolean? - Indicates if direct deposit should be blocked when special check types such as Bonus are processed.<br />
- isSkipPreNote boolean? - Indicates if account will not pre-note.
- nameOnAccount string? - Name on the bank account. Defaults to employee's name. <br />Max length: 30<br />
- preNoteDate string? - Date to end the pre-note of the account. Common formats include MM-DD-CCYY, CCYY-MM-DD.
- routingNumber string? - ABA Transit Routing Number, entered without dashes or spaces. <br />Max length: 9
paylocity: Earning
The employee earning model
Fields
- agency string? - Third-party agency associated with earning. Must match Company setup.<br />Max length: 10
- amount decimal? - Value that matches CalculationCode to add to gross wages. For percentage (%), enter whole number (10 = 10%). <br />Decimal(12,2)
- annualMaximum decimal? - Year to Date dollar amount not to be exceeded for an earning in the calendar year. Used only with company driven maximums. <br />Decimal(12,2)
- calculationCode string? - Defines how earnings are calculated. Common values are % (percentage of gross), flat (flat dollar amount). Defaulted to the Company setup calcCode for earning. <br />Max length: 20
- costCenter1 string? - Cost Center associated with earning. Must match Company setup.<br /> Max length: 10
- costCenter2 string? - Cost Center associated with earning. Must match Company setup.<br /> Max length: 10
- costCenter3 string? - Cost Center associated with earning. Must match Company setup.<br /> Max length: 10
- earningCode string - Earning code. Must match Company setup. <br />Max length: 10
- effectiveDate string? - Date earning is active. Defaulted to run date or check date based on Company setup. Common formats are MM-DD-CCYY, CCYY-MM-DD.
- endDate string? - Stop date of an earning. Common formats are MM-DD-CCYY, CCYY-MM-DD.
- frequency string? - Needed if earning is applied differently from the payroll frequency (one time earning for example).<br /> Max length: 5
- goal decimal? - Dollar amount. The employee earning will stop when the goal amount is reached.<br /> Decimal(12,2)
- hoursOrUnits decimal? - 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. <br /> Decimal(12,2)
- isSelfInsured boolean? - Used for ACA. If not entered, defaulted to Company earning setup.
- jobCode string? - Job code associated with earnings. Must match Company setup.<br /> Max length: 20
- miscellaneousInfo string? - Information to print on the check stub if agency is set up for this earning. <br />Max length: 50
- paidTowardsGoal decimal? - Amount already paid to employee toward goal. <br /> Decimal(12,2)
- payPeriodMaximum decimal? - Maximum amount of the earning on a single paycheck. <br /> Decimal(12,2)
- payPeriodMinimum decimal? - Minimum amount of the earning on a single paycheck. <br /> Decimal(12,2)
- rate decimal? - Rate is used in conjunction with the hoursOrUnits field. <br /> Decimal(12,2)
- rateCode string? - Rate Code applies to additional pay rates entered for an employee. Must match Company setup. <br /> Max length: 10
- startDate string - Start date of an earning based on payroll calendar. Common formats are MM-DD-CCYY, CCYY-MM-DD.
paylocity: EmergencyContact
The emergency contact model
Fields
- address1 string? - 1st address line.
- address2 string? - 2nd address line.
- city string? - City.
- country string? - County.
- county string? - Country. Must be a valid 3 character country code. Common values are USA (United States), CAN (Canada).
- email string? - Contact email. Must be valid email address format.
- firstName string - Required. Contact first name. <br />Max length: 40
- homePhone string? - Contact Home Phone. Valid phone format (###) ####### or ######-#### or ### ### #### or ########## or, if international, starts with +#, only spaces and digits allowed.
- lastName string - Required. Contact last name. <br />Max length: 40
- mobilePhone string? - Contact Mobile Phone. Valid phone format (###) ####### or ######-#### or ### ### #### or ########## or, if international, starts with +#, only spaces and digits allowed.
- notes string? - Notes. <br />Max length: 1000
- pager string? - Contact Pager. Valid phone format (###) ####### or ######-#### or ### ### #### or ########## or, if international, starts with +#, only spaces and digits allowed.
- primaryPhone string? - Required. Contact primary phone type. Must match Company setup. Valid values are H (Home), M (Mobile), P (Pager), W (Work)
- priority string? - Required. Contact priority. Valid values are P (Primary) or S (Secondary).
- relationship string? - Required. Contact relationship. Must match Company setup. Common values are Spouse, Mother, Father.
- state string? - State or Province. If U.S. address, must be valid 2 character state code. Common values are IL (Illinois), CA (California).
- syncEmployeeInfo boolean? - Valid values are true or false.
- workExtension string? - Work Extension.
- workPhone string? - Contact Work Phone. Valid phone format (###) ####### or ######-#### or ### ### #### or ########## or, if international, starts with +#, only spaces and digits allowed.
- zip string? - Postal code. If U.S. address, must be a valid zip code.
paylocity: Employee
The employee model
Fields
- additionalDirectDeposit DirectdepositAdditionaldirectdeposit[]? - 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.
- additionalRate EmployeeAdditionalrate[]? - Add Additional Rates.
- benefitSetup EmployeeBenefitsetup? - Add or update setup values used for employee benefits integration, insurance plan settings, and ACA reporting.
- birthDate string? - Employee birthdate. Common formats include MM-DD-CCYY, CCYY-MM-DD.
- companyFEIN string? - Company FEIN as defined in Web Pay, applicable with GET requests only.<br /> Max length: 20
- companyName string? - Company name as defined in Web Pay, applicable with GET requests only.<br /> Max length: 50
- currency string? - Employee is paid in this currency. <br />Max length: 30
- customBooleanFields EmployeeCustombooleanfields[]? - Up to 8 custom fields of boolean (checkbox) type value.
- customDateFields EmployeeCustomdatefields[]? - Up to 8 custom fields of the date type value.
- customDropDownFields EmployeeCustomdropdownfields[]? - Up to 8 custom fields of the dropdown type value.
- customNumberFields EmployeeCustomnumberfields[]? - Up to 8 custom fields of numeric type value.
- customTextFields EmployeeCustomtextfields[]? - Up to 8 custom fields of text type value.
- departmentPosition EmployeeDepartmentposition? - Add or update home department cost center, position, supervisor, reviewer, employment type, EEO class, pay settings, and union information.
- disabilityDescription string? - Indicates if employee has disability status.
- emergencyContacts EmployeeEmergencycontacts[]? - Add or update Emergency Contacts.
- employeeId string? - Leave blank to have Web Pay automatically assign the next available employee ID.<br />Max length: 10
- ethnicity string? - Employee ethnicity.<br /> Max length: 10
- federalTax EmployeeFederaltax? - Add or update federal tax amount type (taxCalculationCode), amount or percentage, filing status, and exemptions.
- firstName string? - Employee first name. <br />Max length: 40
- gender string? - Employee gender. Common values M (Male), F (Female). <br />Max length: 1
- homeAddress EmployeeHomeaddress? - Add or update employee's home address, personal phone numbers, and personal email.
- isHighlyCompensated boolean? - Indicates if employee meets the highly compensated employee criteria.
- isSmoker boolean? - Indicates if employee is a smoker.
- lastName string? - Employee last name. <br />Max length: 40
- localTax EmployeeLocaltax[]? - Add, update, or delete local tax code, filing status, and exemptions including PA-PSD taxes.
- mainDirectDeposit EmployeeMaindirectdeposit? - Add the main direct deposit account. After deposits are made to any additional direct deposit accounts, the remaining net check is deposited in 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 what is provided on the request. GET API will not return direct deposit data.
- maritalStatus string? - Employee marital status. Common values D (Divorced), M (Married), S (Single), W (Widowed). <br />Max length: 10
- middleName string? - Employee middle name.<br /> Max length: 20
- nonPrimaryStateTax EmployeeNonprimarystatetax? - Add or update non-primary state tax code, amount type (taxCalculationCode), amount or percentage, filing status, exemptions, supplemental check (specialCheckCalc), and reciprocity code information.
- ownerPercent decimal? - Percentage of employee's ownership in the company, entered as a whole number. <br /> Decimal (12,2)
- preferredName string? - Employee preferred display name.<br /> Max length: 20
- primaryPayRate EmployeePrimarypayrate? - Add or update hourly or salary pay rate, effective date, and pay frequency.
- primaryStateTax EmployeePrimarystatetax? - Add or update primary state tax code, amount type (taxCalculationCode), amount or percentage, filing status, exemptions, and supplemental check (specialCheckCalc) information. Only one primary state is allowed. Sending an updated primary state will replace the current primary state.
- priorLastName string? - Prior last name if applicable.<br />Max length: 40
- salutation string? - Employee preferred salutation. <br />Max length: 10
- ssn string? - Employee social security number. Leave it blank if valid social security number not available. <br />Max length: 11
- status EmployeeStatus? - Add or update employee status, change reason, effective date, and adjusted seniority date. Note that companies that are still in Implementation cannot hire future employees.
- suffix string? - Employee name suffix. Common values are Jr, Sr, II.<br />Max length: 30
- taxSetup EmployeeTaxsetup? - Add tax form, 1099 exempt reasons and notes, and 943 agricultural employee information. Once the employee receives wages, this information cannot be updated. Add or update SUI tax state, retirement plan, and statutory information.
- veteranDescription string? - Indicates if employee is a veteran.
- webTime EmployeeWebtime? - Add or update Web Time badge number and charge rate and synchronize Web Pay and Web Time employee data.
- workAddress EmployeeWorkaddress? - Add or update employee's work address, phone numbers, and email. Work Location drop down field is not included.
- workEligibility EmployeeWorkeligibility? - Add or update I-9 work authorization information.
paylocity: EmployeeAdditionalrate
The additional pay rate model
Fields
- changeReason string? - Not required. If populated, must match one of the system coded values available in the Additional Rates Change Reason drop down.<br />
- costCenter1 string? - 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.<br />
- costCenter2 string? - 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.<br />
- costCenter3 string? - 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.<br />
- effectiveDate string? - Required. Common formats include MM-DD-CCYY, CCYY-MM-DD.<br />
- endCheckDate string? - 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.<br />
- job string? - Not required. If populated, must match one of the system coded values available in the Additional Rates Job drop down.<br />
- rate decimal? - Required. Enter dollar amount that corresponds to the Per selection.<br />
- rateCode string? - Required. If populated, must match one of the system coded values available in the Additional Rates Rate Code drop down.<br />
- rateNotes string? - Not required.<br />Max length: 4000<br />
- ratePer string? - Required. Valid values are HOUR or WEEK.<br />
- shift string? - Not required. If populated, must match one of the system coded values available in the Additional Rates Shift drop down.<br />
paylocity: EmployeeBenefitsetup
Add or update setup values used for employee benefits integration, insurance plan settings, and ACA reporting.
Fields
- benefitClass string? - Benefit Class code. Values are configured in Web Pay Company > Setup > Benefits > Classes.<br />Max length: 30
- benefitClassEffectiveDate string? - Date when Benefit Class takes effect. Common formats include MM-DD-CCYY, CCYY-MM-DD.
- benefitSalary decimal? - Salary used to configure benefits.<br />Decimal(12,2)
- benefitSalaryEffectiveDate string? - Date when Benefit Salary takes effect. Common formats include MM-DD-CCYY, CCYY-MM-DD.
- doNotApplyAdministrativePeriod boolean? - Applicable only for HR Enhanced clients and Benefit Classes with ACA Employment Type of Full Time.
- isMeasureAcaEligibility boolean? - Only valid for HR Enhanced clients and Benefit Classes that are ACA Employment Type of Full Time.
paylocity: EmployeeCustombooleanfields
Fields
- category string - The custom field category. Acceptable value is 'PayrollAndHR'.
- label string - The custom field label whose value is to be added/updated. Must match to the label defined in Web Pay Custom Fields setup. Max length: 255.
- value boolean - The custom boolean field value.
paylocity: EmployeeCustomdatefields
Fields
- category string - The custom field category. Acceptable value is 'PayrollAndHR'.
- label string - The custom field label whose value is to be added/updated. Must match to the label defined in Web Pay Custom Fields setup. Max length: 255.
- value string - The custom date field value. Common formats include MM-DD-CCYY, CCYY-MM-DD.
paylocity: EmployeeCustomdropdownfields
Fields
- category string - The custom field category. Acceptable value is 'PayrollAndHR'.
- label string - The custom field label whose value is to be added/updated. Must match to the label defined in Web Pay Custom Fields setup. Max length: 255.
- value string - The custom dropdown field value. Values are configured in Web Pay Company > Setup > List Values > Lookup Values > Custom Fields: PayrollAndHR. Max length: 10.
paylocity: EmployeeCustomnumberfields
Fields
- category string - The custom field category. Acceptable value is 'PayrollAndHR'.
- label string - The custom field label whose value is to be added/updated. Must match to the label defined in Web Pay Custom Fields setup. Max length: 255.
- value decimal - The custom number field value. Decimal (18,6).
paylocity: EmployeeCustomtextfields
Fields
- category string - The custom field category. Acceptable value is 'PayrollAndHR'.
- label string - The custom field label whose value is to be added/updated. Must match to the label defined in Web Pay Custom Fields setup. Max length: 255.
- value string - The custom text field value. Max length: 255.
paylocity: EmployeeDepartmentposition
Add or update home department cost center, position, supervisor, reviewer, employment type, EEO class, pay settings, and union information.
Fields
- changeReason string? - Employee department/position change reason. Must match Company setup. <br />Max length: 15
- clockBadgeNumber string? - Employee clock badge number. Defaults to employeeId. <br />Max length: 10
- costCenter1 string? - Employer defined location, like branch, division, department, etc. Must match Company setup. <br />Max length: 10
- costCenter2 string? - Employer defined location, like branch, division, department, etc. Must match Company setup. <br />Max length: 10
- costCenter3 string? - Employer defined location, like branch, division, department, etc. Must match Company setup. <br />Max length: 10
- effectiveDate string? - The date the position takes effect. Common formats include MM-DD-CCYY, CCYY-MM-DD.
- employeeType string? - Employee current employment type. Common values RFT (Regular Full Time), RPT (Regular Part Time), SNL (Seasonal), TFT (Temporary Full Time), TPT (Temporary Part Time). <br />Max length: 10
- equalEmploymentOpportunityClass string? - Values are configured in Company > Setup > HR > EEO Classes.<br /> Max length: 10
- isMinimumWageExempt boolean? - Indicates if employee is exempt from minimum wage.
- isOvertimeExempt boolean? - Indicates if employee is exempt from overtime.
- isSupervisorReviewer boolean? - Indicates if employee is a supervisor or reviewer.
- isUnionDuesCollected boolean? - Indicates if union dues are collected.
- isUnionInitiationCollected boolean? - Indicates if initiations fees are collected.
- jobTitle string? - Employee current job title. <br />Max length: 50
- payGroup string? - Employee pay group. Must match Company setup. <br /> Max length: 20
- positionCode string? - Employee position code. Must match Company setup.<br />Max length: 20
- reviewerCompanyNumber string? - Company number of reviewer.<br />Max length: 9
- reviewerEmployeeId string? - Employee id of the reviewer.<br />Max length: 10
- shift string? - Employee work shift.<br />Max length: 255
- supervisorCompanyNumber string? - Supervisor's company number. Defaults to employee company number.<br />Max length: 9
- supervisorEmployeeId string? - EmployeeId of the supervisor. <br />Max length: 10
- tipped string? - Indicates if employee receives tips.
- unionAffiliationDate string? - Employee union affiliation effective date. Common formats include MM-DD-CCYY, CCYY-MM-DD.
- unionCode string? - Employee union code. Must match Company setup. <br />Max length: 10
- unionPosition string? - Employee union position. Must match Company setup. <br />Max length: 30
- workersCompensation string? - Employee worker compensation code. Must match Company setup.<br /> Max length: 10
paylocity: EmployeeEmergencycontacts
The emergency contact model
Fields
- address1 string? - 1st address line.
- address2 string? - 2nd address line.
- city string? - City.
- country string? - County.
- county string? - Country. Must be a valid 3 character country code. Common values are USA (United States), CAN (Canada).
- email string? - Contact email. Must be valid email address format.
- firstName string - Required. Contact first name. <br />Max length: 40
- homePhone string? - Contact Home Phone. Valid phone format (###) ####### or ######-#### or ### ### #### or ########## or, if international, starts with +#, only spaces and digits allowed.
- lastName string - Required. Contact last name. <br />Max length: 40
- mobilePhone string? - Contact Mobile Phone. Valid phone format (###) ####### or ######-#### or ### ### #### or ########## or, if international, starts with +#, only spaces and digits allowed.
- notes string? - Notes. <br />Max length: 1000
- pager string? - Contact Pager. Valid phone format (###) ####### or ######-#### or ### ### #### or ########## or, if international, starts with +#, only spaces and digits allowed.
- primaryPhone string? - Required. Contact primary phone type. Must match Company setup. Valid values are H (Home), M (Mobile), P (Pager), W (Work)
- priority string? - Required. Contact priority. Valid values are P (Primary) or S (Secondary).
- relationship string? - Required. Contact relationship. Must match Company setup. Common values are Spouse, Mother, Father.
- state string? - State or Province. If U.S. address, must be valid 2 character state code. Common values are IL (Illinois), CA (California).
- syncEmployeeInfo boolean? - Valid values are true or false.
- workExtension string? - Work Extension.
- workPhone string? - Contact Work Phone. Valid phone format (###) ####### or ######-#### or ### ### #### or ########## or, if international, starts with +#, only spaces and digits allowed.
- zip string? - Postal code. If U.S. address, must be a valid zip code.
paylocity: EmployeeFederaltax
Add or update federal tax amount type (taxCalculationCode), amount or percentage, filing status, and exemptions.
Fields
- amount decimal? - Tax amount. <br />Decimal (12,2)
- deductionsAmount decimal? - Box 4(b) on form W4 (year 2020 or later): Deductions amount. <br />Decimal (12,2)
- dependentsAmount decimal? - Box 3 on form W4 (year 2020 or later): Total dependents amount. <br />Decimal (12,2)
- exemptions decimal? - Federal tax exemptions value. <br />Decimal (12,2)
- filingStatus string? - Employee federal filing status. Common values are S (Single), M (Married).<br />Max length: 50
- higherRate boolean? - Box 2(c) on form W4 (year 2020 or later): Multiple Jobs or Spouse Works. <br />Boolean
- otherIncomeAmount decimal? - Box 4(a) on form W4 (year 2020 or later): Other income amount. <br />Decimal (12,2)
- percentage decimal? - Tax percentage. <br />Decimal (12,2)
- taxCalculationCode string? - Tax calculation code. Common values are F (Flat), P (Percentage), FDFP (Flat Dollar Amount plus Fixed Percentage). <br />Max length: 10
- w4FormYear int? - The federal W4 form year <br />Integer
paylocity: EmployeeHomeaddress
Add or update employee's home address, personal phone numbers, and personal email.
Fields
- address1 string? - 1st address line.<br /> Max length: 40
- address2 string? - 2nd address line. <br /> Max length: 40
- city string? - City.<br /> Max length: 40
- country string? - Country.<br /> Max length: 30
- county string? - County.<br /> Max length: 30
- emailAddress string? - Email. <br />Max length: 50
- mobilePhone string? - Mobile phone number.<br /> Max length: 12
- phone string? - Phone number.<br /> Max length: 12
- postalCode string? - Postal code.<br /> Max length: 10
- state string? - State or province.<br /> Max length: 2
paylocity: EmployeeIdResponse
The EmployeeId Response Model
Fields
- employeeId string? - The EmployeeId
paylocity: EmployeeInfo
The employee info model
Fields
- employeeId string? - Employee Id.<br /> Max length: 10
- statusCode string? - Employee current work status. Common values are A (Active), L (Leave of Absence), T (Terminated). <br />Max length: 20
- statusTypeCode string? - Employee current work status type. <br />Max length: 10
paylocity: EmployeeLocaltax
The Local Tax model
Fields
- exemptions decimal? - Local tax exemptions value.<br />Decimal (12,2)
- exemptions2 decimal? - Local tax exemptions 2 value.<br />Decimal (12,2)
- filingStatus string? - Employee local tax filing status. Must match specific local tax setup. <br /> Max length: 50
- residentPSD string? - Resident PSD (political subdivision code) applicable in PA. Must match Company setup.<br /> Max length: 9
- taxCode string? - Local tax code.<br />Max length: 50
- workPSD string? - Work location PSD. Must match Company setup. <br /> Max length: 9
paylocity: EmployeeMaindirectdeposit
Add the main direct deposit account. After deposits are made to any additional direct deposit accounts, the remaining net check is deposited in 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 what is provided on the request. GET API will not return direct deposit data.
Fields
- accountNumber string? - Account number, entered without special characters and spaces. <br />Max length: 17
- accountType string? - Account type. Valid values are C (Checking), S (Saving), P (Pay Card). <br />Max length: 1
- blockSpecial boolean? - Indicates if direct deposit should be blocked when special check types such as Bonus are processed.<br />
- isSkipPreNote boolean? - Indicates if account will not pre-note.
- nameOnAccount string? - Name on the bank account. Defaults to employee's name. <br />Max length: 30<br />
- preNoteDate string? - Date to end the pre-note of the account. Common formats include MM-DD-CCYY, CCYY-MM-DD.
- routingNumber string? - ABA Transit Routing Number, entered without dashes or spaces. <br />Max length: 9
paylocity: EmployeeNonprimarystatetax
Add or update non-primary state tax code, amount type (taxCalculationCode), amount or percentage, filing status, exemptions, supplemental check (specialCheckCalc), and reciprocity code information.
Fields
- amount decimal? - State tax code.<br /> Max length: 50
- deductionsAmount decimal? - Box 4(b) on form W4 (year 2020 or later): Deductions amount. <br />Decimal (12,2)
- dependentsAmount decimal? - Box 3 on form W4 (year 2020 or later): Total dependents amount. <br />Decimal (12,2)
- exemptions decimal? - State tax exemptions value.<br />Decimal (12,2)
- exemptions2 decimal? - State tax exemptions 2 value.<br />Decimal (12,2)
- filingStatus string? - Employee state tax filing status. Common values are S (Single), M (Married).<br />Max length: 50
- higherRate boolean? - Box 2(c) on form W4 (year 2020 or later): Multiple Jobs or Spouse Works. <br />Boolean
- otherIncomeAmount decimal? - Box 4(a) on form W4 (year 2020 or later): Other income amount. <br />Decimal (12,2)
- percentage decimal? - State Tax percentage. <br />Decimal (12,2)
- reciprocityCode string? - Non-primary state tax reciprocity code.<br /> Max length: 50
- specialCheckCalc string? - Supplemental check calculation code. Common values are Blocked (Taxes blocked on Supplemental checks), Supp (Use supplemental Tax Rate-Code). <br />Max length: 10
- taxCalculationCode string? - Tax calculation code. Common values are F (Flat), P (Percentage), FDFP (Flat Dollar Amount plus Fixed Percentage). <br />Max length: 10
- taxCode string? - State tax code.<br /> Max length: 50
- w4FormYear int? - The state W4 form year <br />Integer
paylocity: EmployeePrimarypayrate
Add or update hourly or salary pay rate, effective date, and pay frequency.
Fields
- annualSalary decimal? - Employee annual salary.<br />Decimal (12,2)
- baseRate decimal? - Employee base rate, used for Hourly employees. <br />Decimal (12,2)
- beginCheckDate string? - 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.
- changeReason string? - Pay rate change reason.<br /> Max length: 30
- defaultHours decimal? - Employee default hours consistently worked. If autoPayType is set to D, employee will be paid hourly base rate for the defaultHours. <br />Decimal (12,2)
- effectiveDate string? - The date the employee's pay rate takes effect. Common formats include MM-DD-CCYY, CCYY-MM-DD.
- isAutoPay boolean? - If set to True, employee will be paid automatically using deafultHours.
- payFrequency string? - Employee current pay frequency. Common values are A (Annual), B (Bi-Weekly), D (Daily), M (Monthly), S (Semi-Monthly), Q (Quarterly), W (Weekly). <br />Max length: 5
- payGrade string? - Employee pay grade. Must match Company setup. <br /> Max length: 10
- payRateNote string? - Pay rate notes regarding employee.<br /> Max length: 250
- payType string? - Employee pay type (rate code). Valid values are Hourly or Salary. <br />Max length: 10
- ratePer string? - Employee base rate frequency used with payType Hourly. Common values are Hour, Week. Default is Hour. <br />Max length: 10
- salary decimal? - Employee gross salary per pay period used with payType Salary.<br />Decimal (12,2)
paylocity: EmployeePrimarystatetax
Add or update primary state tax code, amount type (taxCalculationCode), amount or percentage, filing status, exemptions, and supplemental check (specialCheckCalc) information. Only one primary state is allowed. Sending an updated primary state will replace the current primary state.
Fields
- amount decimal? - State tax code.<br /> Max length: 50
- deductionsAmount decimal? - Box 4(b) on form W4 (year 2020 or later): Deductions amount. <br />Decimal (12,2)
- dependentsAmount decimal? - Box 3 on form W4 (year 2020 or later): Total dependents amount. <br />Decimal (12,2)
- exemptions decimal? - State tax exemptions value.<br />Decimal (12,2)
- exemptions2 decimal? - State tax exemptions 2 value.<br />Decimal (12,2)
- filingStatus string? - Employee state tax filing status. Common values are S (Single), M (Married).<br />Max length: 50
- higherRate boolean? - Box 2(c) on form W4 (year 2020 or later): Multiple Jobs or Spouse Works. <br />Boolean
- otherIncomeAmount decimal? - Box 4(a) on form W4 (year 2020 or later): Other income amount. <br />Decimal (12,2)
- percentage decimal? - State Tax percentage. <br />Decimal (12,2)
- specialCheckCalc string? - Supplemental check calculation code. Common values are Blocked (Taxes blocked on Supplemental checks), Supp (Use supplemental Tax Rate-Code). <br />Max length: 10
- taxCalculationCode string? - Tax calculation code. Common values are F (Flat), P (Percentage), FDFP (Flat Dollar Amount plus Fixed Percentage). <br />Max length: 10
- taxCode string? - State tax code.<br /> Max length: 50
- w4FormYear int? - The state W4 form year <br />Integer
paylocity: EmployeeStatus
Add or update employee status, change reason, effective date, and adjusted seniority date. Note that companies that are still in Implementation cannot hire future employees.
Fields
- adjustedSeniorityDate string? - Adjusted seniority date. Common formats include MM-DD-CCYY, CCYY-MM-DD.
- changeReason string? - Employee status change reason. Must match Company setup.<br /> Max length: 15
- effectiveDate string? - Common formats include MM-DD-CCYY, CCYY-MM-DD.
- employeeStatus string? - Employee current work status. Common values are A (Active), L (Leave of Absence), T (Terminated). <br />Max length: 20
- hireDate string? - Employee hired date. Updates to hire date are not allowed and will be ignored. Common formats include MM-DD-CCYY, CCYY-MM-DD.
- isEligibleForRehire boolean? - Indicates if employee eligible for rehire.
- reHireDate string? - 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.
paylocity: EmployeeTaxsetup
Add tax form, 1099 exempt reasons and notes, and 943 agricultural employee information. Once the employee receives wages, this information cannot be updated. Add or update SUI tax state, retirement plan, and statutory information.
Fields
- fitwExemptNotes string? - Notes for FITW exemption.<br /> Max length: 250
- fitwExemptReason string? - Reason code for FITW exemption. Common values are SE (Statutory employee), CR (clergy/Religious). <br /> Max length: 30
- futaExemptNotes string? - Notes for FUTA exemption.<br /> Max length: 250
- futaExemptReason string? - Reason code for FUTA exemption. Common values are 501 (5019c)(3) Organization), IC (Independent Contractor).<br /> Max length: 30
- isEmployee943 boolean? - Indicates if employee in agriculture or farming.
- isPension boolean? - Indicates if employee is eligible for pension.
- isStatutory boolean? - Indicates if employee is statutory.
- medExemptNotes string? - Notes for Medicare exemption.<br /> Max length: 250
- medExemptReason string? - Reason code for Medicare exemption. Common values are 501 (5019c)(3) Organization), IC (Independent Contractor).<br /> Max length: 30
- sitwExemptNotes string? - Notes for SITW exemption.<br /> Max length: 250
- sitwExemptReason string? - Reason code for SITW exemption. Common values are SE (Statutory employee), CR (clergy/Religious). <br /> Max length: 30
- ssExemptNotes string? - Notes for Social Security exemption.<br /> Max length: 250
- ssExemptReason string? - Reason code for Social Security exemption. Common values are SE (Statutory employee), CR (clergy/Religious). <br /> Max length: 30
- suiExemptNotes string? - Notes for SUI exemption.<br /> Max length: 250
- suiExemptReason string? - Reason code for SUI exemption. Common values are SE (Statutory employee), CR (clergy/Religious). <br /> Max length: 30
- suiState string? - Employee SUI (State Unemployment Insurance) state. <br />Max length: 2
- taxDistributionCode1099R string? - Employee 1099R distribution code. Common values are 7 (Normal Distribution), F (Charitable Gift Annuity). <br />Max length: 1
- taxForm string? - Employee tax form for reporting income. Valid values are W2, 1099M, 1099R. Default is W2. <br />Max length: 15
paylocity: EmployeeWebtime
Add or update Web Time badge number and charge rate and synchronize Web Pay and Web Time employee data.
Fields
- badgeNumber string? - Badge number usually issued for time and attendance system use. <br />Max length: 50
- chargeRate decimal? - 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. <br />Decimal (12,2)
- isTimeLaborEnabled boolean? - If set to true, changes to employee data will be reflected in Web Time.
paylocity: EmployeeWorkaddress
Add or update employee's work address, phone numbers, and email. Work Location drop down field is not included.
Fields
- address1 string? - 1st address line.<br /> Max length: 40
- address2 string? - 2nd address line. <br /> Max length: 40
- city string? - City.<br /> Max length: 40
- country string? - Country.<br /> Max length: 30
- county string? - County.<br /> Max length: 30
- emailAddress string? - Email. <br />Max length: 50
- location string? - Work Location name. <br />Max length: 50
- mailStop string? - Employee mail stop.<br /> Max length: 10
- mobilePhone string? - Mobile phone number.<br /> Max length: 12
- pager string? - Employee pager number.<br /> Max length: 20
- phone string? - Phone number.<br /> Max length: 12
- phoneExtension string? - Phone number extension.<br /> Max length: 10
- postalCode string? - Postal code.<br /> Max length: 10
- state string? - State or province.<br /> Max length: 2
paylocity: EmployeeWorkeligibility
Add or update I-9 work authorization information.
Fields
- alienOrAdmissionDocumentNumber string? - Employee USCIS or Admission Number. <br /> Must be 7-10 characters and may begin with an 'A'
- attestedDate string? - The date the I-9 Verification form was attested by Employer or Authorized representative. Common formats are MM-DD-CCYY, CCYY-MM-DD.
- countryOfIssuance string? - If Foreign Passport number is provided, provide its country of issuance. Must match Paylocity setup.<br /> Max length: 30
- foreignPassportNumber string? - Foreign Passport Number.<br /> Max length: 50
- i94AdmissionNumber string? - Form I-94 admission number.<br /> Must be 11 numeric characters
- i9DateVerified string? - Common formats include MM-DD-CCYY, CCYY-MM-DD.
- i9Notes string? - Notes regarding employee's i9.<br /> Max length: 4000
- isI9Verified boolean? - Indicates if employee I9 is verified.
- isSsnVerified boolean? - Indicates if employee SSN is verified.
- ssnDateVerified string? - The date of employer verification of employee SSN. Common formats include MM-DD-CCYY, CCYY-MM-DD.
- ssnNotes string? - Notes regarding employee's SSN.<br /> Max length: 4000
- visaType string? - Employee Visa type. Must match one of the system coded values.<br /> Max length: 100
- workAuthorization string? - Employee work authorization. Must match one of the system coded values.<br /> Max length: 100
- workUntil string? - End date of employee work eligibility. Common formats include MM-DD-CCYY, CCYY-MM-DD.
paylocity: Error
The error model
Fields
- 'field string? - The name of the field, or property in the request message that contains an error.
- message string? - The error message.
- options ErrorOptions[]? - A list of options associated with this error. These options may indicate valid values for the field, or property that contains an error.
- path string? - The JSON path of the field, or property, that contains an error in the request message.
paylocity: ErrorOptions
The error option model
Fields
- code string? - The code associated with this option.
- description string? - The description of the option.
paylocity: LocalTax
The Local Tax model
Fields
- exemptions decimal? - Local tax exemptions value.<br />Decimal (12,2)
- exemptions2 decimal? - Local tax exemptions 2 value.<br />Decimal (12,2)
- filingStatus string? - Employee local tax filing status. Must match specific local tax setup. <br /> Max length: 50
- residentPSD string? - Resident PSD (political subdivision code) applicable in PA. Must match Company setup.<br /> Max length: 9
- taxCode string? - Local tax code.<br />Max length: 50
- workPSD string? - Work location PSD. Must match Company setup. <br /> Max length: 9
paylocity: NonPrimaryStateTax
The Non-Primary State Tax model
Fields
- amount decimal? - State tax code.<br /> Max length: 50
- deductionsAmount decimal? - Box 4(b) on form W4 (year 2020 or later): Deductions amount. <br />Decimal (12,2)
- dependentsAmount decimal? - Box 3 on form W4 (year 2020 or later): Total dependents amount. <br />Decimal (12,2)
- exemptions decimal? - State tax exemptions value.<br />Decimal (12,2)
- exemptions2 decimal? - State tax exemptions 2 value.<br />Decimal (12,2)
- filingStatus string? - Employee state tax filing status. Common values are S (Single), M (Married).<br />Max length: 50
- higherRate boolean? - Box 2(c) on form W4 (year 2020 or later): Multiple Jobs or Spouse Works. <br />Boolean
- otherIncomeAmount decimal? - Box 4(a) on form W4 (year 2020 or later): Other income amount. <br />Decimal (12,2)
- percentage decimal? - State Tax percentage. <br />Decimal (12,2)
- reciprocityCode string? - Non-primary state tax reciprocity code.<br /> Max length: 50
- specialCheckCalc string? - Supplemental check calculation code. Common values are Blocked (Taxes blocked on Supplemental checks), Supp (Use supplemental Tax Rate-Code). <br />Max length: 10
- taxCalculationCode string? - Tax calculation code. Common values are F (Flat), P (Percentage), FDFP (Flat Dollar Amount plus Fixed Percentage). <br />Max length: 10
- taxCode string? - State tax code.<br /> Max length: 50
- w4FormYear int? - The state W4 form year <br />Integer
paylocity: OAuth2ClientCredentialsGrantConfig
Closed record
OAuth2 Client Credentials Grant Configs
Fields
- Fields Included from * OAuth2ClientCredentialsGrantConfig
- tokenUrl string(default "https://api.paylocity.com/IdentityServer/connect/token") - Token URL
paylocity: PayStatementDetails
The pay statement details model
Fields
- amount decimal? - .<br />
- checkDate string? - .<br />
- det string? - .<br />
- detCode string? - .<br />
- detType string? - .<br />
- eligibleCompensation decimal? - .<br />
- hours decimal? - .<br />
- rate decimal? - .<br />
- transactionNumber int? - <br />
- transactionType string? - .<br />
- year int? - .<br />
paylocity: PayStatementSummary
The pay statement summary model
Fields
- autoPay boolean? - .<br />
- beginDate string? - .<br />
- checkDate string? - .<br />
- checkNumber int? - .<br />
- directDepositAmount decimal? - .<br />
- endDate string? - .<br />
- grossPay decimal? - .<br />
- hours decimal? - .<br />
- netCheck decimal? - .<br />
- netPay decimal? - .<br />
- overtimeDollars decimal? - .<br />
- overtimeHours decimal? - .<br />
- process int? - .<br />
- regularDollars decimal? - .<br />
- regularHours decimal? - .<br />
- transactionNumber int? - <br />
- voucherNumber int? - .<br />
- workersCompCode string? - .<br />
- year int? - .<br />
paylocity: ProxyConfig
Closed record
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
paylocity: StagedEmployee
The staged employee model
Fields
- additionalDirectDeposit StagedemployeeAdditionaldirectdeposit[]? - 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.
- benefitSetup StagedemployeeBenefitsetup[]? - Add setup values used for employee benefits integration, insurance plan settings, and ACA reporting.
- birthDate string? - Employee birthdate. Common formats include MM-DD-CCYY, CCYY-MM-DD.
- customBooleanFields EmployeeCustombooleanfields[]? - Up to 8 custom fields of boolean (checkbox) type value.
- customDateFields EmployeeCustomdatefields[]? - Up to 8 custom fields of the date type value.
- customDropDownFields EmployeeCustomdropdownfields[]? - Up to 8 custom fields of the dropdown type value.
- customNumberFields EmployeeCustomnumberfields[]? - Up to 8 custom fields of numeric type value.
- customTextFields EmployeeCustomtextfields[]? - Up to 8 custom fields of text type value.
- departmentPosition StagedemployeeDepartmentposition[]? - Add home department cost center, position, supervisor, reviewer, employment type, EEO class, pay settings, and union information.
- disabilityDescription string? - Indicates if employee has disability status.
- employeeId string? - Leave blank to have Web Pay automatically assign the next available employee ID.<br /> Max length: 10
- ethnicity string? - Employee ethnicity.<br /> Max length: 10
- federalTax StagedemployeeFederaltax[]? - Add federal tax amount type (taxCalculationCode), amount or percentage, filing status, and exemptions.
- firstName string? - Employee first name. <br />Max length: 40
- fitwExemptReason string? - Reason code for FITW exemption. Common values are SE (Statutory employee), CR (clergy/Religious). <br /> Max length: 30
- futaExemptReason string? - Reason code for FUTA exemption. Common values are 501 (5019c)(3) Organization), IC (Independent Contractor).<br /> Max length: 30
- gender string? - Employee gender. Common values M (Male), F (Female). <br />Max length: 1
- homeAddress StagedemployeeHomeaddress[]? - Add employee's home address, personal phone numbers, and personal email.
- isEmployee943 boolean? - Indicates if employee in agriculture or farming.
- isSmoker boolean? - Indicates if employee is a smoker.
- lastName string? - Employee last name. <br />Max length: 40
- localTax EmployeeLocaltax[]? - Add local tax code, filing status, and exemptions including PA-PSD taxes.
- mainDirectDeposit StagedemployeeMaindirectdeposit[]? - Add the main direct deposit account. After deposits are made to any additional direct deposit accounts, the remaining net check is deposited in 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 what is provided on the request. GET API will not return direct deposit data.
- maritalStatus string? - Employee marital status. Common values D (Divorced), M (Married), S (Single), W (Widowed). <br />Max length: 10
- medExemptReason string? - Reason code for Medicare exemption. Common values are 501 (5019c)(3) Organization), IC (Independent Contractor).<br /> Max length: 30
- middleName string? - Employee middle name.<br /> Max length: 20
- nonPrimaryStateTax StagedemployeeNonprimarystatetax[]? - Add non-primary state tax code, amount type (taxCalculationCode), amount or percentage, filing status, exemptions, supplemental check (specialCheckCalc), and reciprocity code information.
- preferredName string? - Employee preferred display name.<br /> Max length: 20
- primaryPayRate StagedemployeePrimarypayrate[]? - Add hourly or salary pay rate, effective date, and pay frequency.
- primaryStateTax StagedemployeePrimarystatetax[]? - Add primary state tax code, amount type (taxCalculationCode), amount or percentage, filing status, exemptions, and supplemental check (specialCheckCalc) information. Only one primary state is allowed.
- priorLastName string? - Prior last name if applicable.<br />Max length: 40
- salutation string? - Employee preferred salutation. <br />Max length: 10
- sitwExemptReason string? - Reason code for SITW exemption. Common values are SE (Statutory employee), CR (clergy/Religious). <br /> Max length: 30
- ssExemptReason string? - Reason code for Social Security exemption. Common values are SE (Statutory employee), CR (clergy/Religious). <br /> Max length: 30
- ssn string? - Employee social security number. Leave it blank if valid social security number not available. <br />Max length: 11
- status StagedemployeeStatus[]? - Add employee status, change reason, effective date, and adjusted seniority date. Note that companies that are still in Implementation cannot hire future employees.
- suffix string? - Employee name suffix. Common values are Jr, Sr, II.<br />Max length: 30
- suiExemptReason string? - Reason code for SUI exemption. Common values are SE (Statutory employee), CR (clergy/Religious). <br /> Max length: 30
- suiState string? - Employee SUI (State Unemployment Insurance) state. <br />Max length: 2
- taxDistributionCode1099R string? - Employee 1099R distribution code. Common values are 7 (Normal Distribution), F (Charitable Gift Annuity). <br />Max length: 1
- taxForm string? - Employee tax form for reporting income. Valid values are W2, 1099M, 1099R. Default is W2. <br />Max length: 15
- veteranDescription string? - Indicates if employee is a veteran.
- webTime StagedemployeeWebtime? - Add Web Time badge number and charge rate and synchronize Web Pay and Web Time employee data.
- workAddress StagedemployeeWorkaddress[]? - Add employee's work address, phone numbers, and email. Work Location drop down field is not included.
- workEligibility StagedemployeeWorkeligibility[]? - Add I-9 work authorization information.
paylocity: StagedemployeeAdditionaldirectdeposit
The additional direct deposit model
Fields
- accountNumber string? - Account number, entered without special characters and spaces. <br />Max length: 17<br />
- accountType string? - Account type. Valid values are C (Checking), S (Saving), P (Pay Card). <br />Max length: 1<br />
- amount decimal? - Amount value to be deposited to the account.<br />Decimal (12,2)<br />
- amountType string? - Amount type to indicate the context of the amount. Common values are F (FLAT), F- (Net Minus), P (Percent). <br /> Max length: 5<br />
- isSkipPreNote boolean? - Indicates if account will not pre-note.<br />
- preNoteDate string? - Date to end the pre-note of the account. Common formats include MM-DD-CCYY, CCYY-MM-DD.<br />
- routingNumber string? - ABA Transit Routing Number, entered without dashes or spaces. <br />Max length: 9<br />
paylocity: StagedemployeeBenefitsetup
The benefit setup model
Fields
- benefitClass string? - Benefit Class code. Values are configured in Web Pay Company > Setup > Benefits > Classes.<br />Max length: 30
- benefitClassEffectiveDate string? - Date when Benefit Class takes effect. Common formats include MM-DD-CCYY, CCYY-MM-DD.
- benefitSalary decimal? - Salary used to configure benefits.<br />Decimal(12,2)
- benefitSalaryEffectiveDate string? - Date when Benefit Salary takes effect. Common formats include MM-DD-CCYY, CCYY-MM-DD.
- doNotApplyAdministrativePeriod boolean? - Applicable only for ACA Enhanced clients and Benefit Classes with ACA Employment Type of Full Time.
- isMeasureAcaEligibility boolean? - Only valid for ACA Enhanced clients and Benefit Classes that are ACA Employment Type of Full Time.
paylocity: StagedemployeeDepartmentposition
The Department Position model
Fields
- changeReason string? - Employee department/position change reason. Must match Company setup. <br />Max length: 15
- clockBadgeNumber string? - Employee clock badge number. Defaults to employeeId. <br />Max length: 10
- costCenter1 string? - Employer defined location, like branch, division, department, etc. Must match Company setup. <br />Max length: 10
- costCenter2 string? - Employer defined location, like branch, division, department, etc. Must match Company setup. <br />Max length: 10
- costCenter3 string? - Employer defined location, like branch, division, department, etc. Must match Company setup. <br />Max length: 10
- effectiveDate string? - The date the position takes effect. Common formats include MM-DD-CCYY, CCYY-MM-DD.
- employeeType string? - Employee current employment type. Common values RFT (Regular Full Time), RPT (Regular Part Time), SNL (Seasonal), TFT (Temporary Full Time), TPT (Temporary Part Time). <br />Max length: 10
- equalEmploymentOpportunityClass string? - Values are configured in Company > Setup > HR > EEO Classes.<br /> Max length: 10
- isMinimumWageExempt boolean? - Indicates if employee is exempt from minimum wage.
- isOvertimeExempt boolean? - Indicates if employee is exempt from overtime.
- isSupervisorReviewer boolean? - Indicates if employee is a supervisor or reviewer.
- isUnionDuesCollected boolean? - Indicates if union dues are collected.
- isUnionInitiationCollected boolean? - Indicates if initiations fees are collected.
- jobTitle string? - Employee current job title. <br />Max length: 50
- payGroup string? - Employee pay group. Must match Company setup. <br /> Max length: 20
- positionCode string? - Employee position code. Must match Company setup.<br />Max length: 20
- shift string? - Employee work shift.<br />Max length: 255
- supervisorCompanyNumber string? - Supervisor's company number. Defaults to employee company number.<br />Max length: 9
- supervisorEmployeeId string? - EmployeeId of the supervisor. <br />Max length: 10
- tipped string? - Indicates if employee receives tips.
- unionAffiliationDate string? - Employee union affiliation effective date. Common formats include MM-DD-CCYY, CCYY-MM-DD.
- unionCode string? - Employee union code. Must match Company setup. <br />Max length: 10
- unionPosition string? - Employee union position. Must match Company setup. <br />Max length: 30
- workersCompensation string? - Employee worker compensation code. Must match Company setup.<br /> Max length: 10
paylocity: StagedemployeeFederaltax
The Federal Tax model
Fields
- amount decimal? - Tax amount. <br />Decimal (12,2)
- deductionsAmount decimal? - Box 4(b) on form W4 (year 2020 or later): Deductions amount. <br />Decimal (12,2)
- dependentsAmount decimal? - Box 3 on form W4 (year 2020 or later): Total dependents amount. <br />Decimal (12,2)
- exemptions decimal? - Federal tax exemptions value. <br />Decimal (12,2)
- filingStatus string? - Employee federal filing status. Common values are S (Single), M (Married).<br />Max length: 50
- higherRate boolean? - Box 2(c) on form W4 (year 2020 or later): Multiple Jobs or Spouse Works. <br />Boolean
- otherIncomeAmount decimal? - Box 4(a) on form W4 (year 2020 or later): Other income amount. <br />Decimal (12,2)
- percentage decimal? - Tax percentage. <br />Decimal (12,2)
- taxCalculationCode string? - Tax calculation code. Common values are F (Flat), P (Percentage), FDFP (Flat Dollar Amount plus Fixed Percentage). <br />Max length: 10
- w4FormYear int? - The federal W4 form year <br />Integer
paylocity: StagedemployeeHomeaddress
The address model
Fields
- address1 string? - 1st address line.<br /> Max length: 40
- address2 string? - 2nd address line. <br /> Max length: 40
- city string? - City.<br /> Max length: 40
- country string? - Country.<br /> Max length: 30
- county string? - County.<br /> Max length: 30
- emailAddress string? - Email. <br />Max length: 50
- mobilePhone string? - Mobile phone number.<br /> Max length: 12
- phone string? - Phone number.<br /> Max length: 12
- postalCode string? - Postal code.<br /> Max length: 10
- state string? - State or province.<br /> Max length: 2
paylocity: StagedemployeeMaindirectdeposit
The Main Direct Deposit model
Fields
- accountNumber string? - Account number, entered without special characters and spaces. <br />Max length: 17
- accountType string? - Account type. Valid values are C (Checking), S (Saving), P (Pay Card). <br />Max length: 1
- isSkipPreNote boolean? - Indicates if account will not pre-note.
- preNoteDate string? - Date to end the pre-note of the account. Common formats include MM-DD-CCYY, CCYY-MM-DD.
- routingNumber string? - ABA Transit Routing Number, entered without dashes or spaces. <br />Max length: 9
paylocity: StagedemployeeNonprimarystatetax
The Non-Primary State Tax model
Fields
- amount decimal? - State tax code.<br /> Max length: 50
- deductionsAmount decimal? - Box 4(b) on form W4 (year 2020 or later): Deductions amount. <br />Decimal (12,2)
- dependentsAmount decimal? - Box 3 on form W4 (year 2020 or later): Total dependents amount. <br />Decimal (12,2)
- exemptions decimal? - State tax exemptions value.<br />Decimal (12,2)
- exemptions2 decimal? - State tax exemptions 2 value.<br />Decimal (12,2)
- filingStatus string? - Employee state tax filing status. Common values are S (Single), M (Married).<br />Max length: 50
- higherRate boolean? - Box 2(c) on form W4 (year 2020 or later): Multiple Jobs or Spouse Works. <br />Boolean
- otherIncomeAmount decimal? - Box 4(a) on form W4 (year 2020 or later): Other income amount. <br />Decimal (12,2)
- percentage decimal? - State Tax percentage. <br />Decimal (12,2)
- reciprocityCode string? - Non-primary state tax reciprocity code.<br /> Max length: 50
- specialCheckCalc string? - Supplemental check calculation code. Common values are Blocked (Taxes blocked on Supplemental checks), Supp (Use supplemental Tax Rate-Code). <br />Max length: 10
- taxCalculationCode string? - Tax calculation code. Common values are F (Flat), P (Percentage), FDFP (Flat Dollar Amount plus Fixed Percentage). <br />Max length: 10
- taxCode string? - State tax code.<br /> Max length: 50
- w4FormYear int? - The state W4 form year <br />Integer
paylocity: StagedemployeePrimarypayrate
The Primary Pay Rate model
Fields
- baseRate decimal? - Employee base rate, used for Hourly employees. <br />Decimal (12,2)
- changeReason string? - Pay rate change reason.<br /> Max length: 30
- defaultHours decimal? - Employee default hours consistently worked. If autoPayType is set to D, employee will be paid hourly base rate for the defaultHours. <br />Decimal (12,2)
- effectiveDate string? - The date the employee's pay rate takes effect. Common formats include MM-DD-CCYY, CCYY-MM-DD.
- isAutoPay boolean? - If set to True, employee will be paid automatically using deafultHours.
- payFrequency string? - Employee current pay frequency. Common values are A (Annual), B (Bi-Weekly), D (Daily), M (Monthly), S (Semi-Monthly), Q (Quarterly), W (Weekly). <br />Max length: 5
- payGrade string? - Employee pay grade. Must match Company setup. <br /> Max length: 10
- payType string? - Employee pay type (rate code). Valid values are Hourly or Salary. <br />Max length: 10
- ratePer string? - Employee base rate frequency used with payType Hourly. Common values are Hour, Week. Default is Hour. <br />Max length: 10
- salary decimal? - Employee gross salary per pay period used with payType Salary.<br />Decimal (12,2)
paylocity: StagedemployeePrimarystatetax
The State Tax model
Fields
- amount decimal? - State tax code.<br /> Max length: 50
- deductionsAmount decimal? - Box 4(b) on form W4 (year 2020 or later): Deductions amount. <br />Decimal (12,2)
- dependentsAmount decimal? - Box 3 on form W4 (year 2020 or later): Total dependents amount. <br />Decimal (12,2)
- exemptions decimal? - State tax exemptions value.<br />Decimal (12,2)
- exemptions2 decimal? - State tax exemptions 2 value.<br />Decimal (12,2)
- filingStatus string? - Employee state tax filing status. Common values are S (Single), M (Married).<br />Max length: 50
- higherRate boolean? - Box 2(c) on form W4 (year 2020 or later): Multiple Jobs or Spouse Works. <br />Boolean
- otherIncomeAmount decimal? - Box 4(a) on form W4 (year 2020 or later): Other income amount. <br />Decimal (12,2)
- percentage decimal? - State Tax percentage. <br />Decimal (12,2)
- specialCheckCalc string? - Supplemental check calculation code. Common values are Blocked (Taxes blocked on Supplemental checks), Supp (Use supplemental Tax Rate-Code). <br />Max length: 10
- taxCalculationCode string? - Tax calculation code. Common values are F (Flat), P (Percentage), FDFP (Flat Dollar Amount plus Fixed Percentage). <br />Max length: 10
- taxCode string? - State tax code.<br /> Max length: 50
- w4FormYear int? - The state W4 form year <br />Integer
paylocity: StagedemployeeStatus
The employee status model
Fields
- adjustedSeniorityDate string? - Adjusted seniority date. Common formats include MM-DD-CCYY, CCYY-MM-DD.
- changeReason string? - Employee status change reason. Must match Company setup.<br /> Max length: 15
- effectiveDate string? - Common formats include MM-DD-CCYY, CCYY-MM-DD.
- employeeStatus string? - Employee current work status. Common values are A (Active), L (Leave of Absence), T (Terminated). <br />Max length: 20
- hireDate string? - Employee hired date. Common formats include MM-DD-CCYY, CCYY-MM-DD.
- isEligibleForRehire boolean? - Indicates if employee eligible for rehire.
paylocity: StagedemployeeWebtime
Add Web Time badge number and charge rate and synchronize Web Pay and Web Time employee data.
Fields
- badgeNumber string? - Badge number usually issued for time and attendance system use. <br />Max length: 50
- chargeRate decimal? - 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. <br />Decimal (12,2)
- isTimeLaborEnabled boolean? - If set to true, changes to employee data will be reflected in Web Time.
paylocity: StagedemployeeWorkaddress
The address model
Fields
- address1 string? - 1st address line.<br /> Max length: 40
- address2 string? - 2nd address line. <br /> Max length: 40
- city string? - City.<br /> Max length: 40
- country string? - Country.<br /> Max length: 30
- county string? - County.<br /> Max length: 30
- emailAddress string? - Email. <br />Max length: 50
- mobilePhone string? - Mobile phone number.<br /> Max length: 12
- pager string? - Employee pager number.<br /> Max length: 20
- phone string? - Phone number.<br /> Max length: 12
- phoneExtension string? - Phone number extension.<br /> Max length: 10
- postalCode string? - Postal code.<br /> Max length: 10
- state string? - State or province.<br /> Max length: 2
paylocity: StagedemployeeWorkeligibility
The Work Eligibility model
Fields
- alienOrAdmissionDocumentNumber string? - Employee USCIS or Admission Number. <br /> Must be 7-10 characters and may begin with an 'A'
- attestedDate string? - The date the I-9 Verification form was attested by Employer or Authorized representative. Common formats are MM-DD-CCYY, CCYY-MM-DD.
- countryOfIssuance string? - If Foreign Passport number is provided, provide its country of issuance. Must match Paylocity setup.<br /> Max length: 30
- foreignPassportNumber string? - Foreign Passport Number.<br /> Max length: 50
- i94AdmissionNumber string? - Form I-94 admission number.<br /> Must be 11 numeric characters
- i9DateVerified string? - Common formats include MM-DD-CCYY, CCYY-MM-DD.
- i9Notes string? - Notes regarding employee's i9.<br /> Max length: 4000
- isI9Verified boolean? - Indicates if employee I9 is verified.
- isSsnVerified boolean? - Indicates if employee SSN is verified.
- ssnDateVerified string? - The date of employer verification of employee SSN. Common formats include MM-DD-CCYY, CCYY-MM-DD.
- ssnNotes string? - Notes regarding employee's SSN.<br /> Max length: 4000
- visaType string? - Employee Visa type. Must match one of the system coded values.<br /> Max length: 100
- workAuthorization string? - Employee work authorization. Must match one of the system coded values.<br /> Max length: 100
- workUntil string? - End date of employee work eligibility. Common formats include MM-DD-CCYY, CCYY-MM-DD.
paylocity: StateTax
The State Tax model
Fields
- amount decimal? - State tax code.<br /> Max length: 50
- deductionsAmount decimal? - Box 4(b) on form W4 (year 2020 or later): Deductions amount. <br />Decimal (12,2)
- dependentsAmount decimal? - Box 3 on form W4 (year 2020 or later): Total dependents amount. <br />Decimal (12,2)
- exemptions decimal? - State tax exemptions value.<br />Decimal (12,2)
- exemptions2 decimal? - State tax exemptions 2 value.<br />Decimal (12,2)
- filingStatus string? - Employee state tax filing status. Common values are S (Single), M (Married).<br />Max length: 50
- higherRate boolean? - Box 2(c) on form W4 (year 2020 or later): Multiple Jobs or Spouse Works. <br />Boolean
- otherIncomeAmount decimal? - Box 4(a) on form W4 (year 2020 or later): Other income amount. <br />Decimal (12,2)
- percentage decimal? - State Tax percentage. <br />Decimal (12,2)
- specialCheckCalc string? - Supplemental check calculation code. Common values are Blocked (Taxes blocked on Supplemental checks), Supp (Use supplemental Tax Rate-Code). <br />Max length: 10
- taxCalculationCode string? - Tax calculation code. Common values are F (Flat), P (Percentage), FDFP (Flat Dollar Amount plus Fixed Percentage). <br />Max length: 10
- taxCode string? - State tax code.<br /> Max length: 50
- w4FormYear int? - The state W4 form year <br />Integer
paylocity: TrackingNumberResponse
The Tracking Number Response model
Fields
- trackingNumber string? - The unique tracking number