fineract_sdk
Version:
Wrapper around fineract api.
986 lines • 62.4 kB
JavaScript
"use strict";
/* tslint:disable */
/* eslint-disable */
/**
* 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.
*/
var __extends = (this && this.__extends) || (function () {
var extendStatics = function (d, b) {
extendStatics = Object.setPrototypeOf ||
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; };
return extendStatics(d, b);
};
return function (d, b) {
extendStatics(d, b);
function __() { this.constructor = d; }
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
};
})();
var __assign = (this && this.__assign) || function () {
__assign = Object.assign || function(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.JournalEntriesApi = exports.JournalEntriesApiFactory = exports.JournalEntriesApiFp = exports.JournalEntriesApiAxiosParamCreator = void 0;
var axios_1 = require("axios");
// Some imports not used depending on template conditions
// @ts-ignore
var common_1 = require("../common");
// @ts-ignore
var base_1 = require("../base");
/**
* JournalEntriesApi - axios parameter creator
* @export
*/
exports.JournalEntriesApiAxiosParamCreator = function (configuration) {
var _this = this;
return {
/**
* Note: A Balanced (simple) Journal entry would have atleast one \"Debit\" and one \"Credit\" entry whose amounts are equal Compound Journal entries may have \"n\" debits and \"m\" credits where both \"m\" and \"n\" are greater than 0 and the net sum or all debits and credits are equal Mandatory Fields officeId, transactionDate credits- glAccountId, amount, comments debits- glAccountId, amount, comments Optional Fields paymentTypeId, accountNumber, checkNumber, routingCode, receiptNumber, bankNumber
* @summary Create \"Balanced\" Journal Entries
* @param {string} [command] command
* @param {JournalEntryCommand} [journalEntryCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createGLJournalEntry: function (command, journalEntryCommand, options) {
if (options === void 0) { options = {}; }
return __awaiter(_this, void 0, void 0, function () {
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
localVarPath = "/journalentries";
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
localVarHeaderParameter = {};
localVarQueryParameter = {};
// authentication basicAuth required
// http basic authentication required
common_1.setBasicAuthToObject(localVarRequestOptions, configuration);
// authentication tenantid required
return [4 /*yield*/, common_1.setApiKeyToObject(localVarHeaderParameter, "fineract-platform-tenantid", configuration)];
case 1:
// authentication tenantid required
_a.sent();
if (command !== undefined) {
localVarQueryParameter['command'] = command;
}
localVarHeaderParameter['Content-Type'] = 'application/json';
common_1.setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
localVarRequestOptions.data = common_1.serializeDataIfNeeded(journalEntryCommand, localVarRequestOptions, configuration);
return [2 /*return*/, {
url: common_1.toPathString(localVarUrlObj),
options: localVarRequestOptions,
}];
}
});
});
},
/**
* This API calculates the running balances for office. If office ID not provided this API calculates running balances for all offices. Mandatory Fields officeId
* @summary Update Running balances for Journal Entries
* @param {string} transactionId transactionId
* @param {string} [command] command
* @param {PostJournalEntriesTransactionIdRequest} [postJournalEntriesTransactionIdRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createReversalJournalEntry: function (transactionId, command, postJournalEntriesTransactionIdRequest, options) {
if (options === void 0) { options = {}; }
return __awaiter(_this, void 0, void 0, function () {
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
// verify required parameter 'transactionId' is not null or undefined
common_1.assertParamExists('createReversalJournalEntry', 'transactionId', transactionId);
localVarPath = "/journalentries/{transactionId}"
.replace("{" + "transactionId" + "}", encodeURIComponent(String(transactionId)));
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
localVarHeaderParameter = {};
localVarQueryParameter = {};
// authentication basicAuth required
// http basic authentication required
common_1.setBasicAuthToObject(localVarRequestOptions, configuration);
// authentication tenantid required
return [4 /*yield*/, common_1.setApiKeyToObject(localVarHeaderParameter, "fineract-platform-tenantid", configuration)];
case 1:
// authentication tenantid required
_a.sent();
if (command !== undefined) {
localVarQueryParameter['command'] = command;
}
localVarHeaderParameter['Content-Type'] = 'application/json';
common_1.setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
localVarRequestOptions.data = common_1.serializeDataIfNeeded(postJournalEntriesTransactionIdRequest, localVarRequestOptions, configuration);
return [2 /*return*/, {
url: common_1.toPathString(localVarUrlObj),
options: localVarRequestOptions,
}];
}
});
});
},
/**
*
* @param {number} [officeId]
* @param {string} [dateFormat]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getJournalEntriesTemplate: function (officeId, dateFormat, options) {
if (options === void 0) { options = {}; }
return __awaiter(_this, void 0, void 0, function () {
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
localVarPath = "/journalentries/downloadtemplate";
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
localVarHeaderParameter = {};
localVarQueryParameter = {};
// authentication basicAuth required
// http basic authentication required
common_1.setBasicAuthToObject(localVarRequestOptions, configuration);
// authentication tenantid required
return [4 /*yield*/, common_1.setApiKeyToObject(localVarHeaderParameter, "fineract-platform-tenantid", configuration)];
case 1:
// authentication tenantid required
_a.sent();
if (officeId !== undefined) {
localVarQueryParameter['officeId'] = officeId;
}
if (dateFormat !== undefined) {
localVarQueryParameter['dateFormat'] = dateFormat;
}
common_1.setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return [2 /*return*/, {
url: common_1.toPathString(localVarUrlObj),
options: localVarRequestOptions,
}];
}
});
});
},
/**
*
* @param {FormDataContentDisposition} [file]
* @param {string} [locale]
* @param {string} [dateFormat]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postJournalEntriesTemplate: function (file, locale, dateFormat, options) {
if (options === void 0) { options = {}; }
return __awaiter(_this, void 0, void 0, function () {
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, localVarFormParams, headersFromBaseOptions;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
localVarPath = "/journalentries/uploadtemplate";
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
localVarHeaderParameter = {};
localVarQueryParameter = {};
localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)();
// authentication basicAuth required
// http basic authentication required
common_1.setBasicAuthToObject(localVarRequestOptions, configuration);
// authentication tenantid required
return [4 /*yield*/, common_1.setApiKeyToObject(localVarHeaderParameter, "fineract-platform-tenantid", configuration)];
case 1:
// authentication tenantid required
_a.sent();
if (file !== undefined) {
localVarFormParams.append('file', new Blob([JSON.stringify(file)], { type: "application/json", }));
}
if (locale !== undefined) {
localVarFormParams.append('locale', locale);
}
if (dateFormat !== undefined) {
localVarFormParams.append('dateFormat', dateFormat);
}
localVarHeaderParameter['Content-Type'] = 'multipart/form-data';
common_1.setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
localVarRequestOptions.data = localVarFormParams;
return [2 /*return*/, {
url: common_1.toPathString(localVarUrlObj),
options: localVarRequestOptions,
}];
}
});
});
},
/**
* Example Requests: journalentries/1 journalentries/1?fields=officeName,glAccountId,entryType,amount journalentries/1?runningBalance=true journalentries/1?transactionDetails=true
* @summary Retrieve a single Entry
* @param {number} journalEntryId journalEntryId
* @param {boolean} [runningBalance] runningBalance
* @param {boolean} [transactionDetails] transactionDetails
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retreiveJournalEntryById: function (journalEntryId, runningBalance, transactionDetails, options) {
if (options === void 0) { options = {}; }
return __awaiter(_this, void 0, void 0, function () {
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
// verify required parameter 'journalEntryId' is not null or undefined
common_1.assertParamExists('retreiveJournalEntryById', 'journalEntryId', journalEntryId);
localVarPath = "/journalentries/{journalEntryId}"
.replace("{" + "journalEntryId" + "}", encodeURIComponent(String(journalEntryId)));
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
localVarHeaderParameter = {};
localVarQueryParameter = {};
// authentication basicAuth required
// http basic authentication required
common_1.setBasicAuthToObject(localVarRequestOptions, configuration);
// authentication tenantid required
return [4 /*yield*/, common_1.setApiKeyToObject(localVarHeaderParameter, "fineract-platform-tenantid", configuration)];
case 1:
// authentication tenantid required
_a.sent();
if (runningBalance !== undefined) {
localVarQueryParameter['runningBalance'] = runningBalance;
}
if (transactionDetails !== undefined) {
localVarQueryParameter['transactionDetails'] = transactionDetails;
}
common_1.setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return [2 /*return*/, {
url: common_1.toPathString(localVarUrlObj),
options: localVarRequestOptions,
}];
}
});
});
},
/**
* The list capability of journal entries can support pagination and sorting. Example Requests: journalentries journalentries?transactionId=PB37X8Y21EQUY4S journalentries?officeId=1&manualEntriesOnly=true&fromDate=1 July 2013&toDate=15 July 2013&dateFormat=dd MMMM yyyy&locale=en journalentries?fields=officeName,glAccountName,transactionDate journalentries?offset=10&limit=50 journalentries?orderBy=transactionId&sortOrder=DESC journalentries?runningBalance=true journalentries?transactionDetails=true journalentries?loanId=12 journalentries?savingsId=24
* @summary List Journal Entries
* @param {number} [officeId] officeId
* @param {number} [glAccountId] glAccountId
* @param {boolean} [manualEntriesOnly] manualEntriesOnly
* @param {object} [fromDate] fromDate
* @param {object} [toDate] toDate
* @param {string} [transactionId] transactionId
* @param {number} [entityType] entityType
* @param {number} [offset] offset
* @param {number} [limit] limit
* @param {string} [orderBy] orderBy
* @param {string} [sortOrder] sortOrder
* @param {string} [locale] locale
* @param {string} [dateFormat] dateFormat
* @param {number} [loanId] loanId
* @param {number} [savingsId] savingsId
* @param {boolean} [runningBalance] runningBalance
* @param {boolean} [transactionDetails] transactionDetails
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAll1: function (officeId, glAccountId, manualEntriesOnly, fromDate, toDate, transactionId, entityType, offset, limit, orderBy, sortOrder, locale, dateFormat, loanId, savingsId, runningBalance, transactionDetails, options) {
if (options === void 0) { options = {}; }
return __awaiter(_this, void 0, void 0, function () {
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
localVarPath = "/journalentries";
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
localVarHeaderParameter = {};
localVarQueryParameter = {};
// authentication basicAuth required
// http basic authentication required
common_1.setBasicAuthToObject(localVarRequestOptions, configuration);
// authentication tenantid required
return [4 /*yield*/, common_1.setApiKeyToObject(localVarHeaderParameter, "fineract-platform-tenantid", configuration)];
case 1:
// authentication tenantid required
_a.sent();
if (officeId !== undefined) {
localVarQueryParameter['officeId'] = officeId;
}
if (glAccountId !== undefined) {
localVarQueryParameter['glAccountId'] = glAccountId;
}
if (manualEntriesOnly !== undefined) {
localVarQueryParameter['manualEntriesOnly'] = manualEntriesOnly;
}
if (fromDate !== undefined) {
localVarQueryParameter['fromDate'] = fromDate;
}
if (toDate !== undefined) {
localVarQueryParameter['toDate'] = toDate;
}
if (transactionId !== undefined) {
localVarQueryParameter['transactionId'] = transactionId;
}
if (entityType !== undefined) {
localVarQueryParameter['entityType'] = entityType;
}
if (offset !== undefined) {
localVarQueryParameter['offset'] = offset;
}
if (limit !== undefined) {
localVarQueryParameter['limit'] = limit;
}
if (orderBy !== undefined) {
localVarQueryParameter['orderBy'] = orderBy;
}
if (sortOrder !== undefined) {
localVarQueryParameter['sortOrder'] = sortOrder;
}
if (locale !== undefined) {
localVarQueryParameter['locale'] = locale;
}
if (dateFormat !== undefined) {
localVarQueryParameter['dateFormat'] = dateFormat;
}
if (loanId !== undefined) {
localVarQueryParameter['loanId'] = loanId;
}
if (savingsId !== undefined) {
localVarQueryParameter['savingsId'] = savingsId;
}
if (runningBalance !== undefined) {
localVarQueryParameter['runningBalance'] = runningBalance;
}
if (transactionDetails !== undefined) {
localVarQueryParameter['transactionDetails'] = transactionDetails;
}
common_1.setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return [2 /*return*/, {
url: common_1.toPathString(localVarUrlObj),
options: localVarRequestOptions,
}];
}
});
});
},
/**
*
* @param {number} [offset]
* @param {number} [limit]
* @param {number} [entryId]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveJournalEntries: function (offset, limit, entryId, options) {
if (options === void 0) { options = {}; }
return __awaiter(_this, void 0, void 0, function () {
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
localVarPath = "/journalentries/provisioning";
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
localVarHeaderParameter = {};
localVarQueryParameter = {};
// authentication basicAuth required
// http basic authentication required
common_1.setBasicAuthToObject(localVarRequestOptions, configuration);
// authentication tenantid required
return [4 /*yield*/, common_1.setApiKeyToObject(localVarHeaderParameter, "fineract-platform-tenantid", configuration)];
case 1:
// authentication tenantid required
_a.sent();
if (offset !== undefined) {
localVarQueryParameter['offset'] = offset;
}
if (limit !== undefined) {
localVarQueryParameter['limit'] = limit;
}
if (entryId !== undefined) {
localVarQueryParameter['entryId'] = entryId;
}
common_1.setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return [2 /*return*/, {
url: common_1.toPathString(localVarUrlObj),
options: localVarRequestOptions,
}];
}
});
});
},
/**
*
* @param {number} [officeId]
* @param {string} [currencyCode]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveOpeningBalance: function (officeId, currencyCode, options) {
if (options === void 0) { options = {}; }
return __awaiter(_this, void 0, void 0, function () {
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
localVarPath = "/journalentries/openingbalance";
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
if (configuration) {
baseOptions = configuration.baseOptions;
}
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
localVarHeaderParameter = {};
localVarQueryParameter = {};
// authentication basicAuth required
// http basic authentication required
common_1.setBasicAuthToObject(localVarRequestOptions, configuration);
// authentication tenantid required
return [4 /*yield*/, common_1.setApiKeyToObject(localVarHeaderParameter, "fineract-platform-tenantid", configuration)];
case 1:
// authentication tenantid required
_a.sent();
if (officeId !== undefined) {
localVarQueryParameter['officeId'] = officeId;
}
if (currencyCode !== undefined) {
localVarQueryParameter['currencyCode'] = currencyCode;
}
common_1.setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
return [2 /*return*/, {
url: common_1.toPathString(localVarUrlObj),
options: localVarRequestOptions,
}];
}
});
});
},
};
};
/**
* JournalEntriesApi - functional programming interface
* @export
*/
exports.JournalEntriesApiFp = function (configuration) {
var localVarAxiosParamCreator = exports.JournalEntriesApiAxiosParamCreator(configuration);
return {
/**
* Note: A Balanced (simple) Journal entry would have atleast one \"Debit\" and one \"Credit\" entry whose amounts are equal Compound Journal entries may have \"n\" debits and \"m\" credits where both \"m\" and \"n\" are greater than 0 and the net sum or all debits and credits are equal Mandatory Fields officeId, transactionDate credits- glAccountId, amount, comments debits- glAccountId, amount, comments Optional Fields paymentTypeId, accountNumber, checkNumber, routingCode, receiptNumber, bankNumber
* @summary Create \"Balanced\" Journal Entries
* @param {string} [command] command
* @param {JournalEntryCommand} [journalEntryCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createGLJournalEntry: function (command, journalEntryCommand, options) {
return __awaiter(this, void 0, void 0, function () {
var localVarAxiosArgs;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, localVarAxiosParamCreator.createGLJournalEntry(command, journalEntryCommand, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
}
});
});
},
/**
* This API calculates the running balances for office. If office ID not provided this API calculates running balances for all offices. Mandatory Fields officeId
* @summary Update Running balances for Journal Entries
* @param {string} transactionId transactionId
* @param {string} [command] command
* @param {PostJournalEntriesTransactionIdRequest} [postJournalEntriesTransactionIdRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createReversalJournalEntry: function (transactionId, command, postJournalEntriesTransactionIdRequest, options) {
return __awaiter(this, void 0, void 0, function () {
var localVarAxiosArgs;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, localVarAxiosParamCreator.createReversalJournalEntry(transactionId, command, postJournalEntriesTransactionIdRequest, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
}
});
});
},
/**
*
* @param {number} [officeId]
* @param {string} [dateFormat]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getJournalEntriesTemplate: function (officeId, dateFormat, options) {
return __awaiter(this, void 0, void 0, function () {
var localVarAxiosArgs;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getJournalEntriesTemplate(officeId, dateFormat, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
}
});
});
},
/**
*
* @param {FormDataContentDisposition} [file]
* @param {string} [locale]
* @param {string} [dateFormat]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postJournalEntriesTemplate: function (file, locale, dateFormat, options) {
return __awaiter(this, void 0, void 0, function () {
var localVarAxiosArgs;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, localVarAxiosParamCreator.postJournalEntriesTemplate(file, locale, dateFormat, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
}
});
});
},
/**
* Example Requests: journalentries/1 journalentries/1?fields=officeName,glAccountId,entryType,amount journalentries/1?runningBalance=true journalentries/1?transactionDetails=true
* @summary Retrieve a single Entry
* @param {number} journalEntryId journalEntryId
* @param {boolean} [runningBalance] runningBalance
* @param {boolean} [transactionDetails] transactionDetails
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retreiveJournalEntryById: function (journalEntryId, runningBalance, transactionDetails, options) {
return __awaiter(this, void 0, void 0, function () {
var localVarAxiosArgs;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, localVarAxiosParamCreator.retreiveJournalEntryById(journalEntryId, runningBalance, transactionDetails, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
}
});
});
},
/**
* The list capability of journal entries can support pagination and sorting. Example Requests: journalentries journalentries?transactionId=PB37X8Y21EQUY4S journalentries?officeId=1&manualEntriesOnly=true&fromDate=1 July 2013&toDate=15 July 2013&dateFormat=dd MMMM yyyy&locale=en journalentries?fields=officeName,glAccountName,transactionDate journalentries?offset=10&limit=50 journalentries?orderBy=transactionId&sortOrder=DESC journalentries?runningBalance=true journalentries?transactionDetails=true journalentries?loanId=12 journalentries?savingsId=24
* @summary List Journal Entries
* @param {number} [officeId] officeId
* @param {number} [glAccountId] glAccountId
* @param {boolean} [manualEntriesOnly] manualEntriesOnly
* @param {object} [fromDate] fromDate
* @param {object} [toDate] toDate
* @param {string} [transactionId] transactionId
* @param {number} [entityType] entityType
* @param {number} [offset] offset
* @param {number} [limit] limit
* @param {string} [orderBy] orderBy
* @param {string} [sortOrder] sortOrder
* @param {string} [locale] locale
* @param {string} [dateFormat] dateFormat
* @param {number} [loanId] loanId
* @param {number} [savingsId] savingsId
* @param {boolean} [runningBalance] runningBalance
* @param {boolean} [transactionDetails] transactionDetails
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAll1: function (officeId, glAccountId, manualEntriesOnly, fromDate, toDate, transactionId, entityType, offset, limit, orderBy, sortOrder, locale, dateFormat, loanId, savingsId, runningBalance, transactionDetails, options) {
return __awaiter(this, void 0, void 0, function () {
var localVarAxiosArgs;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, localVarAxiosParamCreator.retrieveAll1(officeId, glAccountId, manualEntriesOnly, fromDate, toDate, transactionId, entityType, offset, limit, orderBy, sortOrder, locale, dateFormat, loanId, savingsId, runningBalance, transactionDetails, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
}
});
});
},
/**
*
* @param {number} [offset]
* @param {number} [limit]
* @param {number} [entryId]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveJournalEntries: function (offset, limit, entryId, options) {
return __awaiter(this, void 0, void 0, function () {
var localVarAxiosArgs;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, localVarAxiosParamCreator.retrieveJournalEntries(offset, limit, entryId, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
}
});
});
},
/**
*
* @param {number} [officeId]
* @param {string} [currencyCode]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveOpeningBalance: function (officeId, currencyCode, options) {
return __awaiter(this, void 0, void 0, function () {
var localVarAxiosArgs;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, localVarAxiosParamCreator.retrieveOpeningBalance(officeId, currencyCode, options)];
case 1:
localVarAxiosArgs = _a.sent();
return [2 /*return*/, common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
}
});
});
},
};
};
/**
* JournalEntriesApi - factory interface
* @export
*/
exports.JournalEntriesApiFactory = function (configuration, basePath, axios) {
var localVarFp = exports.JournalEntriesApiFp(configuration);
return {
/**
* Note: A Balanced (simple) Journal entry would have atleast one \"Debit\" and one \"Credit\" entry whose amounts are equal Compound Journal entries may have \"n\" debits and \"m\" credits where both \"m\" and \"n\" are greater than 0 and the net sum or all debits and credits are equal Mandatory Fields officeId, transactionDate credits- glAccountId, amount, comments debits- glAccountId, amount, comments Optional Fields paymentTypeId, accountNumber, checkNumber, routingCode, receiptNumber, bankNumber
* @summary Create \"Balanced\" Journal Entries
* @param {string} [command] command
* @param {JournalEntryCommand} [journalEntryCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createGLJournalEntry: function (command, journalEntryCommand, options) {
return localVarFp.createGLJournalEntry(command, journalEntryCommand, options).then(function (request) { return request(axios, basePath); });
},
/**
* This API calculates the running balances for office. If office ID not provided this API calculates running balances for all offices. Mandatory Fields officeId
* @summary Update Running balances for Journal Entries
* @param {string} transactionId transactionId
* @param {string} [command] command
* @param {PostJournalEntriesTransactionIdRequest} [postJournalEntriesTransactionIdRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createReversalJournalEntry: function (transactionId, command, postJournalEntriesTransactionIdRequest, options) {
return localVarFp.createReversalJournalEntry(transactionId, command, postJournalEntriesTransactionIdRequest, options).then(function (request) { return request(axios, basePath); });
},
/**
*
* @param {number} [officeId]
* @param {string} [dateFormat]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getJournalEntriesTemplate: function (officeId, dateFormat, options) {
return localVarFp.getJournalEntriesTemplate(officeId, dateFormat, options).then(function (request) { return request(axios, basePath); });
},
/**
*
* @param {FormDataContentDisposition} [file]
* @param {string} [locale]
* @param {string} [dateFormat]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
postJournalEntriesTemplate: function (file, locale, dateFormat, options) {
return localVarFp.postJournalEntriesTemplate(file, locale, dateFormat, options).then(function (request) { return request(axios, basePath); });
},
/**
* Example Requests: journalentries/1 journalentries/1?fields=officeName,glAccountId,entryType,amount journalentries/1?runningBalance=true journalentries/1?transactionDetails=true
* @summary Retrieve a single Entry
* @param {number} journalEntryId journalEntryId
* @param {boolean} [runningBalance] runningBalance
* @param {boolean} [transactionDetails] transactionDetails
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retreiveJournalEntryById: function (journalEntryId, runningBalance, transactionDetails, options) {
return localVarFp.retreiveJournalEntryById(journalEntryId, runningBalance, transactionDetails, options).then(function (request) { return request(axios, basePath); });
},
/**
* The list capability of journal entries can support pagination and sorting. Example Requests: journalentries journalentries?transactionId=PB37X8Y21EQUY4S journalentries?officeId=1&manualEntriesOnly=true&fromDate=1 July 2013&toDate=15 July 2013&dateFormat=dd MMMM yyyy&locale=en journalentries?fields=officeName,glAccountName,transactionDate journalentries?offset=10&limit=50 journalentries?orderBy=transactionId&sortOrder=DESC journalentries?runningBalance=true journalentries?transactionDetails=true journalentries?loanId=12 journalentries?savingsId=24
* @summary List Journal Entries
* @param {number} [officeId] officeId
* @param {number} [glAccountId] glAccountId
* @param {boolean} [manualEntriesOnly] manualEntriesOnly
* @param {object} [fromDate] fromDate
* @param {object} [toDate] toDate
* @param {string} [transactionId] transactionId
* @param {number} [entityType] entityType
* @param {number} [offset] offset
* @param {number} [limit] limit
* @param {string} [orderBy] orderBy
* @param {string} [sortOrder] sortOrder
* @param {string} [locale] locale
* @param {string} [dateFormat] dateFormat
* @param {number} [loanId] loanId
* @param {number} [savingsId] savingsId
* @param {boolean} [runningBalance] runningBalance
* @param {boolean} [transactionDetails] transactionDetails
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveAll1: function (officeId, glAccountId, manualEntriesOnly, fromDate, toDate, transactionId, entityType, offset, limit, orderBy, sortOrder, locale, dateFormat, loanId, savingsId, runningBalance, transactionDetails, options) {
return localVarFp.retrieveAll1(officeId, glAccountId, manualEntriesOnly, fromDate, toDate, transactionId, entityType, offset, limit, orderBy, sortOrder, locale, dateFormat, loanId, savingsId, runningBalance, transactionDetails, options).then(function (request) { return request(axios, basePath); });
},
/**
*
* @param {number} [offset]
* @param {number} [limit]
* @param {number} [entryId]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveJournalEntries: function (offset, limit, entryId, options) {
return localVarFp.retrieveJournalEntries(offset, limit, entryId, options).then(function (request) { return request(axios, basePath); });
},
/**
*
* @param {number} [officeId]
* @param {string} [currencyCode]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
retrieveOpeningBalance: function (officeId, currencyCode, options) {
return localVarFp.retrieveOpeningBalance(officeId, currencyCode, options).then(function (request) { return request(axios, basePath); });
},
};
};
/**
* JournalEntriesApi - object-oriented interface
* @export
* @class JournalEntriesApi
* @extends {BaseAPI}
*/
var JournalEntriesApi = /** @class */ (function (_super) {
__extends(JournalEntriesApi, _super);
function JournalEntriesApi() {
return _super !== null && _super.apply(this, arguments) || this;
}
/**
* Note: A Balanced (simple) Journal entry would have atleast one \"Debit\" and one \"Credit\" entry whose amounts are equal Compound Journal entries may have \"n\" debits and \"m\" credits where both \"m\" and \"n\" are greater than 0 and the net sum or all debits and credits are equal Mandatory Fields officeId, transactionDate credits- glAccountId, amount, comments debits- glAccountId, amount, comments Optional Fields paymentTypeId, accountNumber, checkNumber, routingCode, receiptNumber, bankNumber
* @summary Create \"Balanced\" Journal Entries
* @param {string} [command] command
* @param {JournalEntryCommand} [journalEntryCommand]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof JournalEntriesApi
*/
JournalEntriesApi.prototype.createGLJournalEntry = function (command, journalEntryCommand, options) {
var _this = this;
return exports.JournalEntriesApiFp(this.configuration).createGLJournalEntry(command, journalEntryCommand, options).then(function (request) { return request(_this.axios, _this.basePath); });
};
/**
* This API calculates the running balances for office. If office ID not provided this API calculates running balances for all offices. Mandatory Fields officeId
* @summary Update Running balances for Journal Entries
* @param {string} transactionId transactionId
* @param {string} [command] command
* @param {PostJournalEntriesTransactionIdRequest} [postJournalEntriesTransactionIdRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof JournalEntriesApi
*/
JournalEntriesApi.prototype.createReversalJournalEntry = function (transactionId, command, postJournalEntriesTransactionIdRequest, options) {
var _this = this;
return exports.JournalEntriesApiFp(this.configuration).createReversalJournalEntry(transactionId, command, postJournalEntriesTransactionIdRequest, options).then(function (request) { return request(_this.axios, _this.basePath); });
};
/**
*
* @param {number} [officeId]
* @param {string} [dateFormat]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof JournalEntriesApi
*/
JournalEntriesApi.prototype.getJournalEntriesTemplate = function (officeId, dateFormat, options) {
var _this = this;
return exports.JournalEntriesApiFp(this.configuration).getJournalEntriesTemplate(officeId, dateFormat, options).then(function (request) { return request(_this.axios, _this.basePath); });
};
/**
*
* @param {FormDataContentDisposition} [file]
* @param {string} [locale]
* @param {string} [dateFormat]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof JournalEntriesApi
*/
JournalEntriesApi.prototype.postJournalEntriesTemplate = function (file, locale, dateFormat, options) {
var _this = this;
return exports.JournalEntriesApiFp(this.configuration).postJournalEntriesTemplate(file, locale, dateFormat, options).then(function (request) { return request(_this.axios, _this.basePath); });
};
/**
* Example Requests: journalentries/1 journalentries/1?fields=officeName,glAccountId,entryType,amount journalentries/1?runningBalance=true journalentries/1?transactionDetails=true
* @summary Retrieve a single Entry
* @param {number} journalEntryId journalEntryId
* @param {boolean} [runningBalance] runningBalance
* @param {boolean} [transactionDetails] transactionDetails
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof JournalEntriesApi
*/
JournalEntriesApi.prototype.retreiveJournalEntryById = function (journalEntryId, runningBalance, transactionDetails, options) {
var _this = this;
return exports.JournalEntriesApiFp(this.configuration).retreiveJournalEntryById(journalEntryId, runningBalance, transactionDetails, options).then(function (request) { return request(_this.axios, _this.basePath); });
};
/**
* The list capability of journal entries can support pagination and sorting. Example Requests: journalentries journalentries?transactionId=PB37X8Y21EQUY4S journalentries?officeId=1&manualEntriesOnly=true&fromDate=1 July 2013&toDate=15 July 2013&dateFormat=dd MMMM yyyy&locale=en journalentries?fields=officeName,glAccountName,transactionDate journalentries?offset=10&limit=50 journalentries?orderBy=transactionId&sortOrder=DESC journalentries?runningBalance=true journalentries?transactionDetails=true journalentries?loanId=12 journalentries?savingsId=24
* @summary List Journal Entries
* @param {number} [officeId] officeId
* @param {number} [glAccountId] glAccountId
* @param {boolean} [manualEntriesOnly] manualEntriesOnly
* @param {object} [fromDate] fromDate
* @param {object} [toDate] toDate
* @param {string} [transactionId] transactionId
* @param {number} [entityType] entityType
* @param {number} [offset] offset
* @param {number} [limit] limit
* @param {string} [orderBy] orderBy
* @param {string} [sortOrder] sortOrder
* @param {string} [locale] locale
* @param {string} [dateFormat] dateFormat
* @param {number} [loanId] loanId
* @param {number} [savingsId] savingsId
* @param {boolean} [runningBalance] runningBalance
* @param {boolean} [transactionDetails] transactionDetails
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof JournalEntriesApi
*/
JournalEntriesApi.prototype.retrieveAll1 = function (officeId, glAccountId, manualEntriesOnly, fromDate, toDate, transactionId, entityType, offset, limit, orderBy, sortOrder, locale, dateFormat, loanId, savingsId, runningBalance, transactionDetails, options) {
var _this = this;
return exports.JournalEntriesApiFp(this.configuration).retrieveAll1(officeId, glAccountId, manualEntriesOnly, fromDate, toDate, transactionId, entityType, offset, limit, orderBy, sortOrder, locale, dateFormat, loanId, savingsId, runningBalance, transactionDetails, options).then(function (request) { return request(_this.axios, _this.basePath); });
};
/**
*
* @param {number} [offset]
* @param {number} [limit]
* @param {number} [entryId]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof JournalEntriesApi
*/
JournalEntriesApi.prototype.retrieveJournalEntries = function (offset, limit, entryId, options) {
var _this = this;
return exports.JournalEntriesApiFp(this.configuration).retrieveJournalEntries(offset, limit, entryId, options).then(function (request) { return request(_this.axios, _this.basePath); });
};
/**
*
* @param {number} [officeId]
* @param {string} [currencyCode]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof JournalEntriesApi
*/
JournalEntriesApi.prototype.retrieveOpeningBalance = function (officeId, currencyCode, options) {
var _this = this;
return exports.JournalEntriesApiFp(this.configuration).retrieveOpeningBalance(officeId, currencyCode, options).then(function (request) { return request(_this.axios, _this.basePath); });
};
return JournalEntriesApi;
}(base_1.BaseAPI));
exports.JournalEntriesApi = JournalEntriesApi;