{"openapi":"3.0.0","info":{"version":"v1","title":"UKG Pro Personnel — PurpleSuite executable core"},"tags":[{"name":"BusinessStructureStatus","x-parent":"PRO Employee Data"},{"name":"CompensationDetails","x-parent":"PRO Employee data"},{"name":"Changes By Date","x-parent":"PRO Employee data"},{"name":"EmployeeCobraDetails","x-parent":"PRO Employee data"},{"name":"Contact","x-parent":"PRO Employee data"},{"name":"EmployeeContract","x-parent":"PRO Employee data"},{"name":"EmpDedBenOptionDate","x-parent":"PRO Employee data"},{"name":"Employee Deduction History Effective Date","x-parent":"PRO Employee data"},{"name":"Employee Demographic Details","x-parent":"PRO Employee data"},{"name":"DirectDeposit","x-parent":"PRO Employee data"},{"name":"EmployeeEducation","x-parent":"PRO Employee data"},{"name":"EmployeeEmploymentDetails","x-parent":"PRO Employee data"},{"name":"EmployeeExtendedElements","x-parent":"PRO Employee data"},{"name":"EmployeeJobHistoryDetail","x-parent":"PRO Employee data"},{"name":"Employee ID Lookup","x-parent":"PRO Employee data"},{"name":"EmployeeMultipleJobsOPP","x-parent":"PRO Employee data"},{"name":"EmployeeMultiPhoneNumbers","x-parent":"PRO Employee data"},{"name":"EmpMultiplePositions","x-parent":"PRO Employee data"},{"name":"NationalDocument","x-parent":"PRO Employee data"},{"name":"CompanyPayStatement","x-parent":"PRO Employee data"},{"name":"KronosEmployeeProfiles","x-parent":"PRO Employee data"},{"name":"EmployeeSupervisorDetails","x-parent":"PRO Employee data"},{"name":"KronosEmployeeStatus","x-parent":"PRO Employee data"},{"name":"EmploymentDetails","x-parent":"PRO Employee data"},{"name":"EmployeeGlobalBank","x-parent":"PRO Employee data"},{"name":"EmployeeGlobalBanksV2","x-parent":"PRO Employee Data"},{"name":"EmpGlobalLocalizationElement","x-parent":"PRO Employee data"},{"name":"EmployeePayDeductionElement","x-parent":"PRO Employee data"},{"name":"InternationalEmployee","x-parent":"PRO Employee data"},{"name":"OpenEnrollmentEmployeeDeductions","x-parent":"PRO Employee data"},{"name":"EmpDeductions","x-parent":"PRO Employee data"},{"name":"DependentDeductions","x-parent":"PRO Employee data"}],"paths":{"/personnel/v1/employee-demographic-details":{"get":{"tags":["Employee Demographic Details"],"summary":"Get Employee Demographic Details","description":"If no pagination parameters are specified, the default/max is applied. Permissions - UKG Pro service account must have \"View\" role for the \"Personnel Integration\" Web Service. Headers - US-Customer-Api-Key, Authorization (base64 encoded {username}:{password})\n\nExecutable core: JSON only; exact-value filters on the published parameters. Basic password and US-Customer-Api-Key both use this instance key. Other tenant configuration and permissions are outside this profile.","parameters":[{"name":"employeeId","in":"query","required":false,"schema":{"allOf":[{"type":"string","pattern":"^[*a-zA-Z0-9]*$"},{"type":"string","pattern":"^[^*]*$"}]}},{"name":"companyId","in":"query","required":false,"schema":{"allOf":[{"type":"string","pattern":"^[*a-zA-Z0-9]*$"},{"type":"string","pattern":"^[^*]*$"}]}},{"name":"lastName","in":"query","required":false,"schema":{"allOf":[{"type":"string","pattern":"^[*a-zA-Z]*$"},{"type":"string","pattern":"^[^*]*$"}]}},{"name":"emailAddress","in":"query","required":false,"schema":{"allOf":[{"type":"string"},{"type":"string","pattern":"^[^*]*$"}]}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1}},{"name":"per_Page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200}},{"description":"The Pro Customer API key which is unique to each Pro HR Tenant and can be found by navigating to System Configuration > Security > Web Services and referring to the value for `Customer API Key`.","in":"header","name":"US-CUSTOMER-API-KEY","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeDemographicDetails"}}}}},"404":{"description":"NotFound","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}}},"429":{"description":"429","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}}}},"operationId":"get_personnel_v1_employee_demographic_details","x-purplesuite-classification":"modeled-core"}},"/personnel/v1/employee-employment-details":{"get":{"summary":"Retrieve Employee Employment Details","description":"Returns an employee's employement details according to the specified query parameters. If no pagination parameters are specified, the default maximum is applied. Permissions - UKG Pro service account must have the \"View\" role for the \"Personnel Integration\" Web Service.\n\n* Company ID parameter can take in multiple deduction codes separated by comma. ex: [ABC, DEF]\n* Primary Job Code parameter can take in multiple pay frequencies separated by comma. ex: [ABC, DEF]\n* Primary Work Location Code parameter can take in multiple pay frequencies separated by comma. ex: [ABC, DEF]\n* Primary Project Code parameter can take in multiple pay frequencies separated by comma. ex: [ABC, DEF]\n* Deduction Group Code parameter can take in multiple pay frequencies separated by comma. ex: [ABC, DEF]\n* Earning Group Code parameter can take in multiple pay frequencies separated by comma. ex: [ABC, DEF]\n* Employee Type Code parameter can take in multiple pay frequencies separated by comma. ex: [ABC, DEF]\n* Employee Status Code parameter can take in multiple pay frequencies separated by comma. ex: [ABC, DEF]\n* Pay Group parameter can take in multiple pay frequencies separated by comma. ex: [ABC, DEF]\nExecutable core: JSON only; exact-value filters on the published parameters. Basic password and US-Customer-Api-Key both use this instance key. Other tenant configuration and permissions are outside this profile.","operationId":"retrieveEmployeeEmploymentDetails","tags":["EmployeeEmploymentDetails"],"parameters":[{"name":"companyID","in":"query","description":"The unique identifier for the company associated with an employee.","required":false,"schema":{"allOf":[{"type":"string"},{"type":"string","pattern":"^[^*]*$"}]}},{"name":"employeeID","in":"query","description":"The unique identifier for an employee within the organization.","required":false,"schema":{"allOf":[{"type":"string","pattern":"^[a-zA-Z0-9]*$"},{"type":"string","pattern":"^[^*]*$"}]}},{"name":"employeeStatusCode","in":"query","description":"A code representing the current status of the employee.","required":false,"schema":{"allOf":[{"type":"string"},{"type":"string","pattern":"^[^*]*$"}]}},{"name":"employeeNumber","in":"query","description":"The employee number or identifier.","required":false,"schema":{"allOf":[{"type":"string","pattern":"^[0-9]*$"},{"type":"string","pattern":"^[^*]*$"}]}},{"name":"page","in":"query","description":"The page number of a paginated response set.","required":false,"schema":{"type":"integer","minimum":1}},{"name":"per_Page","in":"query","description":"The number of results contained per page in a paginated response set.","required":false,"schema":{"type":"integer","minimum":1,"maximum":200}},{"description":"The Pro Customer API key which is unique to each Pro HR Tenant and can be found by navigating to System Configuration > Security > Web Services and referring to the value for `Customer API Key`.","in":"header","name":"US-CUSTOMER-API-KEY","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeEmploymentDetails"}}}}},"400":{"description":"BadRequest","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}}},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}}}},"x-purplesuite-classification":"modeled-core"}},"/personnel/v1/employee-ids":{"post":{"tags":["Employee ID Lookup"],"description":"Look up Employee ID/Company ID. This operation is a POST due the sensitive nature of the lookup properties not appropriate for URI. This service supports multiple records to be looked up in the body of the request (array of Identifier objects). Permissions - Ultipro service account must have the \"View\" and \"Add\" roles for the \"Personnel Integration\" Web Service. Headers - US-Customer-Api-Key, Authorization (base64 encoded {username}:{password})\nExecutable core: JSON only; exact-value filters on the published parameters. Basic password and US-Customer-Api-Key both use this instance key. Other tenant configuration and permissions are outside this profile.","summary":"Employee ID Lookup","operationId":"EmployeeIds","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"object","additionalProperties":false,"required":["employeeIdentifierType","employeeIdentifierValue"],"properties":{"employeeIdentifierType":{"type":"string","enum":["EmailAddress","EmployeeNumber","PersonID","EmployeeID"]},"employeeIdentifierValue":{"type":"string","minLength":1},"companyIdentifierType":{"type":"string","enum":["Company ID"]},"companyIdentifierValue":{"type":"string","minLength":1}}}}}}},"responses":{"207":{"description":"Multi-Status","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeIdsResponse"}}}}},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests (Exceeded Rate Limit)"}},"parameters":[{"description":"The Pro Customer API key which is unique to each Pro HR Tenant and can be found by navigating to System Configuration > Security > Web Services and referring to the value for `Customer API Key`.","in":"header","name":"US-CUSTOMER-API-KEY","schema":{"type":"string"},"required":true}],"x-purplesuite-classification":"modeled-core"}},"/personnel/v1/employment-details":{"get":{"tags":["EmploymentDetails"],"summary":"Retrieve Employment Details","description":"Returns all employment record details.\n\nIf no pagination parameters are specified, the default maximum is applied.\n\nPermissions - UKG Pro service account must have \"View\" role for the \"Personnel Integration\" Web Service. Headers - US-Customer-Api-Key, Authorization (base64 encoded {username}:{password}).\nCorrect syntax when using date-time parameters are as follows: \n\n\nExecutable core: JSON only; exact-value filters on the published parameters. Basic password and US-Customer-Api-Key both use this instance key. Other tenant configuration and permissions are outside this profile.","parameters":[{"name":"companyId","in":"query","required":false,"schema":{"allOf":[{"type":"string"},{"type":"string","pattern":"^[^*]*$"}]}},{"name":"employeeId","in":"query","required":false,"schema":{"allOf":[{"type":"string"},{"type":"string","pattern":"^[^*]*$"}]}},{"name":"employeeStatusCode","in":"query","required":false,"schema":{"allOf":[{"type":"string"},{"type":"string","pattern":"^[^*]*$"}]}},{"name":"employeeNumber","in":"query","required":false,"schema":{"allOf":[{"type":"string"},{"type":"string","pattern":"^[^*]*$"}]}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1}},{"name":"per_Page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200}},{"description":"The Pro Customer API key which is unique to each Pro HR Tenant and can be found by navigating to System Configuration > Security > Web Services and referring to the value for `Customer API Key`.","in":"header","name":"US-CUSTOMER-API-KEY","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EmpEmploymentDetails"}}}}},"404":{"description":"NotFound"},"429":{"description":"429"},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}}}},"operationId":"get_personnel_v1_employment_details","x-purplesuite-classification":"modeled-core"}},"/personnel/v1/companies/{companyId}/employment-details":{"get":{"tags":["EmploymentDetails"],"summary":"Retrieve Employment Details by Company ID","description":"Returns all employment record details by company.\n\nIf no pagination parameters are specified, the default maximum is applied.\n\nPermissions - UKG Pro service account must have \"View\" role for the \"Personnel Integration\" Web Service. Headers - US-Customer-Api-Key, Authorization (base64 encoded {username}:{password}).\nCorrect syntax when using date-time parameters are as follows: \n\n\nExecutable core: JSON only; exact-value filters on the published parameters. Basic password and US-Customer-Api-Key both use this instance key. Other tenant configuration and permissions are outside this profile.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"query","required":false,"schema":{"allOf":[{"type":"string"},{"type":"string","pattern":"^[^*]*$"}]}},{"name":"employeeId","in":"query","required":false,"schema":{"allOf":[{"type":"string"},{"type":"string","pattern":"^[^*]*$"}]}},{"name":"employeeStatusCode","in":"query","required":false,"schema":{"allOf":[{"type":"string"},{"type":"string","pattern":"^[^*]*$"}]}},{"name":"employeeNumber","in":"query","required":false,"schema":{"allOf":[{"type":"string"},{"type":"string","pattern":"^[^*]*$"}]}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1}},{"name":"per_Page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200}},{"description":"The Pro Customer API key which is unique to each Pro HR Tenant and can be found by navigating to System Configuration > Security > Web Services and referring to the value for `Customer API Key`.","in":"header","name":"US-CUSTOMER-API-KEY","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EmpEmploymentDetails"}}}}},"404":{"description":"NotFound"},"429":{"description":"429"},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}}}},"operationId":"get_personnel_v1_companies_companyId_employment_details","x-purplesuite-classification":"modeled-core"}},"/personnel/v1/companies/{companyId}/employees/{employeeId}/employment-details":{"get":{"tags":["EmploymentDetails"],"summary":"Retrieve Employment Details by Employee ID and Company","description":"Returns a single employment detail by employee ID and companyID.\n\nIf no pagination parameters are specified, the default maximum is applied.\n\nPermissions - UKG Pro service account must have \"View\" role for the \"Personnel Integration\" Web Service. Headers - US-Customer-Api-Key, Authorization (base64 encoded {username}:{password}).\nCorrect syntax when using date-time parameters are as follows: \n\n\nExecutable core: JSON only; exact-value filters on the published parameters. Basic password and US-Customer-Api-Key both use this instance key. Other tenant configuration and permissions are outside this profile.","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string"}},{"name":"employeeId","in":"path","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"query","required":false,"schema":{"allOf":[{"type":"string"},{"type":"string","pattern":"^[^*]*$"}]}},{"name":"employeeId","in":"query","required":false,"schema":{"allOf":[{"type":"string"},{"type":"string","pattern":"^[^*]*$"}]}},{"name":"employeeStatusCode","in":"query","required":false,"schema":{"allOf":[{"type":"string"},{"type":"string","pattern":"^[^*]*$"}]}},{"name":"employeeNumber","in":"query","required":false,"schema":{"allOf":[{"type":"string"},{"type":"string","pattern":"^[^*]*$"}]}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1}},{"name":"per_Page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200}},{"description":"The Pro Customer API key which is unique to each Pro HR Tenant and can be found by navigating to System Configuration > Security > Web Services and referring to the value for `Customer API Key`.","in":"header","name":"US-CUSTOMER-API-KEY","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EmpEmploymentDetails"}}}}},"404":{"description":"NotFound"},"429":{"description":"429"},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}}}},"operationId":"get_personnel_v1_companies_companyId_employees_employeeId_employment_details","x-purplesuite-classification":"modeled-core"}},"/personnel/v1/person-details":{"get":{"summary":"Get all person details","description":"Returns all person details. \nIf no pagination parameters are specified, the default/max is applied. \nPermissions - UKG Pro service account must have \"View\" role for the \"Employee Person Details\" Web Service. Headers - US-Customer-Api-Key, Authorization (base64 encoded {username}:{password}).\nCorrect syntax when using date-time parameters are as follows: \n\n\nExecutable core: JSON only; exact-value filters on the published parameters. Basic password and US-Customer-Api-Key both use this instance key. Other tenant configuration and permissions are outside this profile.","tags":["PersonDetails"],"parameters":[{"name":"companyId","in":"query","required":false,"schema":{"allOf":[{"type":"string"},{"type":"string","pattern":"^[^*]*$"}]}},{"name":"employeeId","in":"query","required":false,"schema":{"allOf":[{"type":"string"},{"type":"string","pattern":"^[^*]*$"}]}},{"name":"lastName","in":"query","required":false,"schema":{"allOf":[{"type":"string"},{"type":"string","pattern":"^[^*]*$"}]}},{"name":"emailAddress","in":"query","required":false,"schema":{"allOf":[{"type":"string"},{"type":"string","pattern":"^[^*]*$"}]}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1}},{"name":"per_Page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200}},{"description":"The Pro Customer API key which is unique to each Pro HR Tenant and can be found by navigating to System Configuration > Security > Web Services and referring to the value for `Customer API Key`.","in":"header","name":"US-CUSTOMER-API-KEY","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EmpPersonDetails"}}}}},"404":{"description":"NotFound"},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}}}},"operationId":"get_personnel_v1_person_details","x-purplesuite-classification":"modeled-core"}},"/personnel/v1/companies/{companyId}/person-details":{"get":{"summary":"Get all person details for a single company","description":"Returns all person details for a single company. \nIf no pagination parameters are specified, the default/max is applied. \nPermissions - UKG Pro service account must have \"View\" role for the \"Employee Person Details\" Web Service. Headers - US-Customer-Api-Key, Authorization (base64 encoded {username}:{password}).\nCorrect syntax when using date-time parameters are as follows: \n\n\nExecutable core: JSON only; exact-value filters on the published parameters. Basic password and US-Customer-Api-Key both use this instance key. Other tenant configuration and permissions are outside this profile.","tags":["PersonDetails"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"query","required":false,"schema":{"allOf":[{"type":"string"},{"type":"string","pattern":"^[^*]*$"}]}},{"name":"employeeId","in":"query","required":false,"schema":{"allOf":[{"type":"string"},{"type":"string","pattern":"^[^*]*$"}]}},{"name":"lastName","in":"query","required":false,"schema":{"allOf":[{"type":"string"},{"type":"string","pattern":"^[^*]*$"}]}},{"name":"emailAddress","in":"query","required":false,"schema":{"allOf":[{"type":"string"},{"type":"string","pattern":"^[^*]*$"}]}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1}},{"name":"per_Page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200}},{"description":"The Pro Customer API key which is unique to each Pro HR Tenant and can be found by navigating to System Configuration > Security > Web Services and referring to the value for `Customer API Key`.","in":"header","name":"US-CUSTOMER-API-KEY","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EmpPersonDetails"}}}}},"404":{"description":"NotFound"},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}}}},"operationId":"get_personnel_v1_companies_companyId_person_details","x-purplesuite-classification":"modeled-core"}},"/personnel/v1/companies/{companyId}/employees/{employeeId}/person-details":{"get":{"summary":"Get a single person detail record for a single company","description":"Returns a single person detail record for a single company. \nIf no pagination parameters are specified, the default/max is applied. \nPermissions - UKG Pro service account must have \"View\" role for the \"Employee Person Details\" Web Service. Headers - US-Customer-Api-Key, Authorization (base64 encoded {username}:{password}).\nCorrect syntax when using date-time parameters are as follows: \n\n\nExecutable core: JSON only; exact-value filters on the published parameters. Basic password and US-Customer-Api-Key both use this instance key. Other tenant configuration and permissions are outside this profile.","tags":["PersonDetails"],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string"}},{"name":"employeeId","in":"path","required":true,"schema":{"type":"string"}},{"name":"companyId","in":"query","required":false,"schema":{"allOf":[{"type":"string"},{"type":"string","pattern":"^[^*]*$"}]}},{"name":"employeeId","in":"query","required":false,"schema":{"allOf":[{"type":"string"},{"type":"string","pattern":"^[^*]*$"}]}},{"name":"lastName","in":"query","required":false,"schema":{"allOf":[{"type":"string"},{"type":"string","pattern":"^[^*]*$"}]}},{"name":"emailAddress","in":"query","required":false,"schema":{"allOf":[{"type":"string"},{"type":"string","pattern":"^[^*]*$"}]}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1}},{"name":"per_Page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200}},{"description":"The Pro Customer API key which is unique to each Pro HR Tenant and can be found by navigating to System Configuration > Security > Web Services and referring to the value for `Customer API Key`.","in":"header","name":"US-CUSTOMER-API-KEY","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EmpPersonDetails"}}}}},"404":{"description":"NotFound"},"500":{"description":"InternalServerError","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}}}},"operationId":"get_personnel_v1_companies_companyId_employees_employeeId_person_details","x-purplesuite-classification":"modeled-core"}},"/personnel/v1/person-details/{employeeId}":{"get":{"summary":"Get a single person detail record","description":"Returns a single person detail record. \nIf no pagination parameters are specified, the default/max is applied. \nPermissions - UKG Pro service account must have \"View\" role for the \"Employee Person Details\" Web Service. Headers - US-Customer-Api-Key, Authorization (base64 encoded {username}:{password}).\nCorrect syntax when using date-time parameters are as follows: \n\n\nExecutable core: JSON only; exact-value filters on the published parameters. Basic password and US-Customer-Api-Key both use this instance key. Other tenant configuration and permissions are outside this profile.","tags":["PersonDetails"],"parameters":[{"name":"employeeId","in":"path","required":true,"schema":{"type":"string"}},{"description":"The Pro Customer API key which is unique to each Pro HR Tenant and can be found by navigating to System Configuration > Security > Web Services and referring to the value for `Customer API Key`.","in":"header","name":"US-CUSTOMER-API-KEY","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmpPersonDetails"}}}},"404":{"description":"NotFound"},"500":{"description":"InternalServerError"}},"operationId":"get_personnel_v1_person_details_employeeId","x-purplesuite-classification":"modeled-core"}},"/personnel/v1/pto-plans":{"get":{"summary":"Get all pto-plans","description":"Returns information about an UltiPro employees PTO Plans. Permissions - Pro service account must have \"View\" role for the \"PTO Plan Integration\" Web Service. Headers - US-Customer-Api-Key, Authorization (base64 encoded {username}:{password}).\n\nExecutable core: JSON only; exact-value filters on the published parameters. Basic password and US-Customer-Api-Key both use this instance key. Other tenant configuration and permissions are outside this profile.","parameters":[{"name":"page","in":"query","description":"Pagination, which page you want to see","required":false,"schema":{"type":"integer","minimum":1}},{"name":"per_page","in":"query","description":"Pagination, how many records per page you want to see","required":false,"schema":{"type":"integer","minimum":1,"maximum":200}},{"description":"The Pro Customer API key which is unique to each Pro HR Tenant and can be found by navigating to System Configuration > Security > Web Services and referring to the value for `Customer API Key`.","in":"header","name":"US-CUSTOMER-API-KEY","schema":{"type":"string"},"required":true}],"tags":["Get All PTO Plans"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/pto-plans"}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests (Exceeded Rate Limit)"}},"operationId":"get_personnel_v1_pto_plans","x-purplesuite-classification":"modeled-core"},"post":{"summary":"Create A PTO Plan","description":"Creates a new UltiPro PTO plan record. Array of objects is permitted for multi-records support. Work Flow or Approvers is not supported. Permissions - Ultipro service account must have \"Add\" role for the \"PTO Plan Integration\" Web Service. Headers - US-Customer-Api-Key, Authorization (base64 encoded {username}:{password}).\n\nExecutable core: JSON only; exact-value filters on the published parameters. Basic password and US-Customer-Api-Key both use this instance key. Other tenant configuration and permissions are outside this profile.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"object","required":["employeeId","companyId","ptoPlan"],"properties":{"employeeId":{"type":"string","description":"Employee Identifier","minLength":1,"maxLength":128},"companyId":{"type":"string","description":"Company Identifier","minLength":1,"maxLength":128},"ptoPlan":{"type":"string","description":"PTO Plan Identifier","minLength":1,"maxLength":128},"earned":{"type":"number","format":"double","description":"Amount of hours earned for PTO"},"taken":{"type":"number","format":"double","description":"Amount of hours taken for PTO"},"pendingBalance":{"type":"number","format":"double","description":"Balance of PTO hours"},"earnedThroughDate":{"type":"string","description":"Date in which PTO is earned through, format should be YYYY-MM-DD","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"reset":{"type":"string","description":"Date in which the PTO reset's, format should be YYYY-MM-DD","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"pendingMoveDate":{"type":"string","description":"Date to be used if pending rules are relevant, format should be YYYY-MM-DD","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},"additionalProperties":false}}}}},"tags":["PTO Plan Post"],"responses":{"207":{"description":"Multi-Status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiStatusResponse"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests (Exceeded Rate Limit)"}},"parameters":[{"description":"The Pro Customer API key which is unique to each Pro HR Tenant and can be found by navigating to System Configuration > Security > Web Services and referring to the value for `Customer API Key`.","in":"header","name":"US-CUSTOMER-API-KEY","schema":{"type":"string"},"required":true}],"operationId":"post_personnel_v1_pto_plans","x-purplesuite-classification":"modeled-core"}},"/personnel/v1/companies/{companyId}/employees/{employeeId}/pto-plans/{ptoPlan}":{"patch":{"summary":"Patch one PTO Plan","description":"Allows the ability to update one PTO Plan for an employee. Work Flow or Approvers is not supported. Permissions - Pro service account must have \"Edit\" role for the \"PTO Plan Integration\" Web Service. Headers - US-Customer-Api-Key, Authorization (base64 encoded {username}:{password}).\n\nExecutable core: JSON only; exact-value filters on the published parameters. Basic password and US-Customer-Api-Key both use this instance key. Other tenant configuration and permissions are outside this profile.","parameters":[{"name":"companyId","in":"path","description":"Company Identifier","required":true,"schema":{"type":"string"}},{"name":"employeeId","in":"path","description":"Employee Identifier","required":true,"schema":{"type":"string"}},{"name":"ptoPlan","in":"path","description":"PTO Plan Identifier","required":true,"schema":{"type":"string"}},{"description":"The Pro Customer API key which is unique to each Pro HR Tenant and can be found by navigating to System Configuration > Security > Web Services and referring to the value for `Customer API Key`.","in":"header","name":"US-CUSTOMER-API-KEY","schema":{"type":"string"},"required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["employeeId","companyId","ptoPlan"],"properties":{"employeeId":{"type":"string","description":"Employee Identifier","minLength":1,"maxLength":128},"companyId":{"type":"string","description":"Company Identifier","minLength":1,"maxLength":128},"ptoPlan":{"type":"string","description":"PTO Plan Identifier","minLength":1,"maxLength":128},"earned":{"type":"number","format":"double","description":"Amount of hours earned for PTO"},"taken":{"type":"number","format":"double","description":"Amount of hours taken for PTO"},"pendingBalance":{"type":"number","format":"double","description":"Balance of PTO hours"},"earnedThroughDate":{"type":"string","description":"Date in which PTO is earned through, format should be YYYY-MM-DD","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"reset":{"type":"string","description":"Date in which the PTO reset's, format should be YYYY-MM-DD","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"pendingMoveDate":{"type":"string","description":"Date to be used if pending rules are relevant, format should be YYYY-MM-DD","pattern":"^\\d{4}-\\d{2}-\\d{2}$"}},"additionalProperties":false}}}},"tags":["PTO Plan Patch"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/pto-plans"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests (Exceeded Rate Limit)"}},"operationId":"patch_personnel_v1_companies_companyId_employees_employeeId_pto_plans_ptoPlan","x-purplesuite-classification":"modeled-core"},"get":{"summary":"Get a specific pto-plan","description":"Returns information about an UltiPro employees PTO Plans. Work flow or Approvers is not supported. Permissions - Ultipro service account must have \"View\" role for the \"PTO Plan Integration\" Web Service. Headers - US-Customer-Api-Key, Authorization (base64 encoded {username}:{password}).\n\nExecutable core: JSON only; exact-value filters on the published parameters. Basic password and US-Customer-Api-Key both use this instance key. Other tenant configuration and permissions are outside this profile.","parameters":[{"name":"companyId","in":"path","description":"Company Identifier","required":true,"schema":{"type":"string"}},{"name":"employeeId","in":"path","description":"Employee Identifier","required":true,"schema":{"type":"string"}},{"name":"ptoPlan","in":"path","description":"PTO Plan Identifier","required":true,"schema":{"type":"string"}},{"description":"The Pro Customer API key which is unique to each Pro HR Tenant and can be found by navigating to System Configuration > Security > Web Services and referring to the value for `Customer API Key`.","in":"header","name":"US-CUSTOMER-API-KEY","schema":{"type":"string"},"required":true}],"tags":["Get Specific PTO Plan"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/pto-plans"}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests (Exceeded Rate Limit)"}},"operationId":"get_personnel_v1_companies_companyId_employees_employeeId_pto_plans_ptoPlan","x-purplesuite-classification":"modeled-core"}},"/personnel/v1/companies/{companyId}/employees/{employeeId}/pto-plans":{"get":{"summary":"Get a specific employees pto-plans","description":"Returns information about an UltiPro employees PTO Plans. Permissions - Pro service account must have \"View\" role for the \"PTO Plan Integration\" Web Service. Headers - US-Customer-Api-Key, Authorization (base64 encoded {username}:{password}).\n\nExecutable core: JSON only; exact-value filters on the published parameters. Basic password and US-Customer-Api-Key both use this instance key. Other tenant configuration and permissions are outside this profile.","parameters":[{"name":"companyId","in":"path","description":"Company Identifier","required":true,"schema":{"type":"string"}},{"name":"employeeId","in":"path","description":"Employee Identifier","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Pagination, which page you want to see","required":false,"schema":{"type":"integer","minimum":1}},{"name":"per_page","in":"query","description":"Pagination, how many records per page you want to see","required":false,"schema":{"type":"integer","minimum":1,"maximum":200}},{"description":"The Pro Customer API key which is unique to each Pro HR Tenant and can be found by navigating to System Configuration > Security > Web Services and referring to the value for `Customer API Key`.","in":"header","name":"US-CUSTOMER-API-KEY","schema":{"type":"string"},"required":true}],"tags":["Get Specific Employees PTO Plans"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/pto-plans"}}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"429":{"description":"Too Many Requests (Exceeded Rate Limit)"}},"operationId":"get_personnel_v1_companies_companyId_employees_employeeId_pto_plans","x-purplesuite-classification":"modeled-core"}}},"servers":[{"url":"/api/purple-suite/{instanceId}/contracts/hris/ukg","variables":{"instanceId":{"default":"instance-id"}}}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"authN":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"UKG Authentication (AuthN) OAuth 2.0 Bearer token. The token must contain the scopes `read:employee-global-banks-V2` and `hrms_data` and use the audience `https://employee-global-banks.ukg.net`."}},"schemas":{"EmpCompensationDetails":{"type":"object","properties":{"employeeID":{"type":"string"},"companyID":{"type":"string"},"annualSalary":{"format":"double","type":"number"},"hourlyPayRate":{"format":"double","type":"number"},"weeklyPayRate":{"format":"double","type":"number"},"payPeriodPayRate":{"format":"double","type":"number"},"currencyCode":{"type":"string"},"otherRate1":{"format":"double","type":"number"},"otherRate2":{"format":"double","type":"number"},"otherRate3":{"format":"double","type":"number"},"otherRate4":{"format":"double","type":"number"},"payGroupDescription":{"type":"string"},"piecePayRate":{"format":"double","type":"number"},"primaryJobCode":{"type":"string"},"jobSalaryGrade":{"type":"string"},"jobChangeReasonCode":{"type":"string"},"jobGroupCode":{"type":"string"},"jobTitle":{"type":"string"},"dateInJob":{"format":"date-time","type":"string"},"dateLastPaid":{"format":"date-time","type":"string"},"dateLastWorked":{"format":"date-time","type":"string"},"dateOfLastSalaryReview":{"format":"date-time","type":"string"},"dateOfNextSalayrReview":{"format":"date-time","type":"string"},"isAutoAllocated":{"type":"boolean"},"isAutoPaid":{"type":"boolean"},"isSeasonalWorker":{"type":"boolean"},"isHighlyCompensated":{"type":"boolean"},"isMultipleJob":{"type":"boolean"},"payGroupCode":{"type":"string"},"payPeriod":{"type":"string"},"payScaleCode":{"type":"string"},"salaryOrHourlyCode":{"type":"string"},"fullTimeOrPartTimeCode":{"type":"string"},"scheduledFullTimeEquivalency":{"format":"double","type":"number"},"scheduledPeriodWorkHours":{"format":"double","type":"number"},"scheduledAnnualWorkHours":{"format":"double","type":"number"},"weeklyHours":{"format":"double","type":"number"},"primaryShiftCode":{"type":"string"},"primaryShiftGroupCode":{"type":"string"},"avgPayRateCurPer":{"format":"float","type":"number"},"bonusTotalHrs":{"format":"float","type":"number"},"bonusTotalOtHrs":{"format":"float","type":"number"},"datePaidThru":{"format":"date-time","type":"string"},"emplStatus":{"type":"string"},"totalAnnSalary":{"format":"float","type":"number"},"distributionCenterCode":{"type":"string"},"numberOfPayments":{"format":"int32","type":"integer"},"performanceReviewRating":{"type":"string"},"performanceReviewType":{"type":"string"}}},"EmployeeChangesResponse":{"type":"object","properties":{"firstName":{"type":"string","description":"Employee First Name"},"lastName":{"type":"string","description":"Employee Last Name"},"preferredName":{"type":"string","description":"Employee Preferred Name"},"emailAddress":{"type":"string","description":"Employee Email Address"},"countryCode":{"type":"string","description":"Employee Country Code"},"languageCode":{"type":"string","description":"Employee Language Code"},"employeeNumber":{"type":"number","description":"Employee Number"},"employeeId":{"type":"string","description":"Employee Identifier"},"personId":{"type":"string","description":"Employee Person Identifier"},"userIntegrationKey":{"type":"string","description":"User Integration Key"},"companyName":{"type":"string","description":"Employee Company Name"},"companyId":{"type":"string","description":"Employee Company Identifier"},"supervisorId":{"type":"string","description":"Employee Surpervisor Identifier"},"salaryOrHourly":{"type":"string","description":"Employee Hourly Salary"},"fullTimeOrPartTime":{"type":"string","description":"Full/Part Time Identifier"},"isActive":{"type":"boolean","description":"Employee Active Flag"},"workLocation":{"type":"string","description":"Employee Work Location"},"jobCode":{"type":"string","description":"Employee Job Code"},"projectCode":{"type":"string","description":"Employee Project Code"},"orgLevel1Code":{"type":"string","description":"Employee Orginizational Level 1"},"orgLevel2Code":{"type":"string","description":"Employee Orginizational Level 2"},"orgLevel3Code":{"type":"string","description":"Employee Orginizational Level 3"},"orgLevel4Code":{"type":"string","description":"Employee Orginizational Level 4"},"middleName":{"type":"string","description":"Employee Middle Name"},"workPhone":{"type":"string","description":"Employee Work Phone"},"homePhone":{"type":"string","description":"Employee Home Phone"},"employeeAddress1":{"type":"string","description":"Employee Address 1"},"employeeAddress2":{"type":"string","description":"Employee Address 2"},"city":{"type":"string","description":"Employee City"},"state":{"type":"string","description":"Employee State"},"zipCode":{"type":"string","description":"Employee Zip Code"},"terminationDate":{"type":"string","description":"Employee Termination Date"},"hireDate":{"type":"string","description":"Employee Hire Date"},"supervisorName":{"type":"string","description":"Employee Supervisor Name"},"prefix":{"type":"string","description":"Employee Name Prefix"},"suffix":{"type":"string","description":"Employee Name Suffix"},"alternateEmailAddress":{"type":"string","description":"Employee Alternative Email Address"},"gender":{"type":"string","description":"Employee Gender"},"employeeStatus":{"type":"string","description":"Employee Employment Status"},"employeeType":{"type":"string","description":"Employee Type"},"emplStatusStartDate":{"type":"string","description":"Employment Status Start Date"},"dateInJob":{"type":"string","description":"Date Employee Started Current Job"},"dateOfLastHire":{"type":"string","description":"Date Employee Last Hired"},"jobGroupCode":{"type":"string","description":"Employee Job Group Code"},"alternateJobTitle":{"type":"string","description":"Alternate Job Title for Employee"}}},"Error":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"errorCount":{"type":"number"},"errors":{"type":"object","properties":{"modelstate":{"type":"object","properties":{"property-name":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"}}}}}}}}}},"EmployeeCobraDetails":{"type":"object","properties":{"personID":{"type":"string"},"employeeID":{"type":"string"},"companyID":{"type":"string"},"cobraExport":{"type":"string"},"cobraIsActive":{"type":"boolean"},"cobraNotes":{"type":"string"},"cobraReason":{"type":"string"},"cobraStatus":{"type":"string"},"cobraStatusDate":{"type":"string","format":"date-time"},"dateOfCobraEvent":{"type":"string","format":"date-time"},"dateOfCobraExport":{"type":"string","format":"date-time"},"dateOfCobraLetter":{"type":"string","format":"date-time"}}},"Contact":{"type":"object","properties":{"city":{"type":"string"},"countryCode":{"type":"string"},"county":{"type":"string"},"addressIsDifferentFromEmployee":{"type":"boolean"},"addressLine1":{"type":"string"},"addressLine2":{"type":"string"},"state":{"type":"string"},"zipCode":{"type":"string"},"cobraExport":{"type":"boolean"},"cobraIsActive":{"type":"boolean"},"cobraReason":{"type":"string"},"cobraStatus":{"type":"string"},"cobraStatusDate":{"format":"date-time","type":"string"},"dateOfBirth":{"format":"date-time","type":"string"},"dateOfCOBRAEvent":{"format":"date-time","type":"string"},"dateOfCOBRALetter":{"format":"date-time","type":"string"},"employeeId":{"type":"string"},"gender":{"type":"string"},"importId":{"type":"string"},"isBeneficiary":{"type":"boolean"},"isDependent":{"type":"boolean"},"isDisabled":{"type":"boolean"},"isEmergencyContact":{"type":"boolean"},"isSmoker":{"type":"boolean"},"isStudent":{"type":"boolean"},"marriageDate":{"format":"date-time","type":"string"},"firstName":{"type":"string"},"formerName":{"type":"string"},"lastName":{"type":"string"},"middleName":{"type":"string"},"nameSuffix":{"type":"string"},"occupation":{"type":"string"},"otherInsurance":{"type":"string"},"homePhoneCountry":{"type":"string"},"homePhoneNumber":{"type":"string"},"otherPhoneNumber":{"type":"string"},"otherPhoneType":{"type":"string"},"preferredPhoneNumber":{"type":"string"},"relationshipCode":{"type":"string"},"relationshipDescription":{"type":"string"},"ssn":{"type":"string"},"contactId":{"type":"string"},"userDefinedField01":{"type":"string"},"workPhoneExtension":{"type":"string"},"workPhoneNumber":{"type":"string"},"cobraNotes":{"type":"string"},"notes":{"type":"string"},"isActive":{"type":"boolean"},"statusAsOfDate":{"format":"date-time","type":"string"},"deathDate":{"format":"date-time","type":"string"},"divorceDate":{"format":"date-time","type":"string"},"emailAddress":{"type":"string"},"otherPhoneCountryCode":{"type":"string"},"healthCareId":{"type":"string"},"nationalId":{"type":"string"},"nationalIdExpirationDate":{"format":"date-time","type":"string"},"personID":{"format":"uuid","type":"string","example":"00000000-0000-0000-0000-000000000000"},"addressID":{"format":"uuid","type":"string","example":"00000000-0000-0000-0000-000000000000"},"workPhoneId":{"format":"uuid","type":"string","example":"00000000-0000-0000-0000-000000000000"},"homePhoneId":{"format":"uuid","type":"string","example":"00000000-0000-0000-0000-000000000000"},"otherPhoneId":{"format":"uuid","type":"string","example":"00000000-0000-0000-0000-000000000000"}}},"EmployeeContract":{"type":"object","properties":{"companyId":{"type":"string"},"employeeId":{"type":"string"},"contractNumber":{"type":"string"},"contractTypeCode":{"type":"string"},"effectiveDate":{"type":"string"},"dateTimeCreated":{"type":"string"},"rowLastChanged":{"type":"string"},"page":{"format":"int32","maximum":2147483647,"minimum":1,"type":"integer"},"per_Page":{"format":"int32","maximum":2147483647,"minimum":1,"type":"integer"},"pagesCount":{"format":"int32","type":"integer"}}},"EmployeeDeductionBenefitOptionChangeDate":{"type":"object","properties":{"companyID":{"type":"string"},"deductionCode":{"type":"string"},"employeeId":{"type":"string"},"optionDate":{"type":"string","format":"date-time"}}},"EmpDedHistoryEffectiveChangeDate":{"type":"object","properties":{"employeeId":{"type":"string"},"companyId":{"type":"string"},"deductionCode":{"type":"string"},"effectiveDate":{"format":"date-time","type":"string"},"fieldValueDataType":{"type":"string"},"fieldValue":{"type":"string"},"fieldValueDate":{"format":"date-time","type":"string"},"fieldValueNumber":{"type":"number"},"changeReason":{"type":"string"}}},"EmployeeDemographicDetails":{"type":"object","properties":{"ethnicDescription":{"type":"string"},"additionalName1":{"type":"string"},"additionalName2":{"type":"string"},"addressId":{"type":"string"},"addressIsOnTaxBoundary":{"type":"string"},"addressLatitude":{"type":"number"},"disabilityType":{"type":"string"},"formerName":{"type":"string"},"healthBloodType":{"type":"string"},"healthEyes":{"type":"string"},"healthHair":{"type":"string"},"healthHeightFeet":{"type":"string"},"healthHeightInches":{"type":"string"},"healthLastDonateDate":{"type":"string"},"healthWeight":{"type":"number"},"previousSSN":{"type":"string"},"originCountry":{"type":"string"},"originLocation":{"type":"string"},"addressSms":{"type":"string"},"homePhoneIsPrivate":{"type":"boolean"},"lastNameNotSameAsSSCard":{"type":"string"},"nationality1":{"type":"string"},"nationality2":{"type":"string"},"nationality3":{"type":"string"},"personId":{"type":"string"},"employeeId":{"type":"string"},"companyId":{"type":"string"},"firstName":{"type":"string"},"middleName":{"type":"string"},"lastName":{"type":"string"},"preferredName":{"type":"string"},"namePrefixCode":{"type":"string"},"nameSuffixCode":{"type":"string"},"emailAddress":{"type":"string"},"emailAddressAlternate":{"type":"string"},"homePhoneID":{"type":"string"},"homePhone":{"type":"string"},"homePhoneCountry":{"type":"string"},"addressLine1":{"type":"string"},"addressLine2":{"type":"string"},"addressLine3":{"type":"string"},"addressLine4":{"type":"string"},"addressCity":{"type":"string"},"addressState":{"type":"string"},"addressZipCode":{"type":"string"},"addressCountry":{"type":"string"},"addressCounty":{"type":"string"},"dateOfBirth":{"type":"string"},"gender":{"type":"string"},"ethnicIdCode":{"type":"string"},"isSmoker":{"type":"boolean"},"isDisabled":{"type":"string"},"maritalStatusCode":{"type":"string"},"ssn":{"type":"string"},"ssnIsSuppressed":{"type":"boolean"},"userID":{"type":"string"},"integrationRecordId":{"type":"string"},"cellPhoneNumber":{"type":"string"}}},"EmployeeEducationModel":{"type":"object","properties":{"employeeId":{"type":"string"},"systemId":{"type":"string"},"school":{"type":"string"},"educationLevel":{"type":"string"},"educationMajor":{"type":"string"},"educationMinor":{"type":"string"},"gpa":{"type":"string"},"beginDate":{"format":"date-time","type":"string"},"endDate":{"format":"date-time","type":"string"},"isGraduate":{"type":"boolean"},"isHighestLevel":{"type":"boolean"},"employeeNumber":{"type":"string"},"country":{"type":"string"}}},"EmployeeEmploymentDetails":{"type":"object","properties":{"companyID":{"type":"string","description":"the unique identifier for the company associated with the employee."},"employeeID":{"type":"string","description":"The unique identifier for an employee within the organization."},"homeCompany":{"type":"string","description":"The primary company where an employee is employed."},"primaryJobCode":{"type":"string","description":"A code which refers to the primary job code assigned to the employee."},"jobCode":{"type":"string","description":"A code which represents the specific job role or position."},"jobGroupCode":{"type":"string","description":"A code which denotes the job group or category."},"annualSalary":{"type":"number","description":"The employee's annual salary."},"mailstop":{"type":"string","description":"The mailstop or location for receiving mail within the organization."},"okToRehire":{"type":"string","description":"A string indicating whether or not a terminated employee is eligible for rehire."},"plannedLeaveReason":{"type":"string","description":"A string describing the reason for planned leave."},"positionCode":{"type":"string","description":"A code referring to the specific position within the company."},"salaryOrHourly":{"type":"string","description":"A string specifying whether the employee is paid on a salary or hourly basis."},"scheduledAnnualHours":{"type":"number","description":"The expected annual work hours for the employee."},"scheduledFTE":{"type":"number","description":"A numerical representation of the full-time equivalent (FTE) status."},"scheduledWorkHours":{"type":"number","description":"The scheduled weekly work hours."},"shift":{"type":"string","description":"A string describing the employee's work shift."},"shiftGroup":{"type":"string","description":"A string indicating the group or category of shifts."},"terminationReasonCode":{"type":"string","description":"A code representing the reason for employee termination."},"terminationDescription":{"type":"string","description":"A string providing additional details about the termination reason."},"termType":{"type":"string","description":"A string specifying the type of termination."},"timeClockID":{"type":"string","description":"The unique identifier for the employee's time clock system."},"weeklyHours":{"type":"number","description":"The expected weekly work hours."},"orgLevel1Code":{"type":"string","description":"The top-level organizational unit."},"orgLevel2Code":{"type":"string","description":"A secondary level of the organizational unit."},"orgLevel3Code":{"type":"string","description":"A lower level of the organizational hierarchy."},"orgLevel4Code":{"type":"string","description":"The lowest level of organizational classification."},"jobTitle":{"type":"string","description":"The official job title of the employee."},"fullTimeOrPartTimeCode":{"type":"string","description":"A code indicating whether the employee is full-time or part-time."},"primaryWorkLocationCode":{"type":"string","description":"A code indicating the primary work location."},"languageCode":{"type":"string","description":"A code indicating the employee's preferred language."},"jobChangeReasonCode":{"type":"string","description":"A code representing the reason for a job change."},"primaryProjectCode":{"type":"string","description":"A code indicating the primary project or assignment."},"workPhoneNumber":{"type":"string","description":"The employee's work phone number."},"workPhoneExtension":{"type":"string","description":"The extension for the work phone."},"workPhoneCountry":{"type":"string","description":"The country code for the work phone number."},"deductionGroupCode":{"type":"string","description":"A code indicating the group of deductions."},"earningGroupCode":{"type":"string","description":"A code indicating the group of earnings."},"employeeTypeCode":{"type":"string","description":"A code indicating the type of employee."},"employeeStatusCode":{"type":"string","description":"A code representing the current status of the employee."},"employeeNumber":{"type":"string","description":"The employee number or identifier."},"leaveReasonCode":{"type":"string","description":"A code representing the reason for taking leave."},"autoAllocate":{"type":"string","description":"A string which indicates whether or not allocation is automated."},"clockCode":{"type":"string","description":"The code used for timekeeping or clocking in and out."},"supervisorID":{"type":"string","description":"The unique identifier of the employee's supervisor."},"originalHireDate":{"type":"string","description":"The date when the employee was originally hired."},"dateInJob":{"type":"string","description":"The date when the employee started the current job."},"dateLastWorked":{"type":"string","description":"The last date the employee worked."},"benefitSeniorityDate":{"type":"string","description":"The date when benefit seniority started."},"seniorityDate":{"type":"string","description":"The date when overall seniority started."},"lastHireDate":{"type":"string","description":"The most recent hire date (if rehired)."},"dateTimeCreated":{"type":"string","description":"The timestamp when the employee record was created."},"dateTimeChanged":{"type":"string","description":"The timestamp for the last update to an employee record."},"dateLastPayDatePaid":{"type":"string","description":"The date the employee was last paid."},"employeeStatusExpectedEndDate":{"type":"string","description":"The expected end date for the current employee status."},"integrationRecordId":{"type":"string","description":"A unique identifier for integration purposes."},"currentCompanyCountryCode":{"type":"string","description":"The country code for the current company where the employee is employed."},"homeCompanyCountryCode":{"type":"string","description":"The country code for the employee's home company."},"hourlyPayRate":{"type":"number","description":"The hourly pay rate for the employee."},"salaryEffectiveDate":{"type":"string","description":"The date a salary change is effective."},"unionLocalCode":{"type":"string","description":"A code representing the local union associated with the employee."},"unionNationalCode":{"type":"string","description":"A code representing the national union associated with the employee."},"earlyRetirementDate":{"type":"string","description":"The date when early retirement is applicable."},"retirementDate":{"type":"string","description":"The date an employee is eligible for retirement."},"suspensionDate":{"type":"string","description":"The date an employee was suspended from work."},"terminationDate":{"type":"string","description":"The date an employee was terminated."},"payGroupCode":{"type":"string","description":"A code representing the pay group or category."},"payPeriod":{"type":"string","description":"The pay period."},"paidThruDate":{"type":"string","description":"The last date for which the employee was paid."},"employeeStatusStartDate":{"type":"string","description":"The start date for the current employee status."},"hireSource":{"type":"string","description":"The source through which the employee was hired."},"isHomeCompany":{"type":"boolean","description":"A Boolean indicator of whether or not the current company is the employee's home company."},"isSupervisor":{"type":"boolean","description":"A Boolean indicator of whether or not the employee is a supervisor."},"isAutoAllocated":{"type":"boolean","description":"A Boolean indicator of whether or not allocation is automated for the employee."},"isAutoPaid":{"type":"boolean","description":"A Boolean indicator of whether or not payment processing is automated for the employee."},"isHighlyCompensated":{"type":"boolean","description":"A Boolean indicator of whether or not the employee is highly compensated."},"isMultipleJob":{"type":"boolean","description":"A Boolean indicator of whether or not the employee holds multiple jobs within the organization."},"isKeyEmployee":{"type":"boolean","description":"A Boolean indicator of whether or not the employee is a key contributor or holds a critical role."},"page":{"type":"integer","description":"The page number of a paginated response set."},"per_Page":{"type":"integer","description":"The number of results contained per page in a paginated response set."}}},"EmployeeExtendedElements":{"type":"object","properties":{"personID":{"type":"string"},"employeeID":{"type":"string"},"companyID":{"type":"string"},"communityBroadcastSMSCode":{"type":"string"},"consentElectronicW2":{"type":"boolean"},"consentElectronicW2PR":{"type":"boolean"},"dateDeceased":{"type":"string","format":"date-time"},"dateOfI9Expiration":{"type":"string","format":"date-time"},"dateTimeChanged":{"type":"string","format":"date-time"},"dateTimeCreated":{"type":"string","format":"date-time"},"i9AlienNumber":{"type":"string"},"i9DocA":{"type":"string"},"i9DocB":{"type":"string"},"i9DocC":{"type":"string"},"i9Verified":{"type":"boolean"},"i9VisaType":{"type":"string"},"i9WorkAuth":{"type":"string"},"isMultiPayGroup":{"type":"boolean"},"militaryBranchServed":{"type":"string"},"militaryEra":{"type":"string"},"militaryIsDisabledVet":{"type":"string"},"militaryIsOthEligVet":{"type":"string"},"militaryIsOthEligVetBasis":{"type":"string"},"militaryIsActiveWartimeVet":{"type":"string"},"w2IsDeceased":{"type":"boolean"},"militarySeparationDate":{"type":"string","format":"date-time"},"smsApprovals":{"type":"boolean"},"smsPayNotification":{"type":"boolean"},"chkCashingInstCode":{"type":"string"},"i9VisaExpirationDate":{"type":"string","format":"date-time"},"militaryIsMedalVet":{"type":"string"},"militaryService":{"type":"string"}}},"EmployeeJobHistoryDetail":{"type":"object","properties":{"annualSalary":{"format":"double","type":"number"},"companyId":{"type":"string"},"dateTimeCreated":{"format":"date-time","type":"string"},"employeeId":{"type":"string"},"employeeType":{"type":"string"},"employeeStatus":{"type":"string"},"flsaCategory":{"type":"string"},"fullTimeOrPartTime":{"type":"string"},"hourlyPayRate":{"format":"double","type":"number"},"isJobChange":{"type":"boolean"},"isOrgchange":{"type":"boolean"},"isOutsideGuidelines":{"type":"boolean"},"isOutsideRange":{"type":"boolean"},"isPromotion":{"type":"boolean"},"isRateChange":{"type":"boolean"},"isSystem":{"type":"boolean"},"isTransfer":{"type":"boolean"},"jobCode":{"type":"string"},"jobDescription":{"type":"string"},"jobEffectiveDate":{"format":"date-time","type":"string"},"jobGroupCode":{"type":"string"},"locationCode":{"type":"string"},"orgLevel1Code":{"type":"string"},"orgLevel2Code":{"type":"string"},"orgLevel3Code":{"type":"string"},"orgLevel4Code":{"type":"string"},"otherRate1":{"format":"double","type":"number"},"otherRate2":{"format":"double","type":"number"},"otherRate3":{"format":"double","type":"number"},"otherRate4":{"format":"double","type":"number"},"payGroupCode":{"type":"string"},"payPeriodCode":{"type":"string"},"payScaleCode":{"type":"string"},"percentChange":{"format":"double","type":"number"},"periodPayRate":{"format":"double","type":"number"},"piecePayRate":{"format":"double","type":"number"},"positionCode":{"type":"string"},"reasonCode":{"type":"string"},"salaryGrade":{"type":"string"},"salaryOrHourly":{"type":"string"},"scheduledAnnualHours":{"format":"double","type":"number"},"scheduledFullTimeEquivalency":{"format":"double","type":"number"},"scheduledWorkHours":{"format":"double","type":"number"},"shiftCode":{"type":"string"},"shiftGroupCode":{"type":"string"},"stepNumber":{"format":"double","type":"number"},"supervisorId":{"type":"string"},"supervisorNameFirst":{"type":"string"},"supervisorNameLast":{"type":"string"},"supervisorNameSuffix":{"type":"string"},"supervisorNotInList":{"type":"boolean"},"systemId":{"type":"string"},"unionNational":{"type":"string"},"usePayScales":{"type":"boolean"},"weeklyPayRate":{"format":"double","type":"number"},"notes":{"type":"string"},"homeCompanyId":{"type":"string"},"integrationEffectiveDate":{"format":"date-time","type":"string"},"projectCode":{"type":"string"},"numberOfPayments":{"format":"double","type":"number"},"weeklyHours":{"format":"double","type":"number"},"isViewableByEmployee":{"type":"boolean"},"createdByUserId":{"format":"double","type":"number"},"jobTitle":{"type":"string"}}},"Identifiers":{"required":["employeeIdentifierType","employeeIdentifierValue"],"type":"object","properties":{"employeeIdentifierType":{"type":"string","enum":["EmailAddress","EmployeeNumber","NationalID","SIN","PersonID","SSN","EmployeeID","UserIntegrationKey"],"description":"Employee Identifier Type"},"employeeIdentifierValue":{"type":"string","description":"Employee Identifier Value (specific to Employee Identifer Type)"},"companyIdentifierType":{"type":"string","enum":["Company ID","Company Code","Federal ID"]},"companyIdentifierValue":{"type":"string","description":"Company Identifier Value (specific to Company Identifer Type)"}}},"EmployeeIdsResponse":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"detail":{"type":"string"},"errorCount":{"type":"number"},"multistatus":{"type":"array","items":{"properties":{"sequenceId":{"type":"number"},"status":{"description":"http status","type":"string"},"modelstate":{"description":"Only present if status is error","type":"object","properties":{"property-name":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"}}}}}},"body":{"description":"Only present if status is success","type":"object","properties":{"eeid":{"type":"string"},"coid":{"type":"array","description":"If more than one company, first element is the home company.","items":{"type":"string"}}}}}}}}},"EmployeeMultipleJobs":{"type":"object","properties":{"annualPayRate":{"type":"number"},"companyId":{"type":"string"},"dateInJob":{"format":"date-time","type":"string"},"employeeId":{"type":"string"},"hourlyPayRate":{"type":"number"},"isPrimaryJob":{"type":"boolean"},"jobCode":{"type":"string"},"jobIsInActive":{"type":"boolean"},"otherRate1":{"type":"number"},"otherRate2":{"type":"number"},"otherRate3":{"type":"number"},"otherRate4":{"type":"number"},"piecePayRate":{"type":"number"}}},"EmployeeMultiplePositions":{"type":"object","properties":{"employeeId":{"type":"string"},"companyId":{"type":"string"},"jobCode":{"type":"string"},"positionCode":{"type":"string"},"isPrimary":{"type":"boolean"},"annualSalary":{"type":"number"},"hourlyPayRate":{"type":"number"},"fullTimeOrPartTimeCode":{"type":"string"},"fullTimeOrPartTime":{"type":"string"},"clockCode":{"type":"string"},"dateTimeCreated":{"format":"date-time","type":"string"},"employeeTypeCode":{"type":"string"},"employeeTypeDescription":{"type":"string"},"effectiveStartDate":{"format":"date-time","type":"string"},"effectiveStopDate":{"format":"date-time","type":"string"},"isEligibleForBenefits":{"type":"boolean"},"locationCode":{"type":"string"},"notes":{"type":"string"},"organizationLevel1Code":{"type":"string"},"organizationLevel2Code":{"type":"string"},"organizationLevel3Code":{"type":"string"},"organizationLevel4Code":{"type":"string"},"otherRate1":{"type":"number"},"otherRate2":{"type":"number"},"otherRate3":{"type":"number"},"otherRate4":{"type":"number"},"overrideIncumbentData":{"type":"string"},"payGroupCode":{"type":"string"},"periodPayRate":{"type":"number"},"piecePayRate":{"type":"number"},"projectCode":{"type":"string"},"salaryOrHourlyCode":{"type":"string"},"salaryOrHourly":{"type":"string"},"scheduledAnnualHours":{"type":"number"},"scheduledFullTimeEmployee":{"type":"number"},"scheduledWorkHours":{"type":"number"},"shiftCode":{"type":"string"},"shiftGroupCode":{"type":"string"},"shiftGroupDescription":{"type":"string"},"systemId":{"type":"string"},"weeklyPayRate":{"type":"number"}}},"EmployeeMultiPhoneNumbers":{"type":"object","properties":{"employeeId":{"type":"string"},"auditKey":{"type":"string"},"firstName":{"type":"string"},"formerName":{"type":"object"},"lastName":{"type":"string"},"middleName":{"type":"string"},"phoneNumber":{"type":"string"},"phoneCountryCode":{"type":"string"},"phoneCountryPrefix":{"type":"object"},"phoneTypeCode":{"type":"string"},"phoneExtension":{"type":"string"},"phoneIsPrivate":{"type":"boolean"},"systemId":{"type":"string"}}},"NationalDocumentModel":{"type":"object","properties":{"employeeId":{"type":"string"},"nationalDocumentId":{"type":"string"},"contactId":{"type":"string"},"nationalDocumentNumber":{"type":"string"},"nationalDocumentDescription":{"type":"string"},"nationalDocumentTypeCode":{"type":"string"},"nationalDocumentIssuingCountryCode":{"type":"string"},"nationalDocumentIssuingPlace":{"type":"string"},"nationalDocumentIssueDate":{"format":"date-time","type":"string"},"employeeNumber":{"type":"string"}}},"EmployeeProfiles":{"type":"object","properties":{"profileValue":{"type":"string"},"profileType":{"type":"string"},"product":{"type":"string"},"module":{"type":"string"},"companyId":{"type":"string"},"employeeId":{"type":"string"},"lastModifiedDate":{"format":"date-time","type":"string"},"isCleared":{"type":"boolean"},"isDateEffective":{"type":"boolean"},"effectiveDate":{"format":"date-time","type":"string"},"recordId":{"type":"number"},"description":{"type":"string"},"changeRecordID":{"type":"number"},"isPrimary":{"type":"boolean"},"isPrimaryEffectiveDate":{"format":"date-time","type":"string"},"originalHireDate":{"format":"date-time","type":"string"}}},"EmployeeSupervisorDetails":{"type":"object","properties":{"employeeID":{"type":"string"},"companyID":{"type":"string"},"employeeNumber":{"type":"string"},"supervisorEmployeeID":{"type":"string"},"supervisorFirstName":{"type":"string"},"supervisorLastName":{"type":"string"},"supervisorEmployeeNumber":{"type":"string"},"supervisorCompanyID":{"type":"string"},"supervisorCompanyCode":{"type":"string"},"supervisorStatusCode":{"type":"string"},"supervisorJobCode":{"type":"string"},"supervisorPositionCode":{"type":"string"},"supervisorEmail":{"type":"string"},"supervisorWorkPhone":{"type":"string"},"supervisorPersonId":{"type":"string"}}},"EmployeeStatus":{"type":"object","properties":{"asOfDate":{"type":"string","format":"date-time"},"employeeId":{"type":"string"},"companyId":{"type":"string"},"triggerTermination":{"type":"boolean"},"status":{"type":"string"},"statusStartDate":{"type":"string","format":"date-time"},"statusReason":{"type":"string"},"statusReasonDesc":{"type":"string"},"isPrimary":{"type":"boolean"},"isPrimaryEffectiveDate":{"type":"string","format":"date-time"},"originalHireDate":{"type":"string","format":"date-time"}}},"EmpEmploymentDetails":{"type":"object","properties":{"companyID":{"type":"string"},"companyCode":{"type":"string"},"companyName":{"type":"string"},"employeeID":{"type":"string"},"jobDescription":{"type":"string"},"payGroupDescription":{"type":"string"},"primaryJobCode":{"type":"string"},"orgLevel1Code":{"type":"string"},"orgLevel2Code":{"type":"string"},"orgLevel3Code":{"type":"string"},"orgLevel4Code":{"type":"string"},"originalHireDate":{"format":"date-time","type":"string"},"lastHireDate":{"format":"date-time","type":"string"},"fullTimeOrPartTimeCode":{"type":"string"},"primaryWorkLocationCode":{"type":"string"},"languageCode":{"type":"string"},"primaryProjectCode":{"type":"string"},"workPhoneNumber":{"type":"string"},"workPhoneExtension":{"type":"string"},"workPhoneCountry":{"type":"string"},"dateInJob":{"format":"date-time","type":"string"},"dateLastWorked":{"format":"date-time","type":"string"},"dateOfBenefitSeniority":{"format":"date-time","type":"string"},"dateOfSeniority":{"format":"date-time","type":"string"},"deductionGroupCode":{"type":"string"},"earningGroupCode":{"type":"string"},"employeeTypeCode":{"type":"string"},"employeeStatusCode":{"type":"string"},"employeeNumber":{"type":"string"},"jobChangeReasonCode":{"type":"string"},"jobTitle":{"type":"string"},"leaveReasonCode":{"type":"string"},"supervisorID":{"type":"string"},"supervisorFirstName":{"type":"string"},"supervisorLastName":{"type":"string"},"autoAllocate":{"type":"string"},"clockCode":{"type":"string"},"dateLastPayDatePaid":{"format":"date-time","type":"string"},"dateOfEarlyRetirement":{"format":"date-time","type":"string"},"dateOfLocalUnion":{"format":"date-time","type":"string"},"dateOfNationalUnion":{"format":"date-time","type":"string"},"dateOfRetirement":{"format":"date-time","type":"string"},"dateOfSuspension":{"format":"date-time","type":"string"},"dateOfTermination":{"format":"date-time","type":"string"},"datePaidThru":{"format":"date-time","type":"string"},"statusStartDate":{"format":"date-time","type":"string"},"hireSource":{"type":"string"},"isAutoAllocated":{"type":"string"},"isAutopaid":{"type":"string"},"isMultipleJob":{"type":"string"},"jobGroupCode":{"type":"string"},"mailstop":{"type":"string"},"okToRehire":{"type":"string"},"payGroup":{"type":"string"},"payPeriod":{"type":"string"},"plannedLeaveReason":{"type":"string"},"positionCode":{"type":"string"},"salaryOrHourly":{"type":"string"},"scheduledAnnualHrs":{"format":"double","type":"number"},"scheduledFTE":{"format":"double","type":"number"},"scheduledWorkHrs":{"format":"double","type":"number"},"shift":{"type":"string"},"shiftGroup":{"type":"string"},"termReason":{"type":"string"},"terminationReasonDescription":{"type":"string"},"termType":{"type":"string"},"timeclockID":{"type":"string"},"unionLocal":{"type":"string"},"unionNational":{"type":"string"},"weeklyHours":{"format":"double","type":"number"},"dateTimeCreated":{"format":"date-time","type":"string"},"dateTimeChanged":{"format":"date-time","type":"string"},"supervisorEmployeeNumber":{"type":"string"},"supervisorCOID":{"type":"string"},"supervisorCompanyCode":{"type":"string"},"companyGLSegment":{"type":"string"},"locationGLSegment":{"type":"string"}}},"EmployeeGlobalBanksModel":{"type":"object","properties":{"bankId":{"type":"string"},"employeeId":{"type":"string"},"companyId":{"type":"string"},"employeeNumber":{"type":"string"},"payGroup":{"type":"string"},"currencyCode":{"type":"string"},"fundingMethod":{"type":"string"},"fundingMethodDescription":{"type":"string"},"addressLine1":{"type":"string"},"addressLine2":{"type":"string"},"addressLine3":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"postalCode":{"type":"string"},"country":{"type":"string"},"bankName":{"type":"string"},"bankBranch":{"type":"string"},"bankCountryCode":{"type":"string"},"beneficiaryName":{"type":"string"},"bankAccountType":{"type":"string"},"bankAccountTypeDescription":{"type":"string"},"bankAccountNumber":{"type":"string"},"iban":{"type":"string"},"swiftCode":{"type":"string"},"bankRequirement1":{"type":"string"},"bankRequirement2":{"type":"string"},"bankRequirement3":{"type":"string"},"dateModified":{"format":"date-time","type":"string"},"bankRequestCode1":{"type":"string"},"bankRequestLabel1":{"type":"string"},"bankRequestCode2":{"type":"string"},"bankRequestLabel2":{"type":"string"},"bankRequestCode3":{"type":"string"},"bankRequestLabel3":{"type":"string"},"employeeCountry":{"type":"string"}}},"EmployeeGlobalBanksV2":{"type":"object","properties":{"bankId":{"type":"string"},"employeeId":{"type":"string"},"companyId":{"type":"string"},"employeeNumber":{"type":"string"},"payGroup":{"type":"string"},"currencyCode":{"type":"string"},"fundingMethod":{"type":"string"},"fundingMethodDescription":{"type":"string"},"beneficiaryAddressLine1":{"type":"string"},"beneficiaryAddressLine2":{"type":"string"},"beneficiaryAddressLine3":{"type":"string"},"beneficiaryCity":{"type":"string"},"beneficiaryState":{"type":"string"},"beneficiaryPostalCode":{"type":"string"},"beneficiaryName":{"type":"string"},"beneficiaryCountryCode":{"type":"string"},"bankAddressLine1":{"type":"string"},"bankAddressLine2":{"type":"string"},"bankAddressLine3":{"type":"string"},"bankCity":{"type":"string"},"bankState":{"type":"string"},"bankPostalCode":{"type":"string"},"bankName":{"type":"string"},"bankBranch":{"type":"string"},"bankCountryCode":{"type":"string"},"bankAccountType":{"type":"string"},"bankAccountTypeDescription":{"type":"string"},"bankAccountNumber":{"type":"string"},"iban":{"type":"string"},"swiftCode":{"type":"string"},"bankRequirement1":{"type":"string"},"bankRequirement2":{"type":"string"},"bankRequirement3":{"type":"string"},"dateModified":{"format":"date-time","type":"string"},"bankRequestCode1":{"type":"string"},"bankRequestLabel1":{"type":"string"},"bankRequestCode2":{"type":"string"},"bankRequestLabel2":{"type":"string"},"bankRequestCode3":{"type":"string"},"bankRequestLabel3":{"type":"string"},"employeeCountry":{"type":"string"}}},"EmpGlobalLocalizationElementModel":{"type":"object","properties":{"employeeId":{"type":"string"},"fieldId":{"type":"string"},"fieldName":{"type":"string"},"booleanValue":{"type":"boolean"},"numericValue":{"type":"string"},"dateTimeValue":{"type":"string"},"stringValue":{"type":"string"},"companyId":{"type":"string"},"created":{"type":"string"},"effective":{"type":"string"}}},"EmployeePayDeductionElementsModel":{"type":"object","properties":{"employeeId":{"type":"string"},"companyId":{"type":"string"},"systemId":{"type":"string"},"payDeductionId":{"type":"string"},"employeeNumber":{"type":"string"},"payGroup":{"type":"string"},"payDeductionName":{"type":"string"},"payDeductionDescription":{"type":"string"},"periodStartId":{"type":"string"},"periodEndId":{"type":"string"},"periodStartName":{"type":"string"},"periodEndName":{"type":"string"},"startDate":{"format":"date-time","type":"string"},"endDate":{"format":"date-time","type":"string"},"project":{"type":"string"},"task":{"type":"string"},"recurring":{"type":"string"},"amount":{"type":"string"},"notes":{"type":"string"},"modifiedDate":{"format":"date-time","type":"string"},"country":{"type":"string"},"paymentOrDeductionIndicator":{"type":"string"}}},"OpenEnrollmentEmployeeDeductions":{"type":"object","properties":{"benefitAmount":{"type":"number"},"benefitAmountRateOrPercent":{"type":"number"},"benefitOption":{"type":"string"},"addCoverage":{"type":"boolean"},"changeReason":{"type":"string"},"benefitStartDate":{"format":"date-time","type":"string"},"benefitStatus":{"type":"string"},"benefitStatusDate":{"format":"date-time","type":"string"},"benefitStopDate":{"format":"date-time","type":"string"},"companyId":{"type":"string"},"customAmount1":{"type":"number"},"customAmount2":{"type":"number"},"customDate":{"format":"date-time","type":"string"},"changeDatetime":{"format":"date-time","type":"string"},"createDatetime":{"format":"date-time","type":"string"},"deductionCode":{"type":"string"},"deductionType":{"type":"string"},"employeeAmount":{"type":"number"},"employeeCalculationRateOrPercent":{"type":"number"},"employeeEligibilityDate":{"format":"date-time","type":"string"},"employeeGoalAmt":{"type":"number"},"employeeGoalToDateAmount":{"type":"number"},"employeeId":{"type":"string"},"employeeMemberOrCaseNo":{"type":"string"},"employeeYearToDateAmount":{"type":"number"},"evidenceofInsurabilityDate":{"format":"date-time","type":"string"},"needEvidenceOfInsurability":{"type":"boolean"},"evidenceofInsurabilityDesiredAmount":{"type":"number"},"employeeEligibilityDesiredCalculationRateOrPercent":{"type":"integer"},"employerAmount":{"type":"number"},"employerCalculationRateOrPercent":{"type":"number"},"employerCalculationRule":{"type":"string"},"employerYearToDateAmount":{"type":"number"},"isDeductionOffset":{"type":"boolean"},"medicalIndicator":{"type":"boolean"},"deductionNotes":{"type":"string"},"primaryCarePhysician":{"type":"string"},"primaryCarePhysicianId":{"type":"string"},"deductionStartDate":{"format":"date-time","type":"string"},"deductionStopDate":{"format":"date-time","type":"string"},"benefitWaiveReason":{"type":"string"},"isBenefitWaived":{"type":"boolean"},"oeDrop":{"type":"boolean"}}},"OpenEnrollmentDependentDeductions":{"type":"object","properties":{"benefitAmount":{"type":"number"},"changeReason":{"type":"string"},"relationship":{"type":"string"},"benefitStartDate":{"format":"date-time","type":"string"},"benefitStatus":{"type":"string"},"benefitStatusDate":{"format":"date-time","type":"string"},"benefitStopDate":{"format":"date-time","type":"string"},"companyId":{"type":"string"},"changeDatetime":{"format":"date-time","type":"string"},"contactId":{"type":"string"},"createDatetime":{"format":"date-time","type":"string"},"certificateNo":{"type":"string"},"currentCoId":{"type":"string"},"declinedByCarrier":{"type":"string"},"declinedByCarrierDate":{"format":"date-time","type":"string"},"declinedByCarrierReason":{"type":"string"},"deductionCode":{"type":"string"},"deductionType":{"type":"string"},"depBPlanTVID":{"type":"number"},"employeeId":{"type":"string"},"evidenceofInsurabilityDate":{"format":"date-time","type":"string"},"needEvidenceOfInsurability":{"type":"boolean"},"employerAmount":{"type":"number"},"deductionNotes":{"type":"string"},"primaryCarePhysician":{"type":"string"},"primaryCarePhysicianId":{"type":"string"},"systemId":{"type":"string"},"isBenefitWaived":{"type":"boolean"},"oeDrop":{"type":"boolean"}}},"InternationalEmployeeModel":{"type":"object","properties":{"caste":{"type":"string"},"casteDescription":{"type":"string"},"countryCode":{"type":"string"},"employeeId":{"type":"string"},"effectiveDate":{"format":"date-time","type":"string"},"ethnicIdCode":{"type":"string"},"healthCareId":{"type":"string"},"isAboriginal":{"type":"string"},"nationalId":{"type":"string"},"nationalIdExpirationDate":{"format":"date-time","type":"string"},"oldNationalId":{"type":"string"},"oldNationalIdExpirationDate":{"format":"date-time","type":"string"},"userDefinedField1":{"type":"string"},"userDefinedField2":{"type":"string"},"userDefinedField3":{"format":"float","type":"number"},"userDefinedField4":{"format":"float","type":"number"},"userDefinedField5":{"format":"date-time","type":"string"},"userDefinedField6":{"format":"date-time","type":"string"},"userDefinedField7":{"type":"string"},"userDefinedField8":{"type":"string"},"userDefinedField9":{"type":"string"},"userDefinedField10":{"format":"float","type":"number"},"userDefinedField11":{"format":"float","type":"number"},"userDefinedField12":{"format":"date-time","type":"string"},"userDefinedField13":{"format":"date-time","type":"string"},"userDefinedField14":{"type":"string"},"currencyCode":{"type":"string"},"isMilitaryReserve":{"type":"string"},"isMilitaryServiceCompleted":{"type":"string"},"medicalRegionCode":{"type":"string"}}},"UserDefinedFields":{"type":"object","properties":{"employeeId":{"type":"string"},"personnelUserDefinedFields":{"type":"object","properties":{"personnelUDField01":{"type":"object","properties":{"field":{"type":"string"},"value":{"type":"string"}}},"personnelUDField02":{"type":"object","properties":{"field":{"type":"string"},"value":{"type":"string"}}},"personnelUDField03":{"type":"object","properties":{"field":{"type":"string"},"value":{"format":"double","type":"number"}}},"personnelUDField04":{"type":"object","properties":{"field":{"type":"string"},"value":{"format":"double","type":"number"}}},"personnelUDField05":{"type":"object","properties":{"field":{"type":"string"},"value":{"format":"date-time","type":"string"}}},"personnelUDField06":{"type":"object","properties":{"field":{"type":"string"},"value":{"format":"date-time","type":"string"}}},"personnelUDField07":{"type":"object","properties":{"field":{"type":"string"},"value":{"type":"string"}}},"personnelUDField08":{"type":"object","properties":{"field":{"type":"string"},"value":{"type":"string"}}},"personnelUDField09":{"type":"object","properties":{"field":{"type":"string"},"value":{"type":"string"}}},"personnelUDField10":{"type":"object","properties":{"field":{"type":"string"},"value":{"format":"double","type":"number"}}},"personnelUDField11":{"type":"object","properties":{"field":{"type":"string"},"value":{"format":"double","type":"number"}}},"personnelUDField12":{"type":"object","properties":{"field":{"type":"string"},"value":{"format":"date-time","type":"string"}}},"personnelUDField13":{"type":"object","properties":{"field":{"type":"string"},"value":{"format":"date-time","type":"string"}}},"personnelUDField14":{"type":"object","properties":{"field":{"type":"string"},"value":{"type":"string"}}}}},"internationalUserDefinedFields":{"type":"object","properties":{"internationalUDField01":{"type":"object","properties":{"field":{"type":"string"},"value":{"type":"string"}}},"internationalUDField02":{"type":"object","properties":{"field":{"type":"string"},"value":{"type":"string"}}},"internationalUDField03":{"type":"object","properties":{"field":{"type":"string"},"value":{"format":"double","type":"number"}}},"internationalUDField04":{"type":"object","properties":{"field":{"type":"string"},"value":{"format":"double","type":"number"}}},"internationalUDField05":{"type":"object","properties":{"field":{"type":"string"},"value":{"format":"date-time","type":"string"}}},"internationalUDField06":{"type":"object","properties":{"field":{"type":"string"},"value":{"format":"date-time","type":"string"}}},"internationalUDField07":{"type":"object","properties":{"field":{"type":"string"},"value":{"type":"string"}}},"internationalUDField08":{"type":"object","properties":{"field":{"type":"string"},"value":{"type":"string"}}},"internationalUDField09":{"type":"object","properties":{"field":{"type":"string"},"value":{"type":"string"}}},"internationalUDField10":{"type":"object","properties":{"field":{"type":"string"},"value":{"format":"double","type":"number"}}},"internationalUDField11":{"type":"object","properties":{"field":{"type":"string"},"value":{"format":"double","type":"number"}}},"internationalUDField12":{"type":"object","properties":{"field":{"type":"string"},"value":{"format":"date-time","type":"string"}}},"internationalUDField13":{"type":"object","properties":{"field":{"type":"string"},"value":{"format":"date-time","type":"string"}}},"internationalUDField14":{"type":"object","properties":{"field":{"type":"string"},"value":{"type":"string"}}}}}}},"pto-plans":{"type":"object","required":["employeeId","companyId","ptoPlan"],"properties":{"employeeId":{"type":"string","description":"Employee Identifier"},"companyId":{"type":"string","description":"Company Identifier"},"ptoPlan":{"type":"string","description":"PTO Plan Identifier"},"earned":{"type":"number","format":"double","description":"Amount of hours earned for PTO"},"taken":{"type":"number","format":"double","description":"Amount of hours taken for PTO"},"pendingBalance":{"type":"number","format":"double","description":"Balance of PTO hours"},"earnedThroughDate":{"type":"string","description":"Date in which PTO is earned through, format should be YYYY-MM-DD"},"reset":{"type":"string","description":"Date in which the PTO reset's, format should be YYYY-MM-DD"},"pendingMoveDate":{"type":"string","description":"Date to be used if pending rules are relevant, format should be YYYY-MM-DD"}}},"pto-plans-body":{"type":"array","items":{"type":"object","required":["employeeId","companyId","ptoPlan"],"properties":{"employeeId":{"type":"string","description":"Employee Identifier"},"companyId":{"type":"string","description":"Company Identifier"},"ptoPlan":{"type":"string","description":"PTO Plan Identifier"},"earned":{"type":"number","format":"double","description":"Amount of hours earned for PTO"},"taken":{"type":"number","format":"double","description":"Amount of hours taken for PTO"},"pendingBalance":{"type":"number","format":"double","description":"Balance of PTO hours"},"earnedThroughDate":{"type":"string","description":"Date in which PTO is earned through, format should be YYYY-MM-DD"},"reset":{"type":"string","description":"Date in which the PTO reset's, format should be YYYY-MM-DD"},"pendingMoveDate":{"type":"string","description":"Date to be used if pending rules are relevant, format should be YYYY-MM-DD"}}}},"MultiStatusResponse":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"detail":{"type":"string"},"errorCount":{"type":"number"},"multistatus":{"type":"array","items":{"properties":{"sequenceId":{"type":"number"},"status":{"description":"http status","type":"string"},"modelstate":{"description":"Only present if status is error","type":"object","properties":{"property-name":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string"}}}}}},"body":{"description":"Only present if status is success","type":"object","properties":{"schema":{"$ref":"#/components/schemas/pto-plans"}}}}}}}},"UserPreferencesDetails":{"type":"object","properties":{"userId":{"type":"string"},"languageCode":{"type":"string"},"dateTimeFormat":{"type":"string"}}},"EmpPersonDetails":{"type":"object","properties":{"additionalName1":{"type":"string"},"additionalName2":{"type":"string"},"addressId":{"format":"uuid","type":"string","example":"00000000-0000-0000-0000-000000000000"},"addressIsOnTaxBoundary":{"type":"boolean"},"addressLatitude":{"format":"double","type":"number"},"cobraExport":{"type":"string"},"cobraIsActive":{"type":"boolean"},"cobraReason":{"type":"string"},"cobraStatus":{"type":"string"},"cobraStatusDate":{"format":"date-time","type":"string"},"communityBroadcastSmsCode":{"type":"string"},"consentElectronicW2":{"type":"boolean"},"consentElectronicw2pr":{"type":"boolean"},"dateDeceased":{"format":"date-time","type":"string"},"dateOfCobraEvent":{"format":"date-time","type":"string"},"dateOfCobraExport":{"format":"date-time","type":"string"},"dateOfCobraLetter":{"format":"date-time","type":"string"},"dateOfI9Expiration":{"format":"date-time","type":"string"},"datetimeChanged":{"format":"date-time","type":"string"},"datetimeCreated":{"format":"date-time","type":"string"},"disabilityType":{"type":"string"},"ethnicDescription":{"type":"string"},"formerName":{"type":"string"},"healthBloodType":{"type":"string"},"healthEyes":{"type":"string"},"healthHair":{"type":"string"},"healthHeightFeet":{"type":"string"},"healthHeightInches":{"type":"string"},"healthLastDonateDate":{"format":"date-time","type":"string"},"healthWeight":{"format":"float","type":"number"},"i9AlienNumber":{"type":"string"},"i9DocA":{"type":"string"},"i9DocB":{"type":"string"},"i9DocC":{"type":"string"},"i9Verified":{"type":"boolean"},"i9VisaType":{"type":"string"},"i9WorkAuth":{"type":"string"},"isDisabled":{"type":"boolean"},"isMultiPayGroup":{"type":"boolean"},"isSmoker":{"type":"boolean"},"militaryService":{"type":"boolean"},"militaryBranchServed":{"type":"string"},"militaryEra":{"type":"string"},"militaryIsDisabledVet":{"type":"string"},"militaryIsOthEligVet":{"type":"string"},"militaryIsOthEligVetBasis":{"type":"string"},"militaryIsActiveWartimeVet":{"type":"string"},"nameFormer":{"type":"string"},"previousSSN":{"type":"string"},"originCountry":{"type":"string"},"originLocation":{"type":"string"},"w2IsDeceased":{"type":"boolean"},"cobraNotes":{"type":"string"},"addressSms":{"type":"string"},"militarySeparationDate":{"format":"date-time","type":"string"},"homePhoneIsPrivate":{"type":"boolean"},"smsApprovals":{"type":"boolean"},"smsPayNotification":{"type":"boolean"},"i9VisaExpirationDate":{"format":"date-time","type":"string"},"militaryIsMedalVet":{"type":"string"},"lastNameNotSameAsSSCard":{"type":"string"},"chkCashingInstCode":{"type":"string"},"nationality1":{"type":"string"},"nationality2":{"type":"string"},"nationality3":{"type":"string"},"personId":{"format":"uuid","type":"string","example":"00000000-0000-0000-0000-000000000000"},"employeeId":{"type":"string"},"companyId":{"type":"string"},"userName":{"type":"string"},"firstName":{"type":"string"},"middleName":{"type":"string"},"lastName":{"type":"string"},"preferredName":{"type":"string"},"namePrefixCode":{"type":"string"},"nameSufixCode":{"type":"string"},"emailAddress":{"type":"string"},"emailAddressAlternate":{"type":"string"},"homePhone":{"type":"string"},"homePhoneCountry":{"type":"string"},"addressLine1":{"type":"string"},"addressLine2":{"type":"string"},"addressCity":{"type":"string"},"addressState":{"type":"string"},"addressZipCode":{"type":"string"},"addressCountry":{"type":"string"},"addressCounty":{"type":"string"},"nationalId":{"type":"string"},"nationalIdCountry":{"type":"string"},"dateOfBirth":{"format":"date-time","type":"string"},"gender":{"type":"string"},"ethnicIDCode":{"type":"string"},"maritalStatusCode":{"type":"string"},"ssn":{"type":"string"},"ssnIsSuppressed":{"type":"boolean"}}},"DependentDeductions":{"type":"object","properties":{"benefitAmount":{"type":"number"},"benefitStartDate":{"type":"string","format":"date-time"},"benefitStatus":{"type":"string"},"benefitStatusDate":{"type":"string","format":"date-time"},"benefitStopDate":{"type":"string","format":"date-time"},"certificateNo":{"type":"string"},"companyID":{"type":"string"},"contactID":{"type":"string"},"currentCOID":{"type":"string"},"dateTimeChanged":{"type":"string","format":"date-time"},"dateTimeCreated":{"type":"string","format":"date-time"},"declinedByCarrierDate":{"type":"string","format":"date-time"},"deductionCode":{"type":"string"},"deductionNotes":{"type":"string"},"deductionType":{"type":"string"},"declinedByCarrier":{"type":"string"},"declinedByCarrierReason":{"type":"string"},"depBPlanTVID":{"type":"integer"},"systemID":{"type":"string"},"employeeId":{"type":"string"},"eoiDate":{"type":"string","format":"date-time"},"needEOI":{"type":"boolean"},"primaryCarePhysician":{"type":"string"},"primaryCarePhysicianId":{"type":"string"},"isBenefitWaived":{"type":"boolean"}}},"EmpDeductions":{"type":"object","properties":{"employeeId":{"type":"string"},"companyId":{"type":"string"},"dedCode":{"type":"string"},"benStatus":{"type":"string"},"benefitOption":{"type":"string"},"endDateTime":{"format":"date-time","type":"string"},"page":{"type":"integer"},"per_Page":{"type":"integer"}}}},"parameters":{"authorizationHeaders":{"description":"The Pro Customer API key which is unique to each Pro HR Tenant and can be found by navigating to System Configuration > Security > Web Services and referring to the value for `Customer API Key`.","in":"header","name":"US-CUSTOMER-API-KEY","schema":{"type":"string"},"required":true},"usCustomerApiKey":{"description":"The Pro Customer API key which is unique to each Pro HR Tenant and can be found by navigating to System Configuration > Security > Web Services and referring to the value for `Customer API Key`.","in":"header","name":"us-customer-api-key","schema":{"type":"string"},"required":true},"usClientId":{"in":"header","name":"us-client-id","description":"The Pro Customer primary company code which is unique to each Pro HR Tenant and can be found by navigating to System Configuration > Company Setup and referring to the value for Primary Company Code.","required":true,"schema":{"type":"string"}}}},"x-explorer-enabled":false,"security":[{"basicAuth":[]}]}