- get - List employee benefits
{
"benefitCategories": [
{
"additionalAmountPayrolledToDateInPayRuns": "double",
"additionalHasFinalisedPayRuns": "boolean",
"additionalHasLinkedPayRuns": "boolean",
"amountForegone": "double",
"amountMadeGood": "double",
"amountPayrolledToDate": "double",
"amountPayrolledToDateInPayRuns": "double",
"amountToBePayrolledPerPeriod": "double",
"benefitCategoryId": "int32",
"benefitCategoryName": "string",
"benefitCategorySubType": "string",
"benefitCategoryType": "string",
"calculationLogs": [
"string"
],
"car": {
"accessories": "double",
"amountPaidByEmployeeForPrivateUse": "double",
"availableFromDate": "date-time",
"availableToDate": "date-time",
"capitalContributions": "double",
"employerProvidesFuelForPrivateUse": "boolean",
"fuel": {
"amountPayrolledToDate": "double",
"amountToBePayrolledPerPeriod": "double",
"availableFromDate": "date-time",
"availableToDate": "date-time",
"cashEquivalent": "double",
"opraAmountForegone": "double",
"proRataInFirstPayRun": "boolean",
"reinstated": "boolean",
"startFromPeriod": "int32"
},
"isShared": "boolean",
"numberOfDaysUnavailable": "int32",
"opraAmountForegone": "double",
"sharedPercentage": "double"
},
"carryBenefitForward": "boolean",
"cashEquivalent": "double",
"dateCreatedUtc": "date-time",
"employeeId": "int32",
"employeeName": "string",
"hasBeenSubmitted": "boolean",
"hasFinalisedPayRuns": "boolean",
"hasLinkedPayRuns": "boolean",
"id": "int32",
"loan": {
"amountForegoneUserEntered": "double",
"amountOutstandingAtEndOfYearOrLoan": "double",
"amountOutstandingAtStartOfYearOrLoan": "double",
"dateLoanWasDischargedIfThisYear": "date-time",
"dateLoanWasMadeIfThisYear": "date-time",
"interestDue": "double",
"interestRate": "double",
"maximumAmountOutstandingDuringTheYear": "double",
"numberOfJointBorrowers": "int32"
},
"payrollingBenefit": "boolean",
"proRataCalculation": {
"endDate": "date-time",
"fullYearAmount": "double",
"proRataInFirstPayRun": "boolean",
"startDate": "date-time",
"useCalculatedValue": "boolean"
},
"startFromPeriod": "int32",
"van": {
"amountPaidByEmployeeForPrivateUse": "double",
"availableFromDate": "date-time",
"availableToDate": "date-time",
"employerProvidesFuelForPrivateUse": "boolean",
"fuel": {
"amountForegone": "double",
"amountPayrolledToDate": "double",
"amountToBePayrolledPerPeriod": "double",
"availableToDate": "date-time",
"cashEquivalent": "double",
"opraAmountForegone": "double",
"proRataInFirstPayRun": "boolean",
"startFromPeriod": "int32"
},
"isShared": "boolean",
"numberOfDaysUnavailable": "int32",
"opraAmountForegone": "double",
"sharedPercentage": "double"
},
"year": "int32"
}
]
}
Name |
Type |
Description |
benefitCategories[]
|
array |
|
benefitCategories[].additionalAmountPayrolledToDateInPayRuns
|
double |
Nullable
|
benefitCategories[].additionalHasFinalisedPayRuns
|
boolean |
Boolean
|
benefitCategories[].additionalHasLinkedPayRuns
|
boolean |
Boolean
|
benefitCategories[].amountForegone
|
double |
Decimal
|
benefitCategories[].amountMadeGood
|
double |
Decimal
|
benefitCategories[].amountPayrolledToDate
|
double |
Decimal
|
benefitCategories[].amountPayrolledToDateInPayRuns
|
double |
Nullable
|
benefitCategories[].amountToBePayrolledPerPeriod
|
double |
Decimal
|
benefitCategories[].benefitCategoryId
|
int32 |
Nullable
|
benefitCategories[].benefitCategoryName
|
string |
String
|
benefitCategories[].benefitCategorySubType
|
string |
String
|
benefitCategories[].benefitCategoryType
|
string |
String
|
benefitCategories[].calculationLogs[]
|
array of string |
|
benefitCategories[].car
|
object |
UkEmployeeBenefitCategoryExtCarEditModel
|
benefitCategories[].car.accessories
|
double |
Decimal
|
benefitCategories[].car.amountPaidByEmployeeForPrivateUse
|
double |
Decimal
|
benefitCategories[].car.availableFromDate
|
date-time |
DateTime
|
benefitCategories[].car.availableToDate
|
date-time |
Nullable
|
benefitCategories[].car.capitalContributions
|
double |
Decimal
|
benefitCategories[].car.employerProvidesFuelForPrivateUse
|
boolean |
Boolean
|
benefitCategories[].car.fuel
|
object |
UkEmployeeBenefitCategoryExtFuelEditModel
|
benefitCategories[].car.fuel.amountPayrolledToDate
|
double |
Decimal
|
benefitCategories[].car.fuel.amountToBePayrolledPerPeriod
|
double |
Decimal
|
benefitCategories[].car.fuel.availableFromDate
|
date-time |
Nullable
|
benefitCategories[].car.fuel.availableToDate
|
date-time |
Nullable
|
benefitCategories[].car.fuel.cashEquivalent
|
double |
Decimal
|
benefitCategories[].car.fuel.opraAmountForegone
|
double |
Nullable
|
benefitCategories[].car.fuel.proRataInFirstPayRun
|
boolean |
Boolean
|
benefitCategories[].car.fuel.reinstated
|
boolean |
Nullable
|
benefitCategories[].car.fuel.startFromPeriod
|
int32 |
Int32
|
benefitCategories[].car.isShared
|
boolean |
Boolean
|
benefitCategories[].car.numberOfDaysUnavailable
|
int32 |
Nullable
|
benefitCategories[].car.opraAmountForegone
|
double |
Nullable
|
benefitCategories[].car.sharedPercentage
|
double |
Nullable
|
benefitCategories[].carryBenefitForward
|
boolean |
Boolean
|
benefitCategories[].cashEquivalent
|
double |
Decimal
|
benefitCategories[].dateCreatedUtc
|
date-time |
DateTime
|
benefitCategories[].employeeId
|
int32 |
Int32
|
benefitCategories[].employeeName
|
string |
String
|
benefitCategories[].hasBeenSubmitted
|
boolean |
Boolean
|
benefitCategories[].hasFinalisedPayRuns
|
boolean |
Boolean
|
benefitCategories[].hasLinkedPayRuns
|
boolean |
Boolean
|
benefitCategories[].id
|
int32 |
Int32
|
benefitCategories[].loan
|
object |
UkEmployeeBenefitCategoryExtLoanEditModel
|
benefitCategories[].loan.amountForegoneUserEntered
|
double |
Nullable
|
benefitCategories[].loan.amountOutstandingAtEndOfYearOrLoan
|
double |
Decimal
|
benefitCategories[].loan.amountOutstandingAtStartOfYearOrLoan
|
double |
Decimal
|
benefitCategories[].loan.dateLoanWasDischargedIfThisYear
|
date-time |
Nullable
|
benefitCategories[].loan.dateLoanWasMadeIfThisYear
|
date-time |
Nullable
|
benefitCategories[].loan.interestDue
|
double |
Decimal
|
benefitCategories[].loan.interestRate
|
double |
Decimal
|
benefitCategories[].loan.maximumAmountOutstandingDuringTheYear
|
double |
Decimal
|
benefitCategories[].loan.numberOfJointBorrowers
|
int32 |
Nullable
|
benefitCategories[].payrollingBenefit
|
boolean |
Boolean
|
benefitCategories[].proRataCalculation
|
object |
UkEmployeeBenefitProRataCalculationModel
|
benefitCategories[].proRataCalculation.endDate
|
date-time |
Nullable
|
benefitCategories[].proRataCalculation.fullYearAmount
|
double |
Nullable
|
benefitCategories[].proRataCalculation.proRataInFirstPayRun
|
boolean |
Boolean
|
benefitCategories[].proRataCalculation.startDate
|
date-time |
DateTime
|
benefitCategories[].proRataCalculation.useCalculatedValue
|
boolean |
Nullable
|
benefitCategories[].startFromPeriod
|
int32 |
Int32
|
benefitCategories[].van
|
object |
UkEmployeeBenefitCategoryExtVanEditModel
|
benefitCategories[].van.amountPaidByEmployeeForPrivateUse
|
double |
Decimal
|
benefitCategories[].van.availableFromDate
|
date-time |
DateTime
|
benefitCategories[].van.availableToDate
|
date-time |
Nullable
|
benefitCategories[].van.employerProvidesFuelForPrivateUse
|
boolean |
Boolean
|
benefitCategories[].van.fuel
|
object |
UkEmployeeBenefitCategoryExtVanFuelEditModel
|
benefitCategories[].van.fuel.amountForegone
|
double |
Decimal
|
benefitCategories[].van.fuel.amountPayrolledToDate
|
double |
Decimal
|
benefitCategories[].van.fuel.amountToBePayrolledPerPeriod
|
double |
Decimal
|
benefitCategories[].van.fuel.availableToDate
|
date-time |
Nullable
|
benefitCategories[].van.fuel.cashEquivalent
|
double |
Decimal
|
benefitCategories[].van.fuel.opraAmountForegone
|
double |
Nullable
|
benefitCategories[].van.fuel.proRataInFirstPayRun
|
boolean |
Boolean
|
benefitCategories[].van.fuel.startFromPeriod
|
int32 |
Int32
|
benefitCategories[].van.isShared
|
boolean |
Boolean
|
benefitCategories[].van.numberOfDaysUnavailable
|
int32 |
Nullable
|
benefitCategories[].van.opraAmountForegone
|
double |
Nullable
|
benefitCategories[].van.sharedPercentage
|
double |
Nullable
|
benefitCategories[].year
|
int32 |
Int32
|