Methods

  • post - Create benefit categories

Resource

{
    "benefitCategories": [
        {
            "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"
        }
    ]
}

Properties

Name Type Description
benefitCategories[] array
benefitCategories[].amountForegone double Nullable
benefitCategories[].benefitType string String
benefitCategories[].car object UkBenefitCategoryExtCarEditModel
benefitCategories[].car.approvedCO2Emissions int32 Nullable
benefitCategories[].car.dateRegistered date-time Nullable
benefitCategories[].car.engineSize string String
benefitCategories[].car.fuelType string String
benefitCategories[].car.makeAndModel string String
benefitCategories[].car.noApprovedCO2Figure boolean Boolean
benefitCategories[].car.registrationNumber string String
benefitCategories[].car.zeroEmissionMileage int32 Nullable
benefitCategories[].carryBenefitForward boolean Boolean
benefitCategories[].description string String
benefitCategories[].entertainment object UkBenefitCategoryExtEntertainmentEditModel
benefitCategories[].entertainment.isTradingOrganisation boolean Boolean
benefitCategories[].id int32 Int32
benefitCategories[].linkedEmployees[] array
benefitCategories[].linkedEmployees[].additionalAmountPayrolledToDateInPayRuns double Nullable
benefitCategories[].linkedEmployees[].additionalHasFinalisedPayRuns boolean Boolean
benefitCategories[].linkedEmployees[].additionalHasLinkedPayRuns boolean Boolean
benefitCategories[].linkedEmployees[].amountForegone double Decimal
benefitCategories[].linkedEmployees[].amountMadeGood double Decimal
benefitCategories[].linkedEmployees[].amountPayrolledToDate double Decimal
benefitCategories[].linkedEmployees[].amountPayrolledToDateInPayRuns double Nullable
benefitCategories[].linkedEmployees[].amountToBePayrolledPerPeriod double Decimal
benefitCategories[].linkedEmployees[].benefitCategoryId int32 Nullable
benefitCategories[].linkedEmployees[].benefitCategoryName string String
benefitCategories[].linkedEmployees[].benefitCategorySubType string String
benefitCategories[].linkedEmployees[].benefitCategoryType string String
benefitCategories[].linkedEmployees[].calculationLogs[] array of string
benefitCategories[].linkedEmployees[].car object UkEmployeeBenefitCategoryExtCarEditModel
benefitCategories[].linkedEmployees[].car.accessories double Decimal
benefitCategories[].linkedEmployees[].car.amountPaidByEmployeeForPrivateUse double Decimal
benefitCategories[].linkedEmployees[].car.availableFromDate date-time DateTime
benefitCategories[].linkedEmployees[].car.availableToDate date-time Nullable
benefitCategories[].linkedEmployees[].car.capitalContributions double Decimal
benefitCategories[].linkedEmployees[].car.employerProvidesFuelForPrivateUse boolean Boolean
benefitCategories[].linkedEmployees[].car.fuel object UkEmployeeBenefitCategoryExtFuelEditModel
benefitCategories[].linkedEmployees[].car.fuel.amountPayrolledToDate double Decimal
benefitCategories[].linkedEmployees[].car.fuel.amountToBePayrolledPerPeriod double Decimal
benefitCategories[].linkedEmployees[].car.fuel.availableFromDate date-time Nullable
benefitCategories[].linkedEmployees[].car.fuel.availableToDate date-time Nullable
benefitCategories[].linkedEmployees[].car.fuel.cashEquivalent double Decimal
benefitCategories[].linkedEmployees[].car.fuel.opraAmountForegone double Nullable
benefitCategories[].linkedEmployees[].car.fuel.proRataInFirstPayRun boolean Boolean
benefitCategories[].linkedEmployees[].car.fuel.reinstated boolean Nullable
benefitCategories[].linkedEmployees[].car.fuel.startFromPeriod int32 Int32
benefitCategories[].linkedEmployees[].car.isShared boolean Boolean
benefitCategories[].linkedEmployees[].car.numberOfDaysUnavailable int32 Nullable
benefitCategories[].linkedEmployees[].car.opraAmountForegone double Nullable
benefitCategories[].linkedEmployees[].car.sharedPercentage double Nullable
benefitCategories[].linkedEmployees[].carryBenefitForward boolean Boolean
benefitCategories[].linkedEmployees[].cashEquivalent double Decimal
benefitCategories[].linkedEmployees[].dateCreatedUtc date-time DateTime
benefitCategories[].linkedEmployees[].employeeId int32 Int32
benefitCategories[].linkedEmployees[].employeeName string String
benefitCategories[].linkedEmployees[].hasBeenSubmitted boolean Boolean
benefitCategories[].linkedEmployees[].hasFinalisedPayRuns boolean Boolean
benefitCategories[].linkedEmployees[].hasLinkedPayRuns boolean Boolean
benefitCategories[].linkedEmployees[].id int32 Int32
benefitCategories[].linkedEmployees[].loan object UkEmployeeBenefitCategoryExtLoanEditModel
benefitCategories[].linkedEmployees[].loan.amountForegoneUserEntered double Nullable
benefitCategories[].linkedEmployees[].loan.amountOutstandingAtEndOfYearOrLoan double Decimal
benefitCategories[].linkedEmployees[].loan.amountOutstandingAtStartOfYearOrLoan double Decimal
benefitCategories[].linkedEmployees[].loan.dateLoanWasDischargedIfThisYear date-time Nullable
benefitCategories[].linkedEmployees[].loan.dateLoanWasMadeIfThisYear date-time Nullable
benefitCategories[].linkedEmployees[].loan.interestDue double Decimal
benefitCategories[].linkedEmployees[].loan.interestRate double Decimal
benefitCategories[].linkedEmployees[].loan.maximumAmountOutstandingDuringTheYear double Decimal
benefitCategories[].linkedEmployees[].loan.numberOfJointBorrowers int32 Nullable
benefitCategories[].linkedEmployees[].payrollingBenefit boolean Boolean
benefitCategories[].linkedEmployees[].proRataCalculation object UkEmployeeBenefitProRataCalculationModel
benefitCategories[].linkedEmployees[].proRataCalculation.endDate date-time Nullable
benefitCategories[].linkedEmployees[].proRataCalculation.fullYearAmount double Nullable
benefitCategories[].linkedEmployees[].proRataCalculation.proRataInFirstPayRun boolean Boolean
benefitCategories[].linkedEmployees[].proRataCalculation.startDate date-time DateTime
benefitCategories[].linkedEmployees[].proRataCalculation.useCalculatedValue boolean Nullable
benefitCategories[].linkedEmployees[].startFromPeriod int32 Int32
benefitCategories[].linkedEmployees[].van object UkEmployeeBenefitCategoryExtVanEditModel
benefitCategories[].linkedEmployees[].van.amountPaidByEmployeeForPrivateUse double Decimal
benefitCategories[].linkedEmployees[].van.availableFromDate date-time DateTime
benefitCategories[].linkedEmployees[].van.availableToDate date-time Nullable
benefitCategories[].linkedEmployees[].van.employerProvidesFuelForPrivateUse boolean Boolean
benefitCategories[].linkedEmployees[].van.fuel object UkEmployeeBenefitCategoryExtVanFuelEditModel
benefitCategories[].linkedEmployees[].van.fuel.amountForegone double Decimal
benefitCategories[].linkedEmployees[].van.fuel.amountPayrolledToDate double Decimal
benefitCategories[].linkedEmployees[].van.fuel.amountToBePayrolledPerPeriod double Decimal
benefitCategories[].linkedEmployees[].van.fuel.availableToDate date-time Nullable
benefitCategories[].linkedEmployees[].van.fuel.cashEquivalent double Decimal
benefitCategories[].linkedEmployees[].van.fuel.opraAmountForegone double Nullable
benefitCategories[].linkedEmployees[].van.fuel.proRataInFirstPayRun boolean Boolean
benefitCategories[].linkedEmployees[].van.fuel.startFromPeriod int32 Int32
benefitCategories[].linkedEmployees[].van.isShared boolean Boolean
benefitCategories[].linkedEmployees[].van.numberOfDaysUnavailable int32 Nullable
benefitCategories[].linkedEmployees[].van.opraAmountForegone double Nullable
benefitCategories[].linkedEmployees[].van.sharedPercentage double Nullable
benefitCategories[].linkedEmployees[].year int32 Int32
benefitCategories[].name string String
benefitCategories[].niTreatment string String
benefitCategories[].payrollingBenefit boolean Boolean
benefitCategories[].subType string String
benefitCategories[].van object UkBenefitCategoryExtVanEditModel
benefitCategories[].van.isZeroEmissions boolean Boolean
benefitCategories[].year int32 Nullable