- post - Create employee benefit
{
"amountForegone": "double",
"amountMadeGood": "double",
"amountPayrolledToDate": "double",
"amountToBePayrolledPerPeriod": "double",
"benefitCategoryId": "int32",
"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",
"employeeId": "int32",
"loan": {
"amountForegoneUserEntered": "double",
"amountOutstandingAtEndOfYearOrLoan": "double",
"amountOutstandingAtStartOfYearOrLoan": "double",
"dateLoanWasDischargedIfThisYear": "date-time",
"dateLoanWasMadeIfThisYear": "date-time",
"interestDue": "double",
"interestRate": "double",
"maximumAmountOutstandingDuringTheYear": "double",
"numberOfJointBorrowers": "int32"
},
"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 |
amountForegone
|
double |
Decimal
|
amountMadeGood
|
double |
Decimal
|
amountPayrolledToDate
|
double |
Decimal
|
amountToBePayrolledPerPeriod
|
double |
Decimal
|
benefitCategoryId
|
int32 |
Nullable
|
car
|
object |
UkEmployeeBenefitCategoryExtCarEditModel
|
car.accessories
|
double |
Decimal
|
car.amountPaidByEmployeeForPrivateUse
|
double |
Decimal
|
car.availableFromDate
|
date-time |
DateTime
|
car.availableToDate
|
date-time |
Nullable
|
car.capitalContributions
|
double |
Decimal
|
car.employerProvidesFuelForPrivateUse
|
boolean |
Boolean
|
car.fuel
|
object |
UkEmployeeBenefitCategoryExtFuelEditModel
|
car.fuel.amountPayrolledToDate
|
double |
Decimal
|
car.fuel.amountToBePayrolledPerPeriod
|
double |
Decimal
|
car.fuel.availableFromDate
|
date-time |
Nullable
|
car.fuel.availableToDate
|
date-time |
Nullable
|
car.fuel.cashEquivalent
|
double |
Decimal
|
car.fuel.opraAmountForegone
|
double |
Nullable
|
car.fuel.proRataInFirstPayRun
|
boolean |
Boolean
|
car.fuel.reinstated
|
boolean |
Nullable
|
car.fuel.startFromPeriod
|
int32 |
Int32
|
car.isShared
|
boolean |
Boolean
|
car.numberOfDaysUnavailable
|
int32 |
Nullable
|
car.opraAmountForegone
|
double |
Nullable
|
car.sharedPercentage
|
double |
Nullable
|
carryBenefitForward
|
boolean |
Boolean
|
cashEquivalent
|
double |
Decimal
|
employeeId
|
int32 |
Int32
|
loan
|
object |
UkEmployeeBenefitCategoryExtLoanEditModel
|
loan.amountForegoneUserEntered
|
double |
Nullable
|
loan.amountOutstandingAtEndOfYearOrLoan
|
double |
Decimal
|
loan.amountOutstandingAtStartOfYearOrLoan
|
double |
Decimal
|
loan.dateLoanWasDischargedIfThisYear
|
date-time |
Nullable
|
loan.dateLoanWasMadeIfThisYear
|
date-time |
Nullable
|
loan.interestDue
|
double |
Decimal
|
loan.interestRate
|
double |
Decimal
|
loan.maximumAmountOutstandingDuringTheYear
|
double |
Decimal
|
loan.numberOfJointBorrowers
|
int32 |
Nullable
|
proRataCalculation
|
object |
UkEmployeeBenefitProRataCalculationModel
|
proRataCalculation.endDate
|
date-time |
Nullable
|
proRataCalculation.fullYearAmount
|
double |
Nullable
|
proRataCalculation.proRataInFirstPayRun
|
boolean |
Boolean
|
proRataCalculation.startDate
|
date-time |
DateTime
|
proRataCalculation.useCalculatedValue
|
boolean |
Nullable
|
startFromPeriod
|
int32 |
Int32
|
van
|
object |
UkEmployeeBenefitCategoryExtVanEditModel
|
van.amountPaidByEmployeeForPrivateUse
|
double |
Decimal
|
van.availableFromDate
|
date-time |
DateTime
|
van.availableToDate
|
date-time |
Nullable
|
van.employerProvidesFuelForPrivateUse
|
boolean |
Boolean
|
van.fuel
|
object |
UkEmployeeBenefitCategoryExtVanFuelEditModel
|
van.fuel.amountForegone
|
double |
Decimal
|
van.fuel.amountPayrolledToDate
|
double |
Decimal
|
van.fuel.amountToBePayrolledPerPeriod
|
double |
Decimal
|
van.fuel.availableToDate
|
date-time |
Nullable
|
van.fuel.cashEquivalent
|
double |
Decimal
|
van.fuel.opraAmountForegone
|
double |
Nullable
|
van.fuel.proRataInFirstPayRun
|
boolean |
Boolean
|
van.fuel.startFromPeriod
|
int32 |
Int32
|
van.isShared
|
boolean |
Boolean
|
van.numberOfDaysUnavailable
|
int32 |
Nullable
|
van.opraAmountForegone
|
double |
Nullable
|
van.sharedPercentage
|
double |
Nullable
|
year
|
int32 |
Int32
|