Create benefit category

Creates a new benefit category

Request

POST http:///api/v2/business/{businessId}/benefitcategory

Path parameters

Parameter name Value Description Additional
businessId string Required

Request body

The request body takes a complete UkBenefitCategoryEditModel 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"
    },
    "name": "string",
    "niTreatment": "string",
    "payrollingBenefit": "boolean",
    "subType": "string",
    "van": {
        "isZeroEmissions": "boolean"
    },
    "year": "int32"
}

Properties

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
name string String
niTreatment string String
payrollingBenefit boolean Boolean
subType string String
van object UkBenefitCategoryExtVanEditModel
van.isZeroEmissions boolean Boolean
year int32 Nullable

Response

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

Status code Description Resource
200 OK

OK

 UkBenefitCategoryReadModel