v1

latestOpenAPI 3.0.32026-07-1352255.1 KB
individual-paye-test-support

Create benefits summary test data

Supports the Individual Benefits API by creating benefits summary test data.

post/individual-paye-test-support/sa/{utr}/benefits/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 the benefits test data being created.

Headers

Accept'application/vnd.hmrc.2.0+json' required

Specifies the response format and the version of the API to be used.

Content-Type'application/json' required

Specifies the format of the request body, which must be JSON.

Authorizationstring required
Example:Bearer 59fc92c1cdf0b8ef1f138a702effdbd2

An OAuth 2.0 Bearer Token.

Request body

object required

Create Individual Benefits summary test data request

Response

Created

Example response

{
  "employments": [
    {
      "employerPayeReference": "123/AB456",
      "companyCarsAndVansBenefit": 44,
      "fuelForCompanyCarsAndVansBenefit": 99,
      "privateMedicalDentalInsurance": 64,
      "vouchersCreditCardsExcessMileageAllowance": 80,
      "goodsEtcProvidedByEmployer": 125,
      "accommodationProvidedByEmployer": 375,
      "otherBenefits": 16,
      "expensesPaymentsReceived": 415
    }
  ]
}
All 5 operations