Sign in

v1

latestOpenAPI 3.0.32026-07-131211345.4 KB
Payments and Liabilities

Retrieve History of a Self Assessment Charge

This endpoint enables you to retrieve the history of changes to an individual charge. A National Insurance number and transaction ID must be provided. You can get the transaction ID using the Retrieve Self Assessment Balance and Transactions endpoint - it is returned as documentId in the documentDetails array.

Test data

Scenario simulation using Gov-Test-Scenario headers is only available in the sandbox environment.

Header Value (Gov-Test-Scenario)Scenario
N/A - DEFAULTSimulates success response.
NOT_FOUNDSimulates the scenario where no data is found.
get/accounts/self-assessment/{nino}/charges/{transactionId}

Path parameters

ninostring required
Example:TC663795B

National Insurance number, in the format AA999999A.

transactionIdstring required
Example:X92AM39DLE3D

A unique identifier for this item.

Must conform to the regular expression ^[0-9A-Za-z]{1,12}$

Headers

Accept'application/vnd.hmrc.4.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:self-assessment scope.

Gov-Test-Scenariostring
Example:-

Only in sandbox environment. See Test Data table for all header values.

Response

Success

Example response

{
  "chargeHistoryDetails": [
    {
      "transactionId": "X123456790A",
      "transactionDate": "2018-04-05",
      "description": "POA1, Balancing charge",
      "totalAmount": 600,
      "changeDate": "2018-04-05",
      "changeTimestamp": "2018-04-05T14:15:22.802Z",
      "changeReason": " Amended return, Customer Request",
      "poaAdjustmentReason": "004"
    }
  ]
}