Create Import Benefit Categories

Example request: { "isPayrollingBenefit": false, "taxYear": 2024, "carryBenefitForward": true, "benefitCategoryType": 13, // OtherItemsNoNic from BenefitCategoryTypeEnum "benefitCategoryName": "Example benefit category", "value": 99.50, "internalBenefitCategoryEnumId": 2, // Other from BenefitCategoryOtherNoNicSubType "description": "Custom benefit description", "fuelType": 1, // For car benefits: DieselMeetingEuroStandards from BenefitCategoryCarFuelType "engineSize": 2 // For car benefits: Between1401And2000 from BenefitCategoryCarEngineSize }

Request

POST http:///api/v2/business/{businessId}/import/benefit-categories

Path parameters

Parameter name Value Description Additional
businessId string Required

Request body

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

{
    "approvedCo2Emissions": "int32",
    "benefitCategoryEnumId": "int32",
    "benefitCategoryName": "string",
    "benefitCategoryType": "string",
    "carryBenefitForward": "boolean",
    "dateFirstRegistered": "date-time",
    "description": "string",
    "engineSize": "string",
    "fuelType": "string",
    "isPayrollingBenefit": "boolean",
    "isVanZeroEmissions": "boolean",
    "listPrice": "int32",
    "makeAndModel": "string",
    "noApprovedCo2Emissions": "boolean",
    "registrationNumber": "string",
    "taxYear": "int32",
    "tradingOrganisation": "boolean",
    "value": "double",
    "zeroEmissionMileage": "int32"
}

Properties

Name Type Description
approvedCo2Emissions int32 Nullable
benefitCategoryEnumId int32 Nullable
benefitCategoryName string String
benefitCategoryType string BenefitCategoryTypeEnum

Possible values are:

  • None
  • PrivateMedicalTreatmentOrInsurance
  • CarsAndCarFuel
  • AssetsTransferred
  • PaymentsMadeOnBehalfOfTheEmployee
  • VouchersAndCreditCards
  • LivingAccommodation
  • MileageAllowancePaymentsNotTaxedAtSource
  • VansAndVanFuel
  • InterestFreeLoans
  • QualifyingRelocationExpenses
  • ServicesSupplied
  • AssetsPlacedAtTheEmployeesDisposal
  • OtherItemsNoNic
  • OtherItems1A
  • ExpensesPaymentsMadeOnBehalfOfTheEmployee
  • MedicalOrHealth
  • CriticalIllness
  • Dental
  • Vision
  • STD
  • LTD
  • LifeInsurance
  • DependantLifeInsurance
  • ADAndD
  • TaxableBenefitInCash
  • TaxableBenefitNonCash
  • TFSA
  • RRSPRestricted
  • RRSPNonRestricted
  • Custom
carryBenefitForward boolean Nullable
dateFirstRegistered date-time Nullable
description string String
engineSize string Nullable

Possible values are:

  • None
  • LessThan1400
  • Between1401And2000
  • MoreThan2001
  • Rotary
fuelType string Nullable

Possible values are:

  • None
  • DieselMeetingEuroStandards
  • Diesel
  • Other
  • Electric
isPayrollingBenefit boolean Boolean
isVanZeroEmissions boolean Nullable
listPrice int32 Nullable
makeAndModel string String
noApprovedCo2Emissions boolean Nullable
registrationNumber string String
taxYear int32 Nullable
tradingOrganisation boolean Nullable
value double Decimal
zeroEmissionMileage int32 Nullable

Response

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

Status code Description Resource
200 OK

OK

 UkBenefitCategoryEditModel
400 Bad Request

Bad Request

 ProblemDetails