Skip to content

Commit

Permalink
Merge pull request #76 from hmrc/DL-9168
Browse files Browse the repository at this point in the history
[DL-9168] VAT (MTD) End-to-End Guide: Updated the hyperlinks to the A…
  • Loading branch information
Thepworth95 authored Nov 29, 2022
2 parents 06d309a + c621840 commit 7335dd5
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 16 deletions.
28 changes: 14 additions & 14 deletions source/documentation/hints.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@ The following hints will help you to build appropriate prompts into your softwar
<td>Prior to VAT return due date</td>
<td>Notify the customer when a VAT return is due, and inform them of their late submission penalty position if they fail to submit on time (i.e. the customer will receive a penalty point or a £200 fine).</td>
<td>
<p><a href="https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/vat-api/1.0#Retrieve%20VAT%20obligations">Retrieve VAT obligations</a> - to find out when the next VAT return is due.</p>
<p><a href="https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/vat-api/1.0#Retrieve%20VAT%20penalties%20[test%20only]">Retrieve VAT penalties</a> - to see the current late submission penalty position, and hence whether the customer will receive a penalty point or a fine if they make a late submission.</p>
<p><a href="https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/vat-api/1.0#_retrieve-vat-obligations_get_details">Retrieve VAT obligations</a> - to find out when the next VAT return is due.</p>
<p><a href="https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/vat-api/1.0#_retrieve-vat-penalties-test-only_get_details">Retrieve VAT penalties</a> - to see the current late submission penalty position, and hence whether the customer will receive a penalty point or a fine if they make a late submission.</p>
</td>
</tr>
<tr>
<td>Customer submits a VAT return late</td>
<td>Notify the customer that they have received a penalty point or they have received a £200 fine. Inform them of their points total.</td>
<td><a href="https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/vat-api/1.0#Retrieve%20VAT%20penalties%20[test%20only]">Retrieve VAT penalties</a></td>
<td><a href="https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/vat-api/1.0#_retrieve-vat-penalties-test-only_get_details">Retrieve VAT penalties</a></td>
</tr>
<tr>
<td>Customer has penalty points</td>
Expand All @@ -40,12 +40,12 @@ The following hints will help you to build appropriate prompts into your softwar
<p>Also, remind the customer to submit any outstanding VAT returns.</p>
</td>
<td>
<p><a href="https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/vat-api/1.0#Retrieve%20VAT%20obligations">Retrieve VAT obligations</a> - to:</p>
<p><a href="https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/vat-api/1.0#_retrieve-vat-obligations_get_details">Retrieve VAT obligations</a> - to:</p>
<ul>
<li>find out when the next VAT return is due.</li>
<li>see any open VAT returns, and remind the customer to submit them.</li>
</ul>
<p><a href="https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/vat-api/1.0#Retrieve%20VAT%20penalties%20[test%20only]">Retrieve VAT penalties</a> - to see whether the individual or organisation currently has any penalty points. If they have, then let them know that they can get closer to resetting their penalty points if they submit the next VAT return on time (and also submit any previous returns that are still open).</p>
<p><a href="https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/vat-api/1.0#_retrieve-vat-penalties-test-only_get_details">Retrieve VAT penalties</a> - to see whether the individual or organisation currently has any penalty points. If they have, then let them know that they can get closer to resetting their penalty points if they submit the next VAT return on time (and also submit any previous returns that are still open).</p>
</td>
</tr>
</table>
Expand All @@ -65,21 +65,21 @@ The following hints will help you to build appropriate prompts into your softwar
<tr>
<td>Prior to payment due date</td>
<td>Remind the customer of the upcoming payment due date.</td>
<td><a href="https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/vat-api/1.0#Retrieve%20VAT%20liabilities">Retrieve VAT liabilities</a> - to get payment due dates.</td>
<td><a href="https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/vat-api/1.0#_retrieve-vat-liabilities_get_details">Retrieve VAT liabilities</a> - to get payment due dates.</td>
</tr>
<tr>
<td>Customer does not pay on or before due date</td>
<td>
<p>Three days after the payment due date, notify the customer that they must pay (or agree to a payment plan) within 15 days of the due date, otherwise they will receive a late payment penalty.</p>
<p>Inform the customer that late payment interest will be due from the date that the amount was outstanding, to the date that it is paid in full.</p>
</td>
<td><a href="https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/vat-api/1.0#Retrieve%20VAT%20liabilities">Retrieve VAT liabilities</a> - to get any liabilities with payment due dates that fall between 3 and 15 days ago, which also have an outstanding amount against them (outstandingAmount).</td>
<td><a href="https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/vat-api/1.0#_retrieve-vat-liabilities_get_details">Retrieve VAT liabilities</a> - to get any liabilities with payment due dates that fall between 3 and 15 days ago, which also have an outstanding amount against them (outstandingAmount).</td>
</tr>
<tr>
<td>Customer has not paid 15 days after due date</td>
<td>16 days after the payment due date, notify the customer that they have incurred a first late payment penalty at 2%. To stop that being increased to another 2%, they must pay (or agree to a payment plan) within 30 days of the due date.</td>
<td>
<p><a href="https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/vat-api/1.0#Retrieve%20VAT%20penalties%20[test%20only]">Retrieve VAT penalties</a> - to get:</p>
<p><a href="https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/vat-api/1.0#_retrieve-vat-penalties-test-only_get_details">Retrieve VAT penalties</a> - to get:</p>
<ul>
<li>details of the new first late payment penalty that has been applied (penaltyAmountPosted)</li>
<li>the amount of unpaid tax at day 16 (latePaymentPenalty1LowerRateCalculationAmount).</li>
Expand All @@ -93,7 +93,7 @@ The following hints will help you to build appropriate prompts into your softwar
<p>Until the customer pays, keep reminding them, at set intervals, of the outstanding debt and that the second penalty is still accruing.</p>
</td>
<td>
<p><a href="https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/vat-api/1.0#Retrieve%20VAT%20penalties%20[test%20only]">Retrieve VAT penalties</a> - to get:</p>
<p><a href="https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/vat-api/1.0#_retrieve-vat-penalties-test-only_get_details">Retrieve VAT penalties</a> - to get:</p>
<ul>
<li>the amount of unpaid tax at day 16 (latePaymentPenalty1LowerRateCalculationAmount).</li>
<li>the amount of unpaid tax at day 31 (latePaymentPenalty1HigherRateCalculationAmount).</li>
Expand All @@ -102,7 +102,7 @@ The following hints will help you to build appropriate prompts into your softwar
<li>the payment due date for the penalty charge (penaltyChargeDueDate).</li>
<li>the number of days for which the second late payment penalty has accrued (latePaymentPenalty2Days), the amount that has accrued (penaltyAmountAccruing) and the amount that is yet to be paid (penaltyAmountOutstanding).</li>
</ul>
<p><a href="https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/vat-api/1.0#Retrieve%20financial%20details%20[test%20only]">Retrieve financial details</a> - passing in:</p>
<p><a href="https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/vat-api/1.0#_retrieve-financial-details-test-only_get_details">Retrieve financial details</a> - passing in:</p>
<ul>
<li>the charge reference of the first late payment penalty, to see further financial information relating to the first late payment penalty. For example, you can see the amount of accruing or posted interest on the penalty (documentInterestTotals).</li>
<li>the charge reference of the second late payment penalty, to see further financial information relating to the second late payment penalty. For example, you can see the amount of accruing or posted interest on the penalty (documentInterestTotals).</li>
Expand All @@ -127,15 +127,15 @@ The following hints will help you to build appropriate prompts into your softwar
<tr>
<td>Prior to payment due date</td>
<td>Remind the customer of the upcoming payment due date.</td>
<td><a href="https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/vat-api/1.0#Retrieve%20VAT%20liabilities">Retrieve VAT liabilities</a> - to get payment due dates.</td>
<td><a href="https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/vat-api/1.0#_retrieve-vat-liabilities_get_details">Retrieve VAT liabilities</a> - to get payment due dates.</td>
</tr>
<tr>
<td>Customer does not pay on or before due date</td>
<td>
<p>Three days after the payment due date, notify the customer that they must pay (or agree to a payment plan) within 30 days of the due date, otherwise they will receive a late payment penalty.</p>
<p>Inform the customer that late payment interest will be due from the date that the amount was outstanding, to the date that it is paid in full.</p>
</td>
<td><a href="https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/vat-api/1.0#Retrieve%20VAT%20liabilities">Retrieve VAT liabilities</a> - to get any liabilities with payment due dates that fall between 3 and 15 days ago, which also have an outstanding amount against them (outstandingAmount).</td>
<td><a href="https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/vat-api/1.0#_retrieve-vat-liabilities_get_details">Retrieve VAT liabilities</a> - to get any liabilities with payment due dates that fall between 3 and 15 days ago, which also have an outstanding amount against them (outstandingAmount).</td>
</tr>
<tr>
<td>Customer has not paid 30 days after due date</td>
Expand All @@ -144,7 +144,7 @@ The following hints will help you to build appropriate prompts into your softwar
<p>Until the customer pays, keep reminding them, at set intervals, of the outstanding debt and that the second penalty is still accruing.</p>
</td>
<td>
<p><a href="https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/vat-api/1.0#Retrieve%20VAT%20penalties%20[test%20only]">Retrieve VAT penalties</a> - to get:</p>
<p><a href="https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/vat-api/1.0#_retrieve-vat-penalties-test-only_get_details">Retrieve VAT penalties</a> - to get:</p>
<ul>
<li>the amount of unpaid tax at day 16 (latePaymentPenalty1LowerRateCalculationAmount).</li>
<li>the amount of unpaid tax at day 31 (latePaymentPenalty1HigherRateCalculationAmount).</li>
Expand All @@ -153,7 +153,7 @@ The following hints will help you to build appropriate prompts into your softwar
<li>the payment due date for the penalty charge (penaltyChargeDueDate).</li>
<li>the number of days for which the second late payment penalty has accrued (latePaymentPenalty2Days), the amount that has accrued (penaltyAmountAccruing) and the amount that is yet to be paid (penaltyAmountOutstanding).</li>
</ul>
<p><a href="https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/vat-api/1.0#Retrieve%20financial%20details%20[test%20only]">Retrieve financial details</a> - passing in:</p>
<p><a href="https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/vat-api/1.0#_retrieve-financial-details-test-only_get_details">Retrieve financial details</a> - passing in:</p>
<ul>
<li>the charge reference of the first late payment penalty, to see further financial information relating to the first late payment penalty. For example, you can see the amount of accruing or posted interest on the penalty (documentInterestTotals).</li>
<li>the charge reference of the second late payment penalty, to see further financial information relating to the second late payment penalty. For example, you can see the amount of accruing or posted interest on the penalty (documentInterestTotals).</li>
Expand Down
4 changes: 2 additions & 2 deletions source/documentation/penalties.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,14 @@ Your software should use the VAT (MTD) API to retrieve details of the penalties

Specifically, the software should use this endpoint:

* [Retrieve VAT penalties](https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/vat-api/1.0#Retrieve%20VAT%20penalties%20[test%20only])
* [Retrieve VAT penalties](https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/vat-api/1.0#_retrieve-vat-penalties-test-only_get_details)

## Retrieve financial details relating to a penalty
<!--- Section owner: MTD Programme --->

To retrieve the financial details relating to a penalty, use this endpoint:

* [Retrieve financial details](https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/vat-api/1.0#Retrieve%20financial%20details%20[test%20only])
* [Retrieve financial details](https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/vat-api/1.0#_retrieve-financial-details-test-only_get_details)

Your software should use the financial-details endpoint after the penalties endpoint, passing the late submission or late payment penalty charge reference that the penalties endpoint has returned:

Expand Down

0 comments on commit 7335dd5

Please sign in to comment.