get https://{hostname}/personnel/v1/deduction-history-effective-change-dates
If no pagination parameters specified, the default/max is applied.
Permissions - UKG Pro service account must have "View" role for the "Personnel Integration" Api endpoints. Headers - US-Customer-Api-Key, Authorization (base64 encoded {username}:{password}).
fieldName is a required parameter that takes one of the following:
- changeReason
- benefitStartDate
- benefitStopDate
- benefitOption
- employeeAmount
- employeeBenefitAmount
- employeeGoalAmount
- eoiDesiredAmount
- eoiDesiredCalcRateOrPercent
- declinedByCarrier
- declinedByCarrierReason
- waiveReason
- deductionStartDate
- deductionStopDate
deductionCode is a required parameter that takes a list of codes [ded1,ded2].
CompanyId is an optional parameter that takes a list of IDs [coid1,coid2].
Correct syntax when using parameters are as follows:
- Get deductions history change date by single deduction code
- Example: /personnel/v1/deduction-history-effective-change-dates?fieldName={fieldName}&deductionCode={dedCode}
- Get deductions history change date by multiple deduction code
- Example: /personnel/v1/deduction-history-effective-change-dates?fieldName={fieldName}&deductionCode={dedCode1,dedCode2}
- Get deductions history change date multiple deduction code with multiple company
- Example: /personnel/v1/deduction-history-effective-change-dates?fieldName={fieldName}&deductionCode={dedCode1,dedCode2}&companyId={companyId1,companyId1}
- Get deductions history change date by sessionDate,deduction code and company
- Example: /personnel/v1/deduction-history-effective-change-dates?fieldName={fieldName}&sessionDate={sessionDate}deductionCode={deductionCode}&companyId={companyId}
- Get deductions history change date per page
- Example: /personnel/v1/deduction-history-effective-change-dates?fieldName={fieldName}&page=1&per_page=100