{"swagger":"2.0","info":{"title":"Paylocity API","description":"For general questions and support of the API, contact: webservices@paylocity.com\r\n# Overview\r\n\r\nPaylocity 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.\r\nPaylocity 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](https://docs.paylocity.com/weblink/guides/Paylocity_Web_Services_API/v1/Paylocity_Web_Services_API.htm). For additional resources regarding v1/v2 differences and conversion path, please contact webservices@paylocity.com.\r\n\r\n##### Setup\r\n\r\nPaylocity 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. \r\n* 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. \r\n* 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. \r\n* 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. \r\n* 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.\r\n\r\n\r\nWhen validating the request, Paylocity API will honor the defaults and required fields set up for the company default New Hire Template as defined in Web Pay.\r\n\r\n\r\n# Authorization\r\n\r\nPaylocity Web Services API uses OAuth2.0 Authentication with JSON Message Format.\r\n\r\n\r\nAll requests of the Paylocity Web Services API require a bearer token which can be obtained by authenticating the client with the Paylocity Web Services API via OAuth 2.0.\r\n\r\n\r\nThe client must request a bearer token from the authorization endpoint:\r\n\r\n\r\nauth-server for production: https://api.paylocity.com/IdentityServer/connect/token\r\n\r\n\r\nauth-server for testing: https://apisandbox.paylocity.com/IdentityServer/connect/token\r\n\r\nPaylocity reserves the right to impose rate limits on the number of calls made to our APIs. Changes to API features/functionality may be made at anytime with or without prior notice.\r\n\r\n##### Authorization Header\r\n\r\nThe request is expected to be in the form of a basic authentication request, with the \"Authorization\" header containing the client-id and client-secret. This means the standard base-64 encoded user:password, prefixed with \"Basic\" as the value for the Authorization header, where user is the client-id and password is the client-secret.\r\n\r\n##### Content-Type Header\r\n\r\nThe \"Content-Type\" header is required to be \"application/x-www-form-urlencoded\".\r\n\r\n##### Additional Values\r\n\r\nThe request must post the following form encoded values within the request body:\r\n\r\n grant_type = client_credentials\r\n scope = WebLinkAPI\r\n\r\n##### Responses\r\n\r\nSuccess will return HTTP 200 OK with JSON content:\r\n\r\n {\r\n \"access_token\": \"xxx\",\r\n \"expires_in\": 3600,\r\n \"token_type\": \"Bearer\"\r\n }\r\n\r\n# Encryption\r\n\r\nPaylocity uses a combination of RSA and AES cryptography. As part of the setup, each client is issued a public RSA key.\r\n\r\nPaylocity recommends the encryption of the incoming requests as additional protection of the sensitive data. Clients can opt-out of the encryption during the initial setup process. Opt-out will allow Paylocity to process unencrypted requests.\r\n\r\nThe Paylocity Public Key has the following properties:\r\n\r\n* 2048 bit key size\r\n\r\n* PKCS1 key format\r\n\r\n* PEM encoding\r\n\r\n##### Properties\r\n\r\n* key (base 64 encoded): The AES symmetric key encrypted with the Paylocity Public Key. It is the key used to encrypt the content. Paylocity will decrypt the AES key using RSA decryption and use it to decrypt the content.\r\n\r\n* iv (base 64 encoded): The AES IV (Initialization Vector) used when encrypting the content.\r\n\r\n* content (base 64 encoded): The AES encrypted request. The key and iv provided in the secureContent request are used by Paylocity for decryption of the content.\r\n\r\nWe suggest using the following for the AES:\r\n\r\n* CBC cipher mode\r\n\r\n* PKCS7 padding\r\n\r\n* 128 bit block size\r\n\r\n* 256 bit key size\r\n\r\n##### Encryption Flow\r\n\r\n* Generate the unencrypted JSON payload to POST/PUT\r\n* Encrypt this JSON payload using your _own key and IV_ (NOT with the Paylocity public key)\r\n* RSA encrypt the _key_ you used in step 2 with the Paylocity Public Key, then, base64 encode the result\r\n* Base64 encode the IV used to encrypt the JSON payload in step 2\r\n* Put together a \"securecontent\" JSON object:\r\n \r\n{\r\n 'secureContent' : {\r\n 'key' : -- RSA-encrypted & base64 encoded key from step 3,\r\n 'iv' : -- base64 encoded iv from step 4\r\n 'content' -- content encrypted with your own key from step 2, base64 encoded\r\n }\r\n}\r\n\r\n##### Sample Example\r\n\r\n {\r\n \"secureContent\": {\r\n \"key\": \"eS3aw6H/qzHMJ00gSi6gQ3xa08DPMazk8BFY96Pd99ODA==\",\r\n \"iv\": \"NLyXMGq9svw0XO5aI9BzWw==\",\r\n \"content\": \"gAEOiQltO1w+LzGUoIK8FiYbU42hug94EasSl7N+Q1w=\"\r\n }\r\n }\r\n\r\n##### Sample C# Code\r\n\r\n using Newtonsoft.Json;\r\n using System;\r\n using System.IO;\r\n using System.Security.Cryptography;\r\n using System.Text;\r\n\r\n public class SecuredContent\r\n {\r\n [JsonProperty(\"key\")]\r\n public string Key { get; set; }\r\n\r\n [JsonProperty(\"iv\")]\r\n public string Iv { get; set; }\r\n\r\n [JsonProperty(\"content\")]\r\n public string Content { get; set; }\r\n\r\n }\r\n\r\n public class EndUserSecureRequestExample\r\n {\r\n public string CreateSecuredRequest(FileInfo paylocityPublicKey, string unsecuredJsonRequest)\r\n {\r\n string publicKeyXml = File.ReadAllText(paylocityPublicKey.FullName, Encoding.UTF8);\r\n\r\n SecuredContent secureContent = this.CreateSecuredContent(publicKeyXml, unsecuredJsonRequest);\r\n\r\n string secureRequest = JsonConvert.SerializeObject(new { secureContent });\r\n\r\n return secureRequest;\r\n }\r\n\r\n private SecuredContent CreateSecuredContent(string publicKeyXml, string request)\r\n {\r\n using (AesCryptoServiceProvider aesCsp = new AesCryptoServiceProvider())\r\n {\r\n aesCsp.Mode = CipherMode.CBC;\r\n aesCsp.Padding = PaddingMode.PKCS7;\r\n aesCsp.BlockSize = 128;\r\n aesCsp.KeySize = 256;\r\n\r\n using (ICryptoTransform crt = aesCsp.CreateEncryptor(aesCsp.Key, aesCsp.IV))\r\n {\r\n using (MemoryStream outputStream = new MemoryStream())\r\n {\r\n using (CryptoStream encryptStream = new CryptoStream(outputStream, crt, CryptoStreamMode.Write))\r\n {\r\n byte[] encodedRequest = Encoding.UTF8.GetBytes(request);\r\n encryptStream.Write(encodedRequest, 0, encodedRequest.Length);\r\n encryptStream.FlushFinalBlock();\r\n byte[] encryptedRequest = outputStream.ToArray();\r\n\r\n using (RSACryptoServiceProvider crp = new RSACryptoServiceProvider())\r\n {\r\n crp.FromXmlstring(publicKeyXml);\r\n byte[] encryptedKey = crp.Encrypt(aesCsp.Key, false);\r\n\r\n return new SecuredContent()\r\n {\r\n Key = Convert.ToBase64string(encryptedKey),\r\n Iv = Convert.ToBase64string(aesCsp.IV),\r\n Content = Convert.ToBase64string(encryptedRequest)\r\n };\r\n }\r\n }\r\n }\r\n }\r\n }\r\n }\r\n }\r\n\r\n## Support\r\n\r\nQuestions about using the Paylocity API? Please contact webservices@paylocity.com.\r\n\r\n# Deductions (v1)\r\n\r\nDeductions API provides endpoints to retrieve, add, update and delete deductions for a company's employees. For schema details, click here.\r\n\r\n# OnBoarding (v1)\r\n\r\nOnboarding API sends employee data into Paylocity Onboarding to help ensure an easy and accurate hiring process for subsequent completion into Web Pay. For schema details, click here.","termsOfService":"Paylocity_Automated_Data_Exchange_Request_Form.pdf","contact":{"email":"webservices@paylocity.com"},"x-logo":{"url":"paylocityLogo.png"},"version":"2"},"host":"api.paylocity.com","basePath":"/api","schemes":["https"],"paths":{"/v2/companies/{companyId}/employees/{employeeId}/additionalRates":{"put":{"tags":["Additional Rates"],"summary":"Add/update additional rates","description":"Sends new or updated employee additional rates information directly to Web Pay.","operationId":"Add or update additional rates","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"json","description":"Additional Rate Model","required":true,"schema":{"$ref":"#/definitions/additionalRate"}},{"in":"path","name":"companyId","description":"Company Id","required":true,"type":"string"},{"in":"path","name":"employeeId","description":"Employee Id","required":true,"type":"string"}],"responses":{"200":{"description":"Successfully added or updated"},"400":{"description":"Bad Request","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}},"security":[{"paylocity_auth":["WebLinkAPI"]}]}},"/v2/credentials/secrets":{"post":{"tags":["Client Credentials"],"summary":"Obtain new client secret.","description":"Obtain new client secret for Paylocity-issued client id. See Setup section for details.","operationId":"Add Client Secret","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"json","description":"Add Client Secret Model","required":true,"schema":{"$ref":"#/definitions/addClientSecret"}}],"responses":{"200":{"description":"Successfully added","schema":{"type":"array","items":{"$ref":"#/definitions/clientCredentialsResponse"}}},"400":{"description":"Bad Request","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}},"security":[{"paylocity_auth":["WebLinkAPI"]}]}},"/v2/companies/{companyId}/codes/{codeResource}":{"get":{"tags":["Company Codes"],"summary":"Get All Company Codes","description":"Get All Company Codes for the selected company and resource","operationId":"Get All Company Codes and Descriptions by Resource","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"path","name":"companyId","description":"Company Id","required":true,"type":"string"},{"in":"path","name":"codeResource","description":"Type of Company Code. Common values costcenter1, costcenter2, costcenter3, deductions, earnings, taxes, paygrade, positions.","required":true,"type":"string"}],"responses":{"200":{"description":"Successfully retrieved","schema":{"type":"array","items":{"$ref":"#/definitions/companyCodes"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Invalid Code Resource","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}},"security":[{"paylocity_auth":["WebLinkAPI"]}]}},"/v2/companies/{companyId}/openapi":{"get":{"tags":["Company-Specific Schema"],"summary":"Get Company-Specific Open API Documentation","description":"The company-specific Open API endpoint allows the client to GET an Open API document for the Paylocity API that is customized with company-specific resource schemas. These customized resource schemas define certain properties as enumerations of pre-defined values that correspond to the company's setup with Web Pay. The customized schemas also indicate which properties are required by the company within Web Pay.
To learn more about Open API, click [here](https://www.openapis.org/)","operationId":"Get company-specific Open API documentation","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"header","name":"Authorization","description":"Bearer + JWT","required":true,"type":"string"},{"in":"path","name":"companyId","description":"Company Id","required":true,"type":"string"}],"responses":{"200":{"description":"Successfully retrieved"},"400":{"description":"Bad Request","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}},"security":[{"paylocity_auth":["WebLinkAPI"]}]}},"/v2/companies/{companyId}/customfields/{category}":{"get":{"tags":["Custom Fields"],"summary":"Get All Custom Fields","description":"Get All Custom Fields for the selected company","operationId":"Get All Custom Fields by category","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"path","name":"companyId","description":"Company Id","required":true,"type":"string"},{"in":"path","name":"category","description":"Custom Fields Category","required":true,"type":"string"}],"responses":{"200":{"description":"Successfully retrieved","schema":{"type":"array","items":{"$ref":"#/definitions/customFieldDefinition"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Invalid Category","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}},"security":[{"paylocity_auth":["WebLinkAPI"]}]}},"/v2/companies/{companyId}/employees/{employeeId}/directDeposit":{"get":{"tags":["Direct Deposit"],"summary":"Get All Direct Deposit","description":"Get All Direct Deposit returns main direct deposit and all additional direct depositsfor the selected employee.","operationId":"Get All Direct Deposit","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"path","name":"companyId","description":"Company Id","required":true,"type":"string"},{"in":"path","name":"employeeId","description":"Employee Id","required":true,"type":"string"}],"responses":{"200":{"description":"Successfully Retrieved","schema":{"type":"array","items":{"$ref":"#/definitions/directDeposit"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The employee, or direct deposit does not exist","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}},"security":[{"paylocity_auth":["WebLinkAPI"]}]}},"/v2/companies/{companyId}/employees/{employeeId}/earnings":{"put":{"tags":["Earnings"],"summary":"Add/Update Earning","description":"Add/Update Earning API sends new or updated employee earnings information directly to Web Pay.","operationId":"Add or update an employee earning","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"json","description":"Earning Model","required":true,"schema":{"$ref":"#/definitions/earning"}},{"in":"path","name":"companyId","description":"Company Id","required":true,"type":"string"},{"in":"path","name":"employeeId","description":"Employee Id","required":true,"type":"string"}],"responses":{"200":{"description":"Successfully added or updated"},"400":{"description":"Bad Request","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}},"security":[{"paylocity_auth":["WebLinkAPI"]}]},"get":{"tags":["Earnings"],"summary":"Get All Earnings","description":"Get All Earnings returns all earnings for the selected employee.","operationId":"Get All Earnings","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"path","name":"companyId","description":"Company Id","required":true,"type":"string"},{"in":"path","name":"employeeId","description":"Employee Id","required":true,"type":"string"}],"responses":{"200":{"description":"Successfully retrieved","schema":{"type":"array","items":{"$ref":"#/definitions/earning"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The employee does not exist"},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}},"security":[{"paylocity_auth":["WebLinkAPI"]}]}},"/v2/companies/{companyId}/employees/{employeeId}/earnings/{earningCode}/{startDate}":{"delete":{"tags":["Earnings"],"summary":"Delete Earning by Earning Code and Start Date","description":"Delete Earning by Earning Code and Start Date","operationId":"Delete Earning by Earning Code and Start Date","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"path","name":"companyId","description":"Company Id","required":true,"type":"string"},{"in":"path","name":"employeeId","description":"Employee Id","required":true,"type":"string"},{"in":"path","name":"earningCode","description":"Earning Code","required":true,"type":"string"},{"in":"path","name":"startDate","description":"Start Date","required":true,"type":"string"}],"responses":{"204":{"description":"Successfully deleted"},"400":{"description":"Bad Request","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The employee does not exist, or the specified earningCode-startDate combination does not exist"},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}},"security":[{"paylocity_auth":["WebLinkAPI"]}]},"get":{"tags":["Earnings"],"summary":"Get Earning by Earning Code and Start Date","description":"Get Earnings returns the single earning with the provided earning code and start date for the selected employee.","operationId":"Get Earning by Earning Code and Start Date","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"path","name":"companyId","description":"Company Id","required":true,"type":"string"},{"in":"path","name":"employeeId","description":"Employee Id","required":true,"type":"string"},{"in":"path","name":"earningCode","description":"Earning Code","required":true,"type":"string"},{"in":"path","name":"startDate","description":"Start Date","required":true,"type":"string"}],"responses":{"200":{"description":"Successfully retrieved","schema":{"$ref":"#/definitions/earning"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The employee does not exist, or the specified earningCode-startDate combination does not exist"},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}},"security":[{"paylocity_auth":["WebLinkAPI"]}]}},"/v2/companies/{companyId}/employees/{employeeId}/earnings/{earningCode}":{"get":{"tags":["Earnings"],"summary":"Get Earnings by Earning Code","description":"Get Earnings returns all earnings with the provided earning code for the selected employee.","operationId":"Get Earnings by Earning Code","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"path","name":"companyId","description":"Company Id","required":true,"type":"string"},{"in":"path","name":"employeeId","description":"Employee Id","required":true,"type":"string"},{"in":"path","name":"earningCode","description":"Earning Code","required":true,"type":"string"}],"responses":{"200":{"description":"Successfully retrieved","schema":{"type":"array","items":{"$ref":"#/definitions/earning"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The employee does not exist"},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}},"security":[{"paylocity_auth":["WebLinkAPI"]}]}},"/v2/companies/{companyId}/employees/{employeeId}/emergencyContacts":{"put":{"tags":["Emergency Contacts"],"summary":"Add/update emergency contacts","description":"Sends new or updated employee emergency contacts directly to Web Pay.","operationId":"Add or update emergency contacts","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"json","description":"Emergency Contact Model","required":true,"schema":{"$ref":"#/definitions/emergencyContact"}},{"in":"path","name":"companyId","description":"Company Id","required":true,"type":"string"},{"in":"path","name":"employeeId","description":"Employee Id","required":true,"type":"string"}],"responses":{"200":{"description":"Successfully added or updated"},"400":{"description":"Bad Request","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}},"security":[{"paylocity_auth":["WebLinkAPI"]}]}},"/v2/companies/{companyId}/employees/{employeeId}/benefitSetup":{"put":{"tags":["Employee Benefit Setup"],"summary":"Add/update employee's benefit setup","description":"Sends new or updated employee benefit setup information directly to Web Pay.","operationId":"Update or add employee benefit setup","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"json","description":"BenefitSetup Model","required":true,"schema":{"$ref":"#/definitions/benefitSetup"}},{"in":"path","name":"companyId","description":"Company Id","required":true,"type":"string"},{"in":"path","name":"employeeId","description":"Employee Id","required":true,"type":"string"}],"responses":{"200":{"description":"Successfully added or updated"},"400":{"description":"Bad Request","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}},"security":[{"paylocity_auth":["WebLinkAPI"]}]}},"/v2/weblinkstaging/companies/{companyId}/employees/newemployees":{"post":{"tags":["Employee Staging"],"summary":"Add new employee to Web Link","description":"Add new employee to Web Link will send partially completed or potentially erroneous new hire record to Web Link, where it can be corrected and competed by company administrator or authorized Paylocity Service Bureau employee.","operationId":"Add new employee to Web Link","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"json","description":"StagedEmployee Model","required":true,"schema":{"$ref":"#/definitions/stagedEmployee"}},{"in":"path","name":"companyId","description":"Company Id","required":true,"type":"string"}],"responses":{"201":{"description":"Successfully Added","schema":{"type":"array","items":{"$ref":"#/definitions/trackingNumberResponse"}}},"400":{"description":"Bad Request","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}},"security":[{"paylocity_auth":["WebLinkAPI"]}]}},"/v2/companies/{companyId}/employees":{"post":{"tags":["Employee"],"summary":"Add new employee","description":"New Employee API sends new employee data directly to Web Pay. Companies who use the New Hire Template in Web Pay may require additional fields when hiring employees. New Employee API Requests will honor these required fields.","operationId":"Add employee","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"json","description":"Employee Model","required":true,"schema":{"$ref":"#/definitions/employee"}},{"in":"path","name":"companyId","description":"Company Id","required":true,"type":"string"}],"responses":{"201":{"description":"Successfully added","schema":{"$ref":"#/definitions/employeeIdResponse"}},"400":{"description":"Bad Request","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}},"security":[{"paylocity_auth":["WebLinkAPI"]}]}},"/v2/companies/{companyId}/employees/":{"get":{"tags":["Employee"],"summary":"Get all employees","description":"Get All Employees API will return employee data currently available in Web Pay.","operationId":"Get all employees","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"path","name":"companyId","description":"Company Id","required":true,"type":"string"},{"in":"query","name":"pagesize","description":"Number of records per page. Default value is 25.","required":false,"type":"integer"},{"in":"query","name":"pagenumber","description":"Page number to retrieve; page numbers are 0-based (so to get the first page of results, pass pagenumber=0). Default value is 0.","required":false,"type":"integer"},{"in":"query","name":"includetotalcount","description":"Whether to include the total record count in the header's X-Pcty-Total-Count property. Default value is true.","required":false,"type":"boolean"}],"responses":{"200":{"description":"Successfully Retrieved","schema":{"type":"array","items":{"$ref":"#/definitions/employeeInfo"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The company does not exist","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}},"security":[{"paylocity_auth":["WebLinkAPI"]}]}},"/v2/companies/{companyId}/employees/{employeeId}":{"get":{"tags":["Employee"],"summary":"Get employee","description":"Get Employee API will return employee data currently available in Web Pay.","operationId":"Get employee","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"path","name":"companyId","description":"Company Id","required":true,"type":"string"},{"in":"path","name":"employeeId","description":"Employee Id","required":true,"type":"string"}],"responses":{"200":{"description":"Successfully Retrieved","schema":{"$ref":"#/definitions/employee"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The employee does not exist","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}},"security":[{"paylocity_auth":["WebLinkAPI"]}]},"patch":{"tags":["Employee"],"summary":"Update employee","description":"Update Employee API will update existing employee data in WebPay.","operationId":"Update employee","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"json","description":"Employee Model","required":true,"schema":{"$ref":"#/definitions/employee"}},{"in":"path","name":"companyId","description":"Company Id","required":true,"type":"string"},{"in":"path","name":"employeeId","description":"Employee Id","required":true,"type":"string"}],"responses":{"200":{"description":"Successfully Updated"},"400":{"description":"Bad Request","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}},"security":[{"paylocity_auth":["WebLinkAPI"]}]}},"/v2/companies/{companyId}/employees/{employeeId}/localTaxes":{"post":{"tags":["Local Taxes"],"summary":"Add new local tax","description":"Sends new employee local tax information directly to Web Pay.","operationId":"Add local tax","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"json","description":"LocalTax Model","required":true,"schema":{"$ref":"#/definitions/localTax"}},{"in":"path","name":"companyId","description":"Company Id","required":true,"type":"string"},{"in":"path","name":"employeeId","description":"Employee Id","required":true,"type":"string"}],"responses":{"201":{"description":"Successfully added"},"400":{"description":"Bad Request","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}},"security":[{"paylocity_auth":["WebLinkAPI"]}]},"get":{"tags":["Local Taxes"],"summary":"Get all local taxes","description":"Returns all local taxes for the selected employee.","operationId":"Get all local taxes","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"path","name":"companyId","description":"Company Id","required":true,"type":"string"},{"in":"path","name":"employeeId","description":"Employee Id","required":true,"type":"string"}],"responses":{"200":{"description":"Successfully retrieved","schema":{"type":"array","items":{"$ref":"#/definitions/localTax"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The employee does not exist"},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}},"security":[{"paylocity_auth":["WebLinkAPI"]}]}},"/v2/companies/{companyId}/employees/{employeeId}/localTaxes/{taxCode}":{"delete":{"tags":["Local Taxes"],"summary":"Delete local tax by tax code","description":"Delete local tax by tax code","operationId":"Delete local tax by tax code","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"path","name":"companyId","description":"Company Id","required":true,"type":"string"},{"in":"path","name":"employeeId","description":"Employee Id","required":true,"type":"string"},{"in":"path","name":"taxCode","description":"Tax Code","required":true,"type":"string"}],"responses":{"204":{"description":"Successfully deleted"},"400":{"description":"Bad Request","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The employee does not exist, or the specified tax code does not exist"},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}},"security":[{"paylocity_auth":["WebLinkAPI"]}]},"get":{"tags":["Local Taxes"],"summary":"Get local taxes by tax code","description":"Returns all local taxes with the provided tax code for the selected employee.","operationId":"Get local tax by tax code","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"path","name":"companyId","description":"Company Id","required":true,"type":"string"},{"in":"path","name":"employeeId","description":"Employee Id","required":true,"type":"string"},{"in":"path","name":"taxCode","description":"Tax Code","required":true,"type":"string"}],"responses":{"200":{"description":"Successfully retrieved","schema":{"type":"array","items":{"$ref":"#/definitions/localTax"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The employee does not exist, or the specified tax code does not exist"},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}},"security":[{"paylocity_auth":["WebLinkAPI"]}]}},"/v2/companies/{companyId}/employees/{employeeId}/nonprimaryStateTax":{"put":{"tags":["Non-Primary State Tax"],"summary":"Add/update non-primary state tax","description":"Sends new or updated employee non-primary state tax information directly to Web Pay.","operationId":"Add or update non-primary state tax","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"json","description":"Non-Primary State Tax Model","required":true,"schema":{"$ref":"#/definitions/nonPrimaryStateTax"}},{"in":"path","name":"companyId","description":"Company Id","required":true,"type":"string"},{"in":"path","name":"employeeId","description":"Employee Id","required":true,"type":"string"}],"responses":{"200":{"description":"Successfully added or updated"},"400":{"description":"Bad Request","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}},"security":[{"paylocity_auth":["WebLinkAPI"]}]}},"/v2/companies/{companyId}/employees/{employeeId}/paystatement/details/{year}/{checkDate}":{"get":{"tags":["PayStatements"],"summary":"Get employee pay statement details data for the specified year and check date.","description":"Get pay statement details API will return employee pay statement detail data currently available in Web Pay for the specified year and check date.","operationId":"Gets employee pay statement detail data based on the specified year and check date","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"path","name":"companyId","description":"Company Id","required":true,"type":"string"},{"in":"path","name":"employeeId","description":"Employee Id","required":true,"type":"string"},{"in":"path","name":"year","description":"The year for which to retrieve pay statement data","required":true,"type":"string"},{"in":"path","name":"checkDate","description":"The check date for which to retrieve pay statement data","required":true,"type":"string"},{"in":"query","name":"pagesize","description":"Number of records per page. Default value is 25.","required":false,"type":"integer"},{"in":"query","name":"pagenumber","description":"Page number to retrieve; page numbers are 0-based (so to get the first page of results, pass pagenumber=0). Default value is 0.","required":false,"type":"integer"},{"in":"query","name":"includetotalcount","description":"Whether to include the total record count in the header's X-Pcty-Total-Count property. Default value is true.","required":false,"type":"boolean"},{"in":"query","name":"codegroup","description":"Retrieve pay statement details related to specific deduction, earning or tax types. Common values include 401k, Memo, Reg, OT, Cash Tips, FED and SITW.","required":false,"type":"string"}],"responses":{"200":{"description":"Successfully Retrieved","schema":{"type":"array","items":{"$ref":"#/definitions/payStatementDetails"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The employee, specified year, or check date does not exist","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}},"security":[{"paylocity_auth":["WebLinkAPI"]}]}},"/v2/companies/{companyId}/employees/{employeeId}/paystatement/details/{year}":{"get":{"tags":["PayStatements"],"summary":"Get employee pay statement details data for the specified year.","description":"Get pay statement details API will return employee pay statement details data currently available in Web Pay for the specified year.","operationId":"Gets employee pay statement detail data based on the specified year","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"path","name":"companyId","description":"Company Id","required":true,"type":"string"},{"in":"path","name":"employeeId","description":"Employee Id","required":true,"type":"string"},{"in":"path","name":"year","description":"The year for which to retrieve pay statement data","required":true,"type":"string"},{"in":"query","name":"pagesize","description":"Number of records per page. Default value is 25.","required":false,"type":"integer"},{"in":"query","name":"pagenumber","description":"Page number to retrieve; page numbers are 0-based (so to get the first page of results, pass pagenumber=0). Default value is 0.","required":false,"type":"integer"},{"in":"query","name":"includetotalcount","description":"Whether to include the total record count in the header's X-Pcty-Total-Count property. Default value is true.","required":false,"type":"boolean"},{"in":"query","name":"codegroup","description":"Retrieve pay statement details related to specific deduction, earning or tax types. Common values include 401k, Memo, Reg, OT, Cash Tips, FED and SITW.","required":false,"type":"string"}],"responses":{"200":{"description":"Successfully Retrieved","schema":{"type":"array","items":{"$ref":"#/definitions/payStatementDetails"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The employee, specified year, or check date does not exist","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}},"security":[{"paylocity_auth":["WebLinkAPI"]}]}},"/v2/companies/{companyId}/employees/{employeeId}/paystatement/summary/{year}/{checkDate}":{"get":{"tags":["PayStatements"],"summary":"Get employee pay statement summary data for the specified year and check date.","description":"Get pay statement summary API will return employee pay statement summary data currently available in Web Pay for the specified year and check date.","operationId":"Gets employee pay statement summary data based on the specified year and check date","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"path","name":"companyId","description":"Company Id","required":true,"type":"string"},{"in":"path","name":"employeeId","description":"Employee Id","required":true,"type":"string"},{"in":"path","name":"year","description":"The year for which to retrieve pay statement data","required":true,"type":"string"},{"in":"path","name":"checkDate","description":"The check date for which to retrieve pay statement data","required":true,"type":"string"},{"in":"query","name":"pagesize","description":"Number of records per page. Default value is 25.","required":false,"type":"integer"},{"in":"query","name":"pagenumber","description":"Page number to retrieve; page numbers are 0-based (so to get the first page of results, pass pagenumber=0). Default value is 0.","required":false,"type":"integer"},{"in":"query","name":"includetotalcount","description":"Whether to include the total record count in the header's X-Pcty-Total-Count property. Default value is true.","required":false,"type":"boolean"},{"in":"query","name":"codegroup","description":"Retrieve pay statement details related to specific deduction, earning or tax types. Common values include 401k, Memo, Reg, OT, Cash Tips, FED and SITW.","required":false,"type":"string"}],"responses":{"200":{"description":"Successfully Retrieved","schema":{"type":"array","items":{"$ref":"#/definitions/payStatementSummary"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The employee, specified year, or check date does not exist","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}},"security":[{"paylocity_auth":["WebLinkAPI"]}]}},"/v2/companies/{companyId}/employees/{employeeId}/paystatement/summary/{year}":{"get":{"tags":["PayStatements"],"summary":"Get employee pay statement summary data for the specified year.","description":"Get pay statement summary API will return employee pay statement summary data currently available in Web Pay for the specified year.","operationId":"Gets employee pay statement summary data based on the specified year","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"path","name":"companyId","description":"Company Id","required":true,"type":"string"},{"in":"path","name":"employeeId","description":"Employee Id","required":true,"type":"string"},{"in":"path","name":"year","description":"The year for which to retrieve pay statement data","required":true,"type":"string"},{"in":"query","name":"pagesize","description":"Number of records per page. Default value is 25.","required":false,"type":"integer"},{"in":"query","name":"pagenumber","description":"Page number to retrieve; page numbers are 0-based (so to get the first page of results, pass pagenumber=0). Default value is 0.","required":false,"type":"integer"},{"in":"query","name":"includetotalcount","description":"Whether to include the total record count in the header's X-Pcty-Total-Count property. Default value is true.","required":false,"type":"boolean"},{"in":"query","name":"codegroup","description":"Retrieve pay statement details related to specific deduction, earning or tax types. Common values include 401k, Memo, Reg, OT, Cash Tips, FED and SITW.","required":false,"type":"string"}],"responses":{"200":{"description":"Successfully Retrieved","schema":{"type":"array","items":{"$ref":"#/definitions/payStatementSummary"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The employee, specified year, or check date does not exist","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}},"security":[{"paylocity_auth":["WebLinkAPI"]}]}},"/v2/companies/{companyId}/employees/{employeeId}/primaryStateTax":{"put":{"tags":["Primary State Tax"],"summary":"Add/update primary state tax","description":"Sends new or updated employee primary state tax information directly to Web Pay.","operationId":"Add or update primary state tax","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"json","description":"Primary State Tax Model","required":true,"schema":{"$ref":"#/definitions/stateTax"}},{"in":"path","name":"companyId","description":"Company Id","required":true,"type":"string"},{"in":"path","name":"employeeId","description":"Employee Id","required":true,"type":"string"}],"responses":{"200":{"description":"Successfully added or updated"},"400":{"description":"Bad Request","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}},"security":[{"paylocity_auth":["WebLinkAPI"]}]}},"/v2/companies/{companyId}/employees/{employeeId}/sensitivedata":{"put":{"tags":["Sensitive Data"],"summary":"Add/update sensitive data","description":"Sends new or updated employee sensitive data information directly to Web Pay.","operationId":"Add or update Sensitive Data","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"json","description":"Sensitive Data Model","required":true,"schema":{"$ref":"#/definitions/sensitiveData"}},{"in":"path","name":"companyId","description":"Company Id","required":true,"type":"string"},{"in":"path","name":"employeeId","description":"Employee Id","required":true,"type":"string"}],"responses":{"200":{"description":"Successfully added or updated"},"400":{"description":"Bad Request","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}},"security":[{"paylocity_auth":["WebLinkAPI"]}]},"get":{"tags":["Sensitive Data"],"summary":"Get sensitive data","description":"Gets employee sensitive data information directly from Web Pay.","operationId":"Get sensitive data","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"path","name":"companyId","description":"Company Id","required":true,"type":"string"},{"in":"path","name":"employeeId","description":"Employee Id","required":true,"type":"string"}],"responses":{"200":{"description":"Successfully Retrieved","schema":{"type":"array","items":{"$ref":"#/definitions/sensitiveData"}}},"400":{"description":"Bad Request","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests"},"500":{"description":"Internal Server Error","schema":{"type":"array","items":{"$ref":"#/definitions/error"}}}},"security":[{"paylocity_auth":["WebLinkAPI"]}]}}},"securityDefinitions":{"paylocity_auth":{"type":"oauth2","tokenUrl":"https://api.paylocity.com/IdentityServer/connect/token","flow":"application","scopes":{"WebLinkAPI":"Web Link Api"}}},"definitions":{"additionalRate":{"description":"The additional pay rate model","type":"object","additionalProperties":false,"properties":{"changeReason":{"description":"Not required. If populated, must match one of the system coded values available in the Additional Rates Change Reason drop down.
","type":["string","null"]},"costCenter1":{"description":"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.
","type":["string","null"]},"costCenter2":{"description":"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.
","type":["string","null"]},"costCenter3":{"description":"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.
","type":["string","null"]},"effectiveDate":{"description":"Required. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.
","type":["string","null"],"format":"paylocity-date"},"endCheckDate":{"description":"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*.
","type":["string","null"],"format":"paylocity-date"},"job":{"description":"Not required. If populated, must match one of the system coded values available in the Additional Rates Job drop down.
","type":["string","null"]},"rate":{"description":"Required. Enter dollar amount that corresponds to the Per selection.
","type":["number","null"]},"rateCode":{"description":"Required. If populated, must match one of the system coded values available in the Additional Rates Rate Code drop down.
","type":["string","null"]},"rateNotes":{"description":"Not required.
Max length: 4000
","type":["string","null"]},"ratePer":{"description":"Required. Valid values are HOUR or WEEK.
","type":["string","null"]},"shift":{"description":"Not required. If populated, must match one of the system coded values available in the Additional Rates Shift drop down.
","type":["string","null"]}}},"error":{"description":"The error model","type":"object","properties":{"field":{"description":"The name of the field, or property in the request message that contains an error.","type":"string"},"message":{"description":"The error message.","type":"string"},"options":{"description":"A list of options associated with this error. These options may indicate valid values for the field, or property that contains an error.","type":"array","items":{"description":"The error option model","type":"object","properties":{"code":{"description":"The code associated with this option.","type":"string"},"description":{"description":"The description of the option.","type":"string"}}}},"path":{"description":"The JSON path of the field, or property, that contains an error in the request message.","type":"string"}}},"addClientSecret":{"description":"The Add Client Secret Request Model","type":"object","properties":{"code":{"description":"A value sent with the 'ACTION NEEDED: Web Link API Credentials Expiring Soon.' email notification.","type":"string"}},"required":["code"]},"clientCredentialsResponse":{"description":"The Client Credentials Response Model","type":"object","additionalProperties":false,"properties":{"clientSecret":{"description":"The client's secret","type":["string","null"]},"clientSecretExpirationDate":{"description":"The client's secret expiration date","type":["string","null"],"format":"paylocity-date"}}},"companyCodes":{"description":"The Company Codes model","type":"object","additionalProperties":false,"properties":{"code":{"description":"Code.
Max length: 40","type":["string","null"]},"description":{"description":"Description.
Max length: 150","type":["string","null"]}}},"customFieldDefinition":{"description":"","type":"object","properties":{"category":{"description":"The custom field category.","type":"string"},"defaultValue":{"description":"Specifies the default value of the custom field.","type":"string"},"isRequired":{"description":"Indicates whether the custom field is required.","type":"boolean"},"label":{"description":"The custom field label.","type":"string"},"type":{"description":"The custom field type.","type":"string"},"values":{"description":"A set of values that are applicable to the custom field.","type":"array","items":{"description":"","type":"object","properties":{"code":{"description":"The custom field code.","type":"string"},"description":{"description":"The custom field description.","type":"string"}}}}}},"directDeposit":{"description":"The Direct Deposit model","type":"object","additionalProperties":false,"properties":{"additionalDirectDeposit":{"description":"Additional Direct Deposits that are not the main Direct Deposit.","type":"array","items":{"description":"The additional direct deposit model","type":"object","additionalProperties":false,"properties":{"accountNumber":{"description":"Account number, entered without special characters and spaces.
Max length: 17
","type":["string","null"]},"accountType":{"description":"Account type. Valid values are *C* (Checking), *S* (Saving), *P* (Pay Card).
Max length: 1
","type":["string","null"]},"amount":{"description":"Amount value to be deposited to the account.
Decimal (12,2)
","type":["number","null"]},"amountType":{"description":"Amount type to indicate the context of the amount. Common values are *F* (FLAT), *F-* (Net Minus), *P* (Percent).
Max length: 5
","type":["string","null"]},"blockSpecial":{"description":"Indicates if direct deposit should be blocked when special check types such as Bonus are processed.
","type":["boolean","null"]},"isSkipPreNote":{"description":"Indicates if account will not pre-note.
","type":["boolean","null"]},"nameOnAccount":{"description":"Name on the bank account. Defaults to employee's name.
Max length: 30
","type":["string","null"]},"preNoteDate":{"description":"Date to end the pre-note of the account. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.
","type":["string","null"],"format":"paylocity-date"},"routingNumber":{"description":"ABA Transit Routing Number, entered without dashes or spaces.
Max length: 9
","type":["string","null"]}}}},"mainDirectDeposit":{"description":"The main Direct Deposit account.","type":"object","additionalProperties":false,"properties":{"accountNumber":{"description":"Account number, entered without special characters and spaces.
Max length: 17","type":["string","null"]},"accountType":{"description":"Account type. Valid values are *C* (Checking), *S* (Saving), *P* (Pay Card).
Max length: 1","type":["string","null"]},"blockSpecial":{"description":"Indicates if direct deposit should be blocked when special check types such as Bonus are processed.
","type":["boolean","null"]},"isSkipPreNote":{"description":"Indicates if account will not pre-note.","type":["boolean","null"]},"nameOnAccount":{"description":"Name on the bank account. Defaults to employee's name.
Max length: 30
","type":["string","null"]},"preNoteDate":{"description":"Date to end the pre-note of the account. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.","type":["string","null"],"format":"paylocity-date"},"routingNumber":{"description":"ABA Transit Routing Number, entered without dashes or spaces.
Max length: 9","type":["string","null"]}}}}},"earning":{"description":"The employee earning model","type":"object","additionalProperties":false,"properties":{"agency":{"description":"Third-party agency associated with earning. Must match Company setup.
Max length: 10","type":["string","null"]},"amount":{"description":"Value that matches CalculationCode to add to gross wages. For percentage (%), enter whole number (10 = 10%).
Decimal(12,2)","type":["number","null"]},"annualMaximum":{"description":"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)","type":["number","null"]},"calculationCode":{"description":"Defines how earnings are calculated. Common values are *% (percentage of gross), flat (flat dollar amount)*. Defaulted to the Company setup calcCode for earning.
Max length: 20","type":["string","null"]},"costCenter1":{"description":"Cost Center associated with earning. Must match Company setup.
Max length: 10","type":["string","null"]},"costCenter2":{"description":"Cost Center associated with earning. Must match Company setup.
Max length: 10","type":["string","null"]},"costCenter3":{"description":"Cost Center associated with earning. Must match Company setup.
Max length: 10","type":["string","null"]},"earningCode":{"description":"Earning code. Must match Company setup.
Max length: 10","type":["string","null"]},"effectiveDate":{"description":"Date earning is active. Defaulted to run date or check date based on Company setup. Common formats are MM-DD-CCYY, CCYY-MM-DD.","type":["string","null"],"format":"paylocity-date"},"endDate":{"description":"Stop date of an earning. Common formats are MM-DD-CCYY, CCYY-MM-DD.","type":["string","null"],"format":"paylocity-date"},"frequency":{"description":"Needed if earning is applied differently from the payroll frequency (one time earning for example).
Max length: 5","type":["string","null"]},"goal":{"description":"Dollar amount. The employee earning will stop when the goal amount is reached.
Decimal(12,2)","type":["number","null"]},"hoursOrUnits":{"description":"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)","type":["number","null"]},"isSelfInsured":{"description":"Used for ACA. If not entered, defaulted to Company earning setup.","type":["boolean","null"]},"jobCode":{"description":"Job code associated with earnings. Must match Company setup.
Max length: 20","type":["string","null"]},"miscellaneousInfo":{"description":"Information to print on the check stub if agency is set up for this earning.
Max length: 50","type":["string","null"]},"paidTowardsGoal":{"description":"Amount already paid to employee toward goal.
Decimal(12,2)","type":["number","null"]},"payPeriodMaximum":{"description":"Maximum amount of the earning on a single paycheck.
Decimal(12,2)","type":["number","null"]},"payPeriodMinimum":{"description":"Minimum amount of the earning on a single paycheck.
Decimal(12,2)","type":["number","null"]},"rate":{"description":"Rate is used in conjunction with the hoursOrUnits field.
Decimal(12,2)","type":["number","null"]},"rateCode":{"description":"Rate Code applies to additional pay rates entered for an employee. Must match Company setup.
Max length: 10","type":["string","null"]},"startDate":{"description":"Start date of an earning based on payroll calendar. Common formats are MM-DD-CCYY, CCYY-MM-DD.","type":["string","null"],"format":"paylocity-date"}},"required":["earningCode","startDate"]},"emergencyContact":{"description":"The emergency contact model","type":"object","additionalProperties":false,"properties":{"address1":{"description":"1st address line.","type":["string","null"]},"address2":{"description":"2nd address line.","type":["string","null"]},"city":{"description":"City.","type":["string","null"]},"country":{"description":"County.","type":["string","null"]},"county":{"description":"Country. Must be a valid 3 character country code. Common values are *USA* (United States), *CAN* (Canada).","type":["string","null"]},"email":{"description":"Contact email. Must be valid email address format.","type":["string","null"]},"firstName":{"description":"Required. Contact first name.
Max length: 40","type":["string","null"]},"homePhone":{"description":"Contact Home Phone. Valid phone format *(###) #######* or *######-####* or *### ### ####* or *##########* or, if international, starts with *+#*, only spaces and digits allowed.","type":["string","null"]},"lastName":{"description":"Required. Contact last name.
Max length: 40","type":["string","null"]},"mobilePhone":{"description":"Contact Mobile Phone. Valid phone format *(###) #######* or *######-####* or *### ### ####* or *##########* or, if international, starts with *+#*, only spaces and digits allowed.","type":["string","null"]},"notes":{"description":"Notes.
Max length: 1000","type":["string","null"]},"pager":{"description":"Contact Pager. Valid phone format *(###) #######* or *######-####* or *### ### ####* or *##########* or, if international, starts with *+#*, only spaces and digits allowed.","type":["string","null"]},"primaryPhone":{"description":"Required. Contact primary phone type. Must match Company setup. Valid values are H (Home), M (Mobile), P (Pager), W (Work)","type":["string","null"]},"priority":{"description":"Required. Contact priority. Valid values are *P* (Primary) or *S* (Secondary).","type":["string","null"]},"relationship":{"description":"Required. Contact relationship. Must match Company setup. Common values are Spouse, Mother, Father.","type":["string","null"]},"state":{"description":"State or Province. If U.S. address, must be valid 2 character state code. Common values are *IL* (Illinois), *CA* (California).","type":["string","null"]},"syncEmployeeInfo":{"description":"Valid values are *true* or *false*.","type":"boolean"},"workExtension":{"description":"Work Extension.","type":["string","null"]},"workPhone":{"description":"Contact Work Phone. Valid phone format *(###) #######* or *######-####* or *### ### ####* or *##########* or, if international, starts with *+#*, only spaces and digits allowed.","type":["string","null"]},"zip":{"description":"Postal code. If U.S. address, must be a valid zip code.","type":["string","null"]}},"required":["firstName","lastName"]},"benefitSetup":{"description":"The benefit setup model","type":"object","additionalProperties":false,"properties":{"benefitClass":{"description":"Benefit Class code. Values are configured in Web Pay Company > Setup > Benefits > Classes.
Max length: 30","type":["string","null"]},"benefitClassEffectiveDate":{"description":"Date when Benefit Class takes effect. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.","type":["string","null"],"format":"paylocity-date"},"benefitSalary":{"description":"Salary used to configure benefits.
Decimal(12,2)","type":["number","null"]},"benefitSalaryEffectiveDate":{"description":"Date when Benefit Salary takes effect. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.","type":["string","null"],"format":"paylocity-date"},"doNotApplyAdministrativePeriod":{"description":"Applicable only for HR Enhanced clients and Benefit Classes with ACA Employment Type of Full Time.","type":["boolean","null"]},"isMeasureAcaEligibility":{"description":"Only valid for HR Enhanced clients and Benefit Classes that are ACA Employment Type of Full Time.","type":["boolean","null"]}}},"stagedEmployee":{"description":"The staged employee model","type":"object","additionalProperties":false,"properties":{"additionalDirectDeposit":{"description":"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.","type":"array","items":{"description":"The additional direct deposit model","type":"object","additionalProperties":false,"properties":{"accountNumber":{"description":"Account number, entered without special characters and spaces.
Max length: 17
","type":["string","null"]},"accountType":{"description":"Account type. Valid values are *C* (Checking), *S* (Saving), *P* (Pay Card).
Max length: 1
","type":["string","null"]},"amount":{"description":"Amount value to be deposited to the account.
Decimal (12,2)
","type":["number","null"]},"amountType":{"description":"Amount type to indicate the context of the amount. Common values are *F* (FLAT), *F-* (Net Minus), *P* (Percent).
Max length: 5
","type":["string","null"]},"isSkipPreNote":{"description":"Indicates if account will not pre-note.
","type":["boolean","null"]},"preNoteDate":{"description":"Date to end the pre-note of the account. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.
","type":["string","null"],"format":"paylocity-date"},"routingNumber":{"description":"ABA Transit Routing Number, entered without dashes or spaces.
Max length: 9
","type":["string","null"]}}},"maxItems":4},"benefitSetup":{"description":"Add setup values used for employee benefits integration, insurance plan settings, and ACA reporting.","type":"array","items":{"description":"The benefit setup model","type":"object","additionalProperties":false,"properties":{"benefitClass":{"description":"Benefit Class code. Values are configured in Web Pay Company > Setup > Benefits > Classes.
Max length: 30","type":["string","null"]},"benefitClassEffectiveDate":{"description":"Date when Benefit Class takes effect. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.","type":["string","null"],"format":"paylocity-date"},"benefitSalary":{"description":"Salary used to configure benefits.
Decimal(12,2)","type":["number","null"]},"benefitSalaryEffectiveDate":{"description":"Date when Benefit Salary takes effect. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.","type":["string","null"],"format":"paylocity-date"},"doNotApplyAdministrativePeriod":{"description":"Applicable only for ACA Enhanced clients and Benefit Classes with ACA Employment Type of Full Time.","type":["boolean","null"]},"isMeasureAcaEligibility":{"description":"Only valid for ACA Enhanced clients and Benefit Classes that are ACA Employment Type of Full Time.","type":["boolean","null"]}}},"maxItems":1},"birthDate":{"description":"Employee birthdate. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.","type":["string","null"],"format":"paylocity-date"},"customBooleanFields":{"description":"Up to 8 custom fields of boolean (checkbox) type value.","type":"array","items":{"description":"","type":"object","additionalProperties":false,"properties":{"category":{"description":"The custom field category. Acceptable value is 'PayrollAndHR'.","type":"string","enum":["PayrollAndHR"]},"label":{"description":"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.","type":["string","null"]},"value":{"description":"The custom boolean field value.","type":["boolean","null"]}},"required":["category","label","value"]},"maxItems":8},"customDateFields":{"description":"Up to 8 custom fields of the date type value.","type":"array","items":{"description":"","type":"object","additionalProperties":false,"properties":{"category":{"description":"The custom field category. Acceptable value is 'PayrollAndHR'.","type":"string","enum":["PayrollAndHR"]},"label":{"description":"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.","type":["string","null"]},"value":{"description":"The custom date field value. Common formats include MM-DD-CCYY, CCYY-MM-DD.","type":["string","null"],"format":"paylocity-date"}},"required":["category","label","value"]},"maxItems":8},"customDropDownFields":{"description":"Up to 8 custom fields of the dropdown type value.","type":"array","items":{"description":"","type":"object","additionalProperties":false,"properties":{"category":{"description":"The custom field category. Acceptable value is 'PayrollAndHR'.","type":"string","enum":["PayrollAndHR"]},"label":{"description":"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.","type":["string","null"]},"value":{"description":"The custom dropdown field value. Values are configured in Web Pay Company > Setup > List Values > Lookup Values > Custom Fields: PayrollAndHR. Max length: 10.","type":["string","null"]}},"required":["category","label","value"]},"maxItems":8},"customNumberFields":{"description":"Up to 8 custom fields of numeric type value.","type":"array","items":{"description":"","type":"object","additionalProperties":false,"properties":{"category":{"description":"The custom field category. Acceptable value is 'PayrollAndHR'.","type":"string","enum":["PayrollAndHR"]},"label":{"description":"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.","type":["string","null"]},"value":{"description":"The custom number field value. Decimal (18,6).","type":["number","null"]}},"required":["category","label","value"]},"maxItems":8},"customTextFields":{"description":"Up to 8 custom fields of text type value.","type":"array","items":{"description":"","type":"object","additionalProperties":false,"properties":{"category":{"description":"The custom field category. Acceptable value is 'PayrollAndHR'.","type":"string","enum":["PayrollAndHR"]},"label":{"description":"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.","type":["string","null"]},"value":{"description":"The custom text field value. Max length: 255.","type":["string","null"]}},"required":["category","label","value"]},"maxItems":8},"departmentPosition":{"description":"Add home department cost center, position, supervisor, reviewer, employment type, EEO class, pay settings, and union information.","type":"array","items":{"description":"The Department Position model","type":"object","additionalProperties":false,"properties":{"changeReason":{"description":"Employee department/position change reason. Must match Company setup.
Max length: 15","type":["string","null"]},"clockBadgeNumber":{"description":"Employee clock badge number. Defaults to employeeId.
Max length: 10","type":["string","null"]},"costCenter1":{"description":"Employer defined location, like *branch, division, department*, etc. Must match Company setup.
Max length: 10","type":["string","null"]},"costCenter2":{"description":"Employer defined location, like *branch, division, department*, etc. Must match Company setup.
Max length: 10","type":["string","null"]},"costCenter3":{"description":"Employer defined location, like *branch, division, department*, etc. Must match Company setup.
Max length: 10","type":["string","null"]},"effectiveDate":{"description":"The date the position takes effect. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.","type":["string","null"],"format":"paylocity-date"},"employeeType":{"description":"Employee current employment type. Common values *RFT (Regular Full Time), RPT (Regular Part Time), SNL (Seasonal), TFT (Temporary Full Time), TPT (Temporary Part Time)*.
Max length: 10","type":["string","null"]},"equalEmploymentOpportunityClass":{"description":"Values are configured in Company > Setup > HR > EEO Classes.
Max length: 10","type":["string","null"]},"isMinimumWageExempt":{"description":"Indicates if employee is exempt from minimum wage.","type":["boolean","null"]},"isOvertimeExempt":{"description":"Indicates if employee is exempt from overtime.","type":["boolean","null"]},"isSupervisorReviewer":{"description":"Indicates if employee is a supervisor or reviewer.","type":["boolean","null"]},"isUnionDuesCollected":{"description":"Indicates if union dues are collected.","type":["boolean","null"]},"isUnionInitiationCollected":{"description":"Indicates if initiations fees are collected.","type":["boolean","null"]},"jobTitle":{"description":"Employee current job title.
Max length: 50","type":["string","null"]},"payGroup":{"description":"Employee pay group. Must match Company setup.
Max length: 20","type":["string","null"]},"positionCode":{"description":"Employee position code. Must match Company setup.
Max length: 20","type":["string","null"]},"shift":{"description":"Employee work shift.
Max length: 255","type":["string","null"]},"supervisorCompanyNumber":{"description":"Supervisor's company number. Defaults to employee company number.
Max length: 9","type":["string","null"]},"supervisorEmployeeId":{"description":"EmployeeId of the supervisor.
Max length: 10","type":["string","null"]},"tipped":{"description":"Indicates if employee receives tips.","type":["string","null"]},"unionAffiliationDate":{"description":"Employee union affiliation effective date. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.","type":["string","null"],"format":"paylocity-date"},"unionCode":{"description":"Employee union code. Must match Company setup.
Max length: 10","type":["string","null"]},"unionPosition":{"description":"Employee union position. Must match Company setup.
Max length: 30","type":["string","null"]},"workersCompensation":{"description":"Employee worker compensation code. Must match Company setup.
Max length: 10","type":["string","null"]}}},"maxItems":1},"disabilityDescription":{"description":"Indicates if employee has disability status.","type":["string","null"]},"employeeId":{"description":"Leave blank to have Web Pay automatically assign the next available employee ID.
Max length: 10","type":["string","null"]},"ethnicity":{"description":"Employee ethnicity.
Max length: 10","type":["string","null"]},"federalTax":{"description":"Add federal tax amount type (taxCalculationCode), amount or percentage, filing status, and exemptions.","type":"array","items":{"description":"The Federal Tax model","type":"object","additionalProperties":false,"properties":{"amount":{"description":"Tax amount.
Decimal (12,2)","type":["number","null"]},"deductionsAmount":{"description":"Box 4(b) on form W4 (year 2020 or later): Deductions amount.
Decimal (12,2)","type":"number"},"dependentsAmount":{"description":"Box 3 on form W4 (year 2020 or later): Total dependents amount.
Decimal (12,2)","type":"number"},"exemptions":{"description":"Federal tax exemptions value.
Decimal (12,2)","type":["number","null"]},"filingStatus":{"description":"Employee federal filing status. Common values are *S* (Single), *M* (Married).
Max length: 50","type":["string","null"]},"higherRate":{"description":"Box 2(c) on form W4 (year 2020 or later): Multiple Jobs or Spouse Works.
Boolean","type":"boolean"},"otherIncomeAmount":{"description":"Box 4(a) on form W4 (year 2020 or later): Other income amount.
Decimal (12,2)","type":"number"},"percentage":{"description":"Tax percentage.
Decimal (12,2)","type":["number","null"]},"taxCalculationCode":{"description":"Tax calculation code. Common values are *F* (Flat), *P* (Percentage), *FDFP* (Flat Dollar Amount plus Fixed Percentage).
Max length: 10","type":["string","null"]},"w4FormYear":{"description":"The federal W4 form year
Integer","type":"integer"}}},"maxItems":1},"firstName":{"description":"Employee first name.
Max length: 40","type":["string","null"]},"fitwExemptReason":{"description":"Reason code for FITW exemption. Common values are *SE* (Statutory employee), *CR* (clergy/Religious).
Max length: 30","type":["string","null"]},"futaExemptReason":{"description":"Reason code for FUTA exemption. Common values are *501* (5019c)(3) Organization), *IC* (Independent Contractor).
Max length: 30","type":["string","null"]},"gender":{"description":"Employee gender. Common values *M* (Male), *F* (Female).
Max length: 1","type":["string","null"]},"homeAddress":{"description":"Add employee's home address, personal phone numbers, and personal email.","type":"array","items":{"description":"The address model","type":"object","additionalProperties":false,"properties":{"address1":{"description":"1st address line.
Max length: 40","type":["string","null"]},"address2":{"description":"2nd address line.
Max length: 40","type":["string","null"]},"city":{"description":"City.
Max length: 40","type":["string","null"]},"country":{"description":"Country.
Max length: 30","type":["string","null"]},"county":{"description":"County.
Max length: 30","type":["string","null"]},"emailAddress":{"description":"Email.
Max length: 50","type":["string","null"]},"mobilePhone":{"description":"Mobile phone number.
Max length: 12","type":["string","null"]},"phone":{"description":"Phone number.
Max length: 12","type":["string","null"]},"postalCode":{"description":"Postal code.
Max length: 10","type":["string","null"]},"state":{"description":"State or province.
Max length: 2","type":["string","null"]}}},"maxItems":1},"isEmployee943":{"description":"Indicates if employee in agriculture or farming.","type":["boolean","null"]},"isSmoker":{"description":"Indicates if employee is a smoker.","type":["boolean","null"]},"lastName":{"description":"Employee last name.
Max length: 40","type":["string","null"]},"localTax":{"description":"Add local tax code, filing status, and exemptions including PA-PSD taxes.","type":"array","items":{"description":"The Local Tax model","type":"object","additionalProperties":false,"properties":{"exemptions":{"description":"Local tax exemptions value.
Decimal (12,2)","type":["number","null"]},"exemptions2":{"description":"Local tax exemptions 2 value.
Decimal (12,2)","type":["number","null"]},"filingStatus":{"description":"Employee local tax filing status. Must match specific local tax setup.
Max length: 50","type":["string","null"]},"residentPSD":{"description":"Resident PSD (political subdivision code) applicable in PA. Must match Company setup.
Max length: 9","type":["string","null"]},"taxCode":{"description":"Local tax code.
Max length: 50","type":["string","null"]},"workPSD":{"description":"Work location PSD. Must match Company setup.
Max length: 9","type":["string","null"]}}},"maxItems":5},"mainDirectDeposit":{"description":"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.","type":"array","items":{"description":"The Main Direct Deposit model","type":"object","additionalProperties":false,"properties":{"accountNumber":{"description":"Account number, entered without special characters and spaces.
Max length: 17","type":["string","null"]},"accountType":{"description":"Account type. Valid values are *C* (Checking), *S* (Saving), *P* (Pay Card).
Max length: 1","type":["string","null"]},"isSkipPreNote":{"description":"Indicates if account will not pre-note.","type":["boolean","null"]},"preNoteDate":{"description":"Date to end the pre-note of the account. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.","type":["string","null"],"format":"paylocity-date"},"routingNumber":{"description":"ABA Transit Routing Number, entered without dashes or spaces.
Max length: 9","type":["string","null"]}}},"maxItems":1},"maritalStatus":{"description":"Employee marital status. Common values *D (Divorced), M (Married), S (Single), W (Widowed)*.
Max length: 10","type":["string","null"]},"medExemptReason":{"description":"Reason code for Medicare exemption. Common values are *501* (5019c)(3) Organization), *IC* (Independent Contractor).
Max length: 30","type":["string","null"]},"middleName":{"description":"Employee middle name.
Max length: 20","type":["string","null"]},"nonPrimaryStateTax":{"description":"Add non-primary state tax code, amount type (taxCalculationCode), amount or percentage, filing status, exemptions, supplemental check (specialCheckCalc), and reciprocity code information.","type":"array","items":{"description":"The Non-Primary State Tax model","type":"object","additionalProperties":false,"properties":{"amount":{"description":"State tax code.
Max length: 50","type":["number","null"]},"deductionsAmount":{"description":"Box 4(b) on form W4 (year 2020 or later): Deductions amount.
Decimal (12,2)","type":"number"},"dependentsAmount":{"description":"Box 3 on form W4 (year 2020 or later): Total dependents amount.
Decimal (12,2)","type":"number"},"exemptions":{"description":"State tax exemptions value.
Decimal (12,2)","type":["number","null"]},"exemptions2":{"description":"State tax exemptions 2 value.
Decimal (12,2)","type":["number","null"]},"filingStatus":{"description":"Employee state tax filing status. Common values are *S* (Single), *M* (Married).
Max length: 50","type":["string","null"]},"higherRate":{"description":"Box 2(c) on form W4 (year 2020 or later): Multiple Jobs or Spouse Works.
Boolean","type":"boolean"},"otherIncomeAmount":{"description":"Box 4(a) on form W4 (year 2020 or later): Other income amount.
Decimal (12,2)","type":"number"},"percentage":{"description":"State Tax percentage.
Decimal (12,2)","type":["number","null"]},"reciprocityCode":{"description":"Non-primary state tax reciprocity code.
Max length: 50","type":["string","null"]},"specialCheckCalc":{"description":"Supplemental check calculation code. Common values are *Blocked* (Taxes blocked on Supplemental checks), *Supp* (Use supplemental Tax Rate-Code).
Max length: 10","type":["string","null"]},"taxCalculationCode":{"description":"Tax calculation code. Common values are *F* (Flat), *P* (Percentage), *FDFP* (Flat Dollar Amount plus Fixed Percentage).
Max length: 10","type":["string","null"]},"taxCode":{"description":"State tax code.
Max length: 50","type":["string","null"]},"w4FormYear":{"description":"The state W4 form year
Integer","type":"integer"}}},"maxItems":1},"preferredName":{"description":"Employee preferred display name.
Max length: 20","type":["string","null"]},"primaryPayRate":{"description":"Add hourly or salary pay rate, effective date, and pay frequency.","type":"array","items":{"description":"The Primary Pay Rate model","type":"object","additionalProperties":false,"properties":{"baseRate":{"description":"Employee base rate, used for Hourly employees.
Decimal (12,2)","type":["number","null"]},"changeReason":{"description":"Pay rate change reason.
Max length: 30","type":["string","null"]},"defaultHours":{"description":"Employee default hours consistently worked. If autoPayType is set to D, employee will be paid hourly base rate for the defaultHours.
Decimal (12,2)","type":["number","null"]},"effectiveDate":{"description":"The date the employee's pay rate takes effect. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.","type":["string","null"],"format":"paylocity-date"},"isAutoPay":{"description":"If set to *True*, employee will be paid automatically using deafultHours.","type":["boolean","null"]},"payFrequency":{"description":"Employee current pay frequency. Common values are *A (Annual), B (Bi-Weekly), D (Daily), M (Monthly), S (Semi-Monthly), Q (Quarterly), W (Weekly)*.
Max length: 5","type":["string","null"]},"payGrade":{"description":"Employee pay grade. Must match Company setup.
Max length: 10","type":["string","null"]},"payType":{"description":"Employee pay type (rate code). Valid values are *Hourly* or *Salary*.
Max length: 10","type":["string","null"]},"ratePer":{"description":"Employee base rate frequency used with payType Hourly. Common values are *Hour, Week*. Default is Hour.
Max length: 10","type":["string","null"]},"salary":{"description":"Employee gross salary per pay period used with payType Salary.
Decimal (12,6)","type":["number","null"]}}},"maxItems":1},"primaryStateTax":{"description":"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.","type":"array","items":{"description":"The State Tax model","type":"object","additionalProperties":false,"properties":{"amount":{"description":"State tax code.
Max length: 50","type":["number","null"]},"deductionsAmount":{"description":"Box 4(b) on form W4 (year 2020 or later): Deductions amount.
Decimal (12,2)","type":"number"},"dependentsAmount":{"description":"Box 3 on form W4 (year 2020 or later): Total dependents amount.
Decimal (12,2)","type":"number"},"exemptions":{"description":"State tax exemptions value.
Decimal (12,2)","type":["number","null"]},"exemptions2":{"description":"State tax exemptions 2 value.
Decimal (12,2)","type":["number","null"]},"filingStatus":{"description":"Employee state tax filing status. Common values are *S* (Single), *M* (Married).
Max length: 50","type":["string","null"]},"higherRate":{"description":"Box 2(c) on form W4 (year 2020 or later): Multiple Jobs or Spouse Works.
Boolean","type":"boolean"},"otherIncomeAmount":{"description":"Box 4(a) on form W4 (year 2020 or later): Other income amount.
Decimal (12,2)","type":"number"},"percentage":{"description":"State Tax percentage.
Decimal (12,2)","type":["number","null"]},"specialCheckCalc":{"description":"Supplemental check calculation code. Common values are *Blocked* (Taxes blocked on Supplemental checks), *Supp* (Use supplemental Tax Rate-Code).
Max length: 10","type":["string","null"]},"taxCalculationCode":{"description":"Tax calculation code. Common values are *F* (Flat), *P* (Percentage), *FDFP* (Flat Dollar Amount plus Fixed Percentage).
Max length: 10","type":["string","null"]},"taxCode":{"description":"State tax code.
Max length: 50","type":["string","null"]},"w4FormYear":{"description":"The state W4 form year
Integer","type":"integer"}}},"maxItems":1},"priorLastName":{"description":"Prior last name if applicable.
Max length: 40","type":["string","null"]},"salutation":{"description":"Employee preferred salutation.
Max length: 10","type":["string","null"]},"sitwExemptReason":{"description":"Reason code for SITW exemption. Common values are *SE* (Statutory employee), *CR* (clergy/Religious).
Max length: 30","type":["string","null"]},"ssExemptReason":{"description":"Reason code for Social Security exemption. Common values are *SE* (Statutory employee), *CR* (clergy/Religious).
Max length: 30","type":["string","null"]},"ssn":{"description":"Employee social security number. Leave it blank if valid social security number not available.
Max length: 11","type":["string","null"]},"status":{"description":"Add employee status, change reason, effective date, and adjusted seniority date. Note that companies that are still in Implementation cannot hire future employees.","type":"array","items":{"description":"The employee status model","type":"object","additionalProperties":false,"properties":{"adjustedSeniorityDate":{"description":"Adjusted seniority date. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.","type":["string","null"],"format":"paylocity-date"},"changeReason":{"description":"Employee status change reason. Must match Company setup.
Max length: 15","type":["string","null"]},"effectiveDate":{"description":"Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.","type":["string","null"],"format":"paylocity-date"},"employeeStatus":{"description":"Employee current work status. Common values are *A* (Active), *L* (Leave of Absence), *T* (Terminated).
Max length: 20","type":["string","null"]},"hireDate":{"description":"Employee hired date. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.","type":["string","null"],"format":"paylocity-date"},"isEligibleForRehire":{"description":"Indicates if employee eligible for rehire.","type":["boolean","null"]}}},"maxItems":1},"suffix":{"description":"Employee name suffix. Common values are *Jr, Sr, II*.
Max length: 30","type":["string","null"]},"suiExemptReason":{"description":"Reason code for SUI exemption. Common values are *SE* (Statutory employee), *CR* (clergy/Religious).
Max length: 30","type":["string","null"]},"suiState":{"description":"Employee SUI (State Unemployment Insurance) state.
Max length: 2","type":["string","null"]},"taxDistributionCode1099R":{"description":"Employee 1099R distribution code. Common values are *7* (Normal Distribution), *F* (Charitable Gift Annuity).
Max length: 1","type":["string","null"]},"taxForm":{"description":"Employee tax form for reporting income. Valid values are *W2, 1099M, 1099R*. Default is W2.
Max length: 15","type":["string","null"]},"veteranDescription":{"description":"Indicates if employee is a veteran.","type":["string","null"]},"webTime":{"description":"Add Web Time badge number and charge rate and synchronize Web Pay and Web Time employee data.","type":"object","additionalProperties":false,"properties":{"badgeNumber":{"description":"Badge number usually issued for time and attendance system use.
Max length: 50","type":["string","null"]},"chargeRate":{"description":"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)","type":["number","null"]},"isTimeLaborEnabled":{"description":"If set to true, changes to employee data will be reflected in Web Time.","type":["boolean","null"]}}},"workAddress":{"description":"Add employee's work address, phone numbers, and email. Work Location drop down field is not included.","type":"array","items":{"description":"The address model","type":"object","additionalProperties":false,"properties":{"address1":{"description":"1st address line.
Max length: 40","type":["string","null"]},"address2":{"description":"2nd address line.
Max length: 40","type":["string","null"]},"city":{"description":"City.
Max length: 40","type":["string","null"]},"country":{"description":"Country.
Max length: 30","type":["string","null"]},"county":{"description":"County.
Max length: 30","type":["string","null"]},"emailAddress":{"description":"Email.
Max length: 50","type":["string","null"]},"mobilePhone":{"description":"Mobile phone number.
Max length: 12","type":["string","null"]},"pager":{"description":"Employee pager number.
Max length: 20","type":["string","null"]},"phone":{"description":"Phone number.
Max length: 12","type":["string","null"]},"phoneExtension":{"description":"Phone number extension.
Max length: 10","type":["string","null"]},"postalCode":{"description":"Postal code.
Max length: 10","type":["string","null"]},"state":{"description":"State or province.
Max length: 2","type":["string","null"]}}},"maxItems":1},"workEligibility":{"description":"Add I-9 work authorization information.","type":"array","items":{"description":"The Work Eligibility model","type":"object","additionalProperties":false,"properties":{"alienOrAdmissionDocumentNumber":{"description":"Employee USCIS or Admission Number.
Must be 7-10 characters and may begin with an 'A'","type":["string","null"]},"attestedDate":{"description":"The date the I-9 Verification form was attested by Employer or Authorized representative. Common formats are *MM-DD-CCYY, CCYY-MM-DD*.","type":["string","null"],"format":"paylocity-date"},"countryOfIssuance":{"description":"If Foreign Passport number is provided, provide its country of issuance. Must match Paylocity setup.
Max length: 30","type":["string","null"]},"foreignPassportNumber":{"description":"Foreign Passport Number.
Max length: 50","type":["string","null"]},"i94AdmissionNumber":{"description":"Form I-94 admission number.
Must be 11 numeric characters","type":["string","null"]},"i9DateVerified":{"description":"Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.","type":["string","null"],"format":"paylocity-date"},"i9Notes":{"description":"Notes regarding employee's i9.
Max length: 4000","type":["string","null"]},"isI9Verified":{"description":"Indicates if employee I9 is verified.","type":["boolean","null"]},"isSsnVerified":{"description":"Indicates if employee SSN is verified.","type":["boolean","null"]},"ssnDateVerified":{"description":"The date of employer verification of employee SSN. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.","type":["string","null"],"format":"paylocity-date"},"ssnNotes":{"description":"Notes regarding employee's SSN.
Max length: 4000","type":["string","null"]},"visaType":{"description":"Employee Visa type. Must match one of the system coded values.
Max length: 100","type":["string","null"]},"workAuthorization":{"description":"Employee work authorization. Must match one of the system coded values.
Max length: 100","type":["string","null"]},"workUntil":{"description":"End date of employee work eligibility. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.","type":["string","null"],"format":"paylocity-date"}}},"maxItems":1}}},"trackingNumberResponse":{"description":"The Tracking Number Response model","type":"object","properties":{"trackingNumber":{"description":"The unique tracking number","type":"string"}}},"employee":{"description":"The employee model","type":"object","additionalProperties":false,"properties":{"additionalDirectDeposit":{"description":"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.","type":"array","items":{"description":"The additional direct deposit model","type":"object","additionalProperties":false,"properties":{"accountNumber":{"description":"Account number, entered without special characters and spaces.
Max length: 17
","type":["string","null"]},"accountType":{"description":"Account type. Valid values are *C* (Checking), *S* (Saving), *P* (Pay Card).
Max length: 1
","type":["string","null"]},"amount":{"description":"Amount value to be deposited to the account.
Decimal (12,2)
","type":["number","null"]},"amountType":{"description":"Amount type to indicate the context of the amount. Common values are *F* (FLAT), *F-* (Net Minus), *P* (Percent).
Max length: 5
","type":["string","null"]},"blockSpecial":{"description":"Indicates if direct deposit should be blocked when special check types such as Bonus are processed.
","type":["boolean","null"]},"isSkipPreNote":{"description":"Indicates if account will not pre-note.
","type":["boolean","null"]},"nameOnAccount":{"description":"Name on the bank account. Defaults to employee's name.
Max length: 30
","type":["string","null"]},"preNoteDate":{"description":"Date to end the pre-note of the account. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.
","type":["string","null"],"format":"paylocity-date"},"routingNumber":{"description":"ABA Transit Routing Number, entered without dashes or spaces.
Max length: 9
","type":["string","null"]}}},"maxItems":19},"additionalRate":{"description":"Add Additional Rates.","type":"array","items":{"description":"The additional pay rate model","type":"object","additionalProperties":false,"properties":{"changeReason":{"description":"Not required. If populated, must match one of the system coded values available in the Additional Rates Change Reason drop down.
","type":["string","null"]},"costCenter1":{"description":"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.
","type":["string","null"]},"costCenter2":{"description":"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.
","type":["string","null"]},"costCenter3":{"description":"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.
","type":["string","null"]},"effectiveDate":{"description":"Required. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.
","type":["string","null"],"format":"paylocity-date"},"endCheckDate":{"description":"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*.
","type":["string","null"],"format":"paylocity-date"},"job":{"description":"Not required. If populated, must match one of the system coded values available in the Additional Rates Job drop down.
","type":["string","null"]},"rate":{"description":"Required. Enter dollar amount that corresponds to the Per selection.
","type":["number","null"]},"rateCode":{"description":"Required. If populated, must match one of the system coded values available in the Additional Rates Rate Code drop down.
","type":["string","null"]},"rateNotes":{"description":"Not required.
Max length: 4000
","type":["string","null"]},"ratePer":{"description":"Required. Valid values are HOUR or WEEK.
","type":["string","null"]},"shift":{"description":"Not required. If populated, must match one of the system coded values available in the Additional Rates Shift drop down.
","type":["string","null"]}}}},"benefitSetup":{"description":" Add or update setup values used for employee benefits integration, insurance plan settings, and ACA reporting.","type":"object","additionalProperties":false,"properties":{"benefitClass":{"description":"Benefit Class code. Values are configured in Web Pay Company > Setup > Benefits > Classes.
Max length: 30","type":["string","null"]},"benefitClassEffectiveDate":{"description":"Date when Benefit Class takes effect. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.","type":["string","null"],"format":"paylocity-date"},"benefitSalary":{"description":"Salary used to configure benefits.
Decimal(12,2)","type":["number","null"]},"benefitSalaryEffectiveDate":{"description":"Date when Benefit Salary takes effect. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.","type":["string","null"],"format":"paylocity-date"},"doNotApplyAdministrativePeriod":{"description":"Applicable only for HR Enhanced clients and Benefit Classes with ACA Employment Type of Full Time.","type":["boolean","null"]},"isMeasureAcaEligibility":{"description":"Only valid for HR Enhanced clients and Benefit Classes that are ACA Employment Type of Full Time.","type":["boolean","null"]}}},"birthDate":{"description":"Employee birthdate. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.","type":["string","null"],"format":"paylocity-date"},"coEmpCode":{"description":"Unique idenifier for SSO.
Max length: 20","type":["string","null"]},"companyFEIN":{"description":"Company FEIN as defined in Web Pay, applicable with GET requests only.
Max length: 20","type":["string","null"]},"companyName":{"description":"Company name as defined in Web Pay, applicable with GET requests only.
Max length: 50","type":["string","null"]},"currency":{"description":"Employee is paid in this currency.
Max length: 30","type":["string","null"]},"customBooleanFields":{"description":"Up to 8 custom fields of boolean (checkbox) type value.","type":"array","items":{"description":"","type":"object","additionalProperties":false,"properties":{"category":{"description":"The custom field category. Acceptable value is 'PayrollAndHR'.","type":"string","enum":["PayrollAndHR"]},"label":{"description":"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.","type":["string","null"]},"value":{"description":"The custom boolean field value.","type":["boolean","null"]}},"required":["category","label","value"]},"maxItems":8},"customDateFields":{"description":"Up to 8 custom fields of the date type value.","type":"array","items":{"description":"","type":"object","additionalProperties":false,"properties":{"category":{"description":"The custom field category. Acceptable value is 'PayrollAndHR'.","type":"string","enum":["PayrollAndHR"]},"label":{"description":"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.","type":["string","null"]},"value":{"description":"The custom date field value. Common formats include MM-DD-CCYY, CCYY-MM-DD.","type":["string","null"],"format":"paylocity-date"}},"required":["category","label","value"]},"maxItems":8},"customDropDownFields":{"description":"Up to 8 custom fields of the dropdown type value.","type":"array","items":{"description":"","type":"object","additionalProperties":false,"properties":{"category":{"description":"The custom field category. Acceptable value is 'PayrollAndHR'.","type":"string","enum":["PayrollAndHR"]},"label":{"description":"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.","type":["string","null"]},"value":{"description":"The custom dropdown field value. Values are configured in Web Pay Company > Setup > List Values > Lookup Values > Custom Fields: PayrollAndHR. Max length: 10.","type":["string","null"]}},"required":["category","label","value"]},"maxItems":8},"customNumberFields":{"description":"Up to 8 custom fields of numeric type value.","type":"array","items":{"description":"","type":"object","additionalProperties":false,"properties":{"category":{"description":"The custom field category. Acceptable value is 'PayrollAndHR'.","type":"string","enum":["PayrollAndHR"]},"label":{"description":"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.","type":["string","null"]},"value":{"description":"The custom number field value. Decimal (18,6).","type":["number","null"]}},"required":["category","label","value"]},"maxItems":8},"customTextFields":{"description":"Up to 8 custom fields of text type value.","type":"array","items":{"description":"","type":"object","additionalProperties":false,"properties":{"category":{"description":"The custom field category. Acceptable value is 'PayrollAndHR'.","type":"string","enum":["PayrollAndHR"]},"label":{"description":"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.","type":["string","null"]},"value":{"description":"The custom text field value. Max length: 255.","type":["string","null"]}},"required":["category","label","value"]},"maxItems":8},"departmentPosition":{"description":"Add or update home department cost center, position, supervisor, reviewer, employment type, EEO class, pay settings, and union information.","type":"object","additionalProperties":false,"properties":{"changeReason":{"description":"Employee department/position change reason. Must match Company setup.
Max length: 15","type":["string","null"]},"clockBadgeNumber":{"description":"Employee clock badge number. Defaults to employeeId.
Max length: 10","type":["string","null"]},"costCenter1":{"description":"Employer defined location, like *branch, division, department*, etc. Must match Company setup.
Max length: 10","type":["string","null"]},"costCenter2":{"description":"Employer defined location, like *branch, division, department*, etc. Must match Company setup.
Max length: 10","type":["string","null"]},"costCenter3":{"description":"Employer defined location, like *branch, division, department*, etc. Must match Company setup.
Max length: 10","type":["string","null"]},"effectiveDate":{"description":"The date the position takes effect. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.","type":["string","null"],"format":"paylocity-date"},"employeeType":{"description":"Employee current employment type. Common values *RFT (Regular Full Time), RPT (Regular Part Time), SNL (Seasonal), TFT (Temporary Full Time), TPT (Temporary Part Time)*.
Max length: 10","type":["string","null"]},"equalEmploymentOpportunityClass":{"description":"Values are configured in Company > Setup > HR > EEO Classes.
Max length: 10","type":["string","null"]},"isMinimumWageExempt":{"description":"Indicates if employee is exempt from minimum wage.","type":["boolean","null"]},"isOvertimeExempt":{"description":"Indicates if employee is exempt from overtime.","type":["boolean","null"]},"isSupervisorReviewer":{"description":"Indicates if employee is a supervisor or reviewer.","type":["boolean","null"]},"isUnionDuesCollected":{"description":"Indicates if union dues are collected.","type":["boolean","null"]},"isUnionInitiationCollected":{"description":"Indicates if initiations fees are collected.","type":["boolean","null"]},"jobTitle":{"description":"Employee current job title.
Max length: 50","type":["string","null"]},"payGroup":{"description":"Employee pay group. Must match Company setup.
Max length: 20","type":["string","null"]},"positionCode":{"description":"Employee position code. Must match Company setup.
Max length: 20","type":["string","null"]},"reviewerCompanyNumber":{"description":"Company number of reviewer.
Max length: 9","type":["string","null"]},"reviewerEmployeeId":{"description":"Employee id of the reviewer.
Max length: 10","type":["string","null"]},"shift":{"description":"Employee work shift.
Max length: 255","type":["string","null"]},"supervisorCompanyNumber":{"description":"Supervisor's company number. Defaults to employee company number.
Max length: 9","type":["string","null"]},"supervisorEmployeeId":{"description":"EmployeeId of the supervisor.
Max length: 10","type":["string","null"]},"tipped":{"description":"Indicates if employee receives tips.","type":["string","null"]},"unionAffiliationDate":{"description":"Employee union affiliation effective date. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.","type":["string","null"],"format":"paylocity-date"},"unionCode":{"description":"Employee union code. Must match Company setup.
Max length: 10","type":["string","null"]},"unionPosition":{"description":"Employee union position. Must match Company setup.
Max length: 30","type":["string","null"]},"workersCompensation":{"description":"Employee worker compensation code. Must match Company setup.
Max length: 10","type":["string","null"]}}},"disabilityDescription":{"description":"Indicates if employee has disability status.","type":["string","null"]},"emergencyContacts":{"description":"Add or update Emergency Contacts.","type":"array","items":{"description":"The emergency contact model","type":"object","additionalProperties":false,"properties":{"address1":{"description":"1st address line.","type":["string","null"]},"address2":{"description":"2nd address line.","type":["string","null"]},"city":{"description":"City.","type":["string","null"]},"country":{"description":"County.","type":["string","null"]},"county":{"description":"Country. Must be a valid 3 character country code. Common values are *USA* (United States), *CAN* (Canada).","type":["string","null"]},"email":{"description":"Contact email. Must be valid email address format.","type":["string","null"]},"firstName":{"description":"Required. Contact first name.
Max length: 40","type":["string","null"]},"homePhone":{"description":"Contact Home Phone. Valid phone format *(###) #######* or *######-####* or *### ### ####* or *##########* or, if international, starts with *+#*, only spaces and digits allowed.","type":["string","null"]},"lastName":{"description":"Required. Contact last name.
Max length: 40","type":["string","null"]},"mobilePhone":{"description":"Contact Mobile Phone. Valid phone format *(###) #######* or *######-####* or *### ### ####* or *##########* or, if international, starts with *+#*, only spaces and digits allowed.","type":["string","null"]},"notes":{"description":"Notes.
Max length: 1000","type":["string","null"]},"pager":{"description":"Contact Pager. Valid phone format *(###) #######* or *######-####* or *### ### ####* or *##########* or, if international, starts with *+#*, only spaces and digits allowed.","type":["string","null"]},"primaryPhone":{"description":"Required. Contact primary phone type. Must match Company setup. Valid values are H (Home), M (Mobile), P (Pager), W (Work)","type":["string","null"]},"priority":{"description":"Required. Contact priority. Valid values are *P* (Primary) or *S* (Secondary).","type":["string","null"]},"relationship":{"description":"Required. Contact relationship. Must match Company setup. Common values are Spouse, Mother, Father.","type":["string","null"]},"state":{"description":"State or Province. If U.S. address, must be valid 2 character state code. Common values are *IL* (Illinois), *CA* (California).","type":["string","null"]},"syncEmployeeInfo":{"description":"Valid values are *true* or *false*.","type":"boolean"},"workExtension":{"description":"Work Extension.","type":["string","null"]},"workPhone":{"description":"Contact Work Phone. Valid phone format *(###) #######* or *######-####* or *### ### ####* or *##########* or, if international, starts with *+#*, only spaces and digits allowed.","type":["string","null"]},"zip":{"description":"Postal code. If U.S. address, must be a valid zip code.","type":["string","null"]}},"required":["firstName","lastName"]}},"employeeId":{"description":"Leave blank to have Web Pay automatically assign the next available employee ID.
Max length: 9","type":["string","null"]},"ethnicity":{"description":"Employee ethnicity.
Max length: 10","type":["string","null"]},"federalTax":{"description":"Add or update federal tax amount type (taxCalculationCode), amount or percentage, filing status, and exemptions.","type":"object","additionalProperties":false,"properties":{"amount":{"description":"Tax amount.
Decimal (12,2)","type":["number","null"]},"deductionsAmount":{"description":"Box 4(b) on form W4 (year 2020 or later): Deductions amount.
Decimal (12,2)","type":"number"},"dependentsAmount":{"description":"Box 3 on form W4 (year 2020 or later): Total dependents amount.
Decimal (12,2)","type":"number"},"exemptions":{"description":"Federal tax exemptions value.
Decimal (12,2)","type":["number","null"]},"filingStatus":{"description":"Employee federal filing status. Common values are *S* (Single), *M* (Married).
Max length: 50","type":["string","null"]},"higherRate":{"description":"Box 2(c) on form W4 (year 2020 or later): Multiple Jobs or Spouse Works.
Boolean","type":"boolean"},"otherIncomeAmount":{"description":"Box 4(a) on form W4 (year 2020 or later): Other income amount.
Decimal (12,2)","type":"number"},"percentage":{"description":"Tax percentage.
Decimal (12,2)","type":["number","null"]},"taxCalculationCode":{"description":"Tax calculation code. Common values are *F* (Flat), *P* (Percentage), *FDFP* (Flat Dollar Amount plus Fixed Percentage).
Max length: 10","type":["string","null"]},"w4FormYear":{"description":"The federal W4 form year
Integer","type":"integer"}}},"firstName":{"description":"Employee first name.
Max length: 40","type":["string","null"]},"gender":{"description":"Employee gender. Common values *M* (Male), *F* (Female).
Max length: 1","type":["string","null"]},"homeAddress":{"description":"Add or update employee's home address, personal phone numbers, and personal email.","type":"object","additionalProperties":false,"properties":{"address1":{"description":"1st address line.
Max length: 40","type":["string","null"]},"address2":{"description":"2nd address line.
Max length: 40","type":["string","null"]},"city":{"description":"City.
Max length: 40","type":["string","null"]},"country":{"description":"Country.
Max length: 30","type":["string","null"]},"county":{"description":"County.
Max length: 30","type":["string","null"]},"emailAddress":{"description":"Email.
Max length: 50","type":["string","null"]},"mobilePhone":{"description":"Mobile phone number.
Max length: 20","type":["string","null"]},"phone":{"description":"Phone number.
Max length: 20","type":["string","null"]},"postalCode":{"description":"Postal code.
Max length: 10","type":["string","null"]},"state":{"description":"State or province.
Max length: 2","type":["string","null"]}}},"isHighlyCompensated":{"description":"Indicates if employee meets the highly compensated employee criteria.","type":"boolean"},"isSmoker":{"description":"Indicates if employee is a smoker.","type":"boolean"},"lastName":{"description":"Employee last name.
Max length: 40","type":["string","null"]},"localTax":{"description":"Add, update, or delete local tax code, filing status, and exemptions including PA-PSD taxes.","type":"array","items":{"description":"The Local Tax model","type":"object","additionalProperties":false,"properties":{"exemptions":{"description":"Local tax exemptions value.
Decimal (12,2)","type":["number","null"]},"exemptions2":{"description":"Local tax exemptions 2 value.
Decimal (12,2)","type":["number","null"]},"filingStatus":{"description":"Employee local tax filing status. Must match specific local tax setup.
Max length: 50","type":["string","null"]},"residentPSD":{"description":"Resident PSD (political subdivision code) applicable in PA. Must match Company setup.
Max length: 9","type":["string","null"]},"taxCode":{"description":"Local tax code.
Max length: 50","type":["string","null"]},"workPSD":{"description":"Work location PSD. Must match Company setup.
Max length: 9","type":["string","null"]}}},"maxItems":5},"mainDirectDeposit":{"description":"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.","type":"object","additionalProperties":false,"properties":{"accountNumber":{"description":"Account number, entered without special characters and spaces.
Max length: 17","type":["string","null"]},"accountType":{"description":"Account type. Valid values are *C* (Checking), *S* (Saving), *P* (Pay Card).
Max length: 1","type":["string","null"]},"blockSpecial":{"description":"Indicates if direct deposit should be blocked when special check types such as Bonus are processed.
","type":["boolean","null"]},"isSkipPreNote":{"description":"Indicates if account will not pre-note.","type":["boolean","null"]},"nameOnAccount":{"description":"Name on the bank account. Defaults to employee's name.
Max length: 30
","type":["string","null"]},"preNoteDate":{"description":"Date to end the pre-note of the account. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.","type":["string","null"],"format":"paylocity-date"},"routingNumber":{"description":"ABA Transit Routing Number, entered without dashes or spaces.
Max length: 9","type":["string","null"]}}},"maritalStatus":{"description":"Employee marital status. Common values *D (Divorced), M (Married), S (Single), W (Widowed)*.
Max length: 10","type":["string","null"]},"middleName":{"description":"Employee middle name.
Max length: 20","type":["string","null"]},"nonPrimaryStateTax":{"description":"Add or update non-primary state tax code, amount type (taxCalculationCode), amount or percentage, filing status, exemptions, supplemental check (specialCheckCalc), and reciprocity code information.","type":"object","additionalProperties":false,"properties":{"amount":{"description":"State tax code.
Max length: 50","type":["number","null"]},"deductionsAmount":{"description":"Box 4(b) on form W4 (year 2020 or later): Deductions amount.
Decimal (12,2)","type":"number"},"dependentsAmount":{"description":"Box 3 on form W4 (year 2020 or later): Total dependents amount.
Decimal (12,2)","type":"number"},"exemptions":{"description":"State tax exemptions value.
Decimal (12,2)","type":["number","null"]},"exemptions2":{"description":"State tax exemptions 2 value.
Decimal (12,2)","type":["number","null"]},"filingStatus":{"description":"Employee state tax filing status. Common values are *S* (Single), *M* (Married).
Max length: 50","type":["string","null"]},"higherRate":{"description":"Box 2(c) on form W4 (year 2020 or later): Multiple Jobs or Spouse Works.
Boolean","type":"boolean"},"otherIncomeAmount":{"description":"Box 4(a) on form W4 (year 2020 or later): Other income amount.
Decimal (12,2)","type":"number"},"percentage":{"description":"State Tax percentage.
Decimal (12,2)","type":["number","null"]},"reciprocityCode":{"description":"Non-primary state tax reciprocity code.
Max length: 50","type":["string","null"]},"specialCheckCalc":{"description":"Supplemental check calculation code. Common values are *Blocked* (Taxes blocked on Supplemental checks), *Supp* (Use supplemental Tax Rate-Code).
Max length: 10","type":["string","null"]},"taxCalculationCode":{"description":"Tax calculation code. Common values are *F* (Flat), *P* (Percentage), *FDFP* (Flat Dollar Amount plus Fixed Percentage).
Max length: 10","type":["string","null"]},"taxCode":{"description":"State tax code.
Max length: 50","type":["string","null"]},"w4FormYear":{"description":"The state W4 form year
Integer","type":"integer"}}},"ownerPercent":{"description":"Percentage of employee's ownership in the company, entered as a whole number.
Decimal (12,2)","type":["number","null"]},"preferredName":{"description":"Employee preferred display name.
Max length: 20","type":["string","null"]},"primaryPayRate":{"description":"Add or update hourly or salary pay rate, effective date, and pay frequency.","type":"object","additionalProperties":false,"properties":{"annualSalary":{"description":"Employee annual salary.
Decimal (12,6)","type":["number","null"]},"baseRate":{"description":"Employee base rate, used for Hourly employees.
Decimal (12,6)","type":["number","null"]},"beginCheckDate":{"description":"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*.","type":["string","null"],"format":"paylocity-date"},"changeReason":{"description":"Pay rate change reason.
Max length: 30","type":["string","null"]},"defaultHours":{"description":"Employee default hours consistently worked. If autoPayType is set to D, employee will be paid hourly base rate for the defaultHours.
Decimal (12,2)","type":["number","null"]},"effectiveDate":{"description":"The date the employee's pay rate takes effect. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.","type":["string","null"],"format":"paylocity-date"},"isAutoPay":{"description":"If set to *True*, employee will be paid automatically using deafultHours.","type":["boolean","null"]},"payFrequency":{"description":"Employee current pay frequency. Common values are *A (Annual), B (Bi-Weekly), D (Daily), M (Monthly), S (Semi-Monthly), Q (Quarterly), W (Weekly)*.
Max length: 5","type":["string","null"]},"payGrade":{"description":"Employee pay grade. Must match Company setup.
Max length: 10","type":["string","null"]},"payRateNote":{"description":"Pay rate notes regarding employee.
Max length: 250","type":["string","null"]},"payType":{"description":"Employee pay type (rate code). Valid values are *Hourly* or *Salary*.
Max length: 10","type":["string","null"]},"ratePer":{"description":"Employee base rate frequency used with payType Hourly. Common values are *Hour, Week*. Default is Hour.
Max length: 10","type":["string","null"]},"salary":{"description":"Employee gross salary per pay period used with payType Salary.
Decimal (12,6)","type":["number","null"]}}},"primaryStateTax":{"description":"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.","type":"object","additionalProperties":false,"properties":{"amount":{"description":"State tax code.
Max length: 50","type":["number","null"]},"deductionsAmount":{"description":"Box 4(b) on form W4 (year 2020 or later): Deductions amount.
Decimal (12,2)","type":"number"},"dependentsAmount":{"description":"Box 3 on form W4 (year 2020 or later): Total dependents amount.
Decimal (12,2)","type":"number"},"exemptions":{"description":"State tax exemptions value.
Decimal (12,2)","type":["number","null"]},"exemptions2":{"description":"State tax exemptions 2 value.
Decimal (12,2)","type":["number","null"]},"filingStatus":{"description":"Employee state tax filing status. Common values are *S* (Single), *M* (Married).
Max length: 50","type":["string","null"]},"higherRate":{"description":"Box 2(c) on form W4 (year 2020 or later): Multiple Jobs or Spouse Works.
Boolean","type":"boolean"},"otherIncomeAmount":{"description":"Box 4(a) on form W4 (year 2020 or later): Other income amount.
Decimal (12,2)","type":"number"},"percentage":{"description":"State Tax percentage.
Decimal (12,2)","type":["number","null"]},"specialCheckCalc":{"description":"Supplemental check calculation code. Common values are *Blocked* (Taxes blocked on Supplemental checks), *Supp* (Use supplemental Tax Rate-Code).
Max length: 10","type":["string","null"]},"taxCalculationCode":{"description":"Tax calculation code. Common values are *F* (Flat), *P* (Percentage), *FDFP* (Flat Dollar Amount plus Fixed Percentage).
Max length: 10","type":["string","null"]},"taxCode":{"description":"State tax code.
Max length: 50","type":["string","null"]},"w4FormYear":{"description":"The state W4 form year
Integer","type":"integer"}}},"priorLastName":{"description":"Prior last name if applicable.
Max length: 40","type":["string","null"]},"salutation":{"description":"Employee preferred salutation.
Max length: 10","type":["string","null"]},"ssn":{"description":"Employee social security number. Leave it blank if valid social security number not available.
Max length: 11","type":["string","null"]},"status":{"description":"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.","type":"object","additionalProperties":false,"properties":{"adjustedSeniorityDate":{"description":"Adjusted seniority date. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.","type":["string","null"],"format":"paylocity-date"},"beginCheckDate":{"description":"The date of the first check on which the new employee status will appear. This value is only applicable when updating an existing employee. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.","type":["string","null"],"format":"paylocity-date"},"changeReason":{"description":"Employee status change reason. Must match Company setup.
Max length: 15","type":["string","null"]},"effectiveDate":{"description":"Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.","type":["string","null"],"format":"paylocity-date"},"employeeStatus":{"description":"Employee current work status. Common values are *A* (Active), *L* (Leave of Absence), *T* (Terminated).
Max length: 20","type":["string","null"]},"hireDate":{"description":"Employee hired date. Updates to hire date are not allowed and will be ignored. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.","type":["string","null"],"format":"paylocity-date"},"isEligibleForRehire":{"description":"Indicates if employee eligible for rehire.","type":["boolean","null"]},"reHireDate":{"description":"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*.","type":["string","null"],"format":"paylocity-date"},"statusType":{"description":"The Status Type associated with the Employee Status code. Each Employee Status code for a company is assigned to one of the Status Type values of A (Active), L (Leave of Absence), T (Terminated).","type":["string","null"]},"terminationDate":{"description":"Employee termination date. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.","type":["string","null"],"format":"paylocity-date"}}},"suffix":{"description":"Employee name suffix. Common values are *Jr, Sr, II*.
Max length: 30","type":["string","null"]},"taxSetup":{"description":"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.","type":"object","additionalProperties":false,"properties":{"fitwExemptNotes":{"description":"Notes for FITW exemption.
Max length: 250","type":["string","null"]},"fitwExemptReason":{"description":"Reason code for FITW exemption. Common values are *SE* (Statutory employee), *CR* (clergy/Religious).
Max length: 30","type":["string","null"]},"futaExemptNotes":{"description":"Notes for FUTA exemption.
Max length: 250","type":["string","null"]},"futaExemptReason":{"description":"Reason code for FUTA exemption. Common values are *501* (5019c)(3) Organization), *IC* (Independent Contractor).
Max length: 30","type":["string","null"]},"isEmployee943":{"description":"Indicates if employee in agriculture or farming.","type":"boolean"},"isPension":{"description":"Indicates if employee is eligible for pension.","type":"boolean"},"isStatutory":{"description":"Indicates if employee is statutory.","type":"boolean"},"medExemptNotes":{"description":"Notes for Medicare exemption.
Max length: 250","type":["string","null"]},"medExemptReason":{"description":"Reason code for Medicare exemption. Common values are *501* (5019c)(3) Organization), *IC* (Independent Contractor).
Max length: 30","type":["string","null"]},"sitwExemptNotes":{"description":"Notes for SITW exemption.
Max length: 250","type":["string","null"]},"sitwExemptReason":{"description":"Reason code for SITW exemption. Common values are *SE* (Statutory employee), *CR* (clergy/Religious).
Max length: 30","type":["string","null"]},"ssExemptNotes":{"description":"Notes for Social Security exemption.
Max length: 250","type":["string","null"]},"ssExemptReason":{"description":"Reason code for Social Security exemption. Common values are *SE* (Statutory employee), *CR* (clergy/Religious).
Max length: 30","type":["string","null"]},"suiExemptNotes":{"description":"Notes for SUI exemption.
Max length: 250","type":["string","null"]},"suiExemptReason":{"description":"Reason code for SUI exemption. Common values are *SE* (Statutory employee), *CR* (clergy/Religious).
Max length: 30","type":["string","null"]},"suiState":{"description":"Employee SUI (State Unemployment Insurance) state.
Max length: 2","type":["string","null"]},"taxDistributionCode1099R":{"description":"Employee 1099R distribution code. Common values are *7* (Normal Distribution), *F* (Charitable Gift Annuity).
Max length: 1","type":["string","null"]},"taxForm":{"description":"Employee tax form for reporting income. Valid values are *W2, 1099M, 1099R*. Default is W2.
Max length: 15","type":["string","null"]}}},"veteranDescription":{"description":"Indicates if employee is a veteran.","type":["string","null"]},"webTime":{"description":"Add or update Web Time badge number and charge rate and synchronize Web Pay and Web Time employee data.","type":"object","additionalProperties":false,"properties":{"badgeNumber":{"description":"Badge number usually issued for time and attendance system use.
Max length: 50","type":["string","null"]},"chargeRate":{"description":"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)","type":["number","null"]},"isTimeLaborEnabled":{"description":"If set to true, changes to employee data will be reflected in Web Time.","type":["boolean","null"]}}},"workAddress":{"description":"Add or update employee's work address, phone numbers, and email. Work Location drop down field is not included.","type":"object","additionalProperties":false,"properties":{"address1":{"description":"1st address line.
Max length: 40","type":["string","null"]},"address2":{"description":"2nd address line.
Max length: 40","type":["string","null"]},"city":{"description":"City.
Max length: 40","type":["string","null"]},"country":{"description":"Country.
Max length: 30","type":["string","null"]},"county":{"description":"County.
Max length: 30","type":["string","null"]},"emailAddress":{"description":"Email.
Max length: 50","type":["string","null"]},"location":{"description":"Work Location name.
Max length: 50","type":["string","null"]},"mailStop":{"description":"Employee mail stop.
Max length: 10","type":["string","null"]},"mobilePhone":{"description":"Mobile phone number.
Max length: 20","type":["string","null"]},"pager":{"description":"Employee pager number.
Max length: 20","type":["string","null"]},"phone":{"description":"Phone number.
Max length: 20","type":["string","null"]},"phoneExtension":{"description":"Phone number extension.
Max length: 10","type":["string","null"]},"postalCode":{"description":"Postal code.
Max length: 10","type":["string","null"]},"state":{"description":"State or province.
Max length: 2","type":["string","null"]}}},"workEligibility":{"description":"Add or update I-9 work authorization information.","type":"object","additionalProperties":false,"properties":{"alienOrAdmissionDocumentNumber":{"description":"Employee USCIS or Admission Number.
Must be 7-10 characters and may begin with an 'A'","type":["string","null"]},"attestedDate":{"description":"The date the I-9 Verification form was attested by Employer or Authorized representative. Common formats are *MM-DD-CCYY, CCYY-MM-DD*.","type":["string","null"],"format":"paylocity-date"},"countryOfIssuance":{"description":"If Foreign Passport number is provided, provide its country of issuance. Must match Paylocity setup.
Max length: 30","type":["string","null"]},"foreignPassportNumber":{"description":"Foreign Passport Number.
Max length: 50","type":["string","null"]},"i94AdmissionNumber":{"description":"Form I-94 admission number.
Must be 11 numeric characters","type":["string","null"]},"i9DateVerified":{"description":"Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.","type":["string","null"],"format":"paylocity-date"},"i9Notes":{"description":"Notes regarding employee's i9.
Max length: 4000","type":["string","null"]},"isI9Verified":{"description":"Indicates if employee I9 is verified.","type":["boolean","null"]},"isSsnVerified":{"description":"Indicates if employee SSN is verified.","type":["boolean","null"]},"ssnDateVerified":{"description":"The date of employer verification of employee SSN. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.","type":["string","null"],"format":"paylocity-date"},"ssnNotes":{"description":"Notes regarding employee's SSN.
Max length: 4000","type":["string","null"]},"visaType":{"description":"Employee Visa type. Must match one of the system coded values.
Max length: 100","type":["string","null"]},"workAuthorization":{"description":"Employee work authorization. Must match one of the system coded values.
Max length: 100","type":["string","null"]},"workUntil":{"description":"End date of employee work eligibility. Common formats include *MM-DD-CCYY*, *CCYY-MM-DD*.","type":["string","null"],"format":"paylocity-date"}}}}},"employeeIdResponse":{"description":"The EmployeeId Response Model","type":"object","properties":{"employeeId":{"description":"The EmployeeId","type":"string"}}},"employeeInfo":{"description":"The employee info model","type":"object","additionalProperties":false,"properties":{"employeeId":{"description":"Employee Id.
Max length: 10","type":["string","null"]},"statusCode":{"description":"Employee current work status. Common values are *A* (Active), *L* (Leave of Absence), *T* (Terminated).
Max length: 20","type":["string","null"]},"statusTypeCode":{"description":"Employee current work status type.
Max length: 10","type":["string","null"]}}},"localTax":{"description":"The Local Tax model","type":"object","additionalProperties":false,"properties":{"exemptions":{"description":"Local tax exemptions value.
Decimal (12,2)","type":["number","null"]},"exemptions2":{"description":"Local tax exemptions 2 value.
Decimal (12,2)","type":["number","null"]},"filingStatus":{"description":"Employee local tax filing status. Must match specific local tax setup.
Max length: 50","type":["string","null"]},"residentPSD":{"description":"Resident PSD (political subdivision code) applicable in PA. Must match Company setup.
Max length: 9","type":["string","null"]},"taxCode":{"description":"Local tax code.
Max length: 50","type":["string","null"]},"workPSD":{"description":"Work location PSD. Must match Company setup.
Max length: 9","type":["string","null"]}}},"nonPrimaryStateTax":{"description":"The Non-Primary State Tax model","type":"object","additionalProperties":false,"properties":{"amount":{"description":"State tax code.
Max length: 50","type":["number","null"]},"deductionsAmount":{"description":"Box 4(b) on form W4 (year 2020 or later): Deductions amount.
Decimal (12,2)","type":"number"},"dependentsAmount":{"description":"Box 3 on form W4 (year 2020 or later): Total dependents amount.
Decimal (12,2)","type":"number"},"exemptions":{"description":"State tax exemptions value.
Decimal (12,2)","type":["number","null"]},"exemptions2":{"description":"State tax exemptions 2 value.
Decimal (12,2)","type":["number","null"]},"filingStatus":{"description":"Employee state tax filing status. Common values are *S* (Single), *M* (Married).
Max length: 50","type":["string","null"]},"higherRate":{"description":"Box 2(c) on form W4 (year 2020 or later): Multiple Jobs or Spouse Works.
Boolean","type":"boolean"},"otherIncomeAmount":{"description":"Box 4(a) on form W4 (year 2020 or later): Other income amount.
Decimal (12,2)","type":"number"},"percentage":{"description":"State Tax percentage.
Decimal (12,2)","type":["number","null"]},"reciprocityCode":{"description":"Non-primary state tax reciprocity code.
Max length: 50","type":["string","null"]},"specialCheckCalc":{"description":"Supplemental check calculation code. Common values are *Blocked* (Taxes blocked on Supplemental checks), *Supp* (Use supplemental Tax Rate-Code).
Max length: 10","type":["string","null"]},"taxCalculationCode":{"description":"Tax calculation code. Common values are *F* (Flat), *P* (Percentage), *FDFP* (Flat Dollar Amount plus Fixed Percentage).
Max length: 10","type":["string","null"]},"taxCode":{"description":"State tax code.
Max length: 50","type":["string","null"]},"w4FormYear":{"description":"The state W4 form year
Integer","type":"integer"}}},"payStatementDetails":{"description":"The pay statement details model","type":"object","additionalProperties":false,"properties":{"amount":{"description":".
","type":["number","null"]},"checkDate":{"description":".
","type":["string","null"],"format":"paylocity-date"},"det":{"description":".
","type":["string","null"]},"detCode":{"description":".
","type":["string","null"]},"detType":{"description":".
","type":["string","null"]},"eligibleCompensation":{"description":".
","type":["number","null"]},"hours":{"description":".
","type":["number","null"]},"rate":{"description":".
","type":["number","null"]},"transactionNumber":{"description":"
","type":"integer"},"transactionType":{"description":".
","type":["string","null"]},"year":{"description":".
","type":"integer"}}},"payStatementSummary":{"description":"The pay statement summary model","type":"object","additionalProperties":false,"properties":{"autoPay":{"description":".
","type":"boolean"},"beginDate":{"description":".
","type":["string","null"],"format":"paylocity-date"},"checkDate":{"description":".
","type":["string","null"],"format":"paylocity-date"},"checkNumber":{"description":".
","type":"integer"},"directDepositAmount":{"description":".
","type":["number","null"]},"endDate":{"description":".
","type":["string","null"],"format":"paylocity-date"},"grossPay":{"description":".
","type":["number","null"]},"hours":{"description":".
","type":["number","null"]},"netCheck":{"description":".
","type":["number","null"]},"netPay":{"description":".
","type":["number","null"]},"overtimeDollars":{"description":".
","type":["number","null"]},"overtimeHours":{"description":".
","type":["number","null"]},"process":{"description":".
","type":"integer"},"regularDollars":{"description":".
","type":["number","null"]},"regularHours":{"description":".
","type":["number","null"]},"transactionNumber":{"description":"
","type":"integer"},"voucherNumber":{"description":".
","type":"integer"},"workersCompCode":{"description":".
","type":["string","null"]},"year":{"description":".
","type":"integer"}}},"stateTax":{"description":"The State Tax model","type":"object","additionalProperties":false,"properties":{"amount":{"description":"State tax code.
Max length: 50","type":["number","null"]},"deductionsAmount":{"description":"Box 4(b) on form W4 (year 2020 or later): Deductions amount.
Decimal (12,2)","type":"number"},"dependentsAmount":{"description":"Box 3 on form W4 (year 2020 or later): Total dependents amount.
Decimal (12,2)","type":"number"},"exemptions":{"description":"State tax exemptions value.
Decimal (12,2)","type":["number","null"]},"exemptions2":{"description":"State tax exemptions 2 value.
Decimal (12,2)","type":["number","null"]},"filingStatus":{"description":"Employee state tax filing status. Common values are *S* (Single), *M* (Married).
Max length: 50","type":["string","null"]},"higherRate":{"description":"Box 2(c) on form W4 (year 2020 or later): Multiple Jobs or Spouse Works.
Boolean","type":"boolean"},"otherIncomeAmount":{"description":"Box 4(a) on form W4 (year 2020 or later): Other income amount.
Decimal (12,2)","type":"number"},"percentage":{"description":"State Tax percentage.
Decimal (12,2)","type":["number","null"]},"specialCheckCalc":{"description":"Supplemental check calculation code. Common values are *Blocked* (Taxes blocked on Supplemental checks), *Supp* (Use supplemental Tax Rate-Code).
Max length: 10","type":["string","null"]},"taxCalculationCode":{"description":"Tax calculation code. Common values are *F* (Flat), *P* (Percentage), *FDFP* (Flat Dollar Amount plus Fixed Percentage).
Max length: 10","type":["string","null"]},"taxCode":{"description":"State tax code.
Max length: 50","type":["string","null"]},"w4FormYear":{"description":"The state W4 form year
Integer","type":"integer"}}},"sensitiveData":{"description":"The sensitive data model","type":"object","additionalProperties":false,"properties":{"disability":{"description":"Add or update disability data.","type":"object","additionalProperties":false,"properties":{"disability":{"description":"Description of employee's disability or accommodation.
Max length: 50","type":["string","null"]},"disabilityClassifications":{"description":"Add or update employee's disability classifications","type":"array","items":{"description":"The disabilty classifications model","type":"object","properties":{"classification":{"description":"Indicates the type of disability. This field is only allowed if hasDisability is set to 1=Yes. Values include:
Auditory
Cognitive, learning, and neurological
Physical
Speech
Vision
Prefer not to say
Valid values can be obtained from Company Codes endpoint, codeResource = disabilityClassification","type":["string","null"]}}}},"hasDisability":{"description":"Indicates if the employee has a disability. Values include:
0 = No
1 = Yes
2 = Prefer not to say","type":["string","null"]}}},"ethnicity":{"description":"Add or update ethnicity data.","type":"object","additionalProperties":false,"properties":{"ethnicity":{"description":"Employee's legal ethnicity or race.
A = Asian
B = Black
H = Hispanic
I = American Indian
N = Native Hawaiian or Pacific Islander
T = Two or More Races
W = White
Valid values can be obtained from Company Codes endpoint, codeResource = ethnicity","type":["string","null"]},"ethnicRacialIdentities":{"description":"Add or update Ethnic Racial Identity","type":"array","items":{"description":"The ethnic racial identity model","type":"object","properties":{"description":{"description":"Employee's preferred or chosen ethnicity or race.
Max length: 40.","type":["string","null"]}}}}}},"gender":{"description":"Add or update gender data.","type":"object","additionalProperties":false,"properties":{"displayPronouns":{"description":"Specifies whether employee's preferred pronouns will be displayed to co-workers in Community, Directory, etc. Values include:
0 = No
1 = Yes","type":["boolean","null"]},"genderIdentityDescription":{"description":"Employee's preferred or chosen gender identification.
Max length: 40","type":["string","null"]},"identifyAsLegalGender":{"description":"Employee's self-identification of legal gender. Numerical values include:
0 = No
1 = Yes
2 = Prefer not to say","type":["string","null"]},"legalGender":{"description":"Employee's legal gender. Values include:
M = Male
F = Female
Valid values can be obtained from Company Codes endpoint, codeResource = legalGender","type":["string","null"]},"pronouns":{"description":"Employee's preferred or chosen pronouns. Values include:
He / Him / His
She / Her / Hers
They / Them / Theirs
Prefer not to say
Valid values can be obtained from Company Codes endpoint, codeResource = preferredPronouns","type":["string","null"]},"sexualOrientation":{"description":"Employee's self-identification of sexual orientation. Values may include values below. Additionally, any custom value may be provided.
Asexual
Gay / Lesbian
Heterosexual / Straight
Pansexual
Queer
Bisexual
Prefer not to say","type":["string","null"]}}},"veteran":{"description":"Add or update veteran data.","type":"object","additionalProperties":false,"properties":{"isVeteran":{"description":"Indicates if the employee is a veteran. Values include:
0 = No
1 = Yes
2 = Prefer not to say","type":["string","null"]},"veteran":{"description":"Employee's Veteran Notes
Max length: 50","type":["string","null"]}}}}}}}