[DL-8970] Aligned the descriptions in the API documentation for the f…

…inancial-details endpoint with the descriptions that are in the Requirements Specification.
hmrc · Dec 8, 2022 · 1d6632e · 1d6632e
1 parent 90d989e
commit 1d6632e
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/resources/public/api/conf/1.0/schemas/penalties/FinancialDetails.json b/resources/public/api/conf/1.0/schemas/penalties/FinancialDetails.json
@@ -13,7 +13,7 @@
           "example": "5009.99"
         },
         "totalNotYetDue": {
-          "description": "The charge amount that has been posted to the account, but is not yet overdue. The due date is in the future. The value must be between -99999999999.99 and 99999999999.99 to 2 decimal places.",
+          "description": "The charge amount that has been posted to the account, but is not yet overdue. The due date is today or in the future. The value must be between -99999999999.99 and 99999999999.99 to 2 decimal places.",
           "type": "number",
           "example": "5009.99"
         },
@@ -132,7 +132,7 @@
                   "example": "2022-08-16"
                 },
                 "amount": {
-                  "description": "The value must be between -99999999999.99 and 99999999999.99 to 2 decimal places.",
+                  "description": "The total amount. The value must be between -99999999999.99 and 99999999999.99 to 2 decimal places.",
                   "type": "number",
                   "example": "5009.99"
                 },
@@ -156,12 +156,12 @@
                       "example": "2.00"
                     },
                     "interestPostedAmount": {
-                      "description": "The amount of interest, relating to the line item, that HMRC has actually posted to the account.",
+                      "description": "The amount of interest, relating to the line item, that HMRC has actually posted to the account. This includes the accrued interest that has been posted to the customer’s account at the end of each month. Interest will continue to be posted at the end of each month, until the customer pays the charge upon which the interest is based. It is then posted as the final amount of interest.",
                       "type": "number",
                       "example": "13.12"
                     },
                     "interestAccruingAmount": {
-                      "description": "The amount of unposted interest that has currently accrued on the line item.",
+                      "description": "The amount of unposted interest that has accrued on the line item to date, since the interest start date.",
                       "type": "number",
                       "example": "12.10"
                     }