au.org.consumerdatastandards.api.banking.models.BankingTermDepositAccount Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api-model Show documentation

This artefact describes the Consumer Data Standards using Java classes and annotations in a way suitable for automatic generation of Open API Specification, documentation, Server Stub, Client Libraries and Reference Test.

There is a newer version: 1.1.1

Show newest version

package au.org.consumerdatastandards.api.banking.models;

import au.org.consumerdatastandards.support.data.*;

@DataDefinition
public class BankingTermDepositAccount {

    public enum MaturityInstructions {
        ROLLED_OVER,
        PAID_OUT_AT_MATURITY
    }

    @Property(
        description = "The lodgement date of the original deposit",
        required = true
    )
    @CDSDataType(CustomDataType.Date)
    String lodgementDate;

    @Property(
        description = "Maturity date for the term deposit",
        required = true
    )
    @CDSDataType(CustomDataType.Date)
    String maturityDate;

    @Property(
        description = "Amount to be paid upon maturity. If absent it implies the amount to paid is variable and cannot currently be calculated"
    )
    @CDSDataType(CustomDataType.Amount)
    String maturityAmount;

    @Property(
        description = "If absent assumes AUD"
    )
    @CDSDataType(CustomDataType.Currency)
    String maturityCurrency;

    @Property(
        description = "Current instructions on action to be taken at maturity",
        required = true
    )
    MaturityInstructions maturityInstructions;
}