mirror of
https://github.com/bigcapitalhq/bigcapital.git
synced 2026-02-17 21:30:31 +00:00
feat: licenses administration basic authentication.
feat: accounts slug. feat: duplicate accounts_balance table and merge balance with accounts table. feat: refactoring customers and vendors. feat: system user soft deleting. feat: preventing build tenant database without any subscription. feat: remove 'password' property from 'req.user' object. feat: refactoring JournalPoster class. feat: delete duplicated directories and files.
This commit is contained in:
Ahmed Bouhuolia
@@ -40,13 +40,84 @@ interface NonInventoryJEntries {
|
||||
export default class JournalCommands{
|
||||
journal: JournalPoster;
|
||||
|
||||
models: any;
|
||||
repositories: any;
|
||||
|
||||
/**
|
||||
* Constructor method.
|
||||
* @param {JournalPoster} journal -
|
||||
*/
|
||||
constructor(journal: JournalPoster) {
|
||||
this.journal = journal;
|
||||
Object.assign(this, arguments[1]);
|
||||
|
||||
this.repositories = this.journal.repositories;
|
||||
this.models = this.journal.models;
|
||||
}
|
||||
|
||||
/**
|
||||
* Customer opening balance journals.
|
||||
* @param {number} customerId
|
||||
* @param {number} openingBalance
|
||||
*/
|
||||
async customerOpeningBalance(customerId: number, openingBalance: number) {
|
||||
const { accountRepository } = this.repositories;
|
||||
|
||||
const openingBalanceAccount = await accountRepository.getBySlug('opening-balance');
|
||||
const receivableAccount = await accountRepository.getBySlug('accounts-receivable');
|
||||
|
||||
const commonEntry = {
|
||||
referenceType: 'CustomerOpeningBalance',
|
||||
referenceId: customerId,
|
||||
contactType: 'Customer',
|
||||
contactId: customerId,
|
||||
};
|
||||
const creditEntry = new JournalEntry({
|
||||
...commonEntry,
|
||||
credit: openingBalance,
|
||||
debit: 0,
|
||||
account: openingBalanceAccount.id,
|
||||
});
|
||||
const debitEntry = new JournalEntry({
|
||||
...commonEntry,
|
||||
credit: 0,
|
||||
debit: openingBalance,
|
||||
account: receivableAccount.id,
|
||||
});
|
||||
this.journal.debit(debitEntry);
|
||||
this.journal.credit(creditEntry);
|
||||
}
|
||||
|
||||
/**
|
||||
* Vendor opening balance journals
|
||||
* @param {number} vendorId
|
||||
* @param {number} openingBalance
|
||||
*/
|
||||
async vendorOpeningBalance(vendorId: number, openingBalance: number) {
|
||||
const { accountRepository } = this.repositories;
|
||||
|
||||
const payableAccount = await accountRepository.getBySlug('accounts-payable');
|
||||
const otherCost = await accountRepository.getBySlug('other-expenses');
|
||||
|
||||
const commonEntry = {
|
||||
referenceType: 'VendorOpeningBalance',
|
||||
referenceId: vendorId,
|
||||
contactType: 'Vendor',
|
||||
contactId: vendorId,
|
||||
};
|
||||
const creditEntry = new JournalEntry({
|
||||
...commonEntry,
|
||||
account: payableAccount.id,
|
||||
credit: openingBalance,
|
||||
debit: 0,
|
||||
});
|
||||
const debitEntry = new JournalEntry({
|
||||
...commonEntry,
|
||||
account: otherCost.id,
|
||||
debit: openingBalance,
|
||||
credit: 0,
|
||||
});
|
||||
this.journal.debit(debitEntry);
|
||||
this.journal.credit(creditEntry);
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
207
server/src/services/Accounting/JournalFinancial.ts
Normal file
207
server/src/services/Accounting/JournalFinancial.ts
Normal file
@@ -0,0 +1,207 @@
|
||||
import moment from 'moment';
|
||||
|
||||
export default class JournalFinancial {
|
||||
accountsBalanceTable: { [key: number]: number; } = {};
|
||||
|
||||
/**
|
||||
* Retrieve the closing balance for the given account and closing date.
|
||||
* @param {Number} accountId -
|
||||
* @param {Date} closingDate -
|
||||
* @param {string} dataType? -
|
||||
* @return {number}
|
||||
*/
|
||||
getClosingBalance(
|
||||
accountId: number,
|
||||
closingDate: Date|string,
|
||||
dateType: string = 'day'
|
||||
): number {
|
||||
let closingBalance = 0;
|
||||
const momentClosingDate = moment(closingDate);
|
||||
|
||||
this.entries.forEach((entry) => {
|
||||
// Can not continue if not before or event same closing date.
|
||||
if (
|
||||
(!momentClosingDate.isAfter(entry.date, dateType) &&
|
||||
!momentClosingDate.isSame(entry.date, dateType)) ||
|
||||
(entry.account !== accountId && accountId)
|
||||
) {
|
||||
return;
|
||||
}
|
||||
if (entry.accountNormal === 'credit') {
|
||||
closingBalance += entry.credit ? entry.credit : -1 * entry.debit;
|
||||
} else if (entry.accountNormal === 'debit') {
|
||||
closingBalance += entry.debit ? entry.debit : -1 * entry.credit;
|
||||
}
|
||||
});
|
||||
return closingBalance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve the given account balance with dependencies accounts.
|
||||
* @param {Number} accountId
|
||||
* @param {Date} closingDate
|
||||
* @param {String} dateType
|
||||
* @return {Number}
|
||||
*/
|
||||
getAccountBalance(accountId: number, closingDate: Date|string, dateType: string) {
|
||||
const accountNode = this.accountsDepGraph.getNodeData(accountId);
|
||||
const depAccountsIds = this.accountsDepGraph.dependenciesOf(accountId);
|
||||
const depAccounts = depAccountsIds
|
||||
.map((id) => this.accountsDepGraph.getNodeData(id));
|
||||
|
||||
let balance: number = 0;
|
||||
|
||||
[...depAccounts, accountNode].forEach((account) => {
|
||||
const closingBalance = this.getClosingBalance(
|
||||
account.id,
|
||||
closingDate,
|
||||
dateType
|
||||
);
|
||||
this.accountsBalanceTable[account.id] = closingBalance;
|
||||
balance += this.accountsBalanceTable[account.id];
|
||||
});
|
||||
return balance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve the credit/debit sumation for the given account and date.
|
||||
* @param {Number} account -
|
||||
* @param {Date|String} closingDate -
|
||||
*/
|
||||
getTrialBalance(accountId, closingDate, dateType) {
|
||||
const momentClosingDate = moment(closingDate);
|
||||
const result = {
|
||||
credit: 0,
|
||||
debit: 0,
|
||||
balance: 0,
|
||||
};
|
||||
this.entries.forEach((entry) => {
|
||||
if (
|
||||
(!momentClosingDate.isAfter(entry.date, dateType) &&
|
||||
!momentClosingDate.isSame(entry.date, dateType)) ||
|
||||
(entry.account !== accountId && accountId)
|
||||
) {
|
||||
return;
|
||||
}
|
||||
result.credit += entry.credit;
|
||||
result.debit += entry.debit;
|
||||
|
||||
if (entry.accountNormal === 'credit') {
|
||||
result.balance += entry.credit - entry.debit;
|
||||
} else if (entry.accountNormal === 'debit') {
|
||||
result.balance += entry.debit - entry.credit;
|
||||
}
|
||||
});
|
||||
return result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve trial balance of the given account with depends.
|
||||
* @param {Number} accountId
|
||||
* @param {Date} closingDate
|
||||
* @param {String} dateType
|
||||
* @return {Number}
|
||||
*/
|
||||
|
||||
getTrialBalanceWithDepands(accountId: number, closingDate: Date, dateType: string) {
|
||||
const accountNode = this.accountsDepGraph.getNodeData(accountId);
|
||||
const depAccountsIds = this.accountsDepGraph.dependenciesOf(accountId);
|
||||
const depAccounts = depAccountsIds.map((id) =>
|
||||
this.accountsDepGraph.getNodeData(id)
|
||||
);
|
||||
const trialBalance = { credit: 0, debit: 0, balance: 0 };
|
||||
|
||||
[...depAccounts, accountNode].forEach((account) => {
|
||||
const _trialBalance = this.getTrialBalance(
|
||||
account.id,
|
||||
closingDate,
|
||||
dateType
|
||||
);
|
||||
|
||||
trialBalance.credit += _trialBalance.credit;
|
||||
trialBalance.debit += _trialBalance.debit;
|
||||
trialBalance.balance += _trialBalance.balance;
|
||||
});
|
||||
return trialBalance;
|
||||
}
|
||||
|
||||
getContactTrialBalance(
|
||||
accountId: number,
|
||||
contactId: number,
|
||||
contactType: string,
|
||||
closingDate: Date|string,
|
||||
openingDate: Date|string,
|
||||
) {
|
||||
const momentClosingDate = moment(closingDate);
|
||||
const momentOpeningDate = moment(openingDate);
|
||||
const trial = {
|
||||
credit: 0,
|
||||
debit: 0,
|
||||
balance: 0,
|
||||
};
|
||||
|
||||
this.entries.forEach((entry) => {
|
||||
if (
|
||||
(closingDate &&
|
||||
!momentClosingDate.isAfter(entry.date, 'day') &&
|
||||
!momentClosingDate.isSame(entry.date, 'day')) ||
|
||||
(openingDate &&
|
||||
!momentOpeningDate.isBefore(entry.date, 'day') &&
|
||||
!momentOpeningDate.isSame(entry.date)) ||
|
||||
(accountId && entry.account !== accountId) ||
|
||||
(contactId && entry.contactId !== contactId) ||
|
||||
entry.contactType !== contactType
|
||||
) {
|
||||
return;
|
||||
}
|
||||
if (entry.credit) {
|
||||
trial.balance -= entry.credit;
|
||||
trial.credit += entry.credit;
|
||||
}
|
||||
if (entry.debit) {
|
||||
trial.balance += entry.debit;
|
||||
trial.debit += entry.debit;
|
||||
}
|
||||
});
|
||||
return trial;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve total balnace of the given customer/vendor contact.
|
||||
* @param {Number} accountId
|
||||
* @param {Number} contactId
|
||||
* @param {String} contactType
|
||||
* @param {Date} closingDate
|
||||
*/
|
||||
getContactBalance(
|
||||
accountId: number,
|
||||
contactId: number,
|
||||
contactType: string,
|
||||
closingDate: Date,
|
||||
openingDate: Date,
|
||||
) {
|
||||
const momentClosingDate = moment(closingDate);
|
||||
let balance = 0;
|
||||
|
||||
this.entries.forEach((entry) => {
|
||||
if (
|
||||
(closingDate &&
|
||||
!momentClosingDate.isAfter(entry.date, 'day') &&
|
||||
!momentClosingDate.isSame(entry.date, 'day')) ||
|
||||
(entry.account !== accountId && accountId) ||
|
||||
(contactId && entry.contactId !== contactId) ||
|
||||
entry.contactType !== contactType
|
||||
) {
|
||||
return;
|
||||
}
|
||||
if (entry.credit) {
|
||||
balance -= entry.credit;
|
||||
}
|
||||
if (entry.debit) {
|
||||
balance += entry.debit;
|
||||
}
|
||||
});
|
||||
return balance;
|
||||
}
|
||||
|
||||
}
|
||||
@@ -1,502 +0,0 @@
|
||||
import { pick } from 'lodash';
|
||||
import moment from 'moment';
|
||||
import JournalEntry from '@/services/Accounting/JournalEntry';
|
||||
import AccountTransaction from '@/models/AccountTransaction';
|
||||
import AccountBalance from '@/models/AccountBalance';
|
||||
import { promiseSerial } from '@/utils';
|
||||
import Account from '@/models/Account';
|
||||
import NestedSet from '../../collection/NestedSet';
|
||||
|
||||
export default class JournalPoster {
|
||||
/**
|
||||
* Journal poster constructor.
|
||||
*/
|
||||
constructor(accountsGraph) {
|
||||
this.entries = [];
|
||||
this.balancesChange = {};
|
||||
this.deletedEntriesIds = [];
|
||||
|
||||
this.accountsBalanceTable = {};
|
||||
this.accountsGraph = accountsGraph;
|
||||
}
|
||||
|
||||
/**
|
||||
* Writes the credit entry for the given account.
|
||||
* @param {JournalEntry} entry -
|
||||
*/
|
||||
credit(entryModel) {
|
||||
if (entryModel instanceof JournalEntry === false) {
|
||||
throw new Error('The entry is not instance of JournalEntry.');
|
||||
}
|
||||
this.entries.push(entryModel.entry);
|
||||
this.setAccountBalanceChange(entryModel.entry, 'credit');
|
||||
}
|
||||
|
||||
/**
|
||||
* Writes the debit entry for the given account.
|
||||
* @param {JournalEntry} entry -
|
||||
*/
|
||||
debit(entryModel) {
|
||||
if (entryModel instanceof JournalEntry === false) {
|
||||
throw new Error('The entry is not instance of JournalEntry.');
|
||||
}
|
||||
this.entries.push(entryModel.entry);
|
||||
this.setAccountBalanceChange(entryModel.entry, 'debit');
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets account balance change.
|
||||
* @param {JournalEntry} entry
|
||||
* @param {String} type
|
||||
*/
|
||||
setAccountBalanceChange(entry, entryType) {
|
||||
const depAccountsIds = this.accountsGraph.dependantsOf(entry.account);
|
||||
|
||||
const balanceChangeEntry = {
|
||||
debit: entry.debit,
|
||||
credit: entry.credit,
|
||||
entryType,
|
||||
accountNormal: entry.accountNormal,
|
||||
};
|
||||
this._setAccountBalanceChange({
|
||||
...balanceChangeEntry,
|
||||
accountId: entry.account,
|
||||
});
|
||||
|
||||
if (entry.contactType && entry.contactId) {
|
||||
|
||||
}
|
||||
|
||||
// Effect parent accounts of the given account id.
|
||||
depAccountsIds.forEach((accountId) => {
|
||||
this._setAccountBalanceChange({
|
||||
...balanceChangeEntry,
|
||||
accountId,
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets account balance change.
|
||||
* @private
|
||||
*/
|
||||
_setAccountBalanceChange({
|
||||
accountId,
|
||||
accountNormal,
|
||||
debit,
|
||||
credit,
|
||||
entryType,
|
||||
}) {
|
||||
if (!this.balancesChange[accountId]) {
|
||||
this.balancesChange[accountId] = 0;
|
||||
}
|
||||
let change = 0;
|
||||
|
||||
if (accountNormal === 'credit') {
|
||||
change = entryType === 'credit' ? credit : -1 * debit;
|
||||
} else if (accountNormal === 'debit') {
|
||||
change = entryType === 'debit' ? debit : -1 * credit;
|
||||
}
|
||||
this.balancesChange[accountId] += change;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set contact balance change.
|
||||
* @param {Object} param -
|
||||
*/
|
||||
_setContactBalanceChange({
|
||||
contactType,
|
||||
contactId,
|
||||
|
||||
accountNormal,
|
||||
debit,
|
||||
credit,
|
||||
entryType,
|
||||
}) {
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* Mapping the balance change to list.
|
||||
*/
|
||||
mapBalanceChangesToList() {
|
||||
const mappedList = [];
|
||||
|
||||
Object.keys(this.balancesChange).forEach((accountId) => {
|
||||
const balance = this.balancesChange[accountId];
|
||||
|
||||
mappedList.push({
|
||||
account_id: accountId,
|
||||
amount: balance,
|
||||
});
|
||||
});
|
||||
return mappedList;
|
||||
}
|
||||
|
||||
/**
|
||||
* Saves the balance change of journal entries.
|
||||
*/
|
||||
async saveBalance() {
|
||||
const balancesList = this.mapBalanceChangesToList();
|
||||
const balanceUpdateOpers = [];
|
||||
const balanceInsertOpers = [];
|
||||
const balanceFindOneOpers = [];
|
||||
let balanceAccounts = [];
|
||||
|
||||
balancesList.forEach((balance) => {
|
||||
const oper = AccountBalance.tenant()
|
||||
.query()
|
||||
.findOne('account_id', balance.account_id);
|
||||
balanceFindOneOpers.push(oper);
|
||||
});
|
||||
balanceAccounts = await Promise.all(balanceFindOneOpers);
|
||||
|
||||
balancesList.forEach((balance) => {
|
||||
const method = balance.amount < 0 ? 'decrement' : 'increment';
|
||||
|
||||
// Detarmine if the account balance is already exists or not.
|
||||
const foundAccBalance = balanceAccounts.some(
|
||||
(account) => account && account.account_id === balance.account_id
|
||||
);
|
||||
|
||||
if (foundAccBalance) {
|
||||
const query = AccountBalance.tenant()
|
||||
.query()
|
||||
[method]('amount', Math.abs(balance.amount))
|
||||
.where('account_id', balance.account_id);
|
||||
|
||||
balanceUpdateOpers.push(query);
|
||||
} else {
|
||||
const query = AccountBalance.tenant().query().insert({
|
||||
account_id: balance.account_id,
|
||||
amount: balance.amount,
|
||||
currency_code: 'USD',
|
||||
});
|
||||
balanceInsertOpers.push(query);
|
||||
}
|
||||
});
|
||||
await Promise.all([...balanceUpdateOpers, ...balanceInsertOpers]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Saves the stacked journal entries to the storage.
|
||||
*/
|
||||
async saveEntries() {
|
||||
const saveOperations = [];
|
||||
|
||||
this.entries.forEach((entry) => {
|
||||
const oper = AccountTransaction.tenant()
|
||||
.query()
|
||||
.insert({
|
||||
accountId: entry.account,
|
||||
...pick(entry, [
|
||||
'credit',
|
||||
'debit',
|
||||
'transactionType',
|
||||
'date',
|
||||
'userId',
|
||||
'referenceType',
|
||||
'referenceId',
|
||||
'note',
|
||||
'contactId',
|
||||
'contactType',
|
||||
]),
|
||||
});
|
||||
saveOperations.push(() => oper);
|
||||
});
|
||||
await promiseSerial(saveOperations);
|
||||
}
|
||||
|
||||
/**
|
||||
* Reverses the stacked journal entries.
|
||||
*/
|
||||
reverseEntries() {
|
||||
const reverseEntries = [];
|
||||
|
||||
this.entries.forEach((entry) => {
|
||||
const reverseEntry = { ...entry };
|
||||
|
||||
if (entry.credit) {
|
||||
reverseEntry.debit = entry.credit;
|
||||
}
|
||||
if (entry.debit) {
|
||||
reverseEntry.credit = entry.debit;
|
||||
}
|
||||
reverseEntries.push(reverseEntry);
|
||||
});
|
||||
this.entries = reverseEntries;
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @param {Array} ids -
|
||||
*/
|
||||
removeEntries(ids = []) {
|
||||
const targetIds = ids.length <= 0 ? this.entries.map((e) => e.id) : ids;
|
||||
const removeEntries = this.entries.filter(
|
||||
(e) => targetIds.indexOf(e.id) !== -1
|
||||
);
|
||||
|
||||
this.entries = this.entries.filter((e) => targetIds.indexOf(e.id) === -1);
|
||||
|
||||
removeEntries.forEach((entry) => {
|
||||
entry.credit = -1 * entry.credit;
|
||||
entry.debit = -1 * entry.debit;
|
||||
|
||||
this.setAccountBalanceChange(entry, entry.accountNormal);
|
||||
});
|
||||
this.deletedEntriesIds.push(...removeEntries.map((entry) => entry.id));
|
||||
}
|
||||
|
||||
/**
|
||||
* Revert the given transactions.
|
||||
* @param {*} entries
|
||||
*/
|
||||
removeTransactions(entries) {
|
||||
this.loadEntries(entries);
|
||||
|
||||
|
||||
this.deletedEntriesIds.push(...entriesIDsShouldDel);
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete all the stacked entries.
|
||||
*/
|
||||
async deleteEntries() {
|
||||
if (this.deletedEntriesIds.length > 0) {
|
||||
await AccountTransaction.tenant()
|
||||
.query()
|
||||
.whereIn('id', this.deletedEntriesIds)
|
||||
.delete();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve the closing balance for the given account and closing date.
|
||||
* @param {Number} accountId -
|
||||
* @param {Date} closingDate -
|
||||
*/
|
||||
getClosingBalance(accountId, closingDate, dateType = 'day') {
|
||||
let closingBalance = 0;
|
||||
const momentClosingDate = moment(closingDate);
|
||||
|
||||
this.entries.forEach((entry) => {
|
||||
// Can not continue if not before or event same closing date.
|
||||
if (
|
||||
(!momentClosingDate.isAfter(entry.date, dateType) &&
|
||||
!momentClosingDate.isSame(entry.date, dateType)) ||
|
||||
(entry.account !== accountId && accountId)
|
||||
) {
|
||||
return;
|
||||
}
|
||||
if (entry.accountNormal === 'credit') {
|
||||
closingBalance += entry.credit ? entry.credit : -1 * entry.debit;
|
||||
} else if (entry.accountNormal === 'debit') {
|
||||
closingBalance += entry.debit ? entry.debit : -1 * entry.credit;
|
||||
}
|
||||
});
|
||||
return closingBalance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve the given account balance with dependencies accounts.
|
||||
* @param {Number} accountId
|
||||
* @param {Date} closingDate
|
||||
* @param {String} dateType
|
||||
* @return {Number}
|
||||
*/
|
||||
getAccountBalance(accountId, closingDate, dateType) {
|
||||
const accountNode = this.accountsGraph.getNodeData(accountId);
|
||||
const depAccountsIds = this.accountsGraph.dependenciesOf(accountId);
|
||||
const depAccounts = depAccountsIds.map((id) =>
|
||||
this.accountsGraph.getNodeData(id)
|
||||
);
|
||||
let balance = 0;
|
||||
|
||||
[...depAccounts, accountNode].forEach((account) => {
|
||||
// if (!this.accountsBalanceTable[account.id]) {
|
||||
const closingBalance = this.getClosingBalance(
|
||||
account.id,
|
||||
closingDate,
|
||||
dateType
|
||||
);
|
||||
this.accountsBalanceTable[account.id] = closingBalance;
|
||||
// }
|
||||
balance += this.accountsBalanceTable[account.id];
|
||||
});
|
||||
return balance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve the credit/debit sumation for the given account and date.
|
||||
* @param {Number} account -
|
||||
* @param {Date|String} closingDate -
|
||||
*/
|
||||
getTrialBalance(accountId, closingDate, dateType) {
|
||||
const momentClosingDate = moment(closingDate);
|
||||
const result = {
|
||||
credit: 0,
|
||||
debit: 0,
|
||||
balance: 0,
|
||||
};
|
||||
this.entries.forEach((entry) => {
|
||||
if (
|
||||
(!momentClosingDate.isAfter(entry.date, dateType) &&
|
||||
!momentClosingDate.isSame(entry.date, dateType)) ||
|
||||
(entry.account !== accountId && accountId)
|
||||
) {
|
||||
return;
|
||||
}
|
||||
result.credit += entry.credit;
|
||||
result.debit += entry.debit;
|
||||
|
||||
if (entry.accountNormal === 'credit') {
|
||||
result.balance += entry.credit - entry.debit;
|
||||
} else if (entry.accountNormal === 'debit') {
|
||||
result.balance += entry.debit - entry.credit;
|
||||
}
|
||||
});
|
||||
return result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve trial balance of the given account with depends.
|
||||
* @param {Number} accountId
|
||||
* @param {Date} closingDate
|
||||
* @param {String} dateType
|
||||
* @return {Number}
|
||||
*/
|
||||
|
||||
getTrialBalanceWithDepands(accountId, closingDate, dateType) {
|
||||
const accountNode = this.accountsGraph.getNodeData(accountId);
|
||||
const depAccountsIds = this.accountsGraph.dependenciesOf(accountId);
|
||||
const depAccounts = depAccountsIds.map((id) =>
|
||||
this.accountsGraph.getNodeData(id)
|
||||
);
|
||||
|
||||
const trialBalance = { credit: 0, debit: 0, balance: 0 };
|
||||
|
||||
[...depAccounts, accountNode].forEach((account) => {
|
||||
const _trialBalance = this.getTrialBalance(
|
||||
account.id,
|
||||
closingDate,
|
||||
dateType
|
||||
);
|
||||
|
||||
trialBalance.credit += _trialBalance.credit;
|
||||
trialBalance.debit += _trialBalance.debit;
|
||||
trialBalance.balance += _trialBalance.balance;
|
||||
});
|
||||
return trialBalance;
|
||||
}
|
||||
|
||||
getContactTrialBalance(
|
||||
accountId,
|
||||
contactId,
|
||||
contactType,
|
||||
closingDate,
|
||||
openingDate
|
||||
) {
|
||||
const momentClosingDate = moment(closingDate);
|
||||
const momentOpeningDate = moment(openingDate);
|
||||
const trial = {
|
||||
credit: 0,
|
||||
debit: 0,
|
||||
balance: 0,
|
||||
};
|
||||
|
||||
this.entries.forEach((entry) => {
|
||||
if (
|
||||
(closingDate &&
|
||||
!momentClosingDate.isAfter(entry.date, 'day') &&
|
||||
!momentClosingDate.isSame(entry.date, 'day')) ||
|
||||
(openingDate &&
|
||||
!momentOpeningDate.isBefore(entry.date, 'day') &&
|
||||
!momentOpeningDate.isSame(entry.date)) ||
|
||||
(accountId && entry.account !== accountId) ||
|
||||
(contactId && entry.contactId !== contactId) ||
|
||||
entry.contactType !== contactType
|
||||
) {
|
||||
return;
|
||||
}
|
||||
if (entry.credit) {
|
||||
trial.balance -= entry.credit;
|
||||
trial.credit += entry.credit;
|
||||
}
|
||||
if (entry.debit) {
|
||||
trial.balance += entry.debit;
|
||||
trial.debit += entry.debit;
|
||||
}
|
||||
});
|
||||
return trial;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve total balnace of the given customer/vendor contact.
|
||||
* @param {Number} accountId
|
||||
* @param {Number} contactId
|
||||
* @param {String} contactType
|
||||
* @param {Date} closingDate
|
||||
*/
|
||||
getContactBalance(
|
||||
accountId,
|
||||
contactId,
|
||||
contactType,
|
||||
closingDate,
|
||||
openingDate
|
||||
) {
|
||||
const momentClosingDate = moment(closingDate);
|
||||
let balance = 0;
|
||||
|
||||
this.entries.forEach((entry) => {
|
||||
if (
|
||||
(closingDate &&
|
||||
!momentClosingDate.isAfter(entry.date, 'day') &&
|
||||
!momentClosingDate.isSame(entry.date, 'day')) ||
|
||||
(entry.account !== accountId && accountId) ||
|
||||
(contactId && entry.contactId !== contactId) ||
|
||||
entry.contactType !== contactType
|
||||
) {
|
||||
return;
|
||||
}
|
||||
if (entry.credit) {
|
||||
balance -= entry.credit;
|
||||
}
|
||||
if (entry.debit) {
|
||||
balance += entry.debit;
|
||||
}
|
||||
});
|
||||
return balance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Load fetched accounts journal entries.
|
||||
* @param {Array} entries -
|
||||
*/
|
||||
loadEntries(entries) {
|
||||
entries.forEach((entry) => {
|
||||
this.entries.push({
|
||||
...entry,
|
||||
account: entry.account ? entry.account.id : entry.accountId,
|
||||
accountNormal:
|
||||
entry.account && entry.account.type
|
||||
? entry.account.type.normal
|
||||
: entry.accountNormal,
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Calculates the entries balance change.
|
||||
*/
|
||||
calculateEntriesBalanceChange() {
|
||||
this.entries.forEach((entry) => {
|
||||
if (entry.credit) {
|
||||
this.setAccountBalanceChange(entry, 'credit');
|
||||
}
|
||||
if (entry.debit) {
|
||||
this.setAccountBalanceChange(entry, 'debit');
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
337
server/src/services/Accounting/JournalPoster.ts
Normal file
337
server/src/services/Accounting/JournalPoster.ts
Normal file
@@ -0,0 +1,337 @@
|
||||
import { omit } from 'lodash';
|
||||
import { Container } from 'typedi';
|
||||
import JournalEntry from '@/services/Accounting/JournalEntry';
|
||||
import TenancyService from '@/services/Tenancy/TenancyService';
|
||||
import {
|
||||
IJournalEntry,
|
||||
IJournalPoster,
|
||||
IAccountChange,
|
||||
IAccountsChange,
|
||||
TEntryType,
|
||||
} from '@/interfaces';
|
||||
|
||||
export default class JournalPoster implements IJournalPoster {
|
||||
tenantId: number;
|
||||
tenancy: TenancyService;
|
||||
logger: any;
|
||||
models: any;
|
||||
repositories: any;
|
||||
|
||||
deletedEntriesIds: number[] = [];
|
||||
entries: IJournalEntry[] = [];
|
||||
balancesChange: IAccountsChange = {};
|
||||
accountsDepGraph: IAccountsChange = {};
|
||||
|
||||
/**
|
||||
* Journal poster constructor.
|
||||
* @param {number} tenantId -
|
||||
*/
|
||||
constructor(
|
||||
tenantId: number,
|
||||
) {
|
||||
this.initTenancy();
|
||||
|
||||
this.tenantId = tenantId;
|
||||
this.models = this.tenancy.models(tenantId);
|
||||
this.repositories = this.tenancy.repositories(tenantId);
|
||||
}
|
||||
|
||||
/**
|
||||
* Initial tenancy.
|
||||
* @private
|
||||
*/
|
||||
private initTenancy() {
|
||||
try {
|
||||
this.tenancy = Container.get(TenancyService);
|
||||
this.logger = Container.get('logger');
|
||||
} catch (exception) {
|
||||
throw new Error('Should execute this class inside tenancy area.');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Async initialize acccounts dependency graph.
|
||||
* @private
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
private async initializeAccountsDepGraph(): Promise<void> {
|
||||
const { accountRepository } = this.repositories;
|
||||
const accountsDepGraph = await accountRepository.getDependencyGraph();
|
||||
this.accountsDepGraph = accountsDepGraph;
|
||||
}
|
||||
|
||||
/**
|
||||
* Writes the credit entry for the given account.
|
||||
* @param {IJournalEntry} entry -
|
||||
*/
|
||||
public credit(entryModel: IJournalEntry): void {
|
||||
if (entryModel instanceof JournalEntry === false) {
|
||||
throw new Error('The entry is not instance of JournalEntry.');
|
||||
}
|
||||
this.entries.push(entryModel.entry);
|
||||
this.setAccountBalanceChange(entryModel.entry);
|
||||
}
|
||||
|
||||
/**
|
||||
* Writes the debit entry for the given account.
|
||||
* @param {JournalEntry} entry -
|
||||
*/
|
||||
public debit(entryModel: IJournalEntry): void {
|
||||
if (entryModel instanceof JournalEntry === false) {
|
||||
throw new Error('The entry is not instance of JournalEntry.');
|
||||
}
|
||||
this.entries.push(entryModel.entry);
|
||||
this.setAccountBalanceChange(entryModel.entry);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets account balance change.
|
||||
* @param {JournalEntry} entry
|
||||
* @param {String} type
|
||||
*/
|
||||
private setAccountBalanceChange(entry: IJournalEntry): void {
|
||||
const accountChange: IAccountChange = {
|
||||
debit: entry.debit,
|
||||
credit: entry.credit,
|
||||
};
|
||||
this._setAccountBalanceChange(entry.account, accountChange);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets account balance change.
|
||||
* @private
|
||||
* @param {number} accountId -
|
||||
* @param {IAccountChange} accountChange
|
||||
*/
|
||||
private _setAccountBalanceChange(
|
||||
accountId: number,
|
||||
accountChange: IAccountChange
|
||||
) {
|
||||
this.balancesChange = this.accountBalanceChangeReducer(
|
||||
this.balancesChange, accountId, accountChange,
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Accounts balance change reducer.
|
||||
* @param {IAccountsChange} balancesChange
|
||||
* @param {number} accountId
|
||||
* @param {IAccountChange} accountChange
|
||||
* @return {IAccountChange}
|
||||
*/
|
||||
private accountBalanceChangeReducer(
|
||||
balancesChange: IAccountsChange,
|
||||
accountId: number,
|
||||
accountChange: IAccountChange,
|
||||
) {
|
||||
const change = { ...balancesChange };
|
||||
|
||||
if (!change[accountId]) {
|
||||
change[accountId] = { credit: 0, debit: 0 };
|
||||
}
|
||||
if (accountChange.credit) {
|
||||
change[accountId].credit += accountChange.credit;
|
||||
}
|
||||
if (accountChange.debit) {
|
||||
change[accountId].debit += accountChange.debit;
|
||||
}
|
||||
return change;
|
||||
}
|
||||
|
||||
/**
|
||||
* Converts balance changes to array.
|
||||
* @private
|
||||
* @param {IAccountsChange} accountsChange -
|
||||
* @return {Promise<{ account: number, change: number }>}
|
||||
*/
|
||||
private async convertBalanceChangesToArr(
|
||||
accountsChange: IAccountsChange
|
||||
) : Promise<{ account: number, change: number }[]>{
|
||||
const { accountTypeRepository } = this.repositories;
|
||||
const mappedList: { account: number, change: number }[] = [];
|
||||
const accountsIds: number[] = Object.keys(accountsChange).map(id => parseInt(id, 10));
|
||||
|
||||
await Promise.all(
|
||||
accountsIds.map(async (account: number) => {
|
||||
const accountChange = accountsChange[account];
|
||||
const accountNode = this.accountsDepGraph.getNodeData(account);
|
||||
const accountTypeMeta = await accountTypeRepository.getTypeMeta(accountNode.accountTypeId);
|
||||
const { normal }: { normal: TEntryType } = accountTypeMeta;
|
||||
let change = 0;
|
||||
|
||||
if (accountChange.credit) {
|
||||
change = (normal === 'credit') ? accountChange.credit : -1 * accountChange.credit;
|
||||
}
|
||||
if (accountChange.debit) {
|
||||
change = (normal === 'debit') ? accountChange.debit : -1 * accountChange.debit;
|
||||
}
|
||||
mappedList.push({ account, change });
|
||||
}),
|
||||
);
|
||||
return mappedList;
|
||||
}
|
||||
|
||||
/**
|
||||
* Saves the balance change of journal entries.
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
public async saveBalance() {
|
||||
await this.initializeAccountsDepGraph();
|
||||
|
||||
const { Account } = this.models;
|
||||
const accountsChange = this.balanceChangeWithDepends(this.balancesChange);
|
||||
const balancesList = await this.convertBalanceChangesToArr(accountsChange);
|
||||
const balancesAccounts = balancesList.map(b => b.account);
|
||||
|
||||
// Ensure the accounts has atleast zero in amount.
|
||||
await Account.query().where('amount', null).whereIn('id', balancesAccounts)
|
||||
.patch({ amount: 0 });
|
||||
|
||||
const balanceUpdateOpers: Promise<void>[] = [];
|
||||
|
||||
balancesList.forEach((balance: { account: number, change: number }) => {
|
||||
const method: string = (balance.change < 0) ? 'decrement' : 'increment';
|
||||
|
||||
this.logger.info('[journal_poster] increment/decrement account balance.', {
|
||||
balance, tenantId: this.tenantId,
|
||||
})
|
||||
const query = Account.query()
|
||||
[method]('amount', Math.abs(balance.change))
|
||||
.where('id', balance.account);
|
||||
|
||||
balanceUpdateOpers.push(query);
|
||||
});
|
||||
|
||||
await Promise.all(balanceUpdateOpers);
|
||||
this.resetAccountsBalanceChange();
|
||||
}
|
||||
|
||||
/**
|
||||
* Changes all accounts that dependencies of changed accounts.
|
||||
* @param {IAccountsChange} accountsChange
|
||||
* @returns {IAccountsChange}
|
||||
*/
|
||||
private balanceChangeWithDepends(accountsChange: IAccountsChange): IAccountsChange {
|
||||
const accountsIds = Object.keys(accountsChange);
|
||||
let changes: IAccountsChange = {};
|
||||
|
||||
accountsIds.forEach((accountId) => {
|
||||
const accountChange = accountsChange[accountId];
|
||||
const depAccountsIds = this.accountsDepGraph.dependenciesOf(accountId);
|
||||
|
||||
[accountId, ...depAccountsIds].forEach((account) => {
|
||||
changes = this.accountBalanceChangeReducer(changes, account, accountChange);
|
||||
});
|
||||
});
|
||||
return changes;
|
||||
}
|
||||
|
||||
/**
|
||||
* Resets accounts balance change.
|
||||
* @private
|
||||
*/
|
||||
private resetAccountsBalanceChange() {
|
||||
this.balancesChange = {};
|
||||
}
|
||||
|
||||
/**
|
||||
* Saves the stacked journal entries to the storage.
|
||||
* @returns {Promise<void>}
|
||||
*/
|
||||
public async saveEntries() {
|
||||
const { AccountTransaction } = this.models;
|
||||
const saveOperations: Promise<void>[] = [];
|
||||
|
||||
this.entries.forEach((entry) => {
|
||||
const oper = AccountTransaction.query()
|
||||
.insert({
|
||||
accountId: entry.account,
|
||||
...omit(entry, ['account']),
|
||||
});
|
||||
saveOperations.push(oper);
|
||||
});
|
||||
await Promise.all(saveOperations);
|
||||
}
|
||||
|
||||
/**
|
||||
* Reverses the stacked journal entries.
|
||||
*/
|
||||
public reverseEntries() {
|
||||
const reverseEntries: IJournalEntry[] = [];
|
||||
|
||||
this.entries.forEach((entry) => {
|
||||
const reverseEntry = { ...entry };
|
||||
|
||||
if (entry.credit) {
|
||||
reverseEntry.debit = entry.credit;
|
||||
}
|
||||
if (entry.debit) {
|
||||
reverseEntry.credit = entry.debit;
|
||||
}
|
||||
reverseEntries.push(reverseEntry);
|
||||
});
|
||||
this.entries = reverseEntries;
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes all stored entries or by the given in ids.
|
||||
* @param {Array} ids -
|
||||
*/
|
||||
removeEntries(ids: number[] = []) {
|
||||
const targetIds = ids.length <= 0 ? this.entries.map((e) => e.id) : ids;
|
||||
const removeEntries = this.entries.filter(
|
||||
(e) => targetIds.indexOf(e.id) !== -1
|
||||
);
|
||||
this.entries = this.entries.filter((e) => targetIds.indexOf(e.id) === -1);
|
||||
|
||||
removeEntries.forEach((entry) => {
|
||||
entry.credit = -1 * entry.credit;
|
||||
entry.debit = -1 * entry.debit;
|
||||
|
||||
this.setAccountBalanceChange(entry, entry.accountNormal);
|
||||
});
|
||||
this.deletedEntriesIds.push(...removeEntries.map((entry) => entry.id));
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete all the stacked entries.
|
||||
* @return {Promise<void>}
|
||||
*/
|
||||
public async deleteEntries() {
|
||||
const { AccountTransaction } = this.models;
|
||||
|
||||
if (this.deletedEntriesIds.length > 0) {
|
||||
await AccountTransaction.query()
|
||||
.whereIn('id', this.deletedEntriesIds)
|
||||
.delete();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Load fetched accounts journal entries.
|
||||
* @param {IJournalEntry[]} entries -
|
||||
*/
|
||||
loadEntries(entries: IJournalEntry[]): void {
|
||||
entries.forEach((entry: IJournalEntry) => {
|
||||
this.entries.push({
|
||||
...entry,
|
||||
account: entry.account ? entry.account.id : entry.accountId,
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Calculates the entries balance change.
|
||||
* @public
|
||||
*/
|
||||
public calculateEntriesBalanceChange() {
|
||||
this.entries.forEach((entry) => {
|
||||
if (entry.credit) {
|
||||
this.setAccountBalanceChange(entry, 'credit');
|
||||
}
|
||||
if (entry.debit) {
|
||||
this.setAccountBalanceChange(entry, 'debit');
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user