PowerShell HMRC VAT MTD: Submit VAT return for period

Back to Index

Submit VAT return for period

Documentation: https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/vat-api/1.0#_submit-vat-return-for-period_post_accordion

CURL Command

curl -X POST  https://test-api.service.hmrc.gov.uk/organisations/vat/MY_HMRC_VRN/returns \
-H 'Authorization: Bearer HMRC_ACCESS_TOKEN' \
-H 'Accept: application/vnd.hmrc.1.0+json' \
-H 'Content-Type: application/json' \
-d '{
  "periodKey": "A001",
  "vatDueSales": 105.50,
  "vatDueAcquisitions": -100.45,
  "totalVatDue": 5.05,
  "vatReclaimedCurrPeriod": 105.15,
  "netVatDue": 100.10,
  "totalValueSalesExVAT": 300,
  "totalValuePurchasesExVAT": 300,
  "totalValueGoodsSuppliedExVAT": 3000,
  "totalAcquisitionsExVAT": 3000,
  "finalised": true
}'

PowerShell Example

[Reflection.Assembly]::LoadFile("C:\myAssemblies\ChilkatDotNet47.dll")

$rest = New-Object Chilkat.Rest

#  URL: https://test-api.service.hmrc.gov.uk/organisations/vat/MY_HMRC_VRN/returns
$bTls = $true
$port = 443
$bAutoReconnect = $true
$success = $rest.Connect("test-api.service.hmrc.gov.uk",$port,$bTls,$bAutoReconnect)
if ($success -ne $true) {
    $("ConnectFailReason: " + $rest.ConnectFailReason)
    $($rest.LastErrorText)
    exit
}

#  See the Online Tool for Generating JSON Creation Code
$json = New-Object Chilkat.JsonObject
$json.UpdateString("periodKey","A001")
$json.UpdateNumber("vatDueSales","105.50")
$json.UpdateNumber("vatDueAcquisitions","-100.45")
$json.UpdateNumber("totalVatDue","5.05")
$json.UpdateNumber("vatReclaimedCurrPeriod","105.15")
$json.UpdateNumber("netVatDue","100.10")
$json.UpdateNumber("totalValueSalesExVAT","300")
$json.UpdateNumber("totalValuePurchasesExVAT","300")
$json.UpdateNumber("totalValueGoodsSuppliedExVAT","3000")
$json.UpdateNumber("totalAcquisitionsExVAT","3000")
$json.UpdateBool("finalised",$true)

$rest.AddHeader("Content-Type","application/json")
$rest.AddHeader("Authorization","Bearer HMRC_ACCESS_TOKEN")
$rest.AddHeader("Accept","application/vnd.hmrc.1.0+json")

$sbRequestBody = New-Object Chilkat.StringBuilder
$json.EmitSb($sbRequestBody)
$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $rest.FullRequestSb("POST","/organisations/vat/MY_HMRC_VRN/returns",$sbRequestBody,$sbResponseBody)
if ($success -ne $true) {
    $($rest.LastErrorText)
    exit
}

$respStatusCode = $rest.ResponseStatusCode
if ($respStatusCode -ge 400) {
    $("Response Status Code = " + $respStatusCode)
    $("Response Header:")
    $($rest.ResponseHeader)
    $("Response Body:")
    $($sbResponseBody.GetAsString())
    exit
}

$jsonResponse = New-Object Chilkat.JsonObject
$jsonResponse.LoadSb($sbResponseBody)

#  See the Online Tool for Generating JSON Parse Code

$processingDate = $jsonResponse.StringOf("processingDate")
$paymentIndicator = $jsonResponse.StringOf("paymentIndicator")
$formBundleNumber = $jsonResponse.StringOf("formBundleNumber")

Sample JSON Response Body

{
  "processingDate": "2019-02-18T14:37:56.561Z",
  "paymentIndicator": "BANK",
  "formBundleNumber": "948551092841"
}