/* tslint:disable */
/* eslint-disable */
/**
 * deposits
 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 *
 * The version of the OpenAPI document: v2
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */

// May contain unused imports in some cases
// @ts-ignore
import type { DepositAccountAccruedAmounts } from './deposit-account-accrued-amounts';
// May contain unused imports in some cases
// @ts-ignore
import type { DepositAccountBalances } from './deposit-account-balances';
// May contain unused imports in some cases
// @ts-ignore
import type { DepositAccountInterestSettings } from './deposit-account-interest-settings';
// May contain unused imports in some cases
// @ts-ignore
import type { DepositAccountInternalControls } from './deposit-account-internal-controls';
// May contain unused imports in some cases
// @ts-ignore
import type { DepositAccountOverdraftInterestSettings } from './deposit-account-overdraft-interest-settings';
// May contain unused imports in some cases
// @ts-ignore
import type { DepositAccountOverdraftSettings } from './deposit-account-overdraft-settings';
// May contain unused imports in some cases
// @ts-ignore
import type { DepositAccountOwnershipHistory } from './deposit-account-ownership-history';

/**
 * Represents information about a deposit account.
 */
export interface DepositAccount {
  /**
   * The encoded key of the account holder, which is an individual client or group.
   */
  accountHolderKey: string;
  /**
   * Indicated the account holder type.
   */
  accountHolderType: DepositAccountAccountHolderTypeEnum;
  /**
   * The state of the deposit account.
   */
  accountState?: DepositAccountAccountStateEnum;
  /**
   * The deposit account type and the product that it belongs to.
   */
  accountType?: DepositAccountAccountTypeEnum;
  accruedAmounts?: DepositAccountAccruedAmounts;
  /**
   * The date when the deposit account was activated, in the organization\'s timezone and time format.
   */
  activationDate?: string;
  /**
   * The date when the deposit account was approved, in the organization\'s timezone and time format.
   */
  approvedDate?: string;
  /**
   * The key of the branch that this deposit account is assigned to.
   */
  assignedBranchKey?: string;
  /**
   * The key of the centre that this account is assigned to.
   */
  assignedCentreKey?: string;
  /**
   * The key of the user that this deposit is assigned to.
   */
  assignedUserKey?: string;
  balances?: DepositAccountBalances;
  /**
   * The date when the deposit account was closed, in UTC.
   */
  closedDate?: string;
  /**
   * The date this deposit account was created, in UTC.
   */
  creationDate?: string;
  /**
   * The key to the credit arrangement where this account is registered.
   */
  creditArrangementKey?: string;
  /**
   * The currency code.
   */
  currencyCode?: string;
  /**
   * The encoded key of the deposit account, which is auto-generated and unique.
   */
  encodedKey?: string;
  /**
   * The ID of the deposit account, which can be generated and customized - but must be unique.
   */
  id?: string;
  interestSettings?: DepositAccountInterestSettings;
  internalControls?: DepositAccountInternalControls;
  /**
   * The date when the account was last evaluated for interest calculations and maturity, in the organization\'s timezone and time format.
   */
  lastAccountAppraisalDate?: string;
  /**
   * The date when interest was last calculated for the account, in the organization\'s timezone and time format.
   */
  lastInterestCalculationDate?: string;
  /**
   * The date when regular interest was last reviewed, in the organization\'s timezone and time format.
   */
  lastInterestReviewDate?: string;
  /**
   * The date when interest was last applied on the account, in the organization\'s timezone and time format.
   */
  lastInterestStoredDate?: string;
  /**
   * The last update date for the deposit account, in UTC.
   */
  lastModifiedDate?: string;
  /**
   * The date when the overdraft interest was last reviewed, in the organization\'s timezone and time format.
   */
  lastOverdraftInterestReviewDate?: string;
  /**
   * The date when the deposit account was set to In Arrears, or null if the account is not In Arrears. The date is in the organization\'s timezone and time format.
   */
  lastSetToArrearsDate?: string;
  /**
   * Lists all loan account keys on which the deposit account is used as the settlement account.
   */
  linkedSettlementAccountKeys?: Array<string>;
  /**
   * The date when the deposit account was locked, in the organization\'s timezone and time format.
   */
  lockedDate?: string;
  /**
   * The date when the account matures, for fixed or compulsory savings plans, in the organization\'s timezone and time format.
   */
  maturityDate?: string;
  /**
   * The migration event encoded key associated with this deposit account. If this account was imported, you can track which migration event it came from.
   */
  migrationEventKey?: string;
  /**
   * The deposit account name.
   */
  name: string;
  /**
   * The notes or description attached to this object.
   */
  notes?: string;
  overdraftInterestSettings?: DepositAccountOverdraftInterestSettings;
  overdraftSettings?: DepositAccountOverdraftSettings;
  /**
   * The history of deposit account ownership
   */
  ownershipHistory?: Array<DepositAccountOwnershipHistory>;
  /**
   * The key to the product type that this account is based on.
   */
  productTypeKey: string;
  /**
   * The tax source where the account withholding taxes will be updated.
   */
  withholdingTaxSourceKey?: string;
}

export const DepositAccountAccountHolderTypeEnum = {
  Client: 'CLIENT',
  Group: 'GROUP',
} as const;

export type DepositAccountAccountHolderTypeEnum =
  (typeof DepositAccountAccountHolderTypeEnum)[keyof typeof DepositAccountAccountHolderTypeEnum];
export const DepositAccountAccountStateEnum = {
  PendingApproval: 'PENDING_APPROVAL',
  Approved: 'APPROVED',
  Active: 'ACTIVE',
  ActiveInArrears: 'ACTIVE_IN_ARREARS',
  Matured: 'MATURED',
  Locked: 'LOCKED',
  Dormant: 'DORMANT',
  Closed: 'CLOSED',
  ClosedWrittenOff: 'CLOSED_WRITTEN_OFF',
  Withdrawn: 'WITHDRAWN',
  ClosedRejected: 'CLOSED_REJECTED',
} as const;

export type DepositAccountAccountStateEnum =
  (typeof DepositAccountAccountStateEnum)[keyof typeof DepositAccountAccountStateEnum];
export const DepositAccountAccountTypeEnum = {
  CurrentAccount: 'CURRENT_ACCOUNT',
  RegularSavings: 'REGULAR_SAVINGS',
  FixedDeposit: 'FIXED_DEPOSIT',
  SavingsPlan: 'SAVINGS_PLAN',
  InvestorAccount: 'INVESTOR_ACCOUNT',
} as const;

export type DepositAccountAccountTypeEnum =
  (typeof DepositAccountAccountTypeEnum)[keyof typeof DepositAccountAccountTypeEnum];