Skip to content

feat: update currency_code to be optional #543

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
olliemath wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: update currency_code to be optional #543

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions documentation/properties/contribution_amount.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,4 @@ schemas: [adjustment]

---

The **contribution_amount** reflects the amount that the adjustment contributes to to the reportable value (in a report/cell). This amount is a monetary amount in minor currency of the corresponding currency_code for the adjustment. Implementation of contributions may differ, but are typically additive so that multiple contributions can be aggregated.

The **contribution_amount** reflects the amount that the adjustment contributes to to the reportable value (in a report/cell). If a currency_code is present, this amount is taken to be monetary in minor currency of the corresponding currency. If no currency code is present, this amount is taken as-is and assumed to be non-monetary (e.g. a percentage or risk weight). Implementation of contributions may differ, but are typically additive so that multiple contributions can be aggregated.
4 changes: 1 addition & 3 deletions documentation/properties/contribution_text.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,4 @@ schemas: [adjustment]

---

The **contribution_text** is used where contributions are not monetary values, but rather text/string values or decimals/percentages. As these values are typically used in reporting in a one-to-one correspondence, aggregations of contribution texts typically don't make sense. Implementation specific cases may also be present to account for the wider range of non-monetary reportable values.


The **contribution_text** is used where contributions are not numbers, but rather text/string values. As these values are typically used in reporting in a one-to-one correspondence, aggregations of contribution texts typically don't make sense.
8 changes: 2 additions & 6 deletions schemas/adjustment.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,8 @@
"type": "string"
},
"contribution_amount": {
"description": "The contribution amount this adjustment should make to the specified report cell. A positive/negative number in minor units (cents/pence).",
"type": "integer",
"monetary": true
"description": "The contribution amount this adjustment should make to the specified report cell. A positive/negative number, which if representing a monetary amount (i.e. accompanied by a currency code) is in minor units (cents/pence).",
"type": "number"
},
"contribution_text": {
"description": "The text to use for the adjustment where the reported cell is not a monetary value.",
Expand Down Expand Up @@ -63,8 +62,5 @@
{"required": ["id", "date", "report_type", "row", "col", "contribution_amount"]},
{"required": ["id", "date", "report_type", "row", "col", "contribution_text"]}
],
"dependencies": {
"contribution_amount": ["currency_code"]
},
"additionalProperties": true
}