balance type description amendment (#90)

accountAPI.yaml

@@ -123,8 +123,8 @@ paths:
       summary: Retrieve account balance information
       description: |
         Returns account balance information of the specified account.
-        * Returns the intraday booked balance (ITBD) for the current day, if called without a date.
-        * Returns the closing booked balance (CLBD) for a specific day, if called for a past date (i.e. the closing booked balance (CLBD) of that day). In case the specified day has not yet been finalized, the response code will be 202.
+        * Returns the interim booked balance (ISO20022 Balance Type ITBD) for the current day, if called without a date. The balance is calculated in the course of the service provider's business day, at the time specified, and subject to further changes during the business day. The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period specified.
+        * Returns the closing booked balance (ISO20022 Balance Type CLBD) for a specific day, if called for a past date. It is the sum of the opening booked balance at the beginning of that day and all entries booked to the account during that day. In case the specified day has not yet been finalized, the response code will be 202.
       parameters:
         - $ref: '#/components/parameters/authorization_in_header'
         - $ref: '#/components/parameters/path_accountId'
@@ -439,7 +439,7 @@ components:
         designation:
           type: string
           maxLength: 140
-          description: The account designation/description. This element shall always be populated with the account alias, if defined, otherwise with specific bank account name (e.g. bank saving account).
+          description: This element shall always be populated with the account alias, if defined, otherwise with specific bank account name (e.g. bank saving account). **NOTE:** This property will become mandatory with the next major release of this API.
           example: Firmenkonto
         accountTypeCode:
           type: string
@@ -450,6 +450,7 @@ components:
             SVGS: Account used for savings (all types of saving accounts)
             TRAN: Account used for transactions (all types of personal, current and payment accounts) - DE: Privat-, Kontokorent- und Zahlungsverkehrskonten
             OTHR: Account not otherwise specified (gathering pool for all other accounts)
+            **NOTE:** This property will become mandatory with the next major release of this API.
           example: TRAN
           enum:
             - CACC