fineract-typescript-client
Version:
TypeScript client for Fineract API
2,668 lines • 4.01 MB
TypeScript
/**
* Apache Fineract REST API
* Apache Fineract is a secure, multi-tenanted microfinance platform. The goal of the Apache Fineract API is to empower developers to build apps on top of the Apache Fineract Platform. The [reference app](https://cui.fineract.dev) (username: mifos, password: password) works on the same demo tenant as the interactive links in this documentation. Until we complete the new REST API documentation you still have the legacy documentation available [here](https://fineract.apache.org/docs/legacy/). Please check [the current Fineract documentation](https://fineract.apache.org/docs/current/) for more information.
*
* The version of the OpenAPI document: 1.13.0-SNAPSHOT
* Contact: dev@fineract.apache.org
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import type { Configuration } from './configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import type { RequestArgs } from './base';
import { BaseAPI } from './base';
/**
*
* @export
* @interface AccountChargesRequest
*/
export interface AccountChargesRequest {
/**
*
* @type {number}
* @memberof AccountChargesRequest
*/
'amount'?: number;
/**
*
* @type {number}
* @memberof AccountChargesRequest
*/
'chargeId'?: number;
}
/**
*
* @export
* @interface AccountRequest
*/
export interface AccountRequest {
/**
*
* @type {string}
* @memberof AccountRequest
*/
'allowDividendCalculationForInactiveClients'?: string;
/**
*
* @type {string}
* @memberof AccountRequest
*/
'applicationDate'?: string;
/**
*
* @type {string}
* @memberof AccountRequest
*/
'approvedDate'?: string;
/**
*
* @type {Array<AccountChargesRequest>}
* @memberof AccountRequest
*/
'charges'?: Array<AccountChargesRequest>;
/**
*
* @type {number}
* @memberof AccountRequest
*/
'clientId'?: number;
/**
*
* @type {string}
* @memberof AccountRequest
*/
'currencyCode'?: string;
/**
*
* @type {string}
* @memberof AccountRequest
*/
'dateFormat'?: string;
/**
*
* @type {number}
* @memberof AccountRequest
*/
'digitsAfterDecimal'?: number;
/**
*
* @type {string}
* @memberof AccountRequest
*/
'externalId'?: string;
/**
*
* @type {number}
* @memberof AccountRequest
*/
'id'?: number;
/**
*
* @type {string}
* @memberof AccountRequest
*/
'inMultiplesOf'?: string;
/**
*
* @type {string}
* @memberof AccountRequest
*/
'locale'?: string;
/**
*
* @type {number}
* @memberof AccountRequest
*/
'lockinPeriodFrequency'?: number;
/**
*
* @type {string}
* @memberof AccountRequest
*/
'lockinPeriodFrequencyType'?: string;
/**
*
* @type {number}
* @memberof AccountRequest
*/
'minimumActivePeriod'?: number;
/**
*
* @type {string}
* @memberof AccountRequest
*/
'minimumActivePeriodFrequencyType'?: string;
/**
*
* @type {number}
* @memberof AccountRequest
*/
'numberOfShares'?: number;
/**
*
* @type {number}
* @memberof AccountRequest
*/
'productId'?: number;
/**
*
* @type {string}
* @memberof AccountRequest
*/
'purchasedDate'?: string;
/**
*
* @type {number}
* @memberof AccountRequest
*/
'requestedShares'?: number;
/**
*
* @type {number}
* @memberof AccountRequest
*/
'savingsAccountId'?: number;
/**
*
* @type {string}
* @memberof AccountRequest
*/
'submittedDate'?: string;
/**
*
* @type {number}
* @memberof AccountRequest
*/
'unitPrice'?: number;
}
/**
*
* @export
* @interface AccountRuleRequest
*/
export interface AccountRuleRequest {
/**
*
* @type {number}
* @memberof AccountRuleRequest
*/
'accountToCredit'?: number;
/**
*
* @type {number}
* @memberof AccountRuleRequest
*/
'accountToDebit'?: number;
/**
*
* @type {string}
* @memberof AccountRuleRequest
*/
'description'?: string;
/**
*
* @type {string}
* @memberof AccountRuleRequest
*/
'name'?: string;
/**
*
* @type {number}
* @memberof AccountRuleRequest
*/
'officeId'?: number;
}
/**
*
* @export
* @interface AccountTransferData
*/
export interface AccountTransferData {
/**
*
* @type {CurrencyData}
* @memberof AccountTransferData
*/
'currency'?: CurrencyData;
/**
*
* @type {PortfolioAccountData}
* @memberof AccountTransferData
*/
'fromAccount'?: PortfolioAccountData;
/**
*
* @type {Array<PortfolioAccountData>}
* @memberof AccountTransferData
*/
'fromAccountOptions'?: Array<PortfolioAccountData>;
/**
*
* @type {EnumOptionData}
* @memberof AccountTransferData
*/
'fromAccountType'?: EnumOptionData;
/**
*
* @type {Array<EnumOptionData>}
* @memberof AccountTransferData
*/
'fromAccountTypeOptions'?: Array<EnumOptionData>;
/**
*
* @type {ClientData}
* @memberof AccountTransferData
*/
'fromClient'?: ClientData;
/**
*
* @type {Array<ClientData>}
* @memberof AccountTransferData
*/
'fromClientOptions'?: Array<ClientData>;
/**
*
* @type {OfficeData}
* @memberof AccountTransferData
*/
'fromOffice'?: OfficeData;
/**
*
* @type {Array<OfficeData>}
* @memberof AccountTransferData
*/
'fromOfficeOptions'?: Array<OfficeData>;
/**
*
* @type {number}
* @memberof AccountTransferData
*/
'id'?: number;
/**
*
* @type {boolean}
* @memberof AccountTransferData
*/
'reversed'?: boolean;
/**
*
* @type {PortfolioAccountData}
* @memberof AccountTransferData
*/
'toAccount'?: PortfolioAccountData;
/**
*
* @type {Array<PortfolioAccountData>}
* @memberof AccountTransferData
*/
'toAccountOptions'?: Array<PortfolioAccountData>;
/**
*
* @type {EnumOptionData}
* @memberof AccountTransferData
*/
'toAccountType'?: EnumOptionData;
/**
*
* @type {Array<EnumOptionData>}
* @memberof AccountTransferData
*/
'toAccountTypeOptions'?: Array<EnumOptionData>;
/**
*
* @type {ClientData}
* @memberof AccountTransferData
*/
'toClient'?: ClientData;
/**
*
* @type {Array<ClientData>}
* @memberof AccountTransferData
*/
'toClientOptions'?: Array<ClientData>;
/**
*
* @type {OfficeData}
* @memberof AccountTransferData
*/
'toOffice'?: OfficeData;
/**
*
* @type {Array<OfficeData>}
* @memberof AccountTransferData
*/
'toOfficeOptions'?: Array<OfficeData>;
/**
*
* @type {number}
* @memberof AccountTransferData
*/
'transferAmount'?: number;
/**
*
* @type {string}
* @memberof AccountTransferData
*/
'transferDate'?: string;
/**
*
* @type {string}
* @memberof AccountTransferData
*/
'transferDescription'?: string;
}
/**
*
* @export
* @interface AccountTransferRequest
*/
export interface AccountTransferRequest {
/**
*
* @type {string}
* @memberof AccountTransferRequest
*/
'dateFormat'?: string;
/**
*
* @type {string}
* @memberof AccountTransferRequest
*/
'fromAccountId'?: string;
/**
*
* @type {string}
* @memberof AccountTransferRequest
*/
'fromAccountType'?: string;
/**
*
* @type {string}
* @memberof AccountTransferRequest
*/
'fromClientId'?: string;
/**
*
* @type {string}
* @memberof AccountTransferRequest
*/
'fromOfficeId'?: string;
/**
*
* @type {string}
* @memberof AccountTransferRequest
*/
'locale'?: string;
/**
*
* @type {string}
* @memberof AccountTransferRequest
*/
'toAccountId'?: string;
/**
*
* @type {string}
* @memberof AccountTransferRequest
*/
'toAccountType'?: string;
/**
*
* @type {string}
* @memberof AccountTransferRequest
*/
'toClientId'?: string;
/**
*
* @type {string}
* @memberof AccountTransferRequest
*/
'toOfficeId'?: string;
/**
*
* @type {string}
* @memberof AccountTransferRequest
*/
'transferAmount'?: string;
/**
*
* @type {string}
* @memberof AccountTransferRequest
*/
'transferDate'?: string;
/**
*
* @type {string}
* @memberof AccountTransferRequest
*/
'transferDescription'?: string;
}
/**
*
* @export
* @interface AccountingRuleData
*/
export interface AccountingRuleData {
/**
*
* @type {boolean}
* @memberof AccountingRuleData
*/
'allowMultipleCreditEntries'?: boolean;
/**
*
* @type {boolean}
* @memberof AccountingRuleData
*/
'allowMultipleDebitEntries'?: boolean;
/**
*
* @type {Array<GLAccountData>}
* @memberof AccountingRuleData
*/
'allowedAccounts'?: Array<GLAccountData>;
/**
*
* @type {Array<CodeValueData>}
* @memberof AccountingRuleData
*/
'allowedCreditTagOptions'?: Array<CodeValueData>;
/**
*
* @type {Array<CodeValueData>}
* @memberof AccountingRuleData
*/
'allowedDebitTagOptions'?: Array<CodeValueData>;
/**
*
* @type {Array<OfficeData>}
* @memberof AccountingRuleData
*/
'allowedOffices'?: Array<OfficeData>;
/**
*
* @type {Array<GLAccountDataForLookup>}
* @memberof AccountingRuleData
*/
'creditAccounts'?: Array<GLAccountDataForLookup>;
/**
*
* @type {Array<AccountingTagRuleData>}
* @memberof AccountingRuleData
*/
'creditTags'?: Array<AccountingTagRuleData>;
/**
*
* @type {Array<GLAccountDataForLookup>}
* @memberof AccountingRuleData
*/
'debitAccounts'?: Array<GLAccountDataForLookup>;
/**
*
* @type {Array<AccountingTagRuleData>}
* @memberof AccountingRuleData
*/
'debitTags'?: Array<AccountingTagRuleData>;
/**
*
* @type {string}
* @memberof AccountingRuleData
*/
'description'?: string;
/**
*
* @type {number}
* @memberof AccountingRuleData
*/
'id'?: number;
/**
*
* @type {string}
* @memberof AccountingRuleData
*/
'name'?: string;
/**
*
* @type {number}
* @memberof AccountingRuleData
*/
'officeId'?: number;
/**
*
* @type {string}
* @memberof AccountingRuleData
*/
'officeName'?: string;
/**
*
* @type {boolean}
* @memberof AccountingRuleData
*/
'systemDefined'?: boolean;
}
/**
*
* @export
* @interface AccountingTagRuleData
*/
export interface AccountingTagRuleData {
/**
*
* @type {number}
* @memberof AccountingTagRuleData
*/
'id'?: number;
/**
*
* @type {CodeValueData}
* @memberof AccountingTagRuleData
*/
'tag'?: CodeValueData;
/**
*
* @type {EnumOptionData}
* @memberof AccountingTagRuleData
*/
'transactionType'?: EnumOptionData;
}
/**
*
* @export
* @interface AdHocData
*/
export interface AdHocData {
/**
*
* @type {string}
* @memberof AdHocData
*/
'createdBy'?: string;
/**
*
* @type {number}
* @memberof AdHocData
*/
'createdById'?: number;
/**
*
* @type {string}
* @memberof AdHocData
*/
'createdOn'?: string;
/**
*
* @type {string}
* @memberof AdHocData
*/
'email'?: string;
/**
*
* @type {number}
* @memberof AdHocData
*/
'id'?: number;
/**
*
* @type {boolean}
* @memberof AdHocData
*/
'isActive'?: boolean;
/**
*
* @type {string}
* @memberof AdHocData
*/
'lastRun'?: string;
/**
*
* @type {string}
* @memberof AdHocData
*/
'name'?: string;
/**
*
* @type {string}
* @memberof AdHocData
*/
'query'?: string;
/**
*
* @type {number}
* @memberof AdHocData
*/
'reportRunEvery'?: number;
/**
*
* @type {Array<EnumOptionData>}
* @memberof AdHocData
*/
'reportRunFrequencies'?: Array<EnumOptionData>;
/**
*
* @type {number}
* @memberof AdHocData
*/
'reportRunFrequency'?: number;
/**
*
* @type {string}
* @memberof AdHocData
*/
'tableFields'?: string;
/**
*
* @type {string}
* @memberof AdHocData
*/
'tableName'?: string;
/**
*
* @type {number}
* @memberof AdHocData
*/
'updatedById'?: number;
/**
*
* @type {string}
* @memberof AdHocData
*/
'updatedOn'?: string;
}
/**
*
* @export
* @interface AdHocRequest
*/
export interface AdHocRequest {
/**
*
* @type {string}
* @memberof AdHocRequest
*/
'email'?: string;
/**
*
* @type {number}
* @memberof AdHocRequest
*/
'id'?: number;
/**
*
* @type {boolean}
* @memberof AdHocRequest
*/
'isActive'?: boolean;
/**
*
* @type {string}
* @memberof AdHocRequest
*/
'name'?: string;
/**
*
* @type {string}
* @memberof AdHocRequest
*/
'query'?: string;
/**
*
* @type {number}
* @memberof AdHocRequest
*/
'reportRunEvery'?: number;
/**
*
* @type {number}
* @memberof AdHocRequest
*/
'reportRunFrequency'?: number;
/**
*
* @type {string}
* @memberof AdHocRequest
*/
'tableFields'?: string;
/**
*
* @type {string}
* @memberof AdHocRequest
*/
'tableName'?: string;
}
/**
*
* @export
* @interface AdHocSearchQueryData
*/
export interface AdHocSearchQueryData {
/**
*
* @type {number}
* @memberof AdHocSearchQueryData
*/
'count'?: number;
/**
*
* @type {number}
* @memberof AdHocSearchQueryData
*/
'loanOutStanding'?: number;
/**
*
* @type {string}
* @memberof AdHocSearchQueryData
*/
'loanProductName'?: string;
/**
*
* @type {Array<LoanProductData>}
* @memberof AdHocSearchQueryData
*/
'loanProducts'?: Array<LoanProductData>;
/**
*
* @type {string}
* @memberof AdHocSearchQueryData
*/
'officeName'?: string;
/**
*
* @type {Array<OfficeData>}
* @memberof AdHocSearchQueryData
*/
'offices'?: Array<OfficeData>;
/**
*
* @type {number}
* @memberof AdHocSearchQueryData
*/
'percentage'?: number;
}
/**
*
* @export
* @interface AddressData
*/
export interface AddressData {
/**
*
* @type {number}
* @memberof AddressData
*/
'addressId'?: number;
/**
*
* @type {string}
* @memberof AddressData
*/
'addressLine1'?: string;
/**
*
* @type {string}
* @memberof AddressData
*/
'addressLine2'?: string;
/**
*
* @type {string}
* @memberof AddressData
*/
'addressLine3'?: string;
/**
*
* @type {string}
* @memberof AddressData
*/
'addressType'?: string;
/**
*
* @type {number}
* @memberof AddressData
*/
'addressTypeId'?: number;
/**
*
* @type {Array<CodeValueData>}
* @memberof AddressData
*/
'addressTypeIdOptions'?: Array<CodeValueData>;
/**
*
* @type {string}
* @memberof AddressData
*/
'city'?: string;
/**
*
* @type {number}
* @memberof AddressData
*/
'clientID'?: number;
/**
*
* @type {number}
* @memberof AddressData
*/
'countryId'?: number;
/**
*
* @type {Array<CodeValueData>}
* @memberof AddressData
*/
'countryIdOptions'?: Array<CodeValueData>;
/**
*
* @type {string}
* @memberof AddressData
*/
'countryName'?: string;
/**
*
* @type {string}
* @memberof AddressData
*/
'countyDistrict'?: string;
/**
*
* @type {string}
* @memberof AddressData
*/
'createdBy'?: string;
/**
*
* @type {string}
* @memberof AddressData
*/
'createdOn'?: string;
/**
*
* @type {boolean}
* @memberof AddressData
*/
'isActive'?: boolean;
/**
*
* @type {number}
* @memberof AddressData
*/
'latitude'?: number;
/**
*
* @type {number}
* @memberof AddressData
*/
'longitude'?: number;
/**
*
* @type {string}
* @memberof AddressData
*/
'postalCode'?: string;
/**
*
* @type {string}
* @memberof AddressData
*/
'stateName'?: string;
/**
*
* @type {number}
* @memberof AddressData
*/
'stateProvinceId'?: number;
/**
*
* @type {Array<CodeValueData>}
* @memberof AddressData
*/
'stateProvinceIdOptions'?: Array<CodeValueData>;
/**
*
* @type {string}
* @memberof AddressData
*/
'street'?: string;
/**
*
* @type {string}
* @memberof AddressData
*/
'townVillage'?: string;
/**
*
* @type {string}
* @memberof AddressData
*/
'updatedBy'?: string;
/**
*
* @type {string}
* @memberof AddressData
*/
'updatedOn'?: string;
}
/**
*
* @export
* @interface AdvancedPaymentData
*/
export interface AdvancedPaymentData {
/**
*
* @type {string}
* @memberof AdvancedPaymentData
*/
'futureInstallmentAllocationRule'?: string;
/**
*
* @type {Array<PaymentAllocationOrder>}
* @memberof AdvancedPaymentData
*/
'paymentAllocationOrder'?: Array<PaymentAllocationOrder>;
/**
*
* @type {string}
* @memberof AdvancedPaymentData
*/
'transactionType'?: string;
}
/**
*
* @export
* @interface AdvancedQueryData
*/
export interface AdvancedQueryData {
/**
*
* @type {Array<ColumnFilterData>}
* @memberof AdvancedQueryData
*/
'columnFilters'?: Array<ColumnFilterData>;
/**
*
* @type {Array<ColumnFilterData>}
* @memberof AdvancedQueryData
*/
'nonNullFilters'?: Array<ColumnFilterData>;
/**
*
* @type {Array<string>}
* @memberof AdvancedQueryData
*/
'nonNullResultColumns'?: Array<string>;
/**
*
* @type {Array<string>}
* @memberof AdvancedQueryData
*/
'resultColumns'?: Array<string>;
}
/**
*
* @export
* @interface AdvancedQueryRequest
*/
export interface AdvancedQueryRequest {
/**
*
* @type {AdvancedQueryData}
* @memberof AdvancedQueryRequest
*/
'baseQuery'?: AdvancedQueryData;
/**
*
* @type {Array<TableQueryData>}
* @memberof AdvancedQueryRequest
*/
'datatableQueries'?: Array<TableQueryData>;
}
/**
*
* @export
* @interface AllowAttributeOverrides
*/
export interface AllowAttributeOverrides {
/**
*
* @type {boolean}
* @memberof AllowAttributeOverrides
*/
'amortizationType'?: boolean;
/**
*
* @type {boolean}
* @memberof AllowAttributeOverrides
*/
'graceOnArrearsAgeing'?: boolean;
/**
*
* @type {boolean}
* @memberof AllowAttributeOverrides
*/
'graceOnPrincipalAndInterestPayment'?: boolean;
/**
*
* @type {boolean}
* @memberof AllowAttributeOverrides
*/
'inArrearsTolerance'?: boolean;
/**
*
* @type {boolean}
* @memberof AllowAttributeOverrides
*/
'interestCalculationPeriodType'?: boolean;
/**
*
* @type {boolean}
* @memberof AllowAttributeOverrides
*/
'interestType'?: boolean;
/**
*
* @type {boolean}
* @memberof AllowAttributeOverrides
*/
'repaymentEvery'?: boolean;
/**
*
* @type {boolean}
* @memberof AllowAttributeOverrides
*/
'transactionProcessingStrategyCode'?: boolean;
}
/**
*
* @export
* @interface AmortizationMappingData
*/
export interface AmortizationMappingData {
/**
*
* @type {string}
* @memberof AmortizationMappingData
*/
'amortizationLoanTransactionExternalId'?: string;
/**
*
* @type {number}
* @memberof AmortizationMappingData
*/
'amortizationLoanTransactionId'?: number;
/**
*
* @type {number}
* @memberof AmortizationMappingData
*/
'amount'?: number;
/**
*
* @type {string}
* @memberof AmortizationMappingData
*/
'date'?: string;
/**
* AM for amortization, AM_ADJ for amortization adjustment
* @type {string}
* @memberof AmortizationMappingData
*/
'type'?: string;
}
/**
*
* @export
* @interface AppUser
*/
export interface AppUser {
/**
*
* @type {boolean}
* @memberof AppUser
*/
'accountNonExpired'?: boolean;
/**
*
* @type {boolean}
* @memberof AppUser
*/
'accountNonLocked'?: boolean;
/**
*
* @type {Set<AppUserClientMapping>}
* @memberof AppUser
*/
'appUserClientMappings'?: Set<AppUserClientMapping>;
/**
*
* @type {Array<GrantedAuthority>}
* @memberof AppUser
*/
'authorities'?: Array<GrantedAuthority>;
/**
*
* @type {boolean}
* @memberof AppUser
*/
'bypassUser'?: boolean;
/**
*
* @type {boolean}
* @memberof AppUser
*/
'checkerSuperUser'?: boolean;
/**
*
* @type {boolean}
* @memberof AppUser
*/
'credentialsNonExpired'?: boolean;
/**
*
* @type {boolean}
* @memberof AppUser
*/
'deleted'?: boolean;
/**
*
* @type {string}
* @memberof AppUser
*/
'displayName'?: string;
/**
*
* @type {string}
* @memberof AppUser
*/
'email'?: string;
/**
*
* @type {boolean}
* @memberof AppUser
*/
'enabled'?: boolean;
/**
*
* @type {string}
* @memberof AppUser
*/
'firstname'?: string;
/**
*
* @type {number}
* @memberof AppUser
*/
'id'?: number;
/**
*
* @type {string}
* @memberof AppUser
*/
'lastTimePasswordUpdated'?: string;
/**
*
* @type {string}
* @memberof AppUser
*/
'lastname'?: string;
/**
*
* @type {boolean}
* @memberof AppUser
*/
'new'?: boolean;
/**
*
* @type {boolean}
* @memberof AppUser
*/
'notEnabled'?: boolean;
/**
*
* @type {Office}
* @memberof AppUser
*/
'office'?: Office;
/**
*
* @type {string}
* @memberof AppUser
*/
'password'?: string;
/**
*
* @type {boolean}
* @memberof AppUser
*/
'passwordNeverExpires'?: boolean;
/**
*
* @type {Set<Role>}
* @memberof AppUser
*/
'roles'?: Set<Role>;
/**
*
* @type {boolean}
* @memberof AppUser
*/
'selfServiceUser'?: boolean;
/**
*
* @type {Staff}
* @memberof AppUser
*/
'staff'?: Staff;
/**
*
* @type {string}
* @memberof AppUser
*/
'staffDisplayName'?: string;
/**
*
* @type {number}
* @memberof AppUser
*/
'staffId'?: number;
/**
*
* @type {boolean}
* @memberof AppUser
*/
'systemUser'?: boolean;
/**
*
* @type {string}
* @memberof AppUser
*/
'username'?: string;
}
/**
*
* @export
* @interface AppUserClientMapping
*/
export interface AppUserClientMapping {
/**
*
* @type {AppUser}
* @memberof AppUserClientMapping
*/
'appUser'?: AppUser;
/**
*
* @type {Client}
* @memberof AppUserClientMapping
*/
'client'?: Client;
/**
*
* @type {number}
* @memberof AppUserClientMapping
*/
'id'?: number;
/**
*
* @type {boolean}
* @memberof AppUserClientMapping
*/
'new'?: boolean;
}
/**
*
* @export
* @interface AppUserData
*/
export interface AppUserData {
/**
*
* @type {Set<ClientData>}
* @memberof AppUserData
*/
'clients'?: Set<ClientData>;
/**
*
* @type {number}
* @memberof AppUserData
*/
'rowIndex'?: number;
/**
*
* @type {boolean}
* @memberof AppUserData
*/
'selfServiceUser'?: boolean;
}
/**
*
* @export
* @interface AuditData
*/
export interface AuditData {
/**
*
* @type {number}
* @memberof AuditData
*/
'createdBy'?: number;
/**
*
* @type {string}
* @memberof AuditData
*/
'createdDate'?: string;
/**
*
* @type {number}
* @memberof AuditData
*/
'lastModifiedBy'?: number;
/**
*
* @type {string}
* @memberof AuditData
*/
'lastModifiedDate'?: string;
}
/**
*
* @export
* @interface AuditSearchData
*/
export interface AuditSearchData {
/**
*
* @type {Array<string>}
* @memberof AuditSearchData
*/
'actionNames'?: Array<string>;
/**
*
* @type {Array<AppUserData>}
* @memberof AuditSearchData
*/
'appUsers'?: Array<AppUserData>;
/**
*
* @type {Array<string>}
* @memberof AuditSearchData
*/
'entityNames'?: Array<string>;
/**
*
* @type {Array<ProcessingResultLookup>}
* @memberof AuditSearchData
*/
'statuses'?: Array<ProcessingResultLookup>;
}
/**
*
* @export
* @interface BatchRequest
*/
export interface BatchRequest {
/**
*
* @type {string}
* @memberof BatchRequest
*/
'body'?: string;
/**
*
* @type {Set<Header>}
* @memberof BatchRequest
*/
'headers'?: Set<Header>;
/**
*
* @type {string}
* @memberof BatchRequest
*/
'method'?: string;
/**
*
* @type {number}
* @memberof BatchRequest
*/
'reference'?: number;
/**
*
* @type {string}
* @memberof BatchRequest
*/
'relativeUrl'?: string;
/**
*
* @type {number}
* @memberof BatchRequest
*/
'requestId'?: number;
}
/**
*
* @export
* @interface BatchResponse
*/
export interface BatchResponse {
/**
*
* @type {string}
* @memberof BatchResponse
*/
'body'?: string;
/**
*
* @type {Set<Header>}
* @memberof BatchResponse
*/
'headers'?: Set<Header>;
/**
*
* @type {number}
* @memberof BatchResponse
*/
'requestId'?: number;
/**
*
* @type {number}
* @memberof BatchResponse
*/
'statusCode'?: number;
}
/**
*
* @export
* @interface BodyPart
*/
export interface BodyPart {
/**
*
* @type {ContentDisposition}
* @memberof BodyPart
*/
'contentDisposition'?: ContentDisposition;
/**
*
* @type {object}
* @memberof BodyPart
*/
'entity'?: object;
/**
*
* @type {BodyPartHeaders}
* @memberof BodyPart
*/
'headers'?: BodyPartHeaders;
/**
*
* @type {MediaType}
* @memberof BodyPart
*/
'mediaType'?: MediaType;
/**
*
* @type {object}
* @memberof BodyPart
*/
'messageBodyWorkers'?: object;
/**
*
* @type {BodyPartParameterizedHeaders}
* @memberof BodyPart
*/
'parameterizedHeaders'?: BodyPartParameterizedHeaders;
/**
*
* @type {MultiPart}
* @memberof BodyPart
*/
'parent'?: MultiPart;
/**
*
* @type {object}
* @memberof BodyPart
*/
'providers'?: object;
}
/**
*
* @export
* @interface BodyPartHeaders
*/
export interface BodyPartHeaders {
[key: string]: Array<string> | any;
/**
*
* @type {boolean}
* @memberof BodyPartHeaders
*/
'empty'?: boolean;
}
/**
*
* @export
* @interface BodyPartParameterizedHeaders
*/
export interface BodyPartParameterizedHeaders {
[key: string]: Array<ParameterizedHeader> | any;
/**
*
* @type {boolean}
* @memberof BodyPartParameterizedHeaders
*/
'empty'?: boolean;
}
/**
*
* @export
* @interface BusinessDateResponse
*/
export interface BusinessDateResponse {
/**
*
* @type {string}
* @memberof BusinessDateResponse
*/
'date'?: string;
/**
*
* @type {string}
* @memberof BusinessDateResponse
*/
'description'?: string;
/**
*
* @type {string}
* @memberof BusinessDateResponse
*/
'type'?: BusinessDateResponseTypeEnum;
}
export declare const BusinessDateResponseTypeEnum: {
readonly BusinessDate: "BUSINESS_DATE";
readonly CobDate: "COB_DATE";
};
export type BusinessDateResponseTypeEnum = typeof BusinessDateResponseTypeEnum[keyof typeof BusinessDateResponseTypeEnum];
/**
*
* @export
* @interface BusinessDateUpdateRequest
*/
export interface BusinessDateUpdateRequest {
/**
*
* @type {string}
* @memberof BusinessDateUpdateRequest
*/
'date': string;
/**
*
* @type {string}
* @memberof BusinessDateUpdateRequest
*/
'dateFormat': string;
/**
*
* @type {string}
* @memberof BusinessDateUpdateRequest
*/
'locale': string;
/**
* Type of business date
* @type {string}
* @memberof BusinessDateUpdateRequest
*/
'type': BusinessDateUpdateRequestTypeEnum;
}
export declare const BusinessDateUpdateRequestTypeEnum: {
readonly BusinessDate: "BUSINESS_DATE";
readonly CobDate: "COB_DATE";
};
export type BusinessDateUpdateRequestTypeEnum = typeof BusinessDateUpdateRequestTypeEnum[keyof typeof BusinessDateUpdateRequestTypeEnum];
/**
*
* @export
* @interface BusinessDateUpdateResponse
*/
export interface BusinessDateUpdateResponse {
/**
*
* @type {{ [key: string]: string; }}
* @memberof BusinessDateUpdateResponse
*/
'changes'?: {
[key: string]: string;
};
/**
*
* @type {string}
* @memberof BusinessDateUpdateResponse
*/
'date'?: string;
/**
*
* @type {string}
* @memberof BusinessDateUpdateResponse
*/
'description'?: string;
/**
*
* @type {string}
* @memberof BusinessDateUpdateResponse
*/
'type'?: BusinessDateUpdateResponseTypeEnum;
}
export declare const BusinessDateUpdateResponseTypeEnum: {
readonly BusinessDate: "BUSINESS_DATE";
readonly CobDate: "COB_DATE";
};
export type BusinessDateUpdateResponseTypeEnum = typeof BusinessDateUpdateResponseTypeEnum[keyof typeof BusinessDateUpdateResponseTypeEnum];
/**
*
* @export
* @interface BusinessStep
*/
export interface BusinessStep {
/**
*
* @type {number}
* @memberof BusinessStep
*/
'order'?: number;
/**
*
* @type {string}
* @memberof BusinessStep
*/
'stepName'?: string;
}
/**
*
* @export
* @interface BusinessStepDetail
*/
export interface BusinessStepDetail {
/**
*
* @type {string}
* @memberof BusinessStepDetail
*/
'stepDescription'?: string;
/**
*
* @type {string}
* @memberof BusinessStepDetail
*/
'stepName'?: string;
}
/**
*
* @export
* @interface BusinessStepRequest
*/
export interface BusinessStepRequest {
/**
*
* @type {Array<BusinessStep>}
* @memberof BusinessStepRequest
*/
'businessSteps'?: Array<BusinessStep>;
}
/**
*
* @export
* @interface BuyDownFeeAmortizationDetails
*/
export interface BuyDownFeeAmortizationDetails {
/**
*
* @type {number}
* @memberof BuyDownFeeAmortizationDetails
*/
'adjustedAmount'?: number;
/**
*
* @type {number}
* @memberof BuyDownFeeAmortizationDetails
*/
'amortizedAmount'?: number;
/**
*
* @type {number}
* @memberof BuyDownFeeAmortizationDetails
*/
'buyDownFeeAmount'?: number;
/**
*
* @type {string}
* @memberof BuyDownFeeAmortizationDetails
*/
'buyDownFeeDate'?: string;
/**
*
* @type {number}
* @memberof BuyDownFeeAmortizationDetails
*/
'chargedOffAmount'?: number;
/**
*
* @type {number}
* @memberof BuyDownFeeAmortizationDetails
*/
'id'?: number;
/**
*
* @type {number}
* @memberof BuyDownFeeAmortizationDetails
*/
'loanId'?: number;
/**
*
* @type {number}
* @memberof BuyDownFeeAmortizationDetails
*/
'notYetAmortizedAmount'?: number;
/**
*
* @type {number}
* @memberof BuyDownFeeAmortizationDetails
*/
'transactionId'?: number;
}
/**
*
* @export
* @interface CacheData
*/
export interface CacheData {
/**
*
* @type {EnumOptionData}
* @memberof CacheData
*/
'cacheType'?: EnumOptionData;
/**
*
* @type {boolean}
* @memberof CacheData
*/
'enabled'?: boolean;
}
/**
*
* @export
* @interface CacheSwitchRequest
*/
export interface CacheSwitchRequest {
/**
*
* @type {number}
* @memberof CacheSwitchRequest
*/
'cacheType': number;
}
/**
*
* @export
* @interface CacheSwitchResponse
*/
export interface CacheSwitchResponse {
/**
*
* @type {number}
* @memberof CacheSwitchResponse
*/
'cacheType'?: number;
/**
*
* @type {{ [key: string]: object; }}
* @memberof CacheSwitchResponse
*/
'changes'?: {
[key: string]: object;
};
}
/**
* CalculateFixedDepositInterestResponse
* @export
* @interface CalculateFixedDepositInterestResponse
*/
export interface CalculateFixedDepositInterestResponse {
/**
*
* @type {number}
* @memberof CalculateFixedDepositInterestResponse
*/
'maturityAmount'?: number;
/**
*
* @type {string}
* @memberof CalculateFixedDepositInterestResponse
*/
'warning'?: string;
}
/**
*
* @export
* @interface CalendarData
*/
export interface CalendarData {
/**
*
* @type {number}
* @memberof CalendarData
*/
'calendarInstanceId'?: number;
/**
*
* @type {Array<EnumOptionData>}
* @memberof CalendarData
*/
'calendarTypeOptions'?: Array<EnumOptionData>;
/**
*
* @type {string}
* @memberof CalendarData
*/
'centerId'?: string;
/**
*
* @type {number}
* @memberof CalendarData
*/
'createdByUserId'?: number;
/**
*
* @type {string}
* @memberof CalendarData
*/
'createdByUsername'?: string;
/**
*
* @type {string}
* @memberof CalendarData
*/
'createdDate'?: string;
/**
*
* @type {string}
* @memberof CalendarData
*/
'dateFormat'?: string;
/**
*
* @type {string}
* @memberof CalendarData
*/
'description'?: string;
/**
*
* @type {number}
* @memberof CalendarData
*/
'duration'?: number;
/**
*
* @type {string}
* @memberof CalendarData
*/
'endDate'?: string;
/**
*
* @type {number}
* @memberof CalendarData
*/
'entityId'?: number;
/**
*
* @type {EnumOptionData}
* @memberof CalendarData
*/
'entityType'?: EnumOptionData;
/**
*
* @type {Array<EnumOptionData>}
* @memberof CalendarData
*/
'entityTypeOptions'?: Array<EnumOptionData>;
/**
*
* @type {number}
* @memberof CalendarData
*/
'firstReminder'?: number;
/**
*
* @type {EnumOptionData}
* @memberof CalendarData
*/
'frequency'?: EnumOptionData;
/**
*
* @type {Array<EnumOptionData>}
* @memberof CalendarData
*/
'frequencyNthDayTypeOptions'?: Array<EnumOptionData>;
/**
*
* @type {Array<EnumOptionData>}
* @memberof CalendarData
*/
'frequencyOptions'?: Array<EnumOptionData>;
/**
*
* @type {string}
* @memberof CalendarData
*/
'humanReadable'?: string;
/**
*
* @type {number}
* @memberof CalendarData
*/
'id'?: number;
/**
*
* @type {number}
* @memberof CalendarData
*/
'interval'?: number;
/**
*
* @type {number}
* @memberof CalendarData
*/
'lastUpdatedByUserId'?: number;
/**
*
* @type {string}
* @memberof CalendarData
*/
'lastUpdatedByUsername'?: string;
/**
*
* @type {string}
* @memberof CalendarData
*/
'lastUpdatedDate'?: string;
/**
*
* @type {string}
* @memberof CalendarData
*/
'locale'?: string;
/**
*
* @type {string}
* @memberof CalendarData
*/
'location'?: string;
/**
*
* @type {LocalTime}
* @memberof CalendarData
*/
'meetingTime'?: LocalTime;
/**
*
* @type {Array<string>}
* @memberof CalendarData
*/
'nextTenRecurringDates'?: Array<string>;
/**
*
* @type {string}
* @memberof CalendarData
*/
'recentEligibleMeetingDate'?: string;
/**
*
* @type {string}
* @memberof CalendarData
*/
'recurrence'?: string;
/**
*
* @type {Array<string>}
* @memberof CalendarData
*/
'recurringDates'?: Array<string>;
/**
*
* @type {EnumOptionData}
* @memberof CalendarData
*/
'remindBy'?: EnumOptionData;
/**
*
* @type {Array<EnumOptionData>}
* @memberof CalendarData
*/
'remindByOptions'?: Array<EnumOptionData>;
/**
*
* @type {boolean}
* @memberof CalendarData
*/
'repeating'?: boolean;
/**
*
* @type {EnumOptionData}
* @memberof CalendarData
*/
'repeatsOnDay'?: EnumOptionData;
/**
*
* @type {number}
* @memberof CalendarData
*/
'repeatsOnDayOfMonth'?: number;
/**
*
* @type {Array<EnumOptionData>}
* @memberof CalendarData
*/
'repeatsOnDayOptions'?: Array<EnumOptionData>;
/**
*
* @type {EnumOptionData}
* @memberof CalendarData
*/
'repeatsOnNthDayOfMonth'?: EnumOptionData;
/**
*
* @type {number}
* @memberof CalendarData
*/
'rowIndex'?: number;
/**
*
* @type {number}
* @memberof CalendarData
*/
'secondReminder'?: number;
/**
*
* @type {string}
* @memberof CalendarData
*/
'startDate'?: string;
/**
*
* @type {string}
* @memberof CalendarData
*/
'title'?: string;
/**
*
* @type {EnumOptionData}
* @memberof CalendarData
*/
'type'?: EnumOptionData;
/**
*
* @type {string}
* @memberof CalendarData
*/
'typeId'?: string;
}
/**
*
* @export
* @interface CalendarRequest
*/
export interface CalendarRequest {
/**
*
* @type {string}
* @memberof CalendarRequest
*/
'dateFormat'?: string;
/**
*
* @type {string}
* @memberof CalendarRequest
*/
'frequency'?: string;
/**
*
* @type {string}
* @memberof CalendarRequest
*/
'interval'?: string;
/**
*
* @type {string}
* @memberof CalendarRequest
*/
'locale'?: string;
/**
*
* @type {string}
* @memberof CalendarRequest
*/
'repeating'?: string;
/**
*
* @type {string}
* @memberof CalendarRequest
*/
'repeatsOnDay'?: string;
/**
*
* @type {string}
* @memberof CalendarRequest
*/
'startDate'?: string;
/**
*
* @type {string}
* @memberof CalendarRequest
*/
'title'?: string;
/**
*
* @type {string}
* @memberof CalendarRequest
*/
'typeId'?: string;
}
/**
*
* @export
* @interface CampaignPreviewData
*/
export interface CampaignPreviewData {
/**
*
* @type {string}
* @memberof CampaignPreviewData
*/
'campaignMessage'?: string;
/**
*
* @type {number}
* @memberof CampaignPreviewData
*/
'totalNumberOfMessages'?: number;
}
/**
*
* @export
* @interface CapitalizedIncomeDetails
*/
export interface CapitalizedIncomeDetails {
/**
*
* @type {number}
* @memberof CapitalizedIncomeDetails
*/
'amortizedAmount'?: number;
/**
*
* @type {number}
* @memberof CapitalizedIncomeDetails
*/
'amount'?: number;
/**
*
* @type {number}
* @memberof CapitalizedIncomeDetails
*/
'amountAdjustment'?: number;
/**
*
* @type {number}
* @memberof CapitalizedIncomeDetails
*/
'chargedOffAmount'?: number;
/**
*
* @type {number}
* @memberof CapitalizedIncomeDetails
*/
'unrecognizedAmount'?: number;
}
/**
*
* @export
* @interface CashierData
*/
export interface CashierData {
/**
*
* @type {string}
* @memberof CashierData
*/
'description'?: string;
/**
*
* @type {string}
* @memberof CashierData
*/
'endDate'?: string;
/**
*
* @type {string}
* @memberof CashierData
*/
'endTime'?: string;
/**
*
* @type {number}
* @memberof CashierData
*/
'id'?: number;
/**
*
* @type {boolean}
* @memberof CashierData
*/
'isFullDay'?: boolean;
/**
*
* @type {number}
* @memberof CashierData
*/
'officeId'?: number;
/**
*
* @type {string}
* @memberof CashierData
*/
'officeName'?: string;
/**
*
* @type {number}
* @memberof CashierData
*/
'staffId'?: number;
/**
*
* @type {string}
* @memberof CashierData
*/
'staffName'?: string;
/**
*
* @type {Array<StaffData>}
* @memberof CashierData
*/
'staffOptions'?: Array<StaffData>;
/**
*
* @type {string}
* @memberof CashierData
*/
'startDate'?: string;
/**
*
* @type {string}
* @memberof CashierData
*/
'startTime'?: string;
/**
*
* @type {number}
* @memberof CashierData
*/
'tellerId'?: number;
/**
*
* @type {string}
* @memberof CashierData
*/
'tellerName'?: string;
}
/**
*
* @export
* @interface CashierTransactionData
*/
export interface CashierTransactionData {
/**
*
* @type {CashierData}
* @memberof CashierTransactionData
*/
'cashierData'?: CashierData;
/**
*
* @type {number}
* @memberof CashierTransactionData
*/
'cashierId'?: number;
/**
*
* @type {string}
* @memberof CashierTransactionData
*/
'cashierName'?: string;
/**
*
* @type {string}
* @memberof CashierTransactionData
*/
'createdDate'?: string;
/**
*
* @type {Array<CurrencyData>}
* @memberof CashierTransactionData
*/
'currencyOptions'?: Array<CurrencyData>;
/**
*
* @type {string}
* @memberof CashierTransactionData
*/
'endDate'?: string;
/**
*
* @type {number}
* @memberof CashierTransactionData
*/
'entityId'?: number;
/**
*
* @type {string}
* @memberof CashierTransactionData
*/
'entityType'?: string;
/**
*
* @type {number}
* @memberof CashierTransactionData
*/
'id'?: number;
/**
*
* @type {number}
* @memberof CashierTransactionData
*/
'officeId'?: number;
/**
*
* @type {string}
* @memberof CashierTransactionData
*/
'officeName'?: string;
/**
*
* @type {string}
* @memberof CashierTransactionData
*/
'startDate'?: string;
/**
*
* @type {number}
* @memberof CashierTransactionData
*/
'tellerId'?: number;
/**
*
* @type {string}
* @memberof CashierTransactionData
*/
'tellerName'?: string;
/**
*
* @type {number}
* @memberof CashierTransactionData
*/
'txnAmount'?: number;
/**
*
* @type {string}
* @memberof CashierTransactionData
*/
'txnDate'?: string;
/**
*
* @type {string}
* @memberof CashierTransactionData
*/
'txnNote'?: string;
/**
*
* @type {CashierTxnType}
* @memberof CashierTransactionData
*/
'txnType'?: CashierTxnType;
}
/**
*
* @export
* @interface CashierTransactionsWithSummaryData
*/
export interface CashierTransactionsWithSummaryData {
/**
*
* @type {number}
* @memberof CashierTransactionsWithSummaryData
*/
'cashierId'?: number;
/**
*
* @type {string}
* @memberof CashierTransactionsWithSummaryData
*/
'cashierName'?: string;
/**
*
* @type {PageCashierTransactionData}
* @memberof CashierTransactionsWithSummaryData
*/
'cashierTransactions'?: PageCashierTransactionData;
/**
*
* @type {number}
* @memberof CashierTransactionsWithSummaryData
*/
'netCash'?: number;
/**
*
* @type {string}
* @memberof CashierTransactionsWithSummaryData
*/
'officeName'?: string;
/**
*
* @type {number}
* @memberof CashierTransactionsWithSummaryData
*/
'sumCashAllocation'?: number;
/**
*
* @type {number}
* @memberof CashierTransactionsWithSummaryData
*/
'sumCashSettlement'?: number;
/**
*
* @type {number}
* @memberof CashierTransactionsWithSummaryData
*/
'sumInwardCash'?: number;
/**
*
* @type {number}
* @memberof CashierTransactionsWithSummaryData
*/
'sumOutwardCash'?: number;
/**
*
* @type {number}
* @memberof CashierTransactionsWithSummaryData
*/
'tellerId'?: number;
/**
*
* @type {string}
* @memberof CashierTransactionsWithSummaryData
*/
'tellerName'?: string;
}
/**
*
* @export
* @interface CashierTxnType
*/
export interface CashierTxnType {
/**
*
* @type {number}
* @memberof CashierTxnType
*/
'id'?: number;
/**
*
* @type {string}
* @memberof CashierTxnType
*/
'value'?: string;
}
/**
*
* @export
* @interface CashiersForTeller
*/
export interface CashiersForTeller {
/**
*
* @type {Array<CashierData>}
* @memberof CashiersForTeller
*/
'cashiers'?: Array<CashierData>;
/**
*
* @type {number}
* @memberof CashiersForTeller
*/
'officeId'?: number;
/**
*
* @type {string}
* @memberof CashiersForTeller
*/
'officeName'?: string;
/**
*
* @type {number}
* @memberof CashiersForTeller
*/
'tellerId'?: number;
/**
*
* @type {string}
* @memberof CashiersForTeller
*/
'tellerName'?: string;
}
/**
*
* @export
* @interface CenterData
*/
export interface CenterData {
/**
*
* @type {string}
* @memberof CenterData
*/
'accountNo'?: string;
/**
*
* @type {CalendarData}
* @memberof CenterData
*/
'collectionMeetingCalendar'?: CalendarData;
/**
*
* @type {Array<DatatableData>}
* @memberof CenterData
*/
'datatables'?: Array<DatatableData>;
/**
*
* @type {string}
* @memberof CenterData
*/
'hierarchy'?: string;
/**
*
* @type {number}
* @memberof CenterData
*/
'id'?: number;
/**
*
* @type {string}
* @memberof CenterData
*/
'name'?: string;
/**
*
* @type {string}
* @memberof CenterData
*/
'officeName'?: string;
/**
*
* @type {number}
* @memberof CenterData
*/
'rowIndex'?: number;
/**
*
* @type {string}
* @memberof CenterData
*/
'staffName'?: string;
}
/**
* ChangeInstanceModeRequest
* @export
* @interface ChangeInstanceModeRequest
*/
export interface ChangeInstanceModeRequest {
/**
*
* @type {boolean}
* @memberof ChangeInstanceModeRequest
*/
'batchManagerEnabled': boolean;
/**
*
* @type {boolean}
* @memberof ChangeInstanceModeRequest
*/
'batchWorkerEnabled': boolean;
/**
*
* @type {boolean}
* @memberof ChangeInstanceModeRequest
*/
'readEnabled': boolean;
/**
*
* @type {boolean}
* @memberof ChangeInstanceModeRequest
*/
'writeEnabled': boolean;
}
/**
* ChangePwdUsersUserIdRequest
* @export
* @interface ChangePwdUsersUserIdRequest
*/
export interface ChangePwdUsersUserIdRequest {
/**
*
* @type {string}
* @memberof ChangePwdUsersUserIdRequest
*/
'password'?: string;
/**
*
* @type {string}
* @membero