Updates a benefit category
PUT https://api.yourpayroll.co.uk/api/v2/business/{businessId}/benefitcategory
| Parameter name | Value | Description | Additional |
|---|---|---|---|
| businessId | string | Required |
The request body takes a complete UkBenefitCategoryReadModel resource, containing the following writable properties:
{
"amountForegone": "double",
"benefitType": "string",
"car": {
"approvedCO2Emissions": "int32",
"dateRegistered": "date-time",
"engineSize": "string",
"fuelType": "string",
"makeAndModel": "string",
"noApprovedCO2Figure": "boolean",
"registrationNumber": "string",
"zeroEmissionMileage": "int32"
},
"carryBenefitForward": "boolean",
"description": "string",
"entertainment": {
"isTradingOrganisation": "boolean"
},
"id": "int32",
"linkedEmployees": [
{
"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": "string",
"niTreatment": "string",
"payrollingBenefit": "boolean",
"subType": "string",
"van": {
"isZeroEmissions": "boolean"
},
"year": "int32"
}| Name | Type | Description |
|---|---|---|
| amountForegone | double |
Nullable |
| benefitType | string | String |
| car | object | UkBenefitCategoryExtCarEditModel |
| car.approvedCO2Emissions | int32 |
Nullable |
| car.dateRegistered | date-time |
Nullable |
| car.engineSize | string | String |
| car.fuelType | string | String |
| car.makeAndModel | string | String |
| car.noApprovedCO2Figure | boolean | Boolean |
| car.registrationNumber | string | String |
| car.zeroEmissionMileage | int32 |
Nullable |
| carryBenefitForward | boolean | Boolean |
| description | string | String |
| entertainment | object | UkBenefitCategoryExtEntertainmentEditModel |
| entertainment.isTradingOrganisation | boolean | Boolean |
| id | int32 | Int32 |
| linkedEmployees[] | array | |
| linkedEmployees[].additionalAmountPayrolledToDateInPayRuns | double |
Nullable |
| linkedEmployees[].additionalHasFinalisedPayRuns | boolean | Boolean |
| linkedEmployees[].additionalHasLinkedPayRuns | boolean | Boolean |
| linkedEmployees[].amountForegone | double | Decimal |
| linkedEmployees[].amountMadeGood | double | Decimal |
| linkedEmployees[].amountPayrolledToDate | double | Decimal |
| linkedEmployees[].amountPayrolledToDateInPayRuns | double |
Nullable |
| linkedEmployees[].amountToBePayrolledPerPeriod | double | Decimal |
| linkedEmployees[].benefitCategoryId | int32 |
Nullable |
| linkedEmployees[].benefitCategoryName | string | String |
| linkedEmployees[].benefitCategorySubType | string | String |
| linkedEmployees[].benefitCategoryType | string | String |
| linkedEmployees[].calculationLogs[] | array of string | |
| linkedEmployees[].car | object | UkEmployeeBenefitCategoryExtCarEditModel |
| linkedEmployees[].car.accessories | double | Decimal |
| linkedEmployees[].car.amountPaidByEmployeeForPrivateUse | double | Decimal |
| linkedEmployees[].car.availableFromDate | date-time | DateTime |
| linkedEmployees[].car.availableToDate | date-time |
Nullable |
| linkedEmployees[].car.capitalContributions | double | Decimal |
| linkedEmployees[].car.employerProvidesFuelForPrivateUse | boolean | Boolean |
| linkedEmployees[].car.fuel | object | UkEmployeeBenefitCategoryExtFuelEditModel |
| linkedEmployees[].car.fuel.amountPayrolledToDate | double | Decimal |
| linkedEmployees[].car.fuel.amountToBePayrolledPerPeriod | double | Decimal |
| linkedEmployees[].car.fuel.availableFromDate | date-time |
Nullable |
| linkedEmployees[].car.fuel.availableToDate | date-time |
Nullable |
| linkedEmployees[].car.fuel.cashEquivalent | double | Decimal |
| linkedEmployees[].car.fuel.opraAmountForegone | double |
Nullable |
| linkedEmployees[].car.fuel.proRataInFirstPayRun | boolean | Boolean |
| linkedEmployees[].car.fuel.reinstated | boolean |
Nullable |
| linkedEmployees[].car.fuel.startFromPeriod | int32 | Int32 |
| linkedEmployees[].car.isShared | boolean | Boolean |
| linkedEmployees[].car.numberOfDaysUnavailable | int32 |
Nullable |
| linkedEmployees[].car.opraAmountForegone | double |
Nullable |
| linkedEmployees[].car.sharedPercentage | double |
Nullable |
| linkedEmployees[].carryBenefitForward | boolean | Boolean |
| linkedEmployees[].cashEquivalent | double | Decimal |
| linkedEmployees[].dateCreatedUtc | date-time | DateTime |
| linkedEmployees[].employeeId | int32 | Int32 |
| linkedEmployees[].employeeName | string | String |
| linkedEmployees[].hasBeenSubmitted | boolean | Boolean |
| linkedEmployees[].hasFinalisedPayRuns | boolean | Boolean |
| linkedEmployees[].hasLinkedPayRuns | boolean | Boolean |
| linkedEmployees[].id | int32 | Int32 |
| linkedEmployees[].loan | object | UkEmployeeBenefitCategoryExtLoanEditModel |
| linkedEmployees[].loan.amountForegoneUserEntered | double |
Nullable |
| linkedEmployees[].loan.amountOutstandingAtEndOfYearOrLoan | double | Decimal |
| linkedEmployees[].loan.amountOutstandingAtStartOfYearOrLoan | double | Decimal |
| linkedEmployees[].loan.dateLoanWasDischargedIfThisYear | date-time |
Nullable |
| linkedEmployees[].loan.dateLoanWasMadeIfThisYear | date-time |
Nullable |
| linkedEmployees[].loan.interestDue | double | Decimal |
| linkedEmployees[].loan.interestRate | double | Decimal |
| linkedEmployees[].loan.maximumAmountOutstandingDuringTheYear | double | Decimal |
| linkedEmployees[].loan.numberOfJointBorrowers | int32 |
Nullable |
| linkedEmployees[].payrollingBenefit | boolean | Boolean |
| linkedEmployees[].proRataCalculation | object | UkEmployeeBenefitProRataCalculationModel |
| linkedEmployees[].proRataCalculation.endDate | date-time |
Nullable |
| linkedEmployees[].proRataCalculation.fullYearAmount | double |
Nullable |
| linkedEmployees[].proRataCalculation.proRataInFirstPayRun | boolean | Boolean |
| linkedEmployees[].proRataCalculation.startDate | date-time | DateTime |
| linkedEmployees[].proRataCalculation.useCalculatedValue | boolean |
Nullable |
| linkedEmployees[].startFromPeriod | int32 | Int32 |
| linkedEmployees[].van | object | UkEmployeeBenefitCategoryExtVanEditModel |
| linkedEmployees[].van.amountPaidByEmployeeForPrivateUse | double | Decimal |
| linkedEmployees[].van.availableFromDate | date-time | DateTime |
| linkedEmployees[].van.availableToDate | date-time |
Nullable |
| linkedEmployees[].van.employerProvidesFuelForPrivateUse | boolean | Boolean |
| linkedEmployees[].van.fuel | object | UkEmployeeBenefitCategoryExtVanFuelEditModel |
| linkedEmployees[].van.fuel.amountForegone | double | Decimal |
| linkedEmployees[].van.fuel.amountPayrolledToDate | double | Decimal |
| linkedEmployees[].van.fuel.amountToBePayrolledPerPeriod | double | Decimal |
| linkedEmployees[].van.fuel.availableToDate | date-time |
Nullable |
| linkedEmployees[].van.fuel.cashEquivalent | double | Decimal |
| linkedEmployees[].van.fuel.opraAmountForegone | double |
Nullable |
| linkedEmployees[].van.fuel.proRataInFirstPayRun | boolean | Boolean |
| linkedEmployees[].van.fuel.startFromPeriod | int32 | Int32 |
| linkedEmployees[].van.isShared | boolean | Boolean |
| linkedEmployees[].van.numberOfDaysUnavailable | int32 |
Nullable |
| linkedEmployees[].van.opraAmountForegone | double |
Nullable |
| linkedEmployees[].van.sharedPercentage | double |
Nullable |
| linkedEmployees[].year | int32 | Int32 |
| name | string | String |
| niTreatment | string | String |
| payrollingBenefit | boolean | Boolean |
| subType | string | String |
| van | object | UkBenefitCategoryExtVanEditModel |
| van.isZeroEmissions | boolean | Boolean |
| year | int32 |
Nullable |
The following HTTP status codes may be returned, optionally with a response resource.
| Status code | Description | Resource |
|---|---|---|
| 200 | OK OK |
UkUpdateBenefitCategoryResult |