v1

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

Create Child Benefit entitlement test data

Supports the Individual Benefits API by creating Child Benefit entitlement test data.

post/individual-paye-test-support/sa/{utr}/child-benefit-entitlement/annual-summary/{taxYear}

Path parameters

utrstring required
Example:2234567890

The 10 digit self assessment UTR for the individual.

taxYearstring required
Example:2025-26

The tax year for the Child Benefit entitlement test data that is being created. Although production data will only be available for a portion of the current Self Assessment year, that policy is not enforced for the data that is created in the sandbox environment by this operation.

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 Child Benefit entitlement test data request

Response

Created

expectedStatusnumber required

The HTTP response status code that should be expected from the Individual Benefits API in the specified scenario.

Example response

{
  "expectedStatus": 200,
  "expectedJson": {
    "childBenefitEntitlement": 450.99
  }
}