Benefit

Used to represent Benefits and Expenses

Name / Description Type / Format Example
taxYear
The TaxYear the employee received this benefit
string "Year2017" "Year2018" "Year2019" "Year2020"
type
The type of benefit
string "AssetsTransferred" "PaymentsOnBehalf" "UnborneTax" "Vouchers" "Accommodation" "MileageAllowance" "Car" "Vans" "Loan" "Medical" "QualifyingRelocationExpenses" "Services" "AssetsAtEmployeeDisposal" "OtherClass1AItems" "OtherNonClass1AItems" "DirectorTax" "TravellingAndSubsistence" "Entertainment" "HomeTelephone" "NonQualifyingRelocationExpenses" "OtherExpenses"
declarationType
Whether this benefit should be declared on a P11d or with PAYE
string "P11D" "Paye"
description
A description of this benefit
string "string"
value number double 0.0
employeeContribution number double 0.0
cashEquivalent number double 0.0
assetType
Only relevant to Benefits with Type AssetsTransferred
string "Other" "Multiple" "Property" "Cars" "PreciousMetals"
useOfAssetType
Only relevant to Benefits with Type AssetsAtEmployeeDisposal
string "Other" "Multiple" "CorporateHospitality" "Boat" "Aircraft" "TimeshareAccommodation" "HolidayAccommodation"
class1AType
Only relevant to Benefits with Type OtherClass1AItems
string "Other" "Multiple" "StopLossCharges" "NonQualifyingRelocationBenefit" "EducationalAssitance" "SubscriptionsAndFees"
nonClass1AType
Only relevant to Benefits with Type OtherNonClass1AItems
string "Other" "Multiple" "LoansWrittenOrWaived" "NurseryPlaces" "EducationalAssitance" "SubscriptionsAndFees"
paymentType
Only relevant to Benefits with Type PaymentsOnBehalf
string "Other" "SeasonTickets" "PrivateCarExpenses" "PrivateEducation" "AccountancyFees" "DomesticBills" "Multiple"
tradingOrganisation
Only relevant to Benefits with Type Entertainment
boolean true
cashEquivalentFuel
Only relevant to Benefits with Type Vans
number double 0.0
loan
Only relevant to Benefits with Type Loan
BenefitDetailsLoan {BenefitDetailsLoan}
car
Only relevant to Benefits with Type Car
BenefitDetailsCar {BenefitDetailsCar}
employee
A representation of the Employee this object relates to
Item {Item}
id
The unique id of the object
string uuid "string"
{
  "taxYear": "Year2017",
  "type": "AssetsTransferred",
  "declarationType": "P11D",
  "description": "string",
  "value": 0.0,
  "employeeContribution": 0.0,
  "cashEquivalent": 0.0,
  "assetType": "Other",
  "useOfAssetType": "Other",
  "class1AType": "Other",
  "nonClass1AType": "Other",
  "paymentType": "Other",
  "tradingOrganisation": true,
  "cashEquivalentFuel": 0.0,
  "loan": {
    "numberOfJointBorrowers": 0,
    "loanMade": "2019-11-19T21:39:20",
    "loanDischarged": "2019-11-19T21:39:20",
    "startingBalance": 0.0,
    "closingBalance": 0.0,
    "maxBalanceInYear": 0.0,
    "interestPaid": 0.0,
    "cashEquivalent": 0.0,
    "fullTaxMonths": 0,
    "monthlyValue": 0.0,
    "officialInterest": 0.0
  },
  "car": {
    "makeAndModel": "string",
    "registration": "string",
    "firstRegistered": "2019-11-19T21:39:20",
    "hasApprovedEmissionsValue": true,
    "co2Emissions": 0,
    "engineSize": 0,
    "zeroEmissionsMileage": 0,
    "fuelType": "Diesel6d",
    "availableFrom": "2019-11-19T21:39:20",
    "availableTo": "2019-11-19T21:39:20",
    "daysUnavailable": 0,
    "listPrice": 0.0,
    "nonStandardAccessories": 0.0,
    "employeeCapitalContributions": 0.0,
    "employeePrivateContributions": 0.0,
    "freeFuel": true,
    "fuelAvailableFrom": "2019-11-19T21:39:20",
    "fuelAvailableTo": "2019-11-19T21:39:20",
    "freeFuelReinstated": true,
    "registeredPriorTo1998": true,
    "rate": 0.0,
    "chargeableValue": 0.0,
    "fullYearCharge": 0.0,
    "cashEquivalent": 0.0,
    "cashEquivalentFuel": 0.0
  },
  "employee": {
    "id": "string",
    "name": "string",
    "metadata": {},
    "url": "string"
  },
  "id": "string"
}
Contained in Models

- none -

Consumed by Operations
Create Benefit
Update Benefit
Returned by Operations
Get Benefit
Update Benefit