fineract_sdk/dist/api/savings-account-api.d.ts

Wrapper around fineract api.

/**
 * Apache Fineract
 * 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<br>The [reference app](https://cui.fineract.dev) (username: mifos, password: password) works on the same demo tenant as the interactive links in this documentation  - The API is organized around [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) - Find out more about Apache Fineract [here](/fineract-provider/api-docs/apiLive.htm#top) - You can [Try The API From Your Browser](/fineract-provider/api-docs/apiLive.htm#interact) - The Generic Options are available [here](/fineract-provider/api-docs/apiLive.htm#genopts) - Find out more about [Updating Dates and Numbers](/fineract-provider/api-docs/apiLive.htm#dates_and_numbers) - For the Authentication and the Basic of HTTP and HTTPS refer [here](/fineract-provider/api-docs/apiLive.htm#authentication_overview) - Check about ERROR codes [here](/fineract-provider/api-docs/apiLive.htm#errors)  Please refer to the [old documentation](/fineract-provider/api-docs/apiLive.htm) for any documentation queries
 *
 * The version of the OpenAPI document: 1.5.0-66-gffae7d4-dirty
 * 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 { AxiosPromise, AxiosInstance } from 'axios';
import { Configuration } from '../configuration';
import { RequestArgs, BaseAPI } from '../base';
import { DeleteSavingsAccountsAccountIdResponse } from '../models';
import { FormDataContentDisposition } from '../models';
import { GetSavingsAccountsAccountIdResponse } from '../models';
import { GetSavingsAccountsResponse } from '../models';
import { GetSavingsAccountsTemplateResponse } from '../models';
import { PostSavingsAccountsAccountIdRequest } from '../models';
import { PostSavingsAccountsAccountIdResponse } from '../models';
import { PostSavingsAccountsRequest } from '../models';
import { PostSavingsAccountsResponse } from '../models';
import { PutSavingsAccountsAccountIdRequest } from '../models';
import { PutSavingsAccountsAccountIdResponse } from '../models';
/**
 * SavingsAccountApi - axios parameter creator
 * @export
 */
export declare const SavingsAccountApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * At present we support hard delete of savings application so long as its in \'Submitted and pending approval\' state. One the application is moves past this state, it is not possible to do a \'hard\' delete of the application or the account. An API endpoint will be added to close/de-activate the savings account.
     * @summary Delete a savings application
     * @param {number} accountId accountId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteSavingsAccount: (accountId: number, options?: any) => Promise<RequestArgs>;
    /**
     * This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of:  Field Defaults Allowed Value Lists  Example Requests:  savingsaccounts/template?clientId=1   savingsaccounts/template?clientId=1&productId=1
     * @summary Retrieve Savings Account Template
     * @param {number} [clientId] clientId
     * @param {number} [groupId] groupId
     * @param {number} [productId] productId
     * @param {boolean} [staffInSelectedOfficeOnly] staffInSelectedOfficeOnly
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getSavingsAccountTemplate: (clientId?: number, groupId?: number, productId?: number, staffInSelectedOfficeOnly?: boolean, options?: any) => Promise<RequestArgs>;
    /**
     *
     * @param {number} [officeId]
     * @param {number} [staffId]
     * @param {string} [dateFormat]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getSavingsTemplate: (officeId?: number, staffId?: number, dateFormat?: string, options?: any) => Promise<RequestArgs>;
    /**
     *
     * @param {number} [officeId]
     * @param {string} [dateFormat]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getSavingsTransactionTemplate: (officeId?: number, dateFormat?: string, options?: any) => Promise<RequestArgs>;
    /**
     *
     * @param {number} parentAccountId
     * @param {string} [command]
     * @param {string} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    handleGSIMCommands: (parentAccountId: number, command?: string, body?: string, options?: any) => Promise<RequestArgs>;
    /**
     * Approve savings application:  Approves savings application so long as its in \'Submitted and pending approval\' state.  Undo approval savings application:  Will move \'approved\' savings application back to \'Submitted and pending approval\' state.  Assign Savings Officer:  Allows you to assign Savings Officer for existing Savings Account.  Unassign Savings Officer:  Allows you to unassign the Savings Officer.  Reject savings application:  Rejects savings application so long as its in \'Submitted and pending approval\' state.  Withdraw savings application:  Used when an applicant withdraws from the savings application. It must be in \'Submitted and pending approval\' state.  Activate a savings account:  Results in an approved savings application being converted into an \'active\' savings account.  Close a savings account:  Results in an Activated savings application being converted into an \'closed\' savings account.  closedOnDate is closure date of savings account  withdrawBalance is a boolean description, true value of this field performs a withdrawal transaction with account\'s running balance.  Mandatory Fields: dateFormat,locale,closedOnDate  Optional Fields: note, withdrawBalance, paymentTypeId, accountNumber, checkNumber, routingCode, receiptNumber, bankNumber  Calculate Interest on Savings Account:  Calculates interest earned on a savings account based on todays date. It does not attempt to post or credit the interest on the account. That is responsibility of the Post Interest API that will likely be called by overnight process.  Post Interest on Savings Account:  Calculates and Posts interest earned on a savings account based on today\'s date and whether an interest posting or crediting event is due.  Block Savings Account:  Blocks Savings account from all types of credit and debit transactions  Unblock Savings Account:  Unblock a blocked account. On unblocking account, user can perform debit and credit transactions  Block Savings Account Credit transactions:  Savings account will be blocked from all types of credit transactions.  Unblock Savings Account Credit transactions:  It unblocks the Saving account\'s credit operations. Now all types of credits can be transacted to Savings account  Block Savings Account Debit transactions:  All types of debit operations from Savings account wil be blocked  Unblock Savings Account debit transactions:  It unblocks the Saving account\'s debit operations. Now all types of debits can be transacted from Savings account  Showing request/response for \'Unassign Savings Officer\'
     * @summary Approve savings application | Undo approval savings application | Assign Savings Officer | Unassign Savings Officer | Reject savings application | Withdraw savings application | Activate a savings account | Close a savings account | Calculate Interest on Savings Account | Post Interest on Savings Account | Block Savings Account | Unblock Savings Account | Block Savings Account Credit transactions | Unblock Savings Account Credit transactions | Block Savings Account Debit transactions | Unblock Savings Account debit transactions
     * @param {number} accountId accountId
     * @param {PostSavingsAccountsAccountIdRequest} postSavingsAccountsAccountIdRequest
     * @param {string} [command] command
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    manageSavingsAccount: (accountId: number, postSavingsAccountsAccountIdRequest: PostSavingsAccountsAccountIdRequest, command?: string, options?: any) => Promise<RequestArgs>;
    /**
     *
     * @param {FormDataContentDisposition} [file]
     * @param {string} [locale]
     * @param {string} [dateFormat]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postSavingsTemplate: (file?: any, locale?: string, dateFormat?: string, options?: any) => Promise<RequestArgs>;
    /**
     *
     * @param {FormDataContentDisposition} [file]
     * @param {string} [locale]
     * @param {string} [dateFormat]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postSavingsTransactionTemplate: (file?: any, locale?: string, dateFormat?: string, options?: any) => Promise<RequestArgs>;
    /**
     * Retrieves a savings application/account  Example Requests :  savingsaccounts/1   savingsaccounts/1?associations=all
     * @summary Retrieve a savings application/account
     * @param {number} accountId accountId
     * @param {boolean} [staffInSelectedOfficeOnly] staffInSelectedOfficeOnly
     * @param {string} [chargeStatus] chargeStatus
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveSavingsAccount: (accountId: number, staffInSelectedOfficeOnly?: boolean, chargeStatus?: string, options?: any) => Promise<RequestArgs>;
    /**
     * Lists savings applications/accounts  Example Requests:  savingsaccounts   savingsaccounts?fields=name
     * @summary List savings applications/accounts
     * @param {string} [sqlSearch] sqlSearch
     * @param {string} [externalId] externalId
     * @param {number} [offset] offset
     * @param {number} [limit] limit
     * @param {string} [orderBy] orderBy
     * @param {string} [sortOrder] sortOrder
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveSavingsAccounts: (sqlSearch?: string, externalId?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, options?: any) => Promise<RequestArgs>;
    /**
     *
     * @param {string} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    submitGSIMApplication: (body?: string, options?: any) => Promise<RequestArgs>;
    /**
     * Submits new savings application  Mandatory Fields: clientId or groupId, productId, submittedOnDate  Optional Fields: accountNo, externalId, fieldOfficerId  Inherited from Product (if not provided): nominalAnnualInterestRate, interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType, minRequiredOpeningBalance, lockinPeriodFrequency, lockinPeriodFrequencyType, withdrawalFeeForTransfers, allowOverdraft, overdraftLimit, withHoldTax  Additional Mandatory Field if Entity-Datatable Check is enabled for the entity of type Savings: datatables
     * @summary Submit new savings application
     * @param {PostSavingsAccountsRequest} postSavingsAccountsRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    submitSavingsAccountsApplication: (postSavingsAccountsRequest: PostSavingsAccountsRequest, options?: any) => Promise<RequestArgs>;
    /**
     *
     * @param {number} parentAccountId
     * @param {string} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateGsim: (parentAccountId: number, body?: string, options?: any) => Promise<RequestArgs>;
    /**
     * Modify a savings application:  Savings application can only be modified when in \'Submitted and pending approval\' state. Once the application is approved, the details cannot be changed using this method. Specific api endpoints will be created to allow change of interest detail such as rate, compounding period, posting period etc  Modify savings account withhold tax applicability:  Savings application\'s withhold tax can be modified when in \'Active\' state. Once the application is activated, can modify the account withhold tax to post tax or vice-versaShowing request/response for \'Modify a savings application\'
     * @summary Modify a savings application | Modify savings account withhold tax applicability
     * @param {number} accountId accountId
     * @param {PutSavingsAccountsAccountIdRequest} putSavingsAccountsAccountIdRequest
     * @param {string} [command] command
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateSavingsAccount: (accountId: number, putSavingsAccountsAccountIdRequest: PutSavingsAccountsAccountIdRequest, command?: string, options?: any) => Promise<RequestArgs>;
};
/**
 * SavingsAccountApi - functional programming interface
 * @export
 */
export declare const SavingsAccountApiFp: (configuration?: Configuration) => {
    /**
     * At present we support hard delete of savings application so long as its in \'Submitted and pending approval\' state. One the application is moves past this state, it is not possible to do a \'hard\' delete of the application or the account. An API endpoint will be added to close/de-activate the savings account.
     * @summary Delete a savings application
     * @param {number} accountId accountId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteSavingsAccount(accountId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteSavingsAccountsAccountIdResponse>>;
    /**
     * This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of:  Field Defaults Allowed Value Lists  Example Requests:  savingsaccounts/template?clientId=1   savingsaccounts/template?clientId=1&productId=1
     * @summary Retrieve Savings Account Template
     * @param {number} [clientId] clientId
     * @param {number} [groupId] groupId
     * @param {number} [productId] productId
     * @param {boolean} [staffInSelectedOfficeOnly] staffInSelectedOfficeOnly
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getSavingsAccountTemplate(clientId?: number, groupId?: number, productId?: number, staffInSelectedOfficeOnly?: boolean, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSavingsAccountsTemplateResponse>>;
    /**
     *
     * @param {number} [officeId]
     * @param {number} [staffId]
     * @param {string} [dateFormat]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getSavingsTemplate(officeId?: number, staffId?: number, dateFormat?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @param {number} [officeId]
     * @param {string} [dateFormat]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getSavingsTransactionTemplate(officeId?: number, dateFormat?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @param {number} parentAccountId
     * @param {string} [command]
     * @param {string} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    handleGSIMCommands(parentAccountId: number, command?: string, body?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
    /**
     * Approve savings application:  Approves savings application so long as its in \'Submitted and pending approval\' state.  Undo approval savings application:  Will move \'approved\' savings application back to \'Submitted and pending approval\' state.  Assign Savings Officer:  Allows you to assign Savings Officer for existing Savings Account.  Unassign Savings Officer:  Allows you to unassign the Savings Officer.  Reject savings application:  Rejects savings application so long as its in \'Submitted and pending approval\' state.  Withdraw savings application:  Used when an applicant withdraws from the savings application. It must be in \'Submitted and pending approval\' state.  Activate a savings account:  Results in an approved savings application being converted into an \'active\' savings account.  Close a savings account:  Results in an Activated savings application being converted into an \'closed\' savings account.  closedOnDate is closure date of savings account  withdrawBalance is a boolean description, true value of this field performs a withdrawal transaction with account\'s running balance.  Mandatory Fields: dateFormat,locale,closedOnDate  Optional Fields: note, withdrawBalance, paymentTypeId, accountNumber, checkNumber, routingCode, receiptNumber, bankNumber  Calculate Interest on Savings Account:  Calculates interest earned on a savings account based on todays date. It does not attempt to post or credit the interest on the account. That is responsibility of the Post Interest API that will likely be called by overnight process.  Post Interest on Savings Account:  Calculates and Posts interest earned on a savings account based on today\'s date and whether an interest posting or crediting event is due.  Block Savings Account:  Blocks Savings account from all types of credit and debit transactions  Unblock Savings Account:  Unblock a blocked account. On unblocking account, user can perform debit and credit transactions  Block Savings Account Credit transactions:  Savings account will be blocked from all types of credit transactions.  Unblock Savings Account Credit transactions:  It unblocks the Saving account\'s credit operations. Now all types of credits can be transacted to Savings account  Block Savings Account Debit transactions:  All types of debit operations from Savings account wil be blocked  Unblock Savings Account debit transactions:  It unblocks the Saving account\'s debit operations. Now all types of debits can be transacted from Savings account  Showing request/response for \'Unassign Savings Officer\'
     * @summary Approve savings application | Undo approval savings application | Assign Savings Officer | Unassign Savings Officer | Reject savings application | Withdraw savings application | Activate a savings account | Close a savings account | Calculate Interest on Savings Account | Post Interest on Savings Account | Block Savings Account | Unblock Savings Account | Block Savings Account Credit transactions | Unblock Savings Account Credit transactions | Block Savings Account Debit transactions | Unblock Savings Account debit transactions
     * @param {number} accountId accountId
     * @param {PostSavingsAccountsAccountIdRequest} postSavingsAccountsAccountIdRequest
     * @param {string} [command] command
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    manageSavingsAccount(accountId: number, postSavingsAccountsAccountIdRequest: PostSavingsAccountsAccountIdRequest, command?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostSavingsAccountsAccountIdResponse>>;
    /**
     *
     * @param {FormDataContentDisposition} [file]
     * @param {string} [locale]
     * @param {string} [dateFormat]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postSavingsTemplate(file?: any, locale?: string, dateFormat?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
    /**
     *
     * @param {FormDataContentDisposition} [file]
     * @param {string} [locale]
     * @param {string} [dateFormat]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postSavingsTransactionTemplate(file?: any, locale?: string, dateFormat?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
    /**
     * Retrieves a savings application/account  Example Requests :  savingsaccounts/1   savingsaccounts/1?associations=all
     * @summary Retrieve a savings application/account
     * @param {number} accountId accountId
     * @param {boolean} [staffInSelectedOfficeOnly] staffInSelectedOfficeOnly
     * @param {string} [chargeStatus] chargeStatus
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveSavingsAccount(accountId: number, staffInSelectedOfficeOnly?: boolean, chargeStatus?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSavingsAccountsAccountIdResponse>>;
    /**
     * Lists savings applications/accounts  Example Requests:  savingsaccounts   savingsaccounts?fields=name
     * @summary List savings applications/accounts
     * @param {string} [sqlSearch] sqlSearch
     * @param {string} [externalId] externalId
     * @param {number} [offset] offset
     * @param {number} [limit] limit
     * @param {string} [orderBy] orderBy
     * @param {string} [sortOrder] sortOrder
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveSavingsAccounts(sqlSearch?: string, externalId?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSavingsAccountsResponse>>;
    /**
     *
     * @param {string} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    submitGSIMApplication(body?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
    /**
     * Submits new savings application  Mandatory Fields: clientId or groupId, productId, submittedOnDate  Optional Fields: accountNo, externalId, fieldOfficerId  Inherited from Product (if not provided): nominalAnnualInterestRate, interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType, minRequiredOpeningBalance, lockinPeriodFrequency, lockinPeriodFrequencyType, withdrawalFeeForTransfers, allowOverdraft, overdraftLimit, withHoldTax  Additional Mandatory Field if Entity-Datatable Check is enabled for the entity of type Savings: datatables
     * @summary Submit new savings application
     * @param {PostSavingsAccountsRequest} postSavingsAccountsRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    submitSavingsAccountsApplication(postSavingsAccountsRequest: PostSavingsAccountsRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostSavingsAccountsResponse>>;
    /**
     *
     * @param {number} parentAccountId
     * @param {string} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateGsim(parentAccountId: number, body?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
    /**
     * Modify a savings application:  Savings application can only be modified when in \'Submitted and pending approval\' state. Once the application is approved, the details cannot be changed using this method. Specific api endpoints will be created to allow change of interest detail such as rate, compounding period, posting period etc  Modify savings account withhold tax applicability:  Savings application\'s withhold tax can be modified when in \'Active\' state. Once the application is activated, can modify the account withhold tax to post tax or vice-versaShowing request/response for \'Modify a savings application\'
     * @summary Modify a savings application | Modify savings account withhold tax applicability
     * @param {number} accountId accountId
     * @param {PutSavingsAccountsAccountIdRequest} putSavingsAccountsAccountIdRequest
     * @param {string} [command] command
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateSavingsAccount(accountId: number, putSavingsAccountsAccountIdRequest: PutSavingsAccountsAccountIdRequest, command?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutSavingsAccountsAccountIdResponse>>;
};
/**
 * SavingsAccountApi - factory interface
 * @export
 */
export declare const SavingsAccountApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * At present we support hard delete of savings application so long as its in \'Submitted and pending approval\' state. One the application is moves past this state, it is not possible to do a \'hard\' delete of the application or the account. An API endpoint will be added to close/de-activate the savings account.
     * @summary Delete a savings application
     * @param {number} accountId accountId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteSavingsAccount(accountId: number, options?: any): AxiosPromise<DeleteSavingsAccountsAccountIdResponse>;
    /**
     * This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of:  Field Defaults Allowed Value Lists  Example Requests:  savingsaccounts/template?clientId=1   savingsaccounts/template?clientId=1&productId=1
     * @summary Retrieve Savings Account Template
     * @param {number} [clientId] clientId
     * @param {number} [groupId] groupId
     * @param {number} [productId] productId
     * @param {boolean} [staffInSelectedOfficeOnly] staffInSelectedOfficeOnly
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getSavingsAccountTemplate(clientId?: number, groupId?: number, productId?: number, staffInSelectedOfficeOnly?: boolean, options?: any): AxiosPromise<GetSavingsAccountsTemplateResponse>;
    /**
     *
     * @param {number} [officeId]
     * @param {number} [staffId]
     * @param {string} [dateFormat]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getSavingsTemplate(officeId?: number, staffId?: number, dateFormat?: string, options?: any): AxiosPromise<void>;
    /**
     *
     * @param {number} [officeId]
     * @param {string} [dateFormat]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getSavingsTransactionTemplate(officeId?: number, dateFormat?: string, options?: any): AxiosPromise<void>;
    /**
     *
     * @param {number} parentAccountId
     * @param {string} [command]
     * @param {string} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    handleGSIMCommands(parentAccountId: number, command?: string, body?: string, options?: any): AxiosPromise<string>;
    /**
     * Approve savings application:  Approves savings application so long as its in \'Submitted and pending approval\' state.  Undo approval savings application:  Will move \'approved\' savings application back to \'Submitted and pending approval\' state.  Assign Savings Officer:  Allows you to assign Savings Officer for existing Savings Account.  Unassign Savings Officer:  Allows you to unassign the Savings Officer.  Reject savings application:  Rejects savings application so long as its in \'Submitted and pending approval\' state.  Withdraw savings application:  Used when an applicant withdraws from the savings application. It must be in \'Submitted and pending approval\' state.  Activate a savings account:  Results in an approved savings application being converted into an \'active\' savings account.  Close a savings account:  Results in an Activated savings application being converted into an \'closed\' savings account.  closedOnDate is closure date of savings account  withdrawBalance is a boolean description, true value of this field performs a withdrawal transaction with account\'s running balance.  Mandatory Fields: dateFormat,locale,closedOnDate  Optional Fields: note, withdrawBalance, paymentTypeId, accountNumber, checkNumber, routingCode, receiptNumber, bankNumber  Calculate Interest on Savings Account:  Calculates interest earned on a savings account based on todays date. It does not attempt to post or credit the interest on the account. That is responsibility of the Post Interest API that will likely be called by overnight process.  Post Interest on Savings Account:  Calculates and Posts interest earned on a savings account based on today\'s date and whether an interest posting or crediting event is due.  Block Savings Account:  Blocks Savings account from all types of credit and debit transactions  Unblock Savings Account:  Unblock a blocked account. On unblocking account, user can perform debit and credit transactions  Block Savings Account Credit transactions:  Savings account will be blocked from all types of credit transactions.  Unblock Savings Account Credit transactions:  It unblocks the Saving account\'s credit operations. Now all types of credits can be transacted to Savings account  Block Savings Account Debit transactions:  All types of debit operations from Savings account wil be blocked  Unblock Savings Account debit transactions:  It unblocks the Saving account\'s debit operations. Now all types of debits can be transacted from Savings account  Showing request/response for \'Unassign Savings Officer\'
     * @summary Approve savings application | Undo approval savings application | Assign Savings Officer | Unassign Savings Officer | Reject savings application | Withdraw savings application | Activate a savings account | Close a savings account | Calculate Interest on Savings Account | Post Interest on Savings Account | Block Savings Account | Unblock Savings Account | Block Savings Account Credit transactions | Unblock Savings Account Credit transactions | Block Savings Account Debit transactions | Unblock Savings Account debit transactions
     * @param {number} accountId accountId
     * @param {PostSavingsAccountsAccountIdRequest} postSavingsAccountsAccountIdRequest
     * @param {string} [command] command
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    manageSavingsAccount(accountId: number, postSavingsAccountsAccountIdRequest: PostSavingsAccountsAccountIdRequest, command?: string, options?: any): AxiosPromise<PostSavingsAccountsAccountIdResponse>;
    /**
     *
     * @param {FormDataContentDisposition} [file]
     * @param {string} [locale]
     * @param {string} [dateFormat]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postSavingsTemplate(file?: any, locale?: string, dateFormat?: string, options?: any): AxiosPromise<string>;
    /**
     *
     * @param {FormDataContentDisposition} [file]
     * @param {string} [locale]
     * @param {string} [dateFormat]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    postSavingsTransactionTemplate(file?: any, locale?: string, dateFormat?: string, options?: any): AxiosPromise<string>;
    /**
     * Retrieves a savings application/account  Example Requests :  savingsaccounts/1   savingsaccounts/1?associations=all
     * @summary Retrieve a savings application/account
     * @param {number} accountId accountId
     * @param {boolean} [staffInSelectedOfficeOnly] staffInSelectedOfficeOnly
     * @param {string} [chargeStatus] chargeStatus
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveSavingsAccount(accountId: number, staffInSelectedOfficeOnly?: boolean, chargeStatus?: string, options?: any): AxiosPromise<GetSavingsAccountsAccountIdResponse>;
    /**
     * Lists savings applications/accounts  Example Requests:  savingsaccounts   savingsaccounts?fields=name
     * @summary List savings applications/accounts
     * @param {string} [sqlSearch] sqlSearch
     * @param {string} [externalId] externalId
     * @param {number} [offset] offset
     * @param {number} [limit] limit
     * @param {string} [orderBy] orderBy
     * @param {string} [sortOrder] sortOrder
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    retrieveSavingsAccounts(sqlSearch?: string, externalId?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, options?: any): AxiosPromise<GetSavingsAccountsResponse>;
    /**
     *
     * @param {string} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    submitGSIMApplication(body?: string, options?: any): AxiosPromise<string>;
    /**
     * Submits new savings application  Mandatory Fields: clientId or groupId, productId, submittedOnDate  Optional Fields: accountNo, externalId, fieldOfficerId  Inherited from Product (if not provided): nominalAnnualInterestRate, interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType, minRequiredOpeningBalance, lockinPeriodFrequency, lockinPeriodFrequencyType, withdrawalFeeForTransfers, allowOverdraft, overdraftLimit, withHoldTax  Additional Mandatory Field if Entity-Datatable Check is enabled for the entity of type Savings: datatables
     * @summary Submit new savings application
     * @param {PostSavingsAccountsRequest} postSavingsAccountsRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    submitSavingsAccountsApplication(postSavingsAccountsRequest: PostSavingsAccountsRequest, options?: any): AxiosPromise<PostSavingsAccountsResponse>;
    /**
     *
     * @param {number} parentAccountId
     * @param {string} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateGsim(parentAccountId: number, body?: string, options?: any): AxiosPromise<string>;
    /**
     * Modify a savings application:  Savings application can only be modified when in \'Submitted and pending approval\' state. Once the application is approved, the details cannot be changed using this method. Specific api endpoints will be created to allow change of interest detail such as rate, compounding period, posting period etc  Modify savings account withhold tax applicability:  Savings application\'s withhold tax can be modified when in \'Active\' state. Once the application is activated, can modify the account withhold tax to post tax or vice-versaShowing request/response for \'Modify a savings application\'
     * @summary Modify a savings application | Modify savings account withhold tax applicability
     * @param {number} accountId accountId
     * @param {PutSavingsAccountsAccountIdRequest} putSavingsAccountsAccountIdRequest
     * @param {string} [command] command
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateSavingsAccount(accountId: number, putSavingsAccountsAccountIdRequest: PutSavingsAccountsAccountIdRequest, command?: string, options?: any): AxiosPromise<PutSavingsAccountsAccountIdResponse>;
};
/**
 * SavingsAccountApi - object-oriented interface
 * @export
 * @class SavingsAccountApi
 * @extends {BaseAPI}
 */
export declare class SavingsAccountApi extends BaseAPI {
    /**
     * At present we support hard delete of savings application so long as its in \'Submitted and pending approval\' state. One the application is moves past this state, it is not possible to do a \'hard\' delete of the application or the account. An API endpoint will be added to close/de-activate the savings account.
     * @summary Delete a savings application
     * @param {number} accountId accountId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SavingsAccountApi
     */
    deleteSavingsAccount(accountId: number, options?: any): Promise<import("axios").AxiosResponse<DeleteSavingsAccountsAccountIdResponse>>;
    /**
     * This is a convenience resource. It can be useful when building maintenance user interface screens for client applications. The template data returned consists of any or all of:  Field Defaults Allowed Value Lists  Example Requests:  savingsaccounts/template?clientId=1   savingsaccounts/template?clientId=1&productId=1
     * @summary Retrieve Savings Account Template
     * @param {number} [clientId] clientId
     * @param {number} [groupId] groupId
     * @param {number} [productId] productId
     * @param {boolean} [staffInSelectedOfficeOnly] staffInSelectedOfficeOnly
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SavingsAccountApi
     */
    getSavingsAccountTemplate(clientId?: number, groupId?: number, productId?: number, staffInSelectedOfficeOnly?: boolean, options?: any): Promise<import("axios").AxiosResponse<GetSavingsAccountsTemplateResponse>>;
    /**
     *
     * @param {number} [officeId]
     * @param {number} [staffId]
     * @param {string} [dateFormat]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SavingsAccountApi
     */
    getSavingsTemplate(officeId?: number, staffId?: number, dateFormat?: string, options?: any): Promise<import("axios").AxiosResponse<void>>;
    /**
     *
     * @param {number} [officeId]
     * @param {string} [dateFormat]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SavingsAccountApi
     */
    getSavingsTransactionTemplate(officeId?: number, dateFormat?: string, options?: any): Promise<import("axios").AxiosResponse<void>>;
    /**
     *
     * @param {number} parentAccountId
     * @param {string} [command]
     * @param {string} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SavingsAccountApi
     */
    handleGSIMCommands(parentAccountId: number, command?: string, body?: string, options?: any): Promise<import("axios").AxiosResponse<string>>;
    /**
     * Approve savings application:  Approves savings application so long as its in \'Submitted and pending approval\' state.  Undo approval savings application:  Will move \'approved\' savings application back to \'Submitted and pending approval\' state.  Assign Savings Officer:  Allows you to assign Savings Officer for existing Savings Account.  Unassign Savings Officer:  Allows you to unassign the Savings Officer.  Reject savings application:  Rejects savings application so long as its in \'Submitted and pending approval\' state.  Withdraw savings application:  Used when an applicant withdraws from the savings application. It must be in \'Submitted and pending approval\' state.  Activate a savings account:  Results in an approved savings application being converted into an \'active\' savings account.  Close a savings account:  Results in an Activated savings application being converted into an \'closed\' savings account.  closedOnDate is closure date of savings account  withdrawBalance is a boolean description, true value of this field performs a withdrawal transaction with account\'s running balance.  Mandatory Fields: dateFormat,locale,closedOnDate  Optional Fields: note, withdrawBalance, paymentTypeId, accountNumber, checkNumber, routingCode, receiptNumber, bankNumber  Calculate Interest on Savings Account:  Calculates interest earned on a savings account based on todays date. It does not attempt to post or credit the interest on the account. That is responsibility of the Post Interest API that will likely be called by overnight process.  Post Interest on Savings Account:  Calculates and Posts interest earned on a savings account based on today\'s date and whether an interest posting or crediting event is due.  Block Savings Account:  Blocks Savings account from all types of credit and debit transactions  Unblock Savings Account:  Unblock a blocked account. On unblocking account, user can perform debit and credit transactions  Block Savings Account Credit transactions:  Savings account will be blocked from all types of credit transactions.  Unblock Savings Account Credit transactions:  It unblocks the Saving account\'s credit operations. Now all types of credits can be transacted to Savings account  Block Savings Account Debit transactions:  All types of debit operations from Savings account wil be blocked  Unblock Savings Account debit transactions:  It unblocks the Saving account\'s debit operations. Now all types of debits can be transacted from Savings account  Showing request/response for \'Unassign Savings Officer\'
     * @summary Approve savings application | Undo approval savings application | Assign Savings Officer | Unassign Savings Officer | Reject savings application | Withdraw savings application | Activate a savings account | Close a savings account | Calculate Interest on Savings Account | Post Interest on Savings Account | Block Savings Account | Unblock Savings Account | Block Savings Account Credit transactions | Unblock Savings Account Credit transactions | Block Savings Account Debit transactions | Unblock Savings Account debit transactions
     * @param {number} accountId accountId
     * @param {PostSavingsAccountsAccountIdRequest} postSavingsAccountsAccountIdRequest
     * @param {string} [command] command
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SavingsAccountApi
     */
    manageSavingsAccount(accountId: number, postSavingsAccountsAccountIdRequest: PostSavingsAccountsAccountIdRequest, command?: string, options?: any): Promise<import("axios").AxiosResponse<PostSavingsAccountsAccountIdResponse>>;
    /**
     *
     * @param {FormDataContentDisposition} [file]
     * @param {string} [locale]
     * @param {string} [dateFormat]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SavingsAccountApi
     */
    postSavingsTemplate(file?: FormDataContentDisposition, locale?: string, dateFormat?: string, options?: any): Promise<import("axios").AxiosResponse<string>>;
    /**
     *
     * @param {FormDataContentDisposition} [file]
     * @param {string} [locale]
     * @param {string} [dateFormat]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SavingsAccountApi
     */
    postSavingsTransactionTemplate(file?: FormDataContentDisposition, locale?: string, dateFormat?: string, options?: any): Promise<import("axios").AxiosResponse<string>>;
    /**
     * Retrieves a savings application/account  Example Requests :  savingsaccounts/1   savingsaccounts/1?associations=all
     * @summary Retrieve a savings application/account
     * @param {number} accountId accountId
     * @param {boolean} [staffInSelectedOfficeOnly] staffInSelectedOfficeOnly
     * @param {string} [chargeStatus] chargeStatus
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SavingsAccountApi
     */
    retrieveSavingsAccount(accountId: number, staffInSelectedOfficeOnly?: boolean, chargeStatus?: string, options?: any): Promise<import("axios").AxiosResponse<GetSavingsAccountsAccountIdResponse>>;
    /**
     * Lists savings applications/accounts  Example Requests:  savingsaccounts   savingsaccounts?fields=name
     * @summary List savings applications/accounts
     * @param {string} [sqlSearch] sqlSearch
     * @param {string} [externalId] externalId
     * @param {number} [offset] offset
     * @param {number} [limit] limit
     * @param {string} [orderBy] orderBy
     * @param {string} [sortOrder] sortOrder
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SavingsAccountApi
     */
    retrieveSavingsAccounts(sqlSearch?: string, externalId?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, options?: any): Promise<import("axios").AxiosResponse<GetSavingsAccountsResponse>>;
    /**
     *
     * @param {string} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SavingsAccountApi
     */
    submitGSIMApplication(body?: string, options?: any): Promise<import("axios").AxiosResponse<string>>;
    /**
     * Submits new savings application  Mandatory Fields: clientId or groupId, productId, submittedOnDate  Optional Fields: accountNo, externalId, fieldOfficerId  Inherited from Product (if not provided): nominalAnnualInterestRate, interestCompoundingPeriodType, interestCalculationType, interestCalculationDaysInYearType, minRequiredOpeningBalance, lockinPeriodFrequency, lockinPeriodFrequencyType, withdrawalFeeForTransfers, allowOverdraft, overdraftLimit, withHoldTax  Additional Mandatory Field if Entity-Datatable Check is enabled for the entity of type Savings: datatables
     * @summary Submit new savings application
     * @param {PostSavingsAccountsRequest} postSavingsAccountsRequest
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SavingsAccountApi
     */
    submitSavingsAccountsApplication(postSavingsAccountsRequest: PostSavingsAccountsRequest, options?: any): Promise<import("axios").AxiosResponse<PostSavingsAccountsResponse>>;
    /**
     *
     * @param {number} parentAccountId
     * @param {string} [body]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SavingsAccountApi
     */
    updateGsim(parentAccountId: number, body?: string, options?: any): Promise<import("axios").AxiosResponse<string>>;
    /**
     * Modify a savings application:  Savings application can only be modified when in \'Submitted and pending approval\' state. Once the application is approved, the details cannot be changed using this method. Specific api endpoints will be created to allow change of interest detail such as rate, compounding period, posting period etc  Modify savings account withhold tax applicability:  Savings application\'s withhold tax can be modified when in \'Active\' state. Once the application is activated, can modify the account withhold tax to post tax or vice-versaShowing request/response for \'Modify a savings application\'
     * @summary Modify a savings application | Modify savings account withhold tax applicability
     * @param {number} accountId accountId
     * @param {PutSavingsAccountsAccountIdRequest} putSavingsAccountsAccountIdRequest
     * @param {string} [command] command
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof SavingsAccountApi
     */
    updateSavingsAccount(accountId: number, putSavingsAccountsAccountIdRequest: PutSavingsAccountsAccountIdRequest, command?: string, options?: any): Promise<import("axios").AxiosResponse<PutSavingsAccountsAccountIdResponse>>;
}