UNPKG

fineract_sdk

Version:

Wrapper around fineract api.

788 lines (787 loc) 39.4 kB
/** * 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 { DeleteTellersTellerIdCashiersCashierIdResponse } from '../models'; import { GetTellersResponse } from '../models'; import { GetTellersTellerIdCashiersCashierIdResponse } from '../models'; import { GetTellersTellerIdCashiersCashiersIdSummaryAndTransactionsResponse } from '../models'; import { GetTellersTellerIdCashiersCashiersIdTransactionsResponse } from '../models'; import { GetTellersTellerIdCashiersCashiersIdTransactionsTemplateResponse } from '../models'; import { GetTellersTellerIdCashiersResponse } from '../models'; import { GetTellersTellerIdCashiersTemplateResponse } from '../models'; import { PostTellersRequest } from '../models'; import { PostTellersResponse } from '../models'; import { PostTellersTellerIdCashiersCashierIdAllocateRequest } from '../models'; import { PostTellersTellerIdCashiersCashierIdAllocateResponse } from '../models'; import { PostTellersTellerIdCashiersCashierIdSettleRequest } from '../models'; import { PostTellersTellerIdCashiersCashierIdSettleResponse } from '../models'; import { PostTellersTellerIdCashiersRequest } from '../models'; import { PostTellersTellerIdCashiersResponse } from '../models'; import { PutTellersRequest } from '../models'; import { PutTellersResponse } from '../models'; import { PutTellersTellerIdCashiersCashierIdRequest } from '../models'; import { PutTellersTellerIdCashiersCashierIdResponse } from '../models'; /** * TellerCashManagementApi - axios parameter creator * @export */ export declare const TellerCashManagementApiAxiosParamCreator: (configuration?: Configuration) => { /** * Mandatory Fields: Date, Amount, Currency, Notes/Comments * @summary Allocate Cash To Cashier * @param {number} tellerId tellerId * @param {number} cashierId cashierId * @param {PostTellersTellerIdCashiersCashierIdAllocateRequest} postTellersTellerIdCashiersCashierIdAllocateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ allocateCashToCashier: (tellerId: number, cashierId: number, postTellersTellerIdCashiersCashierIdAllocateRequest: PostTellersTellerIdCashiersCashierIdAllocateRequest, options?: any) => Promise<RequestArgs>; /** * Mandatory Fields: Cashier/staff, Fromm Date, To Date, Full Day or From time and To time Optional Fields: Description/Notes * @summary Create Cashiers * @param {number} tellerId tellerId * @param {PostTellersTellerIdCashiersRequest} postTellersTellerIdCashiersRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCashier: (tellerId: number, postTellersTellerIdCashiersRequest: PostTellersTellerIdCashiersRequest, options?: any) => Promise<RequestArgs>; /** * Mandatory Fields Teller name, OfficeId, Description, Start Date, Status Optional Fields End Date * @summary Create teller * @param {PostTellersRequest} postTellersRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createTeller: (postTellersRequest: PostTellersRequest, options?: any) => Promise<RequestArgs>; /** * * @summary Delete Cashier * @param {number} tellerId tellerId * @param {number} cashierId cashierId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteCashier: (tellerId: number, cashierId: number, options?: any) => Promise<RequestArgs>; /** * * @param {number} tellerId tellerId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteTeller: (tellerId: number, options?: any) => Promise<RequestArgs>; /** * * @summary Retrieve a cashier * @param {number} tellerId tellerId * @param {number} cashierId cashierId * @param {*} [options] Override http request option. * @throws {RequiredError} */ findCashierData: (tellerId: number, cashierId: number, options?: any) => Promise<RequestArgs>; /** * * @summary Retrieve tellers * @param {number} tellerId tellerId * @param {*} [options] Override http request option. * @throws {RequiredError} */ findTeller: (tellerId: number, options?: any) => Promise<RequestArgs>; /** * * @param {number} tellerId tellerId * @param {number} transactionId transactionId * @param {*} [options] Override http request option. * @throws {RequiredError} */ findTransactionData: (tellerId: number, transactionId: number, options?: any) => Promise<RequestArgs>; /** * * @summary List Cashiers * @param {number} tellerId tellerId * @param {string} [fromdate] fromdate * @param {string} [todate] todate * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCashierData1: (tellerId: number, fromdate?: string, todate?: string, options?: any) => Promise<RequestArgs>; /** * * @summary Find Cashiers * @param {number} tellerId tellerId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCashierTemplate: (tellerId: number, options?: any) => Promise<RequestArgs>; /** * * @summary Retrieve Cashier Transaction Template * @param {number} tellerId tellerId * @param {number} cashierId cashierId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCashierTxnTemplate: (tellerId: number, cashierId: number, options?: any) => Promise<RequestArgs>; /** * * @param {number} tellerId tellerId * @param {number} [cashierId] cashierId * @param {string} [dateRange] dateRange * @param {*} [options] Override http request option. * @throws {RequiredError} */ getJournalData: (tellerId: number, cashierId?: number, dateRange?: string, options?: any) => Promise<RequestArgs>; /** * Retrieves list tellers * @summary List all tellers * @param {number} [officeId] officeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTellerData: (officeId?: number, options?: any) => Promise<RequestArgs>; /** * * @param {number} tellerId tellerId * @param {string} [dateRange] dateRange * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTransactionData: (tellerId: number, dateRange?: string, options?: any) => Promise<RequestArgs>; /** * * @summary Retrieve Cashier Transaction * @param {number} tellerId tellerId * @param {number} cashierId cashierId * @param {string} [currencyCode] currencyCode * @param {number} [offset] offset * @param {number} [limit] limit * @param {string} [orderBy] orderBy * @param {string} [sortOrder] sortOrder * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTransactionsForCashier: (tellerId: number, cashierId: number, currencyCode?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, options?: any) => Promise<RequestArgs>; /** * * @summary Transactions Wtih Summary For Cashier * @param {number} tellerId tellerId * @param {number} cashierId cashierId * @param {string} [currencyCode] currencyCode * @param {number} [offset] offset * @param {number} [limit] limit * @param {string} [orderBy] orderBy * @param {string} [sortOrder] sortOrder * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTransactionsWtihSummaryForCashier: (tellerId: number, cashierId: number, currencyCode?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, options?: any) => Promise<RequestArgs>; /** * Mandatory Fields Date, Amount, Currency, Notes/Comments * @summary Settle Cash From Cashier * @param {number} tellerId tellerId * @param {number} cashierId cashierId * @param {PostTellersTellerIdCashiersCashierIdSettleRequest} postTellersTellerIdCashiersCashierIdSettleRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ settleCashFromCashier: (tellerId: number, cashierId: number, postTellersTellerIdCashiersCashierIdSettleRequest: PostTellersTellerIdCashiersCashierIdSettleRequest, options?: any) => Promise<RequestArgs>; /** * * @summary Update Cashier * @param {number} tellerId tellerId * @param {number} cashierId cashierId * @param {PutTellersTellerIdCashiersCashierIdRequest} putTellersTellerIdCashiersCashierIdRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCashier: (tellerId: number, cashierId: number, putTellersTellerIdCashiersCashierIdRequest: PutTellersTellerIdCashiersCashierIdRequest, options?: any) => Promise<RequestArgs>; /** * * @summary Update teller * @param {number} tellerId tellerId * @param {PutTellersRequest} putTellersRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateTeller: (tellerId: number, putTellersRequest: PutTellersRequest, options?: any) => Promise<RequestArgs>; }; /** * TellerCashManagementApi - functional programming interface * @export */ export declare const TellerCashManagementApiFp: (configuration?: Configuration) => { /** * Mandatory Fields: Date, Amount, Currency, Notes/Comments * @summary Allocate Cash To Cashier * @param {number} tellerId tellerId * @param {number} cashierId cashierId * @param {PostTellersTellerIdCashiersCashierIdAllocateRequest} postTellersTellerIdCashiersCashierIdAllocateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ allocateCashToCashier(tellerId: number, cashierId: number, postTellersTellerIdCashiersCashierIdAllocateRequest: PostTellersTellerIdCashiersCashierIdAllocateRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostTellersTellerIdCashiersCashierIdAllocateResponse>>; /** * Mandatory Fields: Cashier/staff, Fromm Date, To Date, Full Day or From time and To time Optional Fields: Description/Notes * @summary Create Cashiers * @param {number} tellerId tellerId * @param {PostTellersTellerIdCashiersRequest} postTellersTellerIdCashiersRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCashier(tellerId: number, postTellersTellerIdCashiersRequest: PostTellersTellerIdCashiersRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostTellersTellerIdCashiersResponse>>; /** * Mandatory Fields Teller name, OfficeId, Description, Start Date, Status Optional Fields End Date * @summary Create teller * @param {PostTellersRequest} postTellersRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createTeller(postTellersRequest: PostTellersRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostTellersResponse>>; /** * * @summary Delete Cashier * @param {number} tellerId tellerId * @param {number} cashierId cashierId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteCashier(tellerId: number, cashierId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteTellersTellerIdCashiersCashierIdResponse>>; /** * * @param {number} tellerId tellerId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteTeller(tellerId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @summary Retrieve a cashier * @param {number} tellerId tellerId * @param {number} cashierId cashierId * @param {*} [options] Override http request option. * @throws {RequiredError} */ findCashierData(tellerId: number, cashierId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTellersTellerIdCashiersCashierIdResponse>>; /** * * @summary Retrieve tellers * @param {number} tellerId tellerId * @param {*} [options] Override http request option. * @throws {RequiredError} */ findTeller(tellerId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTellersResponse>>; /** * * @param {number} tellerId tellerId * @param {number} transactionId transactionId * @param {*} [options] Override http request option. * @throws {RequiredError} */ findTransactionData(tellerId: number, transactionId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @summary List Cashiers * @param {number} tellerId tellerId * @param {string} [fromdate] fromdate * @param {string} [todate] todate * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCashierData1(tellerId: number, fromdate?: string, todate?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTellersTellerIdCashiersResponse>>; /** * * @summary Find Cashiers * @param {number} tellerId tellerId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCashierTemplate(tellerId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTellersTellerIdCashiersTemplateResponse>>; /** * * @summary Retrieve Cashier Transaction Template * @param {number} tellerId tellerId * @param {number} cashierId cashierId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCashierTxnTemplate(tellerId: number, cashierId: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTellersTellerIdCashiersCashiersIdTransactionsTemplateResponse>>; /** * * @param {number} tellerId tellerId * @param {number} [cashierId] cashierId * @param {string} [dateRange] dateRange * @param {*} [options] Override http request option. * @throws {RequiredError} */ getJournalData(tellerId: number, cashierId?: number, dateRange?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * Retrieves list tellers * @summary List all tellers * @param {number} [officeId] officeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTellerData(officeId?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetTellersResponse>>>; /** * * @param {number} tellerId tellerId * @param {string} [dateRange] dateRange * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTransactionData(tellerId: number, dateRange?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>; /** * * @summary Retrieve Cashier Transaction * @param {number} tellerId tellerId * @param {number} cashierId cashierId * @param {string} [currencyCode] currencyCode * @param {number} [offset] offset * @param {number} [limit] limit * @param {string} [orderBy] orderBy * @param {string} [sortOrder] sortOrder * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTransactionsForCashier(tellerId: number, cashierId: number, currencyCode?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetTellersTellerIdCashiersCashiersIdTransactionsResponse>>>; /** * * @summary Transactions Wtih Summary For Cashier * @param {number} tellerId tellerId * @param {number} cashierId cashierId * @param {string} [currencyCode] currencyCode * @param {number} [offset] offset * @param {number} [limit] limit * @param {string} [orderBy] orderBy * @param {string} [sortOrder] sortOrder * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTransactionsWtihSummaryForCashier(tellerId: number, cashierId: number, currencyCode?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTellersTellerIdCashiersCashiersIdSummaryAndTransactionsResponse>>; /** * Mandatory Fields Date, Amount, Currency, Notes/Comments * @summary Settle Cash From Cashier * @param {number} tellerId tellerId * @param {number} cashierId cashierId * @param {PostTellersTellerIdCashiersCashierIdSettleRequest} postTellersTellerIdCashiersCashierIdSettleRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ settleCashFromCashier(tellerId: number, cashierId: number, postTellersTellerIdCashiersCashierIdSettleRequest: PostTellersTellerIdCashiersCashierIdSettleRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostTellersTellerIdCashiersCashierIdSettleResponse>>; /** * * @summary Update Cashier * @param {number} tellerId tellerId * @param {number} cashierId cashierId * @param {PutTellersTellerIdCashiersCashierIdRequest} putTellersTellerIdCashiersCashierIdRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCashier(tellerId: number, cashierId: number, putTellersTellerIdCashiersCashierIdRequest: PutTellersTellerIdCashiersCashierIdRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutTellersTellerIdCashiersCashierIdResponse>>; /** * * @summary Update teller * @param {number} tellerId tellerId * @param {PutTellersRequest} putTellersRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateTeller(tellerId: number, putTellersRequest: PutTellersRequest, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PutTellersResponse>>; }; /** * TellerCashManagementApi - factory interface * @export */ export declare const TellerCashManagementApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Mandatory Fields: Date, Amount, Currency, Notes/Comments * @summary Allocate Cash To Cashier * @param {number} tellerId tellerId * @param {number} cashierId cashierId * @param {PostTellersTellerIdCashiersCashierIdAllocateRequest} postTellersTellerIdCashiersCashierIdAllocateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ allocateCashToCashier(tellerId: number, cashierId: number, postTellersTellerIdCashiersCashierIdAllocateRequest: PostTellersTellerIdCashiersCashierIdAllocateRequest, options?: any): AxiosPromise<PostTellersTellerIdCashiersCashierIdAllocateResponse>; /** * Mandatory Fields: Cashier/staff, Fromm Date, To Date, Full Day or From time and To time Optional Fields: Description/Notes * @summary Create Cashiers * @param {number} tellerId tellerId * @param {PostTellersTellerIdCashiersRequest} postTellersTellerIdCashiersRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createCashier(tellerId: number, postTellersTellerIdCashiersRequest: PostTellersTellerIdCashiersRequest, options?: any): AxiosPromise<PostTellersTellerIdCashiersResponse>; /** * Mandatory Fields Teller name, OfficeId, Description, Start Date, Status Optional Fields End Date * @summary Create teller * @param {PostTellersRequest} postTellersRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createTeller(postTellersRequest: PostTellersRequest, options?: any): AxiosPromise<PostTellersResponse>; /** * * @summary Delete Cashier * @param {number} tellerId tellerId * @param {number} cashierId cashierId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteCashier(tellerId: number, cashierId: number, options?: any): AxiosPromise<DeleteTellersTellerIdCashiersCashierIdResponse>; /** * * @param {number} tellerId tellerId * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteTeller(tellerId: number, options?: any): AxiosPromise<string>; /** * * @summary Retrieve a cashier * @param {number} tellerId tellerId * @param {number} cashierId cashierId * @param {*} [options] Override http request option. * @throws {RequiredError} */ findCashierData(tellerId: number, cashierId: number, options?: any): AxiosPromise<GetTellersTellerIdCashiersCashierIdResponse>; /** * * @summary Retrieve tellers * @param {number} tellerId tellerId * @param {*} [options] Override http request option. * @throws {RequiredError} */ findTeller(tellerId: number, options?: any): AxiosPromise<GetTellersResponse>; /** * * @param {number} tellerId tellerId * @param {number} transactionId transactionId * @param {*} [options] Override http request option. * @throws {RequiredError} */ findTransactionData(tellerId: number, transactionId: number, options?: any): AxiosPromise<string>; /** * * @summary List Cashiers * @param {number} tellerId tellerId * @param {string} [fromdate] fromdate * @param {string} [todate] todate * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCashierData1(tellerId: number, fromdate?: string, todate?: string, options?: any): AxiosPromise<GetTellersTellerIdCashiersResponse>; /** * * @summary Find Cashiers * @param {number} tellerId tellerId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCashierTemplate(tellerId: number, options?: any): AxiosPromise<GetTellersTellerIdCashiersTemplateResponse>; /** * * @summary Retrieve Cashier Transaction Template * @param {number} tellerId tellerId * @param {number} cashierId cashierId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCashierTxnTemplate(tellerId: number, cashierId: number, options?: any): AxiosPromise<GetTellersTellerIdCashiersCashiersIdTransactionsTemplateResponse>; /** * * @param {number} tellerId tellerId * @param {number} [cashierId] cashierId * @param {string} [dateRange] dateRange * @param {*} [options] Override http request option. * @throws {RequiredError} */ getJournalData(tellerId: number, cashierId?: number, dateRange?: string, options?: any): AxiosPromise<string>; /** * Retrieves list tellers * @summary List all tellers * @param {number} [officeId] officeId * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTellerData(officeId?: number, options?: any): AxiosPromise<Array<GetTellersResponse>>; /** * * @param {number} tellerId tellerId * @param {string} [dateRange] dateRange * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTransactionData(tellerId: number, dateRange?: string, options?: any): AxiosPromise<string>; /** * * @summary Retrieve Cashier Transaction * @param {number} tellerId tellerId * @param {number} cashierId cashierId * @param {string} [currencyCode] currencyCode * @param {number} [offset] offset * @param {number} [limit] limit * @param {string} [orderBy] orderBy * @param {string} [sortOrder] sortOrder * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTransactionsForCashier(tellerId: number, cashierId: number, currencyCode?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, options?: any): AxiosPromise<Array<GetTellersTellerIdCashiersCashiersIdTransactionsResponse>>; /** * * @summary Transactions Wtih Summary For Cashier * @param {number} tellerId tellerId * @param {number} cashierId cashierId * @param {string} [currencyCode] currencyCode * @param {number} [offset] offset * @param {number} [limit] limit * @param {string} [orderBy] orderBy * @param {string} [sortOrder] sortOrder * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTransactionsWtihSummaryForCashier(tellerId: number, cashierId: number, currencyCode?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, options?: any): AxiosPromise<GetTellersTellerIdCashiersCashiersIdSummaryAndTransactionsResponse>; /** * Mandatory Fields Date, Amount, Currency, Notes/Comments * @summary Settle Cash From Cashier * @param {number} tellerId tellerId * @param {number} cashierId cashierId * @param {PostTellersTellerIdCashiersCashierIdSettleRequest} postTellersTellerIdCashiersCashierIdSettleRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ settleCashFromCashier(tellerId: number, cashierId: number, postTellersTellerIdCashiersCashierIdSettleRequest: PostTellersTellerIdCashiersCashierIdSettleRequest, options?: any): AxiosPromise<PostTellersTellerIdCashiersCashierIdSettleResponse>; /** * * @summary Update Cashier * @param {number} tellerId tellerId * @param {number} cashierId cashierId * @param {PutTellersTellerIdCashiersCashierIdRequest} putTellersTellerIdCashiersCashierIdRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCashier(tellerId: number, cashierId: number, putTellersTellerIdCashiersCashierIdRequest: PutTellersTellerIdCashiersCashierIdRequest, options?: any): AxiosPromise<PutTellersTellerIdCashiersCashierIdResponse>; /** * * @summary Update teller * @param {number} tellerId tellerId * @param {PutTellersRequest} putTellersRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateTeller(tellerId: number, putTellersRequest: PutTellersRequest, options?: any): AxiosPromise<PutTellersResponse>; }; /** * TellerCashManagementApi - object-oriented interface * @export * @class TellerCashManagementApi * @extends {BaseAPI} */ export declare class TellerCashManagementApi extends BaseAPI { /** * Mandatory Fields: Date, Amount, Currency, Notes/Comments * @summary Allocate Cash To Cashier * @param {number} tellerId tellerId * @param {number} cashierId cashierId * @param {PostTellersTellerIdCashiersCashierIdAllocateRequest} postTellersTellerIdCashiersCashierIdAllocateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TellerCashManagementApi */ allocateCashToCashier(tellerId: number, cashierId: number, postTellersTellerIdCashiersCashierIdAllocateRequest: PostTellersTellerIdCashiersCashierIdAllocateRequest, options?: any): Promise<import("axios").AxiosResponse<PostTellersTellerIdCashiersCashierIdAllocateResponse>>; /** * Mandatory Fields: Cashier/staff, Fromm Date, To Date, Full Day or From time and To time Optional Fields: Description/Notes * @summary Create Cashiers * @param {number} tellerId tellerId * @param {PostTellersTellerIdCashiersRequest} postTellersTellerIdCashiersRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TellerCashManagementApi */ createCashier(tellerId: number, postTellersTellerIdCashiersRequest: PostTellersTellerIdCashiersRequest, options?: any): Promise<import("axios").AxiosResponse<PostTellersTellerIdCashiersResponse>>; /** * Mandatory Fields Teller name, OfficeId, Description, Start Date, Status Optional Fields End Date * @summary Create teller * @param {PostTellersRequest} postTellersRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TellerCashManagementApi */ createTeller(postTellersRequest: PostTellersRequest, options?: any): Promise<import("axios").AxiosResponse<PostTellersResponse>>; /** * * @summary Delete Cashier * @param {number} tellerId tellerId * @param {number} cashierId cashierId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TellerCashManagementApi */ deleteCashier(tellerId: number, cashierId: number, options?: any): Promise<import("axios").AxiosResponse<DeleteTellersTellerIdCashiersCashierIdResponse>>; /** * * @param {number} tellerId tellerId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TellerCashManagementApi */ deleteTeller(tellerId: number, options?: any): Promise<import("axios").AxiosResponse<string>>; /** * * @summary Retrieve a cashier * @param {number} tellerId tellerId * @param {number} cashierId cashierId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TellerCashManagementApi */ findCashierData(tellerId: number, cashierId: number, options?: any): Promise<import("axios").AxiosResponse<GetTellersTellerIdCashiersCashierIdResponse>>; /** * * @summary Retrieve tellers * @param {number} tellerId tellerId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TellerCashManagementApi */ findTeller(tellerId: number, options?: any): Promise<import("axios").AxiosResponse<GetTellersResponse>>; /** * * @param {number} tellerId tellerId * @param {number} transactionId transactionId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TellerCashManagementApi */ findTransactionData(tellerId: number, transactionId: number, options?: any): Promise<import("axios").AxiosResponse<string>>; /** * * @summary List Cashiers * @param {number} tellerId tellerId * @param {string} [fromdate] fromdate * @param {string} [todate] todate * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TellerCashManagementApi */ getCashierData1(tellerId: number, fromdate?: string, todate?: string, options?: any): Promise<import("axios").AxiosResponse<GetTellersTellerIdCashiersResponse>>; /** * * @summary Find Cashiers * @param {number} tellerId tellerId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TellerCashManagementApi */ getCashierTemplate(tellerId: number, options?: any): Promise<import("axios").AxiosResponse<GetTellersTellerIdCashiersTemplateResponse>>; /** * * @summary Retrieve Cashier Transaction Template * @param {number} tellerId tellerId * @param {number} cashierId cashierId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TellerCashManagementApi */ getCashierTxnTemplate(tellerId: number, cashierId: number, options?: any): Promise<import("axios").AxiosResponse<GetTellersTellerIdCashiersCashiersIdTransactionsTemplateResponse>>; /** * * @param {number} tellerId tellerId * @param {number} [cashierId] cashierId * @param {string} [dateRange] dateRange * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TellerCashManagementApi */ getJournalData(tellerId: number, cashierId?: number, dateRange?: string, options?: any): Promise<import("axios").AxiosResponse<string>>; /** * Retrieves list tellers * @summary List all tellers * @param {number} [officeId] officeId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TellerCashManagementApi */ getTellerData(officeId?: number, options?: any): Promise<import("axios").AxiosResponse<GetTellersResponse[]>>; /** * * @param {number} tellerId tellerId * @param {string} [dateRange] dateRange * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TellerCashManagementApi */ getTransactionData(tellerId: number, dateRange?: string, options?: any): Promise<import("axios").AxiosResponse<string>>; /** * * @summary Retrieve Cashier Transaction * @param {number} tellerId tellerId * @param {number} cashierId cashierId * @param {string} [currencyCode] currencyCode * @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 TellerCashManagementApi */ getTransactionsForCashier(tellerId: number, cashierId: number, currencyCode?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, options?: any): Promise<import("axios").AxiosResponse<GetTellersTellerIdCashiersCashiersIdTransactionsResponse[]>>; /** * * @summary Transactions Wtih Summary For Cashier * @param {number} tellerId tellerId * @param {number} cashierId cashierId * @param {string} [currencyCode] currencyCode * @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 TellerCashManagementApi */ getTransactionsWtihSummaryForCashier(tellerId: number, cashierId: number, currencyCode?: string, offset?: number, limit?: number, orderBy?: string, sortOrder?: string, options?: any): Promise<import("axios").AxiosResponse<GetTellersTellerIdCashiersCashiersIdSummaryAndTransactionsResponse>>; /** * Mandatory Fields Date, Amount, Currency, Notes/Comments * @summary Settle Cash From Cashier * @param {number} tellerId tellerId * @param {number} cashierId cashierId * @param {PostTellersTellerIdCashiersCashierIdSettleRequest} postTellersTellerIdCashiersCashierIdSettleRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TellerCashManagementApi */ settleCashFromCashier(tellerId: number, cashierId: number, postTellersTellerIdCashiersCashierIdSettleRequest: PostTellersTellerIdCashiersCashierIdSettleRequest, options?: any): Promise<import("axios").AxiosResponse<PostTellersTellerIdCashiersCashierIdSettleResponse>>; /** * * @summary Update Cashier * @param {number} tellerId tellerId * @param {number} cashierId cashierId * @param {PutTellersTellerIdCashiersCashierIdRequest} putTellersTellerIdCashiersCashierIdRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TellerCashManagementApi */ updateCashier(tellerId: number, cashierId: number, putTellersTellerIdCashiersCashierIdRequest: PutTellersTellerIdCashiersCashierIdRequest, options?: any): Promise<import("axios").AxiosResponse<PutTellersTellerIdCashiersCashierIdResponse>>; /** * * @summary Update teller * @param {number} tellerId tellerId * @param {PutTellersRequest} putTellersRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TellerCashManagementApi */ updateTeller(tellerId: number, putTellersRequest: PutTellersRequest, options?: any): Promise<import("axios").AxiosResponse<PutTellersResponse>>; }