Merge pull request #433 from ConsumerDataStandardsAustralia/maintenan…

…ce/652

Standards Maintenance Issue #652

slate/source/includes/releasenotes/releasenotes.1.32.0.html.md

@@ -27,6 +27,7 @@ This release addresses the following minor defects raised on [Standards Staging]
 This release addresses the following change requests raised on [Standards Maintenance](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues):
 
 - [Standards Maintenance #641 - Update CDS documentation to clarify expected rate value 'sign' (+/-) for each RateType](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/641)
+- [Standards Maintenance #652 - Specify units of currency to be used for the AmountString field type](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/652)
 
 
 ### Decision Proposals
@@ -54,6 +55,7 @@ This release addresses the following Decision Proposals published on [Standards]
 |Change|Description|Link|
 |------|-----------|----|
 | Common Field Types examples | [**Standards Staging #410**](https://github.com/ConsumerDataStandardsAustralia/standards-staging/issues/410): Clarified formatting of RateString type | [Common Field Types](../../#common-field-types)
+| Updated AmountString description | [**Standards Maintenance #652**](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/652): Updated the description of the AmountString field type, clarifying the currency format and noting it defaults to AUD. | [Common Field Types](../../#common-field-types)
 
 
 ## API Endpoints

slate/source/includes/standards/_types.md

@@ -1,6 +1,8 @@
 ## Common Field Types
 
 ```diff
+Updated description of `AmountString` field clarifying the currency format and noting it defaults to AUD 
+
 Clarified formatting of RateString type
 ```
 
@@ -23,7 +25,7 @@ DateString | Date string as per **[[RFC3339]](#nref-RFC3339)** (labelled full-da
 TimeString | Time string as per **[[RFC3339]](#nref-RFC3339)** (labelled full-time in the RFC). As specified in **[[RFC3339]](#nref-RFC3339)** times MUST be offset relative to UTC | “15:43:00.12345Z”<br/>“15:43:00-12:00”
 CurrencyString | Standard 3 character currency codes as per ISO-4217 | “AUD”<br/>“USD”<br/>“GBP”
 RateString | A string representing a percentage (e.g., an interest rate). For example, a rate of 100% would be represented by the value `"1"` and a rate of -100% by `"-1"`<br/>- At least 1 and up to a total of 16 significant digits before a decimal point<br/>- Up to 16 digits following a decimal point if required<br/>- No formatting, e.g., thousand-separating commas. | `"0"` or `"0.0"` (0%)<br/>`"1"` or `"1.0"` (100%)<br/>`"-1.234567"` (-123.4567%)<br/>`"-0.056"` (-5.6%)<br/>`"0.03456789"` (3.456789%)<br/>`"0.2"` (20%)<br/>`"23.456"` (2345.6%)
-AmountString | A string representing an amount of currency.<br/>- A positive, zero or negative number<br/>- Negative numbers identified with a ‘-‘<br/>- Currency symbols MUST NOT be supplied<br/>- At least 1 and up to a total of 16 significant digits before decimal point<br/>- Minimum 2 digits following a decimal point (more digits allowable but only if required)<br/>- No additional formatting, eg thousand separating commas | “0.01”<br/>“10.00”<br/>“1234567.89”<br/>“-1001.23”<br/>“1.999”
+AmountString | A string representing a monetary amount in currency units with fractional units after a decimal point (e.g., if working with Australian dollars: "123.45" for one hundred and twenty-three dollars and forty-five cents).<br/>- A positive, zero or negative number<br/>- Negative numbers identified with a ‘-‘ prefix<br/>- Currency symbols MUST NOT be supplied<br/>- At least 1 and up to a total of 16 significant digits before decimal point<br/>- Minimum 2 digits following a decimal point (more digits allowable but only if required)<br/>- No additional formatting, eg thousand separating commas<br/>- Assumed to be in AUD unless specified otherwise | “0.01”<br/>“10.00”<br/>“1234567.89”<br/>“-1001.23”<br/>“1.999”
 MaskedPANString | Masked credit card number. Lower case ‘x’ MUST be used to mask numbers and only the last four digits MUST be exposed to facilitate identification. This type is expected to be used for display so the format MUST be logical for this context | "xxxx xxxx xxxx 1234"
 MaskedAccountString | Masked bank account number genericised for a variety of account types.  MUST be represented as the full account number would normally be represented for display (including formatting) but with all digits except the last four replaced with a lowercase x. This type is expected to be used for display so the format MUST be logical for this context | "xxxx xxxx xxxx 1234"<br/>"xxx-xxx xxxxx1234"
 URIString | A valid URI | "http://www.google.com"