Organisation isACNCRegistered values are unclear #685
Labels
Breaking change
A change expected to result in a new endpoint version.
Common
Issues related to Common APIs.
Description
The optional isACNCRegistered field of the CommonOrganisation schema is a Boolean type, but the description suggests three meaningful value options:
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.
The text was updated successfully, but these errors were encountered: