ACMC GraphQL ENUM Type
ENUM types in the ACMC schema provide a way to define a fixed set of values for specific fields, ensuring data consistency and improving query efficiency. These types, such as AccountOpenState, CommandState, and PartyType, represent predefined sets of options that can be used across various parts of the schema.
Examples of how ENUM types can be used in the ACMC schema:
AccountOpenState:- Possible values: OPEN, CLOSING, CLOSED
- Use case: Indicating the current status of an account in its lifecycle.
CommandState:- Possible values: SUBMITTED, SUCCESSFUL, PARTIALLY_SUCCESSFUL, FAILED
- Use case: Indicating the current state of a command in the system.
PartyType:- Possible values: INDIVIDUAL, COMPANY, TRUST, ASSOCIATION
- Use case: Categorizing the types of parties in the system.
ENUM TYPES EXAMPLES
| Name | Description | Possible Values |
|---|---|---|
| AUWithholdingTaxDesignation | Specifies the withholding tax status for Australian accounts | EXEMPT, SELF_REPORTING, RESIDENT_WITHHOLDING_TAX, NON_RESIDENT_WITHHOLDING_TAX |
| AccountOpenState | Represents the current operational state of an account | OPEN, CLOSING, CLOSED |
| AccrualType | Defines the types of accrual events for financial calculations | SCHEDULED, CLOSURE, BALANCE_ADJUSTMENT, RATE_ADJUSTMENT, PRODUCT_MOVEMENT, ON_DEMAND |
| AggregateInstructionState | Indicates the processing status of aggregate instructions | PROCESSING, SUCCEEDED, FAILED |
| AggregatePaymentMethod | Specifies the method used for aggregate payments | DE, NPP, RTGS |
| AggregatePaymentState | Represents the current state of an aggregate payment | PROCESSING, COMPLETE |
| AggregatePaymentType | Defines the types of aggregate payments | DE, NPP, RTGS |
| AllocationState | Indicates the current state of an allocation process | PENDING, ALLOCATED, UNALLOCATED, FAILED, MATCHED, MOVING_TO_CLA, MOVED_TO_CLA, DELETED, DELETION_REQUESTED, RESTORATION_REQUESTED, SPLITTING, SPLIT, DEFERRED |
| ApprovalRole | Defines the roles involved in an approval process | APPROVER, INSTIGATOR, REJECTOR |
| ApprovalState | Represents the current state of an approval process | PENDING, APPROVING, APPROVED, REJECTED |
| BusinessProcessType | N/A | RECEIPT, PAYMENT, PAYMENT_REQUEST, INTERNAL_TRANSFER, INTEREST, MANUAL_INTEREST_ADJUSTMENT, WITHHOLDING_TAX_ACCOUNT_REFUND, AGGREGATE_PAYMENT |
| CommandState | The current processing state of a command. | SUBMITTED, SUCCESSFUL, PARTIALLY_SUCCESSFUL, FAILED |
| IncorporatedAssociationType | N/A | INCORPORATED |
| IndividualTINMissingReason | N/A | NOT_ISSUED, NOT_REQUIRED, APPLIED_FOR, UNOBTAINABLE, NOT_PROVIDED, NO_TAX_RETURN_REQUIRED, NON_RESIDENT, PENSIONER, PENSION_OR_BENEFITS |
| KYCStatus | Indicates the status of Know Your Customer (KYC) verification | COMPLETE, NEW, OBSOLETE, PARTIALLY_COMPLETE |
| NonIndividualClientClassification | Classifies non-individual clients into categories | COMPANY, TRUST, FI, OTHER, SMSF |
| NonIndividualTINMissingReason | Specifies reasons for missing Tax Identification Numbers for non-individual entities | NOT_ISSUED, NOT_REQUIRED, APPLIED_FOR, UNOBTAINABLE, NOT_PROVIDED, NO_TAX_RETURN_REQUIRED, NON_RESIDENT |
| NonIndividualTaxReportingType | Tax reporting types applicable for companies or trusts. | EXEMPT_ENTITY, MANAGED_INVESTMENT_ENTITY_CRS_COUNTRY, FINANCIAL_INSTITUTION, ACTIVE_NON_FINANCIAL_ENTITY, MANAGED_INVESTMENT_ENTITY_NON_CRS_COUNTRY, PASSIVE_NON_FINANCIAL_ENTITY |
| PartyTrustOffshoreUnregulatedTestamentaryType | Defines the type for offshore unregulated testamentary trusts | OFFSHORE_UNREGULATED_TESTAMENTARY |
| PartyTrustOffshoreUnregulatedUnitType | Specifies the type for offshore unregulated unit trusts | OFFSHORE_UNREGULATED_UNIT |
| PartyType | Categorizes the types of parties in the system | INDIVIDUAL, COMPANY, TRUST, ASSOCIATION, COOPERATIVE, PARTNERSHIP, GOVERNMENT_BODY |
| PaymentRequestMethod | Defines the methods available for payment requests | DE, NPP |
| PaymentRequestStatus | Indicates the current status of a payment request | SUBMITTED, RECEIVED, PROCESSING, PENDING, REJECTED, COMPLETED, COMPLETED_WITH_ERRORS |
| PaymentState | Represents the current state of a payment | SUBMITTED, RECEIVED, PENDING, PROCESSING, COMPLETED, COMPLETED_WITH_ERRORS, REJECTED |
| ReportingFinancialInstitution | Indicates whether an entity is a reporting financial institution | YES, NO |
| Role | Defines the roles associated with a party in the system | BENEFICIARY, TRUSTEE, CONTROLLING_PERSON |
| TinMissingReason | Specifies reasons for missing Tax Identification Numbers | APPLIED_FOR, FINANCE_PROVIDER, NO_TAX_RETURN_REQUIRED, NON_RESIDENT, NOT_ISSUED, NOT_PROVIDED, NOT_REQUIRED, PENSION_OR_BENEFITS, PENSIONER, UNDER_16, UNOBTAINABLE |
| TransactionState | Indicates the current state of a transaction | PENDING, SUCCESSFUL, FAILED |
| UnallocatedReasonCode | Specifies reasons for unallocated funds or transactions | MULTIPLE_DESTINATIONS, NO_DESTINATION, TRANSACT_FAILED, MANUAL_UNALLOCATION, REVERSAL, UNMATCHED, BLOCKED_DIRECT_DEBIT, PAYMENT_REJECTED, PAYMENT_REQUEST_REJECTED, DELETION_DENIED, RESTORED |
| VerificationStatuses | Represents the possible statuses of a verification process | ESCALATE, NON_VERIFIED, NON_VERIFIED_MIGRATED, RE_VERIFICATION_REQUIRED, VERIFIED_MIGRATED |
This overview provides a summary of key ENUM types available in the ACMC GraphQL API, including their possible values and basic use cases. For more comprehensive information, detailed usage examples, and the complete set of available ENUM types, please refer to the full ACMC GraphQL schema documentation and dedicated sample pages.