Updates an existing employee benefit

Request

PUT https://api.yourpayroll.co.uk/api/v2/business/{businessId}/employee/{employeeId}/benefit

Path parameters

Parameter name Value Description Additional
businessId string Required
employeeId string Required

Request body

The request body takes a complete UkEmployeeBenefitCategoryModel resource, containing the following writable properties:

{
    "additionalAmountPayrolledToDateInPayRuns": "double",
    "additionalHasFinalisedPayRuns": "boolean",
    "additionalHasLinkedPayRuns": "boolean",
    "amountForegone": "double",
    "amountMadeGood": "double",
    "amountPayrolledToDate": "double",
    "amountPayrolledToDateInPayRuns": "double",
    "amountToBePayrolledPerPeriod": "double",
    "benefitCategoryId": "int32",
    "benefitCategoryName": "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",
    "employeeId": "int32",
    "employeeName": "string",
    "hasFinalisedPayRuns": "boolean",
    "hasLinkedPayRuns": "boolean",
    "id": "int32",
    "proRataCalculation": {
        "endDate": "date-time",
        "fullYearAmount": "double",
        "proRataInFirstPayRun": "boolean",
        "startDate": "date-time",
        "useCalculatedValue": "boolean"
    },
    "startFromPeriod": "int32",
    "year": "int32"
}

Properties

Name Type Description
additionalAmountPayrolledToDateInPayRuns double Nullable
additionalHasFinalisedPayRuns boolean Boolean
additionalHasLinkedPayRuns boolean Boolean
amountForegone double Decimal
amountMadeGood double Decimal
amountPayrolledToDate double Decimal
amountPayrolledToDateInPayRuns double Nullable
amountToBePayrolledPerPeriod double Decimal
benefitCategoryId int32 Nullable
benefitCategoryName string String
benefitCategoryType string String
calculationLogs[] array of string
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
employeeName string String
hasFinalisedPayRuns boolean Boolean
hasLinkedPayRuns boolean Boolean
id int32 Int32
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
year int32 Int32

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

OK

UkEmployeeBenefitCategoryModel