| Name / Description | Type / Format | Example | |
|---|---|---|---|
uniqueId
Optional. If value is provided then update else create benefit.
|
string
uuid
|
"string"
|
|
payrollCode
The payroll code of the employee to update
|
string
|
"string"
|
|
taxYear
|
string
|
"Year2017"
"Year2018"
"Year2019"
"Year2020"
"Year2021"
"Year2022"
"Year2023"
"Year2024"
"Year2025"
|
|
type
|
string
|
"AssetsTransferred"
"PaymentsOnBehalf"
"UnborneTax"
"Vouchers"
"Accommodation"
"MileageAllowance"
"Car"
"Vans"
"Loan"
"Medical"
"QualifyingRelocationExpenses"
"Services"
"AssetsAtEmployeeDisposal"
"OtherClass1AItems"
"OtherNonClass1AItems"
"DirectorTax"
"TravellingAndSubsistence"
"Entertainment"
"HomeTelephone"
"NonQualifyingRelocationExpenses"
"OtherExpenses"
|
|
declarationType
|
string
|
"P11D"
"Paye"
|
|
description
A description of this benefit
|
string
|
"string"
|
|
value
The total value of the benefit.
|
number
double
|
0.0
|
|
employeeContribution
Amount contributed by the employee.
|
number
double
|
0.0
|
|
assetType
|
string
|
"Other"
"Multiple"
"Property"
"Cars"
"PreciousMetals"
|
|
useOfAssetType
|
string
|
"Other"
"Multiple"
"CorporateHospitality"
"Boat"
"Aircraft"
"TimeshareAccommodation"
"HolidayAccommodation"
|
|
class1AType
|
string
|
"Other"
"Multiple"
"StopLossCharges"
"NonQualifyingRelocationBenefit"
"EducationalAssitance"
"SubscriptionsAndFees"
|
|
nonClass1AType
|
string
|
"Other"
"Multiple"
"LoansWrittenOrWaived"
"NurseryPlaces"
"EducationalAssitance"
"SubscriptionsAndFees"
|
|
paymentType
|
string
|
"Other"
"SeasonTickets"
"PrivateCarExpenses"
"PrivateEducation"
"AccountancyFees"
"DomesticBills"
"Multiple"
|
|
isPeriodValue
To be used for the benefit period
|
boolean
|
true
|
|
tradingOrganisation
Only relevant to Benefits with Type Entertainment
|
boolean
|
true
|
|
cashEquivalentFuel
Only relevant to Benefits with Type Vans
|
number
double
|
0.0
|
|
startDate
Start date for imported benefit
|
string
date
|
"2025-07-02"
|
|
endDate
End date for imported benefit
|
string
date
|
"2025-07-02"
|
|
useProRata
Benefit calculation should be done on pro rata rules
|
boolean
|
true
|
|
openingBalance
The amount of benefit paid YTD when setting up a benefit
|
number
double
|
0.0
|
|
overrideOpeningBalance
To be used to change the opening balance if the benefit has been payrolled
|
boolean
|
true
|
{
"uniqueId": "string",
"payrollCode": "string",
"taxYear": "Year2017",
"type": "AssetsTransferred",
"declarationType": "P11D",
"description": "string",
"value": 0.0,
"employeeContribution": 0.0,
"assetType": "Other",
"useOfAssetType": "Other",
"class1AType": "Other",
"nonClass1AType": "Other",
"paymentType": "Other",
"isPeriodValue": true,
"tradingOrganisation": true,
"cashEquivalentFuel": 0.0,
"startDate": "2025-07-02",
"endDate": "2025-07-02",
"useProRata": true,
"openingBalance": 0.0,
"overrideOpeningBalance": true
}