organisations

Retrieve financial details

Retrieves the financial details relating to a late submission or late payment penalty that has been applied to a VAT account.

Test data

<p>Scenario simulations using Gov-Test-Scenario headers are only available in sandbox environment.</p> <table> <thead> <tr> <th>Header Value (Gov-Test-Scenario)</th> <th>Scenario</th> </tr> </thead> <tbody> <tr> <td><p>DEFAULT</p></td> <td><p>The default scenario.</p></td> </tr> </tbody> </table>

get/organisations/vat/{vrn}/financial-details/{penaltyChargeReference}

Request

Base URL
https://test-api.service.hmrc.gov.uk
Auth
OAuth 2
Authorization codehttps://api.service.hmrc.gov.uk/oauth/authorize
Token URLhttps://api.service.hmrc.gov.uk/oauth/token
Scopesread:vat
TypeScript
https://skmtc.dev/hmrc/apis/vat-api/docs/organisations/vat/:vrn/financial-details/:penaltyChargeReference/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

vrnstring required

Example:123456789

VAT registration number. <br> A nine-digit number.

penaltyChargeReferencestring required

Example:XP123456789012

The late submission chargeReference or late payment penaltyChargeReference, which has been obtained from the Retrieve VAT penalties endpoint. Only the financial details that relate to this charge will be returned.

Headers

Gov-Test-Scenariostring

Example:-

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

Response

Example response

{
  "totalisations": {
    "totalOverdue": 5009.99,
    "totalNotYetDue": 5009.99,
    "totalBalance": 5009.99,
    "totalCredit": 5009.99,
    "totalCleared": 5009.99,
    "additionalReceivableTotalisations": {
      "totalAccountPostedInterest": 200,
      "totalAccountAccruingInterest": 45.35
    }
  },
  "documentDetails": [
    {
      "postingDate": "2022-08-16",
      "issueDate": "2022-08-16",
      "documentInterestTotals": {
        "interestPostedAmount": 13.12,
        "interestAccruingAmount": 12.1
      },
      "documentTotalAmount": 5009.99,
      "documentClearedAmount": 5009.99,
      "documentOutstandingAmount": 5009.99,
      "lineItemDetails": [
        {
          "chargeDescription": "VAT Return",
          "periodFromDate": "2022-08-16",
          "periodToDate": "2022-08-16",
          "netDueDate": "2022-08-16",
          "amount": 5009.99,
          "lineItemInterestDetails": {
            "interestStartDate": "2022-08-16",
            "currentInterestRate": 2,
            "interestPostedAmount": 13.12,
            "interestAccruingAmount": 12.1
          }
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.