Skip to content
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.

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

Organisation isACNCRegistered values are unclear #685

Open
nils-work opened this issue Feb 7, 2025 · 0 comments
Open

Organisation isACNCRegistered values are unclear #685

nils-work opened this issue Feb 7, 2025 · 0 comments
Labels
Breaking change A change expected to result in a new endpoint version. Common Issues related to Common APIs.

Comments

@nils-work
Copy link
Member

Description

The optional isACNCRegistered field of the CommonOrganisation schema is a Boolean type, but the description suggests three meaningful value options:

true if registered with the ACNC. false if not. Absent or null if not confirmed.

While this is a valid pattern according to Empty/Null Fields, specifying this field as an Enum with clearer values will avoid ambiguity.

Intention and Value of Change

Clarify the charity status of an organisation by removing any ambiguity from the negative and absent value options.
This field supports rule Sch.3, 1.3: (I) whether the business is a charitable or not‑for‑profit organisation;

Area Affected

Change Proposed

Specify the field Type as an Enum with three positive value options:

  • REGISTERED
  • NOT_REGISTERED
  • UNKNOWN

This change could be incorporated with other changes to this schema, such as the removal of 'agent' detail suggested in: ConsumerDataStandardsAustralia/future-plan#90.

@nils-work nils-work added Common Issues related to Common APIs. Breaking change A change expected to result in a new endpoint version. labels Feb 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Breaking change A change expected to result in a new endpoint version. Common Issues related to Common APIs.
Projects
Status: Full Backlog
Development

No branches or pull requests

1 participant