v1
latestOpenAPI 3.0.32026-07-132422.9 KBindividual-benefits
Get benefits summary
Fetches an individual’s annual benefits summary for the given tax year.
get/individual-benefits/sa/{utr}/annual-summary/{taxYear}
Path parameters
utrstring required
Example:2234567890
The 10 digit self-assessment UTR for the individual.
taxYearstring required
Example:2016-17
The tax year for which the Child Benefit amount is being retrieved. This must be the current tax year.
Headers
Accept'application/vnd.hmrc.2.0+json' required
Specifies the response format and the version of the API to be used.
Authorizationstring required
Example:Bearer bb7fed3fe10dd235a2ccda3d50fb
An OAuth 2.0 Bearer Token with the read:individual-benefits scope.
Response
OK
Example response
{
"employments": [
{
"employerPayeReference": "123/AB456",
"companyCarsAndVansBenefit": 44,
"fuelForCompanyCarsAndVansBenefit": 99,
"privateMedicalDentalInsurance": 64,
"vouchersCreditCardsExcessMileageAllowance": 80,
"goodsEtcProvidedByEmployer": 125,
"accommodationProvidedByEmployer": 375,
"otherBenefits": 16,
"expensesPaymentsReceived": 415
}
]
}