From b7d15f9a97625fd2650c27708f2c7537bb0d7043 Mon Sep 17 00:00:00 2001 From: Hemang Rathod Date: Fri, 30 Aug 2024 17:02:13 +1000 Subject: [PATCH 1/3] Standards Maintenance Issue #652: Updated description of AmountString field clarifying the currency format and noting it defaults to AUD --- .../includes/releasenotes/releasenotes.1.32.0.html.md | 4 ++-- slate/source/includes/standards/_types.md | 6 ++++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/slate/source/includes/releasenotes/releasenotes.1.32.0.html.md b/slate/source/includes/releasenotes/releasenotes.1.32.0.html.md index 3ef0a75c..16e12e04 100644 --- a/slate/source/includes/releasenotes/releasenotes.1.32.0.html.md +++ b/slate/source/includes/releasenotes/releasenotes.1.32.0.html.md @@ -21,7 +21,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 #XXX - Title](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/XXX) +- [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 @@ -46,7 +46,7 @@ This release addresses the following Decision Proposals published on [Standards] ## High Level Standards |Change|Description|Link| |------|-----------|----| - +| Updated AmountString description | [**Standards Maintenance #652**](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/652): Updated description of `AmountString` field clarifying the currency format and noting it defaults to AUD | [Common Field Types](../../#common-field-types) ## API Endpoints |Change|Description|Link| diff --git a/slate/source/includes/standards/_types.md b/slate/source/includes/standards/_types.md index f9100d0a..3dfa7639 100644 --- a/slate/source/includes/standards/_types.md +++ b/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 +``` The following table outlines the common data types for fields used in the standard. @@ -21,7 +23,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”
“15:43:00-12:00” CurrencyString | Standard 3 character currency codes as per ISO-4217 | “AUD”
“USD”
“GBP” RateString | A string representing a percentage (e.g. an interest rate). A rate of 100% would be represented by the value 1.0 and a rate of -100% by -1.0
- At least 1 and up to a total of 16 significant digits before decimal point
- Up to 16 digits following the decimal point
- No formatting, eg thousand separating commas | “0.05”`(=5%)`
“-0.05”`(=-5%)`
“12.3456789”`(=1234.56789%)`
“-99.123456789123”`(=9912.3456789123%)` -AmountString | A string representing an amount of currency.
- A positive, zero or negative number
- Negative numbers identified with a ‘-‘
- Currency symbols MUST NOT be supplied
- At least 1 and up to a total of 16 significant digits before decimal point
- Minimum 2 digits following a decimal point (more digits allowable but only if required)
- No additional formatting, eg thousand separating commas | “0.01”
“10.00”
“1234567.89”
“-1001.23”
“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 twenty-three dollars and forty-five cents).
- A positive, zero or negative number
- Negative numbers identified with a ‘-‘ prefix
- Currency symbols MUST NOT be supplied
- At least 1 and up to a total of 16 significant digits before decimal point
- Minimum 2 digits following a decimal point (more digits allowable but only if required)
- No additional formatting, eg thousand separating commas
- Assumed to be in AUD unless specified otherwise | “0.01”
“10.00”
“1234567.89”
“-1001.23”
“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"
"xxx-xxx xxxxx1234" URIString | A valid URI | "http://www.google.com" From 1034d8b32583e7a83fc31fd1a900858fafe160a6 Mon Sep 17 00:00:00 2001 From: Nils Berge <60594671+nils-work@users.noreply.github.com> Date: Mon, 2 Sep 2024 10:30:26 +1000 Subject: [PATCH 2/3] adding 'and' for one hundred 'and' twenty-three dollars --- slate/source/includes/standards/_types.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/slate/source/includes/standards/_types.md b/slate/source/includes/standards/_types.md index 3dfa7639..320e5a85 100644 --- a/slate/source/includes/standards/_types.md +++ b/slate/source/includes/standards/_types.md @@ -23,7 +23,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”
“15:43:00-12:00” CurrencyString | Standard 3 character currency codes as per ISO-4217 | “AUD”
“USD”
“GBP” RateString | A string representing a percentage (e.g. an interest rate). A rate of 100% would be represented by the value 1.0 and a rate of -100% by -1.0
- At least 1 and up to a total of 16 significant digits before decimal point
- Up to 16 digits following the decimal point
- No formatting, eg thousand separating commas | “0.05”`(=5%)`
“-0.05”`(=-5%)`
“12.3456789”`(=1234.56789%)`
“-99.123456789123”`(=9912.3456789123%)` -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 twenty-three dollars and forty-five cents).
- A positive, zero or negative number
- Negative numbers identified with a ‘-‘ prefix
- Currency symbols MUST NOT be supplied
- At least 1 and up to a total of 16 significant digits before decimal point
- Minimum 2 digits following a decimal point (more digits allowable but only if required)
- No additional formatting, eg thousand separating commas
- Assumed to be in AUD unless specified otherwise | “0.01”
“10.00”
“1234567.89”
“-1001.23”
“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).
- A positive, zero or negative number
- Negative numbers identified with a ‘-‘ prefix
- Currency symbols MUST NOT be supplied
- At least 1 and up to a total of 16 significant digits before decimal point
- Minimum 2 digits following a decimal point (more digits allowable but only if required)
- No additional formatting, eg thousand separating commas
- Assumed to be in AUD unless specified otherwise | “0.01”
“10.00”
“1234567.89”
“-1001.23”
“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"
"xxx-xxx xxxxx1234" URIString | A valid URI | "http://www.google.com" From 11cd3dff866110cc0dea15ccd7af80874f33a4c3 Mon Sep 17 00:00:00 2001 From: Nils Berge <60594671+nils-work@users.noreply.github.com> Date: Thu, 5 Sep 2024 16:35:51 +1000 Subject: [PATCH 3/3] Minor update to styling and wording --- slate/source/includes/releasenotes/releasenotes.1.32.0.html.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/slate/source/includes/releasenotes/releasenotes.1.32.0.html.md b/slate/source/includes/releasenotes/releasenotes.1.32.0.html.md index 16e12e04..7513d00b 100644 --- a/slate/source/includes/releasenotes/releasenotes.1.32.0.html.md +++ b/slate/source/includes/releasenotes/releasenotes.1.32.0.html.md @@ -46,7 +46,7 @@ This release addresses the following Decision Proposals published on [Standards] ## High Level Standards |Change|Description|Link| |------|-----------|----| -| Updated AmountString description | [**Standards Maintenance #652**](https://github.com/ConsumerDataStandardsAustralia/standards-maintenance/issues/652): Updated description of `AmountString` field clarifying the currency format and noting it defaults to AUD | [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 |Change|Description|Link|