Compare commits

..

38 Commits

Author SHA1 Message Date
Ahmed Bouhuolia
ee92c2815b fix: darkmode ui bugs 2026-01-03 18:24:33 +02:00
Ahmed Bouhuolia
5767f1f603 Merge pull request #890 from bigcapitalhq/named-imports-hocs
fix: account transactions don't show up
2026-01-01 22:16:02 +02:00
Ahmed Bouhuolia
885d8014c2 fix: account transactions don't show up 2026-01-01 22:13:47 +02:00
Ahmed Bouhuolia
3ffab896ed Merge pull request #889 from bigcapitalhq/revert-888-named-imports-hocs
Revert "fix: account transactions don't show up"
2026-01-01 22:13:31 +02:00
Ahmed Bouhuolia
92a5086f1f Revert "fix: account transactions don't show up" 2026-01-01 22:13:08 +02:00
Ahmed Bouhuolia
1bf9038ddc Merge pull request #888 from bigcapitalhq/named-imports-hocs
fix: account transactions don't show up
2026-01-01 22:11:56 +02:00
Ahmed Bouhuolia
2736b76ced fix: account transactions don't show up 2026-01-01 22:09:51 +02:00
Ahmed Bouhuolia
9e921b074f Merge pull request #887 from bigcapitalhq/named-imports-hocs
refactor: HOCs named imports
2026-01-01 22:00:58 +02:00
Ahmed Bouhuolia
0f377e19f3 refactor: HOCs named imports 2026-01-01 21:58:42 +02:00
Ahmed Bouhuolia
5d872798ff Merge pull request #886 from bigcapitalhq/fix-credit-note-print
fix: credit note printing
2026-01-01 17:21:36 +02:00
Ahmed Bouhuolia
0ef78a19fe fix: credit note printing 2026-01-01 17:19:06 +02:00
Ahmed Bouhuolia
70b0a4833c Merge pull request #885 from bigcapitalhq/refund-credit-notes
fix: refund credit notes
2026-01-01 17:05:36 +02:00
Ahmed Bouhuolia
ead4fc9b97 fix: refund credit notes 2026-01-01 17:03:48 +02:00
Ahmed Bouhuolia
a91a7c612f Merge pull request #882 from bigcapitalhq/bugs-bashing2
Bug fixes, refactoring, and improvements
2025-12-31 01:01:08 +02:00
Ahmed Bouhuolia
339289be9f refactor(export): move PDF table template to shared package 2025-12-29 23:54:43 +02:00
Ahmed Bouhuolia
350d229e98 feat(transactions-locking): enable settings schema and add dark mode support 2025-12-29 23:35:34 +02:00
Ahmed Bouhuolia
8152a16fd5 Merge pull request #881 from bigcapitalhq/bugs-bashing
bugs bashing
2025-12-29 22:08:56 +02:00
Ahmed Bouhuolia
00aad6e35c wip 2025-12-29 22:06:49 +02:00
Ahmed Bouhuolia
30d8fdb4c0 fix: running compute item cost processor 2025-12-28 12:30:06 +02:00
Ahmed Bouhuolia
872fc661ce bugs bashing 2025-12-28 12:01:24 +02:00
Ahmed Bouhuolia
054cd1fae4 Merge pull request #880 from bigcapitalhq/fix-dark-mode-bank-transaction-drawer
fix: darkmode bank transaction drawer
2025-12-23 20:00:50 +02:00
Ahmed Bouhuolia
7cb169bce9 fix: darkmode bank transaction drawer 2025-12-23 19:57:31 +02:00
Ahmed Bouhuolia
f2663c4af3 Merge pull request #879 from bigcapitalhq/refactor-bound-formik-fields
refactor(webapp): bound Formik fields
2025-12-22 23:28:17 +02:00
Ahmed Bouhuolia
6fea7779da refactor(webapp): bound Formik fields 2025-12-22 23:25:43 +02:00
Ahmed Bouhuolia
c00af18327 Merge pull request #878 from bigcapitalhq/fix-match-bank-transactions
fix: match uncategorized bank transactions
2025-12-22 23:06:36 +02:00
Ahmed Bouhuolia
37f0f4e227 fix: match uncategorized bank transactions 2025-12-22 23:02:08 +02:00
Ahmed Bouhuolia
8662c5899e Merge pull request #877 from bigcapitalhq/fix-import-bank-transactions
fix: import bank transactions
2025-12-22 22:52:34 +02:00
Ahmed Bouhuolia
a9a7cd8617 fix: import bank transactions 2025-12-22 22:49:58 +02:00
Ahmed Bouhuolia
e50fc3b523 Merge pull request #876 from bigcapitalhq/refactor-date-input
refactor: date input field
2025-12-21 23:39:09 +02:00
Ahmed Bouhuolia
b294a72a26 refactor: date input field 2025-12-21 23:34:11 +02:00
Ahmed Bouhuolia
62ae49941b Merge pull request #875 from bigcapitalhq/fix-accounts-suggest-field
fix: accounts suggest field
2025-12-21 16:15:39 +02:00
Ahmed Bouhuolia
31f5cbf335 fix: accounts suggest field 2025-12-21 16:11:01 +02:00
Ahmed Bouhuolia
b22328cff9 Merge pull request #874 from bigcapitalhq/feature/20251218134811
fix: import module bugs
2025-12-18 21:25:34 +02:00
Ahmed Bouhuolia
58f609353c fix: import bugs 2025-12-18 21:21:54 +02:00
Ahmed Bouhuolia
8a2a8eed3b fix: import rows aggregator 2025-12-18 20:44:05 +02:00
Ahmed Bouhuolia
636d206b0e fix: bugs sprint 2025-12-18 13:48:12 +02:00
Ahmed Bouhuolia
63922c391a fix: formatted money attributes 2025-12-14 16:51:06 +02:00
Ahmed Bouhuolia
6ecfe1ff12 fix: remove the auth body background 2025-12-14 14:30:25 +02:00
878 changed files with 6174 additions and 6633 deletions

View File

@@ -167,6 +167,9 @@
"**/*.(t|j)s"
],
"coverageDirectory": "../coverage",
"testEnvironment": "node"
"testEnvironment": "node",
"moduleNameMapper": {
"^@/(.*)$": "<rootDir>/$1"
}
}
}

View File

@@ -1,4 +1,27 @@
// import { getTransactionsLockingSettingsSchema } from '@/api/controllers/TransactionsLocking/utils';
import { chain, mapKeys } from 'lodash';
const getTransactionsLockingSettingsSchema = (modules: string[]) => {
const moduleSchema = {
active: { type: 'boolean' },
lock_to_date: { type: 'date' },
unlock_from_date: { type: 'date' },
unlock_to_date: { type: 'date' },
lock_reason: { type: 'string' },
unlock_reason: { type: 'string' },
};
return chain(modules)
.map((module: string) => {
return mapKeys(moduleSchema, (value, key: string) => `${module}.${key}`);
})
.flattenDeep()
.reduce((result, value) => {
return {
...result,
...value,
};
}, {})
.value();
};
export const SettingsOptions = {
organization: {
@@ -223,12 +246,12 @@ export const SettingsOptions = {
'locking-type': {
type: 'string',
},
// ...getTransactionsLockingSettingsSchema([
// 'all',
// 'sales',
// 'purchases',
// 'financial',
// ]),
...getTransactionsLockingSettingsSchema([
'all',
'sales',
'purchases',
'financial',
]),
},
features: {
'multi-warehouses': {

View File

@@ -3,6 +3,7 @@
"field.description": "Description",
"field.slug": "Account slug",
"field.code": "Account code",
"field.code_hint": "Unique number to identify the account.",
"field.root_type": "Root type",
"field.normal": "Account normal",
"field.normal.credit": "Credit",
@@ -13,5 +14,6 @@
"field.balance": "Balance",
"field.bank_balance": "Bank Balance",
"field.parent_account": "Parent Account",
"field.created_at": "Created at"
"field.created_at": "Created at",
"field.account_hint": "Matches the account name or code."
}

View File

@@ -0,0 +1,27 @@
{
"field.vendor": "Vendor",
"field.bill_number": "Bill No.",
"field.bill_date": "Date",
"field.due_date": "Due Date",
"field.reference_no": "Reference No.",
"field.exchange_rate": "Exchange Rate",
"field.note": "Note",
"field.open": "Open",
"field.entries": "Entries",
"field.item": "Item",
"field.item_hint": "Matches the item name or code.",
"field.rate": "Rate",
"field.quantity": "Quantity",
"field.description": "Line Description",
"field.amount": "Amount",
"field.payment_amount": "Payment Amount",
"field.status": "Status",
"field.status.paid": "Paid",
"field.status.partially-paid": "Partially Paid",
"field.status.overdue": "Overdue",
"field.status.unpaid": "Unpaid",
"field.status.opened": "Opened",
"field.status.draft": "Draft",
"field.created_at": "Created At"
}

View File

@@ -0,0 +1,15 @@
{
"field.vendor": "Vendor",
"field.payment_date": "Payment Date",
"field.payment_number": "Payment No.",
"field.payment_account": "Payment Account",
"field.exchange_rate": "Exchange Rate",
"field.note": "Note",
"field.reference": "Reference",
"field.entries": "Entries",
"field.entries.bill": "Bill",
"field.entries.payment_amount": "Payment Amount",
"field.payment_number_hint": "The payment number should be unique.",
"field.bill_hint": "Matches the bill number."
}

View File

@@ -0,0 +1,16 @@
{
"field.customer": "Customer",
"field.exchange_rate": "Exchange Rate",
"field.credit_note_date": "Credit Note Date",
"field.reference_no": "Reference No.",
"field.note": "Note",
"field.terms_conditions": "Terms & Conditions",
"field.credit_note_number": "Credit Note Number",
"field.open": "Open",
"field.entries": "Entries",
"field.item": "Item",
"field.rate": "Rate",
"field.quantity": "Quantity",
"field.description": "Description"
}

View File

@@ -0,0 +1,21 @@
{
"field.customer": "Customer",
"field.estimate_date": "Estimate Date",
"field.expiration_date": "Expiration Date",
"field.estimate_number": "Estimate No.",
"field.reference_no": "Reference No.",
"field.exchange_rate": "Exchange Rate",
"field.currency": "Currency",
"field.note": "Note",
"field.terms_conditions": "Terms & Conditions",
"field.delivered": "Delivered",
"field.entries": "Entries",
"field.amount": "Amount",
"field.status": "Status",
"field.status.draft": "Draft",
"field.status.delivered": "Delivered",
"field.status.rejected": "Rejected",
"field.status.approved": "Approved",
"field.created_at": "Created At"
}

View File

@@ -26,6 +26,7 @@
"field.due_amount": "Due amount",
"field.delivered": "Delivered",
"field.item_name": "Item Name",
"field.item_hint": "Matches the item name or code.",
"field.rate": "Rate",
"field.quantity": "Quantity",
"field.description": "Description",
@@ -38,5 +39,7 @@
"field.status.draft": "Draft",
"field.created_at": "Created at",
"field.currency": "Currency",
"field.entries": "Entries"
"field.entries": "Entries",
"field.branch": "Branch",
"field.warehouse": "Warehouse"
}

View File

@@ -17,6 +17,7 @@
"field.quantity_on_hand": "Quantity on Hand",
"field.note": "Note",
"field.category": "Category",
"field.category_hint": "Matches the category name.",
"field.active": "Active",
"field.created_at": "Created At"
}

View File

@@ -0,0 +1,17 @@
{
"field.customer": "Customer",
"field.payment_date": "Payment Date",
"field.amount": "Amount",
"field.reference_no": "Reference No.",
"field.deposit_account": "Deposit Account",
"field.payment_receive_no": "Payment No.",
"field.statement": "Statement",
"field.entries": "Entries",
"field.exchange_rate": "Exchange Rate",
"field.invoice": "Invoice",
"field.entries.payment_amount": "Payment Amount",
"field.created_at": "Created At",
"field.payment_no_hint": "The payment number should be unique.",
"field.invoice_hint": "Matches the invoice number."
}

View File

@@ -10,5 +10,21 @@
"paper.receipt_amount": "Receipt amount",
"paper.total": "Total",
"paper.balance_due": "Balance Due",
"paper.payment_amount": "Payment Amount"
"paper.payment_amount": "Payment Amount",
"field.receipt_date": "Receipt Date",
"field.customer": "Customer",
"field.deposit_account": "Deposit Account",
"field.exchange_rate": "Exchange Rate",
"field.receipt_number": "Receipt Number",
"field.reference_no": "Reference No.",
"field.closed": "Closed",
"field.entries": "Entries",
"field.statement": "Statement",
"field.receipt_message": "Receipt Message",
"field.amount": "Amount",
"field.status": "Status",
"field.status.draft": "Draft",
"field.status.closed": "Closed",
"field.created_at": "Created At"
}

View File

@@ -2,5 +2,18 @@
"view.draft": "Draft",
"view.published": "Published",
"view.open": "Open",
"view.closed": "Closed"
"view.closed": "Closed",
"field.vendor": "Vendor",
"field.vendor_credit_number": "Vendor Credit No.",
"field.vendor_credit_date": "Vendor Credit Date",
"field.reference_no": "Reference No.",
"field.exchange_rate": "Exchange Rate",
"field.note": "Note",
"field.open": "Open",
"field.entries": "Entries",
"field.item": "Item",
"field.rate": "Rate",
"field.quantity": "Quantity",
"field.description": "Description"
}

View File

@@ -156,7 +156,7 @@ export const AccountMeta = {
minLength: 3,
maxLength: 6,
unique: true,
importHint: 'Unique number to identify the account.',
importHint: 'account.field.code_hint',
},
accountType: {
name: 'account.field.type',

View File

@@ -1,7 +1,7 @@
import { Inject, Injectable } from '@nestjs/common';
import { Knex } from 'knex';
import * as yup from 'yup';
import uniqid from 'uniqid';
import * as uniqid from 'uniqid';
import { Importable } from '../../Import/Importable';
import { CreateUncategorizedTransactionService } from './CreateUncategorizedTransaction.service';
import { ImportableContext } from '../../Import/interfaces';
@@ -9,8 +9,10 @@ import { BankTransactionsSampleData } from '../../BankingTransactions/constants'
import { Account } from '@/modules/Accounts/models/Account.model';
import { CreateUncategorizedTransactionDTO } from '../types/BankingCategorize.types';
import { TenantModelProxy } from '@/modules/System/models/TenantBaseModel';
import { ImportableService } from '../../Import/decorators/Import.decorator';
import { UncategorizedBankTransaction } from '../../BankingTransactions/models/UncategorizedBankTransaction';
@Injectable()
@ImportableService({ name: UncategorizedBankTransaction.name })
export class UncategorizedTransactionsImportable extends Importable {
constructor(
private readonly createUncategorizedTransaction: CreateUncategorizedTransactionService,

View File

@@ -1,6 +1,6 @@
import * as moment from 'moment';
import * as R from 'ramda';
import { isEmpty, sumBy } from 'lodash';
import { isEmpty, round, sumBy } from 'lodash';
import { ERRORS, MatchedTransactionPOJO } from './types';
import { ServiceError } from '../Items/ServiceError';
@@ -22,18 +22,24 @@ export const sortClosestMatchTransactions = (
};
export const sumMatchTranasctions = (transactions: Array<any>) => {
return transactions.reduce(
(total, item) =>
total +
(item.transactionNormal === 'debit' ? 1 : -1) * parseFloat(item.amount),
const total = transactions.reduce(
(sum, item) => {
const amount = parseFloat(item.amount) || 0;
const multiplier = item.transactionNormal === 'debit' ? 1 : -1;
return sum + multiplier * amount;
},
0
);
// Round to 2 decimal places to avoid floating-point precision issues
return round(total, 2);
};
export const sumUncategorizedTransactions = (
uncategorizedTransactions: Array<any>
) => {
return sumBy(uncategorizedTransactions, 'amount');
const total = sumBy(uncategorizedTransactions, 'amount');
// Round to 2 decimal places to avoid floating-point precision issues
return round(total, 2);
};
export const validateUncategorizedTransactionsNotMatched = (

View File

@@ -34,7 +34,7 @@ export class MatchBankTransactions {
private readonly uncategorizedBankTransactionModel: TenantModelProxy<
typeof UncategorizedBankTransaction
>,
) {}
) { }
/**
* Validates the match bank transactions DTO.
@@ -100,7 +100,10 @@ export class MatchBankTransactions {
);
// Validates the total given matching transcations whether is not equal
// uncategorized transaction amount.
if (totalUncategorizedTransactions !== totalMatchedTranasctions) {
// Use tolerance-based comparison to handle floating-point precision issues
const tolerance = 0.01; // Allow 0.01 difference for floating-point precision
const difference = Math.abs(totalUncategorizedTransactions - totalMatchedTranasctions);
if (difference > tolerance) {
throw new ServiceError(ERRORS.TOTAL_MATCHING_TRANSACTIONS_INVALID);
}
}

View File

@@ -12,24 +12,30 @@ export class MatchTransactionsTypes {
private static registry: MatchTransactionsTypesRegistry;
/**
* Consttuctor method.
* Constructor method.
*/
constructor() {
constructor(
private readonly getMatchedInvoicesService: GetMatchedTransactionsByInvoices,
private readonly getMatchedBillsService: GetMatchedTransactionsByBills,
private readonly getMatchedExpensesService: GetMatchedTransactionsByExpenses,
private readonly getMatchedManualJournalsService: GetMatchedTransactionsByManualJournals,
private readonly getMatchedCashflowService: GetMatchedTransactionsByCashflow,
) {
this.boot();
}
get registered() {
return [
{ type: 'SaleInvoice', service: GetMatchedTransactionsByInvoices },
{ type: 'Bill', service: GetMatchedTransactionsByBills },
{ type: 'Expense', service: GetMatchedTransactionsByExpenses },
{ type: 'SaleInvoice', service: this.getMatchedInvoicesService },
{ type: 'Bill', service: this.getMatchedBillsService },
{ type: 'Expense', service: this.getMatchedExpensesService },
{
type: 'ManualJournal',
service: GetMatchedTransactionsByManualJournals,
service: this.getMatchedManualJournalsService,
},
{
type: 'CashflowTransaction',
service: GetMatchedTransactionsByCashflow,
service: this.getMatchedCashflowService,
},
];
}
@@ -50,14 +56,13 @@ export class MatchTransactionsTypes {
* Boots all the registered importables.
*/
public boot() {
if (!MatchTransactionsTypes.registry) {
const instance = MatchTransactionsTypesRegistry.getInstance();
const instance = MatchTransactionsTypesRegistry.getInstance();
this.registered.forEach((registered) => {
// const serviceInstanace = Container.get(registered.service);
// instance.register(registered.type, serviceInstanace);
});
MatchTransactionsTypes.registry = instance;
}
// Always register services to ensure they're available
this.registered.forEach((registered) => {
instance.register(registered.type, registered.service);
});
MatchTransactionsTypes.registry = instance;
}
}

View File

@@ -83,4 +83,4 @@ const models = [
CreateBankTransactionService
],
})
export class BankingTransactionsModule {}
export class BankingTransactionsModule { }

View File

@@ -0,0 +1,72 @@
export const UncategorizedBankTransactionMeta = {
defaultFilterField: 'createdAt',
defaultSort: {
sortOrder: 'DESC',
sortField: 'created_at',
},
importable: true,
fields: {
date: {
name: 'Date',
column: 'date',
fieldType: 'date',
},
payee: {
name: 'Payee',
column: 'payee',
fieldType: 'text',
},
description: {
name: 'Description',
column: 'description',
fieldType: 'text',
},
referenceNo: {
name: 'Reference No.',
column: 'reference_no',
fieldType: 'text',
},
amount: {
name: 'Amount',
column: 'Amount',
fieldType: 'numeric',
required: true,
},
account: {
name: 'Account',
column: 'account_id',
fieldType: 'relation',
to: { model: 'Account', to: 'id' },
},
createdAt: {
name: 'Created At',
column: 'createdAt',
fieldType: 'date',
importable: false,
},
},
fields2: {
date: {
name: 'Date',
fieldType: 'date',
required: true,
},
payee: {
name: 'Payee',
fieldType: 'text',
},
description: {
name: 'Description',
fieldType: 'text',
},
referenceNo: {
name: 'Reference No.',
fieldType: 'text',
},
amount: {
name: 'Amount',
fieldType: 'number',
required: true,
},
},
};

View File

@@ -2,7 +2,10 @@
import * as moment from 'moment';
import { Model } from 'objection';
import { TenantBaseModel } from '@/modules/System/models/TenantBaseModel';
import { UncategorizedBankTransactionMeta } from './UncategorizedBankTransaction.meta';
import { InjectModelMeta } from '@/modules/Tenancy/TenancyModels/decorators/InjectModelMeta.decorator';
@InjectModelMeta(UncategorizedBankTransactionMeta)
export class UncategorizedBankTransaction extends TenantBaseModel {
readonly amount!: number;
readonly date!: Date | string;

View File

@@ -104,6 +104,12 @@ export class BillPaymentResponseDto {
@ApiProperty({ description: 'The formatted amount', example: '100.00 USD' })
formattedAmount: string;
@ApiProperty({ description: 'The formatted total', example: '100.00 USD' })
formattedTotal: string;
@ApiProperty({ description: 'The formatted subtotal', example: '100.00 USD' })
formattedSubtotal: string;
@ApiProperty({
description: 'The date when the payment was created',
example: '2024-01-01T12:00:00Z',

View File

@@ -167,7 +167,7 @@ export const BillPaymentMeta = {
name: 'bill_payment.field.payment_number',
fieldType: 'text',
unique: true,
importHint: 'The payment number should be unique.',
importHint: 'bill_payment.field.payment_number_hint',
},
paymentAccountId: {
name: 'bill_payment.field.payment_account',
@@ -175,7 +175,7 @@ export const BillPaymentMeta = {
relationModel: 'Account',
relationImportMatch: ['name', 'code'],
required: true,
importHint: 'Matches the account name or code.',
importHint: 'account.field.account_hint',
},
exchangeRate: {
name: 'bill_payment.field.exchange_rate',
@@ -203,7 +203,7 @@ export const BillPaymentMeta = {
relationModel: 'Bill',
relationImportMatch: 'billNumber',
required: true,
importHint: 'Matches the bill number.',
importHint: 'bill_payment.field.bill_hint',
},
paymentAmount: {
name: 'bill_payment.field.entries.payment_amount',
@@ -213,7 +213,7 @@ export const BillPaymentMeta = {
},
},
branchId: {
name: 'Branch',
name: 'invoice.field.branch',
fieldType: 'relation',
relationModel: 'Branch',
relationImportMatch: ['name', 'code'],

View File

@@ -13,6 +13,8 @@ export class BillPaymentTransformer extends Transformer {
'formattedPaymentDate',
'formattedCreatedAt',
'formattedAmount',
'formattedTotal',
'formattedSubtotal',
'entries',
'attachments',
];
@@ -47,6 +49,29 @@ export class BillPaymentTransformer extends Transformer {
});
};
/**
* Retrieves the formatted total.
* @param {IBillPayment} billPayment
* @returns {string}
*/
protected formattedTotal = (billPayment: BillPayment): string => {
return this.formatNumber(billPayment.amount, {
currencyCode: billPayment.currencyCode,
money: true,
});
};
/**
* Retrieves the formatted subtotal.
* @param {IBillPayment} billPayment
* @returns {string}
*/
protected formattedSubtotal = (billPayment: BillPayment): string => {
return this.formatNumber(billPayment.amount, {
currencyCode: billPayment.currencyCode,
});
};
/**
* Retreives the bill payment entries.
*/

View File

@@ -184,76 +184,76 @@ export const BillMeta = {
},
fields2: {
billNumber: {
name: 'Bill No.',
name: 'bill.field.bill_number',
fieldType: 'text',
required: true,
},
referenceNo: {
name: 'Reference No.',
name: 'bill.field.reference_no',
fieldType: 'text',
},
billDate: {
name: 'Date',
name: 'bill.field.bill_date',
fieldType: 'date',
required: true,
},
dueDate: {
name: 'Due Date',
name: 'bill.field.due_date',
fieldType: 'date',
required: true,
},
vendorId: {
name: 'Vendor',
name: 'bill.field.vendor',
fieldType: 'relation',
relationModel: 'Contact',
relationImportMatch: 'displayName',
required: true,
},
exchangeRate: {
name: 'Exchange Rate',
name: 'bill.field.exchange_rate',
fieldType: 'number',
},
note: {
name: 'Note',
name: 'bill.field.note',
fieldType: 'text',
},
open: {
name: 'Open',
name: 'bill.field.open',
fieldType: 'boolean',
},
entries: {
name: 'Entries',
name: 'bill.field.entries',
fieldType: 'collection',
collectionOf: 'object',
collectionMinLength: 1,
required: true,
fields: {
itemId: {
name: 'Item',
name: 'bill.field.item',
fieldType: 'relation',
relationModel: 'Item',
relationImportMatch: ['name', 'code'],
required: true,
importHint: 'Matches the item name or code.',
importHint: 'bill.field.item_hint',
},
rate: {
name: 'Rate',
name: 'bill.field.rate',
fieldType: 'number',
required: true,
},
quantity: {
name: 'Quantity',
name: 'bill.field.quantity',
fieldType: 'number',
required: true,
},
description: {
name: 'Line Description',
name: 'bill.field.description',
fieldType: 'text',
},
},
},
branchId: {
name: 'Branch',
name: 'invoice.field.branch',
fieldType: 'relation',
relationModel: 'Branch',
relationImportMatch: ['name', 'code'],
@@ -261,7 +261,7 @@ export const BillMeta = {
required: true,
},
warehouseId: {
name: 'Warehouse',
name: 'invoice.field.warehouse',
fieldType: 'relation',
relationModel: 'Warehouse',
relationImportMatch: ['name', 'code'],

View File

@@ -94,6 +94,7 @@ export class BillTransformer extends Transformer {
protected formattedDueAmount = (bill: Bill): string => {
return this.formatNumber(bill.dueAmount, {
currencyCode: bill.currencyCode,
money: true,
});
};
@@ -169,6 +170,7 @@ export class BillTransformer extends Transformer {
protected totalFormatted = (bill: Bill): string => {
return this.formatNumber(bill.total, {
currencyCode: bill.currencyCode,
money: true,
});
};

View File

@@ -17,7 +17,7 @@ export class BillBranchValidateSubscriber {
* Validate branch existance on bill creating.
* @param {IBillCreatingPayload} payload
*/
@OnEvent(events.bill.onCreating, { suppressErrors: false })
@OnEvent(events.bill.onCreating)
async validateBranchExistanceOnBillCreating({
billDTO,
}: IBillCreatingPayload) {
@@ -30,7 +30,7 @@ export class BillBranchValidateSubscriber {
* Validate branch existance once bill editing.
* @param {IBillEditingPayload} payload
*/
@OnEvent(events.bill.onEditing, { suppressErrors: false })
@OnEvent(events.bill.onEditing)
async validateBranchExistanceOnBillEditing({ billDTO }: IBillEditingPayload) {
await this.validateBranchExistance.validateTransactionBranchWhenActive(
billDTO.branchId,

View File

@@ -14,7 +14,7 @@ export class CashflowBranchDTOValidatorSubscriber {
* Validate branch existance once cashflow transaction creating.
* @param {ICommandCashflowCreatingPayload} payload
*/
@OnEvent(events.cashflow.onTransactionCreating, { suppressErrors: false })
@OnEvent(events.cashflow.onTransactionCreating)
async validateBranchExistanceOnCashflowTransactionCreating({
newTransactionDTO,
}: ICommandCashflowCreatingPayload) {

View File

@@ -15,13 +15,13 @@ import {
export class ContactBranchValidateSubscriber {
constructor(
private readonly validateBranchExistance: ValidateBranchExistance,
) {}
) { }
/**
* Validate branch existance on customer creating.
* @param {ICustomerEventCreatingPayload} payload
*/
@OnEvent(events.customers.onCreating, { suppressErrors: false })
@OnEvent(events.customers.onCreating)
async validateBranchExistanceOnCustomerCreating({
customerDTO,
}: ICustomerEventCreatingPayload) {
@@ -37,7 +37,7 @@ export class ContactBranchValidateSubscriber {
* Validate branch existance once customer opening balance editing.
* @param {ICustomerOpeningBalanceEditingPayload} payload
*/
@OnEvent(events.customers.onOpeningBalanceChanging, { suppressErrors: false })
@OnEvent(events.customers.onOpeningBalanceChanging)
async validateBranchExistanceOnCustomerOpeningBalanceEditing({
openingBalanceEditDTO,
}: ICustomerOpeningBalanceEditingPayload) {
@@ -52,7 +52,7 @@ export class ContactBranchValidateSubscriber {
* Validates the branch existance on vendor creating.
* @param {IVendorEventCreatingPayload} payload
*/
@OnEvent(events.vendors.onCreating, { suppressErrors: false })
@OnEvent(events.vendors.onCreating)
async validateBranchExistanceonVendorCreating({
vendorDTO,
}: IVendorEventCreatingPayload) {
@@ -68,7 +68,7 @@ export class ContactBranchValidateSubscriber {
* Validate branch existance once the vendor opening balance editing.
* @param {IVendorOpeningBalanceEditingPayload} payload
*/
@OnEvent(events.vendors.onOpeningBalanceChanging, { suppressErrors: false })
@OnEvent(events.vendors.onOpeningBalanceChanging)
async validateBranchExistanceOnVendorOpeningBalanceEditing({
openingBalanceEditDTO,
}: IVendorOpeningBalanceEditingPayload) {

View File

@@ -15,7 +15,7 @@ export class CreditNoteBranchValidateSubscriber {
* Validate branch existance on credit note creating.
* @param {ICreditNoteCreatingPayload} payload
*/
@OnEvent(events.creditNote.onCreating, { suppressErrors: false })
@OnEvent(events.creditNote.onCreating)
async validateBranchExistanceOnCreditCreating({
creditNoteDTO,
}: ICreditNoteCreatingPayload) {
@@ -28,7 +28,7 @@ export class CreditNoteBranchValidateSubscriber {
* Validate branch existance once credit note editing.
* @param {ICreditNoteEditingPayload} payload
*/
@OnEvent(events.creditNote.onEditing, { suppressErrors: false })
@OnEvent(events.creditNote.onEditing)
async validateBranchExistanceOnCreditEditing({
creditNoteEditDTO,
}: ICreditNoteEditingPayload) {

View File

@@ -14,7 +14,7 @@ export class CreditNoteRefundBranchValidateSubscriber {
* Validate branch existance on refund credit note creating.
* @param {IRefundCreditNoteCreatingPayload} payload
*/
@OnEvent(events.creditNote.onRefundCreating, { suppressErrors: false })
@OnEvent(events.creditNote.onRefundCreating)
async validateBranchExistanceOnCreditRefundCreating({
newCreditNoteDTO,
}: IRefundCreditNoteCreatingPayload) {

View File

@@ -16,7 +16,7 @@ export class ExpenseBranchValidateSubscriber {
* Validate branch existance once expense transaction creating.
* @param {IExpenseCreatingPayload} payload
*/
@OnEvent(events.expenses.onCreating, { suppressErrors: false })
@OnEvent(events.expenses.onCreating)
async validateBranchExistanceOnExpenseCreating({
expenseDTO,
}: IExpenseCreatingPayload) {
@@ -29,7 +29,7 @@ export class ExpenseBranchValidateSubscriber {
* Validate branch existance once expense transaction editing.
* @param {IExpenseEventEditingPayload} payload
*/
@OnEvent(events.expenses.onEditing, { suppressErrors: false })
@OnEvent(events.expenses.onEditing)
async validateBranchExistanceOnExpenseEditing({
expenseDTO,
}: IExpenseEventEditingPayload) {

View File

@@ -14,7 +14,7 @@ export class InventoryAdjustmentBranchValidateSubscriber {
* Validate branch existance on inventory adjustment creating.
* @param {IInventoryAdjustmentCreatingPayload} payload
*/
@OnEvent(events.inventoryAdjustment.onQuickCreating, { suppressErrors: false })
@OnEvent(events.inventoryAdjustment.onQuickCreating)
async validateBranchExistanceOnInventoryCreating({
quickAdjustmentDTO,
}: IInventoryAdjustmentCreatingPayload) {

View File

@@ -17,7 +17,7 @@ export class InvoiceBranchValidateSubscriber {
* Validate branch existance on invoice creating.
* @param {ISaleInvoiceCreatingPayload} payload
*/
@OnEvent(events.saleInvoice.onCreating, { suppressErrors: false })
@OnEvent(events.saleInvoice.onCreating)
async validateBranchExistanceOnInvoiceCreating({
saleInvoiceDTO,
}: ISaleInvoiceCreatingPaylaod) {
@@ -30,7 +30,7 @@ export class InvoiceBranchValidateSubscriber {
* Validate branch existance once invoice editing.
* @param {ISaleInvoiceEditingPayload} payload
*/
@OnEvent(events.saleInvoice.onEditing, { suppressErrors: false })
@OnEvent(events.saleInvoice.onEditing)
async validateBranchExistanceOnInvoiceEditing({
saleInvoiceDTO,
}: ISaleInvoiceEditingPayload) {

View File

@@ -17,7 +17,7 @@ export class PaymentMadeBranchValidateSubscriber {
* Validate branch existance on estimate creating.
* @param {ISaleEstimateCreatedPayload} payload
*/
@OnEvent(events.billPayment.onCreating, { suppressErrors: false })
@OnEvent(events.billPayment.onCreating)
async validateBranchExistanceOnPaymentCreating({
billPaymentDTO,
}: IBillPaymentCreatingPayload) {
@@ -30,7 +30,7 @@ export class PaymentMadeBranchValidateSubscriber {
* Validate branch existance once estimate editing.
* @param {ISaleEstimateEditingPayload} payload
*/
@OnEvent(events.billPayment.onEditing, { suppressErrors: false })
@OnEvent(events.billPayment.onEditing)
async validateBranchExistanceOnPaymentEditing({
billPaymentDTO,
}: IBillPaymentEditingPayload) {

View File

@@ -17,7 +17,7 @@ export class PaymentReceiveBranchValidateSubscriber {
* Validate branch existance on estimate creating.
* @param {IPaymentReceivedCreatingPayload} payload
*/
@OnEvent(events.paymentReceive.onCreating, { suppressErrors: false })
@OnEvent(events.paymentReceive.onCreating)
async validateBranchExistanceOnPaymentCreating({
paymentReceiveDTO,
}: IPaymentReceivedCreatingPayload) {
@@ -30,7 +30,7 @@ export class PaymentReceiveBranchValidateSubscriber {
* Validate branch existance once estimate editing.
* @param {IPaymentReceivedEditingPayload} payload
*/
@OnEvent(events.paymentReceive.onEditing, { suppressErrors: false })
@OnEvent(events.paymentReceive.onEditing)
async validateBranchExistanceOnPaymentEditing({
paymentReceiveDTO,
}: IPaymentReceivedEditingPayload) {

View File

@@ -17,7 +17,7 @@ export class SaleEstimateBranchValidateSubscriber {
* Validate branch existance on estimate creating.
* @param {ISaleEstimateCreatedPayload} payload
*/
@OnEvent(events.saleEstimate.onCreating, { suppressErrors: false })
@OnEvent(events.saleEstimate.onCreating)
async validateBranchExistanceOnEstimateCreating({
estimateDTO,
}: ISaleEstimateCreatingPayload) {
@@ -30,7 +30,7 @@ export class SaleEstimateBranchValidateSubscriber {
* Validate branch existance once estimate editing.
* @param {ISaleEstimateEditingPayload} payload
*/
@OnEvent(events.saleEstimate.onEditing, { suppressErrors: false })
@OnEvent(events.saleEstimate.onEditing)
async validateBranchExistanceOnEstimateEditing({
estimateDTO,
}: ISaleEstimateEditingPayload) {

View File

@@ -17,7 +17,7 @@ export class SaleReceiptBranchValidateSubscriber {
* Validate branch existance on estimate creating.
* @param {ISaleReceiptCreatingPayload} payload
*/
@OnEvent(events.saleReceipt.onCreating, { suppressErrors: false })
@OnEvent(events.saleReceipt.onCreating)
async validateBranchExistanceOnInvoiceCreating({
saleReceiptDTO,
}: ISaleReceiptCreatingPayload) {
@@ -30,7 +30,7 @@ export class SaleReceiptBranchValidateSubscriber {
* Validate branch existance once estimate editing.
* @param {ISaleReceiptEditingPayload} payload
*/
@OnEvent(events.saleReceipt.onEditing, { suppressErrors: false })
@OnEvent(events.saleReceipt.onEditing)
async validateBranchExistanceOnInvoiceEditing({
saleReceiptDTO,
}: ISaleReceiptEditingPayload) {

View File

@@ -17,7 +17,7 @@ export class VendorCreditBranchValidateSubscriber {
* Validate branch existance on estimate creating.
* @param {ISaleEstimateCreatedPayload} payload
*/
@OnEvent(events.vendorCredit.onCreating, { suppressErrors: false })
@OnEvent(events.vendorCredit.onCreating)
async validateBranchExistanceOnCreditCreating({
vendorCreditCreateDTO,
}: IVendorCreditCreatingPayload) {
@@ -30,7 +30,7 @@ export class VendorCreditBranchValidateSubscriber {
* Validate branch existance once estimate editing.
* @param {ISaleEstimateEditingPayload} payload
*/
@OnEvent(events.vendorCredit.onEditing, { suppressErrors: false })
@OnEvent(events.vendorCredit.onEditing)
async validateBranchExistanceOnCreditEditing({
vendorCreditDTO,
}: IVendorCreditEditingPayload) {

View File

@@ -14,7 +14,7 @@ export class VendorCreditRefundBranchValidateSubscriber {
* Validate branch existance on refund credit note creating.
* @param {IRefundVendorCreditCreatingPayload} payload
*/
@OnEvent(events.vendorCredit.onRefundCreating, { suppressErrors: false })
@OnEvent(events.vendorCredit.onRefundCreating)
async validateBranchExistanceOnCreditRefundCreating({
refundVendorCreditDTO,
}: IRefundVendorCreditCreatingPayload) {

View File

@@ -1,5 +1,6 @@
import { ApiProperty } from '@nestjs/swagger';
import { IsNotEmpty, IsOptional, IsPositive, IsString } from 'class-validator';
import { ToNumber, IsOptional } from '@/common/decorators/Validators';
import { IsDateString, IsNotEmpty, IsPositive, IsString } from 'class-validator';
import { IsDate } from 'class-validator';
import { IsNumber } from 'class-validator';
@@ -10,8 +11,13 @@ export class CreditNoteRefundDto {
description: 'The id of the from account',
example: 1,
})
@ApiProperty({
description: 'The id of the from account',
example: 1,
})
fromAccountId: number;
@ToNumber()
@IsNumber()
@IsPositive()
@IsNotEmpty()
@@ -21,6 +27,7 @@ export class CreditNoteRefundDto {
})
amount: number;
@ToNumber()
@IsNumber()
@IsOptional()
@IsPositive()
@@ -30,23 +37,23 @@ export class CreditNoteRefundDto {
})
exchangeRate?: number;
@IsOptional()
@IsString()
@IsNotEmpty()
@ApiProperty({
description: 'The reference number of the credit note refund',
example: '123456',
})
referenceNo: string;
@IsOptional()
@IsString()
@IsNotEmpty()
@ApiProperty({
description: 'The description of the credit note refund',
example: 'Credit note refund',
})
description: string;
@IsDate()
@IsDateString()
@IsNotEmpty()
@ApiProperty({
description: 'The date of the credit note refund',
@@ -54,6 +61,7 @@ export class CreditNoteRefundDto {
})
date: Date;
@ToNumber()
@IsNumber()
@IsOptional()
@ApiProperty({

View File

@@ -164,73 +164,73 @@ export const CreditNoteMeta = {
},
fields2: {
customerId: {
name: 'Customer',
name: 'credit_note.field.customer',
fieldType: 'relation',
relationModel: 'Contact',
relationImportMatch: 'displayName',
required: true,
},
exchangeRate: {
name: 'Exchange Rate',
name: 'credit_note.field.exchange_rate',
fieldType: 'number',
},
creditNoteDate: {
name: 'Credit Note Date',
name: 'credit_note.field.credit_note_date',
fieldType: 'date',
required: true,
},
referenceNo: {
name: 'Reference No.',
name: 'credit_note.field.reference_no',
fieldType: 'text',
},
note: {
name: 'Note',
name: 'credit_note.field.note',
fieldType: 'text',
},
termsConditions: {
name: 'Terms & Conditions',
name: 'credit_note.field.terms_conditions',
fieldType: 'text',
},
creditNoteNumber: {
name: 'Credit Note Number',
name: 'credit_note.field.credit_note_number',
fieldType: 'text',
},
open: {
name: 'Open',
name: 'credit_note.field.open',
fieldType: 'boolean',
},
entries: {
name: 'Entries',
name: 'credit_note.field.entries',
fieldType: 'collection',
collectionOf: 'object',
collectionMinLength: 1,
fields: {
itemId: {
name: 'Item',
name: 'credit_note.field.item',
fieldType: 'relation',
relationModel: 'Item',
relationImportMatch: ['name', 'code'],
required: true,
importHint: 'Matches the item name or code.',
importHint: 'invoice.field.item_hint',
},
rate: {
name: 'Rate',
name: 'credit_note.field.rate',
fieldType: 'number',
required: true,
},
quantity: {
name: 'Quantity',
name: 'credit_note.field.quantity',
fieldType: 'number',
required: true,
},
description: {
name: 'Description',
name: 'credit_note.field.description',
fieldType: 'text',
},
},
},
branchId: {
name: 'Branch',
name: 'invoice.field.branch',
fieldType: 'relation',
relationModel: 'Branch',
relationImportMatch: ['name', 'code'],
@@ -238,7 +238,7 @@ export const CreditNoteMeta = {
required: true,
},
warehouseId: {
name: 'Warehouse',
name: 'invoice.field.warehouse',
fieldType: 'relation',
relationModel: 'Warehouse',
relationImportMatch: ['name', 'code'],

View File

@@ -90,7 +90,7 @@ export class CreditNoteTransformer extends Transformer {
* @returns {string}
*/
protected formattedSubtotal = (credit): string => {
return this.formatNumber(credit.amount, { money: false });
return this.formatNumber(credit.amount);
};
/**
@@ -130,7 +130,7 @@ export class CreditNoteTransformer extends Transformer {
* @returns {string}
*/
protected adjustmentFormatted = (credit): string => {
return this.formatMoney(credit.adjustment, {
return this.formatNumber(credit.adjustment, {
currencyCode: credit.currencyCode,
excerptZero: true,
});
@@ -156,6 +156,7 @@ export class CreditNoteTransformer extends Transformer {
protected totalFormatted = (credit): string => {
return this.formatNumber(credit.total, {
currencyCode: credit.currencyCode,
money: true,
});
};
@@ -167,6 +168,7 @@ export class CreditNoteTransformer extends Transformer {
protected totalLocalFormatted = (credit): string => {
return this.formatNumber(credit.totalLocal, {
currencyCode: credit.currencyCode,
money: true,
});
};

View File

@@ -1,10 +1,10 @@
import { Inject, Injectable } from '@nestjs/common';
import { renderCreditNotePaperTemplateHtml } from '@bigcapital/pdf-templates';
import { GetCreditNoteService } from './GetCreditNote.service';
import { CreditNoteBrandingTemplate } from './CreditNoteBrandingTemplate.service';
import { transformCreditNoteToPdfTemplate } from '../utils';
import { CreditNote } from '../models/CreditNote';
import { ChromiumlyTenancy } from '@/modules/ChromiumlyTenancy/ChromiumlyTenancy.service';
import { TemplateInjectable } from '@/modules/TemplateInjectable/TemplateInjectable.service';
import { EventEmitter2 } from '@nestjs/event-emitter';
import { PdfTemplateModel } from '@/modules/PdfTemplate/models/PdfTemplate';
import { CreditNotePdfTemplateAttributes } from '../types/CreditNotes.types';
@@ -15,7 +15,6 @@ import { TenantModelProxy } from '@/modules/System/models/TenantBaseModel';
export class GetCreditNotePdf {
/**
* @param {ChromiumlyTenancy} chromiumlyTenancy - Chromiumly tenancy service.
* @param {TemplateInjectable} templateInjectable - Template injectable service.
* @param {GetCreditNote} getCreditNoteService - Get credit note service.
* @param {CreditNoteBrandingTemplate} creditNoteBrandingTemplate - Credit note branding template service.
* @param {EventEmitter2} eventPublisher - Event publisher service.
@@ -24,7 +23,6 @@ export class GetCreditNotePdf {
*/
constructor(
private readonly chromiumlyTenancy: ChromiumlyTenancy,
private readonly templateInjectable: TemplateInjectable,
private readonly getCreditNoteService: GetCreditNoteService,
private readonly creditNoteBrandingTemplate: CreditNoteBrandingTemplate,
private readonly eventPublisher: EventEmitter2,
@@ -36,23 +34,40 @@ export class GetCreditNotePdf {
private readonly pdfTemplateModel: TenantModelProxy<
typeof PdfTemplateModel
>,
) {}
) { }
/**
* Retrieves sale invoice pdf content.
* Retrieves credit note html content.
* @param {number} creditNoteId - Credit note id.
* @returns {Promise<string>}
*/
public async getCreditNoteHtml(creditNoteId: number): Promise<string> {
const brandingAttributes =
await this.getCreditNoteBrandingAttributes(creditNoteId);
// Map attributes to match the React component props
// The branding template returns companyLogoUri, but type may have companyLogo
const props = {
...brandingAttributes,
companyLogoUri:
(brandingAttributes as any).companyLogoUri ||
(brandingAttributes as any).companyLogo ||
'',
};
return renderCreditNotePaperTemplateHtml(props);
}
/**
* Retrieves credit note pdf content.
* @param {number} creditNoteId - Credit note id.
* @returns {Promise<[Buffer, string]>}
*/
public async getCreditNotePdf(
creditNoteId: number,
): Promise<[Buffer, string]> {
const brandingAttributes =
await this.getCreditNoteBrandingAttributes(creditNoteId);
const htmlContent = await this.templateInjectable.render(
'modules/credit-note-standard',
brandingAttributes,
);
const filename = await this.getCreditNoteFilename(creditNoteId);
const htmlContent = await this.getCreditNoteHtml(creditNoteId);
const document =
await this.chromiumlyTenancy.convertHtmlContent(htmlContent);

View File

@@ -1,103 +1,117 @@
import { Injectable } from '@nestjs/common';
import { AccountNormal } from '@/interfaces/Account';
import { ILedgerEntry } from '@/modules/Ledger/types/Ledger.types';
import { Ledger } from '@/modules/Ledger/Ledger';
import { Customer } from './models/Customer';
// import { Service, Inject } from 'typedi';
// import { AccountNormal, ICustomer, ILedgerEntry } from '@/interfaces';
// import Ledger from '@/services/Accounting/Ledger';
@Injectable()
export class CustomerGLEntries {
/**
* Retrieves the customer opening balance common entry attributes.
*/
private getCustomerOpeningGLCommonEntry = (customer: Customer) => {
return {
exchangeRate: customer.openingBalanceExchangeRate,
currencyCode: customer.currencyCode,
// @Service()
// export class CustomerGLEntries {
// /**
// * Retrieves the customer opening balance common entry attributes.
// * @param {ICustomer} customer
// */
// private getCustomerOpeningGLCommonEntry = (customer: ICustomer) => {
// return {
// exchangeRate: customer.openingBalanceExchangeRate,
// currencyCode: customer.currencyCode,
transactionType: 'CustomerOpeningBalance',
transactionId: customer.id,
// transactionType: 'CustomerOpeningBalance',
// transactionId: customer.id,
date: customer.openingBalanceAt,
contactId: customer.id,
// date: customer.openingBalanceAt,
// userId: customer.userId,
// contactId: customer.id,
credit: 0,
debit: 0,
// credit: 0,
// debit: 0,
branchId: customer.openingBalanceBranchId,
};
};
// branchId: customer.openingBalanceBranchId,
// };
// };
/**
* Retrieves the customer opening GL credit entry.
*/
private getCustomerOpeningGLCreditEntry = (
ARAccountId: number,
customer: Customer
): ILedgerEntry => {
const commonEntry = this.getCustomerOpeningGLCommonEntry(customer);
// /**
// * Retrieves the customer opening GL credit entry.
// * @param {number} ARAccountId
// * @param {ICustomer} customer
// * @returns {ILedgerEntry}
// */
// private getCustomerOpeningGLCreditEntry = (
// ARAccountId: number,
// customer: ICustomer
// ): ILedgerEntry => {
// const commonEntry = this.getCustomerOpeningGLCommonEntry(customer);
return {
...commonEntry,
credit: 0,
debit: customer.localOpeningBalance,
accountId: ARAccountId,
accountNormal: AccountNormal.DEBIT,
index: 1,
};
};
// return {
// ...commonEntry,
// credit: 0,
// debit: customer.localOpeningBalance,
// accountId: ARAccountId,
// accountNormal: AccountNormal.DEBIT,
// index: 1,
// };
// };
/**
* Retrieves the customer opening GL debit entry.
*/
private getCustomerOpeningGLDebitEntry = (
incomeAccountId: number,
customer: Customer
): ILedgerEntry => {
const commonEntry = this.getCustomerOpeningGLCommonEntry(customer);
// /**
// * Retrieves the customer opening GL debit entry.
// * @param {number} incomeAccountId
// * @param {ICustomer} customer
// * @returns {ILedgerEntry}
// */
// private getCustomerOpeningGLDebitEntry = (
// incomeAccountId: number,
// customer: ICustomer
// ): ILedgerEntry => {
// const commonEntry = this.getCustomerOpeningGLCommonEntry(customer);
return {
...commonEntry,
credit: customer.localOpeningBalance,
debit: 0,
accountId: incomeAccountId,
accountNormal: AccountNormal.CREDIT,
// return {
// ...commonEntry,
// credit: customer.localOpeningBalance,
// debit: 0,
// accountId: incomeAccountId,
// accountNormal: AccountNormal.CREDIT,
index: 2,
};
};
// index: 2,
// };
// };
/**
* Retrieves the customer opening GL entries.
*/
public getCustomerOpeningGLEntries = (
ARAccountId: number,
incomeAccountId: number,
customer: Customer
) => {
const debitEntry = this.getCustomerOpeningGLDebitEntry(
incomeAccountId,
customer
);
const creditEntry = this.getCustomerOpeningGLCreditEntry(
ARAccountId,
customer
);
return [debitEntry, creditEntry];
};
// /**
// * Retrieves the customer opening GL entries.
// * @param {number} ARAccountId
// * @param {number} incomeAccountId
// * @param {ICustomer} customer
// * @returns {ILedgerEntry[]}
// */
// public getCustomerOpeningGLEntries = (
// ARAccountId: number,
// incomeAccountId: number,
// customer: ICustomer
// ) => {
// const debitEntry = this.getCustomerOpeningGLDebitEntry(
// incomeAccountId,
// customer
// );
// const creditEntry = this.getCustomerOpeningGLCreditEntry(
// ARAccountId,
// customer
// );
// return [debitEntry, creditEntry];
// };
/**
* Retrieves the customer opening balance ledger.
*/
public getCustomerOpeningLedger = (
ARAccountId: number,
incomeAccountId: number,
customer: Customer
) => {
const entries = this.getCustomerOpeningGLEntries(
ARAccountId,
incomeAccountId,
customer
);
return new Ledger(entries);
};
}
// /**
// * Retrieves the customer opening balance ledger.
// * @param {number} ARAccountId
// * @param {number} incomeAccountId
// * @param {ICustomer} customer
// * @returns {ILedger}
// */
// public getCustomerOpeningLedger = (
// ARAccountId: number,
// incomeAccountId: number,
// customer: ICustomer
// ) => {
// const entries = this.getCustomerOpeningGLEntries(
// ARAccountId,
// incomeAccountId,
// customer
// );
// return new Ledger(entries);
// };
// }

View File

@@ -1,84 +1,90 @@
import { Knex } from 'knex';
import { Inject, Injectable } from '@nestjs/common';
import { LedgerStorageService } from '@/modules/Ledger/LedgerStorage.service';
import { AccountRepository } from '@/modules/Accounts/repositories/Account.repository';
import { CustomerGLEntries } from './CustomerGLEntries';
import { Customer } from './models/Customer';
import { TenantModelProxy } from '@/modules/System/models/TenantBaseModel';
import { Account } from '../Accounts/models/Account.model';
// import { Knex } from 'knex';
// import LedgerStorageService from '@/services/Accounting/LedgerStorageService';
// import HasTenancyService from '@/services/Tenancy/TenancyService';
// import { Service, Inject } from 'typedi';
// import { CustomerGLEntries } from './CustomerGLEntries';
@Injectable()
export class CustomerGLEntriesStorage {
constructor(
private readonly ledgerStorage: LedgerStorageService,
private readonly accountRepository: AccountRepository,
private readonly customerGLEntries: CustomerGLEntries,
// @Service()
// export class CustomerGLEntriesStorage {
// @Inject()
// private tenancy: HasTenancyService;
@Inject(Account.name)
private readonly accountModel: TenantModelProxy<typeof Account>,
// @Inject()
// private ledegrRepository: LedgerStorageService;
@Inject(Customer.name)
private readonly customerModel: TenantModelProxy<typeof Customer>,
) { }
// @Inject()
// private customerGLEntries: CustomerGLEntries;
/**
* Customer opening balance journals.
*/
public writeCustomerOpeningBalance = async (
customerId: number,
trx?: Knex.Transaction,
) => {
const customer = await this.customerModel()
.query(trx)
.findById(customerId);
// /**
// * Customer opening balance journals.
// * @param {number} tenantId
// * @param {number} customerId
// * @param {Knex.Transaction} trx
// */
// public writeCustomerOpeningBalance = async (
// tenantId: number,
// customerId: number,
// trx?: Knex.Transaction
// ) => {
// const { Customer } = this.tenancy.models(tenantId);
// const { accountRepository } = this.tenancy.repositories(tenantId);
// Finds the income account.
const incomeAccount = await this.accountModel()
.query(trx)
.findOne({ slug: 'other-income' });
// const customer = await Customer.query(trx).findById(customerId);
// Find or create the A/R account.
const ARAccount =
await this.accountRepository.findOrCreateAccountReceivable(
customer.currencyCode,
{},
trx,
);
// Retrieves the customer opening balance ledger.
const ledger = this.customerGLEntries.getCustomerOpeningLedger(
ARAccount.id,
incomeAccount.id,
customer,
);
// Commits the ledger entries to the storage.
await this.ledgerStorage.commit(ledger, trx);
};
// // Finds the income account.
// const incomeAccount = await accountRepository.findOne({
// slug: 'other-income',
// });
// // Find or create the A/R account.
// const ARAccount = await accountRepository.findOrCreateAccountReceivable(
// customer.currencyCode,
// {},
// trx
// );
// // Retrieves the customer opening balance ledger.
// const ledger = this.customerGLEntries.getCustomerOpeningLedger(
// ARAccount.id,
// incomeAccount.id,
// customer
// );
// // Commits the ledger entries to the storage.
// await this.ledegrRepository.commit(tenantId, ledger, trx);
// };
/**
* Reverts the customer opening balance GL entries.
*/
public revertCustomerOpeningBalance = async (
customerId: number,
trx?: Knex.Transaction,
) => {
await this.ledgerStorage.deleteByReference(
customerId,
'CustomerOpeningBalance',
trx,
);
};
// /**
// * Reverts the customer opening balance GL entries.
// * @param {number} tenantId
// * @param {number} customerId
// * @param {Knex.Transaction} trx
// */
// public revertCustomerOpeningBalance = async (
// tenantId: number,
// customerId: number,
// trx?: Knex.Transaction
// ) => {
// await this.ledegrRepository.deleteByReference(
// tenantId,
// customerId,
// 'CustomerOpeningBalance',
// trx
// );
// };
/**
* Writes the customer opening balance GL entries.
*/
public rewriteCustomerOpeningBalance = async (
customerId: number,
trx?: Knex.Transaction,
) => {
// Reverts the customer opening balance entries.
await this.revertCustomerOpeningBalance(customerId, trx);
// /**
// * Writes the customer opening balance GL entries.
// * @param {number} tenantId
// * @param {number} customerId
// * @param {Knex.Transaction} trx
// */
// public rewriteCustomerOpeningBalance = async (
// tenantId: number,
// customerId: number,
// trx?: Knex.Transaction
// ) => {
// // Reverts the customer opening balance entries.
// await this.revertCustomerOpeningBalance(tenantId, customerId, trx);
// Write the customer opening balance entries.
await this.writeCustomerOpeningBalance(customerId, trx);
};
}
// // Write the customer opening balance entries.
// await this.writeCustomerOpeningBalance(tenantId, customerId, trx);
// };
// }

View File

@@ -9,7 +9,10 @@ import {
Query,
} from '@nestjs/common';
import { CustomersApplication } from './CustomersApplication.service';
import { CustomerOpeningBalanceEditDto } from './dtos/CustomerOpeningBalanceEdit.dto';
import {
ICustomerOpeningBalanceEditDTO,
ICustomersFilter,
} from './types/Customers.types';
import {
ApiOperation,
ApiResponse,
@@ -103,7 +106,7 @@ export class CustomersController {
})
editOpeningBalance(
@Param('id') customerId: number,
@Body() openingBalanceDTO: CustomerOpeningBalanceEditDto,
@Body() openingBalanceDTO: ICustomerOpeningBalanceEditDTO,
) {
return this.customersApplication.editOpeningBalance(
customerId,

View File

@@ -18,19 +18,9 @@ import { GetCustomers } from './queries/GetCustomers.service';
import { DynamicListModule } from '../DynamicListing/DynamicList.module';
import { BulkDeleteCustomersService } from './BulkDeleteCustomers.service';
import { ValidateBulkDeleteCustomersService } from './ValidateBulkDeleteCustomers.service';
import { LedgerModule } from '../Ledger/Ledger.module';
import { AccountsModule } from '../Accounts/Accounts.module';
import { CustomerGLEntries } from './CustomerGLEntries';
import { CustomerGLEntriesStorage } from './CustomerGLEntriesStorage';
import { CustomerWriteGLOpeningBalanceSubscriber } from './subscribers/CustomerGLEntriesSubscriber';
@Module({
imports: [
TenancyDatabaseModule,
DynamicListModule,
LedgerModule,
AccountsModule,
],
imports: [TenancyDatabaseModule, DynamicListModule],
controllers: [CustomersController],
providers: [
ActivateCustomer,
@@ -51,9 +41,6 @@ import { CustomerWriteGLOpeningBalanceSubscriber } from './subscribers/CustomerG
GetCustomers,
BulkDeleteCustomersService,
ValidateBulkDeleteCustomersService,
CustomerGLEntries,
CustomerGLEntriesStorage,
CustomerWriteGLOpeningBalanceSubscriber,
],
})
export class CustomersModule {}

View File

@@ -4,7 +4,10 @@ import { CreateCustomer } from './commands/CreateCustomer.service';
import { EditCustomer } from './commands/EditCustomer.service';
import { DeleteCustomer } from './commands/DeleteCustomer.service';
import { EditOpeningBalanceCustomer } from './commands/EditOpeningBalanceCustomer.service';
import { CustomerOpeningBalanceEditDto } from './dtos/CustomerOpeningBalanceEdit.dto';
import {
ICustomerOpeningBalanceEditDTO,
ICustomersFilter,
} from './types/Customers.types';
import { CreateCustomerDto } from './dtos/CreateCustomer.dto';
import { EditCustomerDto } from './dtos/EditCustomer.dto';
import { GetCustomers } from './queries/GetCustomers.service';
@@ -15,12 +18,12 @@ import { ValidateBulkDeleteCustomersService } from './ValidateBulkDeleteCustomer
@Injectable()
export class CustomersApplication {
constructor(
private readonly getCustomerService: GetCustomerService,
private readonly createCustomerService: CreateCustomer,
private readonly editCustomerService: EditCustomer,
private readonly deleteCustomerService: DeleteCustomer,
private readonly editOpeningBalanceService: EditOpeningBalanceCustomer,
private readonly getCustomersService: GetCustomers,
private getCustomerService: GetCustomerService,
private createCustomerService: CreateCustomer,
private editCustomerService: EditCustomer,
private deleteCustomerService: DeleteCustomer,
private editOpeningBalanceService: EditOpeningBalanceCustomer,
private getCustomersService: GetCustomers,
private readonly bulkDeleteCustomersService: BulkDeleteCustomersService,
private readonly validateBulkDeleteCustomersService: ValidateBulkDeleteCustomersService,
) {}
@@ -69,7 +72,7 @@ export class CustomersApplication {
*/
public editOpeningBalance = (
customerId: number,
openingBalanceEditDTO: CustomerOpeningBalanceEditDto,
openingBalanceEditDTO: ICustomerOpeningBalanceEditDTO,
) => {
return this.editOpeningBalanceService.changeOpeningBalance(
customerId,
@@ -79,7 +82,7 @@ export class CustomersApplication {
/**
* Retrieve customers paginated list.
* @param {GetCustomersQueryDto} filter - Cusotmers filter.
* @param {ICustomersFilter} filter - Cusotmers filter.
*/
public getCustomers = (filterDTO: GetCustomersQueryDto) => {
return this.getCustomersService.getCustomersList(filterDTO);

View File

@@ -31,7 +31,7 @@ export class CreateCustomer {
/**
* Creates a new customer.
* @param {CreateCustomerDto} customerDTO
* @param {ICustomerNewDTO} customerDTO
* @return {Promise<ICustomer>}
*/
public async createCustomer(

View File

@@ -1,10 +1,10 @@
import { Inject, Injectable } from '@nestjs/common';
import { Knex } from 'knex';
import {
ICustomerOpeningBalanceEditDTO,
ICustomerOpeningBalanceEditedPayload,
ICustomerOpeningBalanceEditingPayload,
} from '../types/Customers.types';
import { CustomerOpeningBalanceEditDto } from '../dtos/CustomerOpeningBalanceEdit.dto';
import { EventEmitter2 } from '@nestjs/event-emitter';
import { UnitOfWork } from '@/modules/Tenancy/TenancyDB/UnitOfWork.service';
import { Customer } from '../models/Customer';
@@ -29,11 +29,11 @@ export class EditOpeningBalanceCustomer {
/**
* Changes the opening balance of the given customer.
* @param {number} customerId - Customer ID.
* @param {CustomerOpeningBalanceEditDto} openingBalanceEditDTO
* @param {ICustomerOpeningBalanceEditDTO} openingBalanceEditDTO
*/
public async changeOpeningBalance(
customerId: number,
openingBalanceEditDTO: CustomerOpeningBalanceEditDto,
openingBalanceEditDTO: ICustomerOpeningBalanceEditDTO,
): Promise<Customer> {
// Retrieves the old customer or throw not found error.
const oldCustomer = await this.customerModel()

View File

@@ -4,7 +4,6 @@ import {
IsNotEmpty,
IsNumber,
IsString,
ValidateIf,
} from 'class-validator';
import { ApiProperty } from '@nestjs/swagger';
import { IsOptional, ToNumber } from '@/common/decorators/Validators';
@@ -41,11 +40,10 @@ export class CreateCustomerDto extends ContactAddressDto {
@ApiProperty({
required: false,
description: 'Opening balance date (required when openingBalance is provided)',
description: 'Opening balance date',
example: '2024-01-01',
})
@ValidateIf((o) => o.openingBalance != null)
@IsNotEmpty({ message: 'openingBalanceAt is required when openingBalance is provided' })
@IsOptional()
@IsString()
openingBalanceAt?: string;

View File

@@ -1,44 +0,0 @@
import { IsNotEmpty, IsNumber, IsString } from 'class-validator';
import { ApiProperty } from '@nestjs/swagger';
import { IsOptional, ToNumber } from '@/common/decorators/Validators';
export class CustomerOpeningBalanceEditDto {
@ApiProperty({
required: true,
description: 'Opening balance',
example: 5000.0,
})
@IsNumber()
@IsNotEmpty()
@ToNumber()
openingBalance: number;
@ApiProperty({
required: false,
description: 'Opening balance date',
example: '2024-01-01',
})
@IsOptional()
@IsString()
openingBalanceAt?: string;
@ApiProperty({
required: false,
description: 'Opening balance exchange rate',
example: 1.0,
})
@IsOptional()
@IsNumber()
@ToNumber()
openingBalanceExchangeRate?: number;
@ApiProperty({
required: false,
description: 'Opening balance branch ID',
example: 101,
})
@IsOptional()
@IsNumber()
@ToNumber()
openingBalanceBranchId?: number;
}

View File

@@ -1,63 +1,91 @@
import { Injectable } from '@nestjs/common';
import { OnEvent } from '@nestjs/event-emitter';
import {
ICustomerEventCreatedPayload,
ICustomerEventDeletedPayload,
ICustomerOpeningBalanceEditedPayload,
} from '../types/Customers.types';
import { events } from '@/common/events/events';
import { CustomerGLEntriesStorage } from '../CustomerGLEntriesStorage';
// import { Service, Inject } from 'typedi';
// import {
// ICustomerEventCreatedPayload,
// ICustomerEventDeletedPayload,
// ICustomerOpeningBalanceEditedPayload,
// } from '@/interfaces';
// import events from '@/subscribers/events';
// import { CustomerGLEntriesStorage } from '../CustomerGLEntriesStorage';
@Injectable()
export class CustomerWriteGLOpeningBalanceSubscriber {
constructor(private readonly customerGLEntries: CustomerGLEntriesStorage) { }
// @Service()
// export class CustomerWriteGLOpeningBalanceSubscriber {
// @Inject()
// private customerGLEntries: CustomerGLEntriesStorage;
/**
* Handles the writing opening balance journal entries once the customer created.
*/
@OnEvent(events.customers.onCreated)
public async handleWriteOpenBalanceEntries({
customer,
trx,
}: ICustomerEventCreatedPayload) {
// Writes the customer opening balance journal entries.
if (customer.openingBalance) {
await this.customerGLEntries.writeCustomerOpeningBalance(
customer.id,
trx,
);
}
}
// /**
// * Attaches events with handlers.
// */
// public attach(bus) {
// bus.subscribe(
// events.customers.onCreated,
// this.handleWriteOpenBalanceEntries
// );
// bus.subscribe(
// events.customers.onDeleted,
// this.handleRevertOpeningBalanceEntries
// );
// bus.subscribe(
// events.customers.onOpeningBalanceChanged,
// this.handleRewriteOpeningEntriesOnChanged
// );
// }
/**
* Handles the deleting opening balance journal entries once the customer deleted.
*/
@OnEvent(events.customers.onDeleted)
public async handleRevertOpeningBalanceEntries({
customerId,
trx,
}: ICustomerEventDeletedPayload) {
await this.customerGLEntries.revertCustomerOpeningBalance(customerId, trx);
}
// /**
// * Handles the writing opening balance journal entries once the customer created.
// * @param {ICustomerEventCreatedPayload} payload -
// */
// private handleWriteOpenBalanceEntries = async ({
// tenantId,
// customer,
// trx,
// }: ICustomerEventCreatedPayload) => {
// // Writes the customer opening balance journal entries.
// if (customer.openingBalance) {
// await this.customerGLEntries.writeCustomerOpeningBalance(
// tenantId,
// customer.id,
// trx
// );
// }
// };
/**
* Handles the rewrite opening balance entries once opening balance changed.
*/
@OnEvent(events.customers.onOpeningBalanceChanged)
public async handleRewriteOpeningEntriesOnChanged({
customer,
trx,
}: ICustomerOpeningBalanceEditedPayload) {
if (customer.openingBalance) {
await this.customerGLEntries.rewriteCustomerOpeningBalance(
customer.id,
trx,
);
} else {
await this.customerGLEntries.revertCustomerOpeningBalance(
customer.id,
trx,
);
}
}
}
// /**
// * Handles the deleting opeing balance journal entrise once the customer deleted.
// * @param {ICustomerEventDeletedPayload} payload -
// */
// private handleRevertOpeningBalanceEntries = async ({
// tenantId,
// customerId,
// trx,
// }: ICustomerEventDeletedPayload) => {
// await this.customerGLEntries.revertCustomerOpeningBalance(
// tenantId,
// customerId,
// trx
// );
// };
// /**
// * Handles the rewrite opening balance entries once opening balnace changed.
// * @param {ICustomerOpeningBalanceEditedPayload} payload -
// */
// private handleRewriteOpeningEntriesOnChanged = async ({
// tenantId,
// customer,
// trx,
// }: ICustomerOpeningBalanceEditedPayload) => {
// if (customer.openingBalance) {
// await this.customerGLEntries.rewriteCustomerOpeningBalance(
// tenantId,
// customer.id,
// trx
// );
// } else {
// await this.customerGLEntries.revertCustomerOpeningBalance(
// tenantId,
// customer.id,
// trx
// );
// }
// };
// }

View File

@@ -4,7 +4,6 @@ import { IContactAddressDTO } from '@/modules/Contacts/types/Contacts.types';
import { IDynamicListFilter } from '@/modules/DynamicListing/DynamicFilter/DynamicFilter.types';
import { IFilterMeta, IPaginationMeta } from '@/interfaces/Model';
import { CreateCustomerDto } from '../dtos/CreateCustomer.dto';
import { CustomerOpeningBalanceEditDto } from '../dtos/CustomerOpeningBalanceEdit.dto';
import { EditCustomerDto } from '../dtos/EditCustomer.dto';
// Customer Interfaces.
@@ -114,16 +113,23 @@ export enum VendorAction {
View = 'View',
}
export interface ICustomerOpeningBalanceEditDTO {
openingBalance: number;
openingBalanceAt: Date | string;
openingBalanceExchangeRate: number;
openingBalanceBranchId?: number;
}
export interface ICustomerOpeningBalanceEditingPayload {
oldCustomer: Customer;
openingBalanceEditDTO: CustomerOpeningBalanceEditDto;
openingBalanceEditDTO: ICustomerOpeningBalanceEditDTO;
trx?: Knex.Transaction;
}
export interface ICustomerOpeningBalanceEditedPayload {
customer: Customer;
oldCustomer: Customer;
openingBalanceEditDTO: CustomerOpeningBalanceEditDto;
openingBalanceEditDTO: ICustomerOpeningBalanceEditDTO;
trx: Knex.Transaction;
}

View File

@@ -5,10 +5,10 @@ import { ExpensesSampleData } from './constants';
import { CreateExpense } from './commands/CreateExpense.service';
import { CreateExpenseDto } from './dtos/Expense.dto';
import { ImportableService } from '../Import/decorators/Import.decorator';
import { ManualJournal } from '../ManualJournals/models/ManualJournal';
import { Expense } from './models/Expense.model';
@Injectable()
@ImportableService({ name: ManualJournal.name })
@ImportableService({ name: Expense.name })
export class ExpensesImportable extends Importable {
constructor(private readonly createExpenseService: CreateExpense) {
super();

View File

@@ -135,7 +135,7 @@ export const ExpenseMeta = {
relationModel: 'Account',
relationImportMatch: ['name', 'code'],
required: true,
importHint: 'Matches the account name or code.',
importHint: 'account.field.account_hint',
},
referenceNo: {
name: 'expense.field.reference_no',
@@ -169,7 +169,7 @@ export const ExpenseMeta = {
relationModel: 'Account',
relationImportMatch: ['name', 'code'],
required: true,
importHint: 'Matches the account name or code.',
importHint: 'account.field.account_hint',
},
amount: {
name: 'expense.field.amount',
@@ -187,7 +187,7 @@ export const ExpenseMeta = {
fieldType: 'boolean',
},
branchId: {
name: 'Branch',
name: 'invoice.field.branch',
fieldType: 'relation',
relationModel: 'Branch',
relationImportMatch: ['name', 'code'],

View File

@@ -1,14 +1,13 @@
import { Injectable } from '@nestjs/common';
import { ChromiumlyTenancy } from '../ChromiumlyTenancy/ChromiumlyTenancy.service';
import { TemplateInjectable } from '../TemplateInjectable/TemplateInjectable.service';
import { renderExportResourceTableTemplateHtml } from '@bigcapital/pdf-templates';
import { mapPdfRows } from './utils';
@Injectable()
export class ExportPdf {
constructor(
private readonly templateInjectable: TemplateInjectable,
private readonly chromiumlyTenancy: ChromiumlyTenancy,
) {}
) { }
/**
* Generates the pdf table sheet for the given data and columns.
@@ -19,21 +18,18 @@ export class ExportPdf {
* @returns
*/
public async pdf(
columns: { accessor: string },
columns: { accessor: string; name?: string; style?: string; group?: string }[],
data: Record<string, any>,
sheetTitle: string = '',
sheetDescription: string = ''
) {
const rows = mapPdfRows(columns, data);
const htmlContent = await this.templateInjectable.render(
'modules/export-resource-table',
{
table: { rows, columns },
sheetTitle,
sheetDescription,
}
);
const htmlContent = renderExportResourceTableTemplateHtml({
table: { rows, columns },
sheetTitle,
sheetDescription,
});
// Convert the HTML content to PDF
return this.chromiumlyTenancy.convertHtmlContent(htmlContent, {
margins: { top: 0.2, bottom: 0.2, left: 0.2, right: 0.2 },

View File

@@ -211,7 +211,7 @@ export class InventoryValuationSheet extends FinancialSheet {
* Detarmines whether the items post filter is active.
*/
private isItemsPostFilter = (): boolean => {
return isEmpty(this.query.itemsIds);
return !isEmpty(this.query.itemsIds);
};
/**

View File

@@ -18,7 +18,7 @@ export class InventoryValuationSheetService {
private readonly inventoryValuationMeta: InventoryValuationMetaInjectable,
private readonly eventPublisher: EventEmitter2,
private readonly inventoryValuationSheetRepository: InventoryValuationSheetRepository,
) {}
) { }
/**
* Inventory valuation sheet.

View File

@@ -172,7 +172,10 @@ export class TrialBalanceSheet extends FinancialSheet {
private filterNoneTransactions = (
accountNode: ITrialBalanceAccount
): boolean => {
return false === this.repository.totalAccountsLedger.isEmpty();
const accountLedger = this.repository.totalAccountsLedger.whereAccountId(
accountNode.id,
);
return !accountLedger.isEmpty();
};
/**

View File

@@ -22,7 +22,7 @@ export class ImportFileCommon {
private readonly importFileValidator: ImportFileDataValidator,
private readonly resource: ResourceService,
private readonly importableRegistry: ImportableRegistry,
) {}
) { }
/**
* Imports the given parsed data to the resource storage through registered importable service.

View File

@@ -18,7 +18,7 @@ import { CurrencyParsingDTOs } from './_constants';
export class ImportFileDataTransformer {
constructor(
private readonly resource: ResourceService,
) {}
) { }
/**
* Parses the given sheet data before passing to the service layer.
@@ -55,9 +55,8 @@ export class ImportFileDataTransformer {
/**
* Aggregates parsed data based on resource metadata configuration.
* @param {number} tenantId
* @param {string} resourceName
* @param {Record<string, any>} parsedData
* @param {string} resourceName - The resource name.
* @param {Record<string, any>} parsedData - The parsed data to aggregate.
* @returns {Record<string, any>[]}
*/
public aggregateParsedValues(
@@ -110,8 +109,11 @@ export class ImportFileDataTransformer {
valueDTOs: Record<string, any>[],
trx?: Knex.Transaction
): Promise<Record<string, any>[]> {
// const tenantModels = this.tenancy.models(tenantId);
const _valueParser = valueParser(fields, {}, trx);
// Create a model resolver function that uses ResourceService
const modelResolver = (modelName: string) => {
return this.resource.getResourceModel(modelName)();
};
const _valueParser = valueParser(fields, modelResolver, trx);
const _keyParser = parseKey(fields);
const parseAsync = async (valueDTO) => {

View File

@@ -19,7 +19,8 @@ export class ImportFileDataValidator {
/**
* Validates the given mapped DTOs and returns errors with their index.
* @param {Record<string, any>} mappedDTOs
* @param {ResourceMetaFieldsMap} importableFields - Already localized fields from ResourceService
* @param {Record<string, any>} data
* @returns {Promise<void | ImportInsertError[]>}
*/
public async validateData(

View File

@@ -24,7 +24,7 @@ export class ImportFileUploadService {
@Inject(ImportModel.name)
private readonly importModel: typeof ImportModel,
) {}
) { }
/**
* Imports the specified file for the given resource.
@@ -84,7 +84,7 @@ export class ImportFileUploadService {
} catch (error) {
throw error;
}
const _params = this.importFileCommon.transformParams(resource, params);
const _params = await this.importFileCommon.transformParams(resource, params);
const paramsStringified = JSON.stringify(_params);
const tenant = await this.tenancyContext.getTenant();

View File

@@ -6,7 +6,7 @@ import { ContextIdFactory, ModuleRef } from '@nestjs/core';
@Injectable()
export class ImportableRegistry {
constructor(private readonly moduleRef: ModuleRef) {}
constructor(private readonly moduleRef: ModuleRef) { }
/**
* Retrieves the importable service instance of the given resource name.
* @param {string} name
@@ -15,6 +15,12 @@ export class ImportableRegistry {
public async getImportable(name: string) {
const _name = this.sanitizeResourceName(name);
const importable = getImportableService(_name);
if (!importable) {
throw new Error(
`No importable service found for resource "${_name}". Make sure the resource has an @ImportableService decorator registered.`,
);
}
const contextId = ContextIdFactory.create();
const importableInstance = await this.moduleRef.resolve(importable, contextId, {

View File

@@ -0,0 +1,287 @@
import { aggregate } from './_utils';
describe('aggregate', () => {
describe('basic aggregation', () => {
it('should aggregate entries with matching comparator attribute', () => {
const input = [
{ id: 1, name: 'John', entries: ['entry1'] },
{ id: 2, name: 'Jane', entries: ['entry2'] },
{ id: 1, name: 'John', entries: ['entry3'] },
];
const result = aggregate(input, 'id', 'entries');
expect(result).toHaveLength(2);
expect(result[0]).toEqual({
id: 1,
name: 'John',
entries: ['entry1', 'entry3'],
});
expect(result[1]).toEqual({
id: 2,
name: 'Jane',
entries: ['entry2'],
});
});
it('should preserve order of first occurrence', () => {
const input = [
{ id: 2, entries: ['a'] },
{ id: 1, entries: ['b'] },
{ id: 2, entries: ['c'] },
];
const result = aggregate(input, 'id', 'entries');
expect(result[0].id).toBe(2);
expect(result[1].id).toBe(1);
});
});
describe('no matching entries', () => {
it('should return all entries unchanged when no comparator matches', () => {
const input = [
{ id: 1, name: 'John', entries: ['entry1'] },
{ id: 2, name: 'Jane', entries: ['entry2'] },
{ id: 3, name: 'Bob', entries: ['entry3'] },
];
const result = aggregate(input, 'id', 'entries');
expect(result).toHaveLength(3);
expect(result).toEqual(input);
});
});
describe('edge cases', () => {
it('should return empty array when input is empty', () => {
const result = aggregate([], 'id', 'entries');
expect(result).toEqual([]);
expect(result).toHaveLength(0);
});
it('should return single entry unchanged when input has one item', () => {
const input = [{ id: 1, name: 'John', entries: ['entry1'] }];
const result = aggregate(input, 'id', 'entries');
expect(result).toHaveLength(1);
expect(result[0]).toEqual({
id: 1,
name: 'John',
entries: ['entry1'],
});
});
it('should handle multiple entries with same comparator value', () => {
const input = [
{ id: 1, entries: ['a'] },
{ id: 1, entries: ['b'] },
{ id: 1, entries: ['c'] },
{ id: 1, entries: ['d'] },
];
const result = aggregate(input, 'id', 'entries');
expect(result).toHaveLength(1);
expect(result[0].entries).toEqual(['a', 'b', 'c', 'd']);
});
});
describe('different comparator attributes', () => {
it('should work with string comparator attribute', () => {
const input = [
{ name: 'Product A', category: 'Electronics', entries: ['item1'] },
{ name: 'Product B', category: 'Books', entries: ['item2'] },
{ name: 'Product C', category: 'Electronics', entries: ['item3'] },
];
const result = aggregate(input, 'category', 'entries');
expect(result).toHaveLength(2);
expect(result[0]).toEqual({
name: 'Product A',
category: 'Electronics',
entries: ['item1', 'item3'],
});
expect(result[1]).toEqual({
name: 'Product B',
category: 'Books',
entries: ['item2'],
});
});
it('should not aggregate items with undefined comparator values', () => {
const input = [
{ id: undefined, entries: ['a'] },
{ id: 1, entries: ['b'] },
{ id: undefined, entries: ['c'] },
];
const result = aggregate(input, 'id', 'entries');
expect(result).toHaveLength(3);
// Items with undefined id are NOT aggregated - each remains separate
expect(result[0].entries).toEqual(['a']);
expect(result[1].entries).toEqual(['b']);
expect(result[2].entries).toEqual(['c']);
});
it('should handle null comparator values separately', () => {
const input = [
{ id: null, entries: ['a'] },
{ id: 1, entries: ['b'] },
{ id: null, entries: ['c'] },
];
const result = aggregate(input, 'id', 'entries');
expect(result).toHaveLength(3);
expect(result[0].entries).toEqual(['a']);
expect(result[1].entries).toEqual(['b']);
expect(result[2].entries).toEqual(['c']);
});
it('should not aggregate items missing the comparatorAttr property', () => {
const input = [
{ id: 1, entries: ['a'] },
{ name: 'No ID', entries: ['b'] }, // missing 'id' property
{ id: 1, entries: ['c'] },
{ entries: ['d'] }, // also missing 'id' property
];
const result = aggregate(input, 'id', 'entries');
// 3 entries: aggregated id:1, and two separate items without 'id' property
expect(result).toHaveLength(3);
// Items with id: 1 are aggregated
expect(result[0]).toEqual({ id: 1, entries: ['a', 'c'] });
// Items missing 'id' are NOT aggregated - each remains separate
expect(result[1]).toEqual({ name: 'No ID', entries: ['b'] });
expect(result[2]).toEqual({ entries: ['d'] });
});
});
describe('different group attributes', () => {
it('should work with different groupOn attribute name', () => {
const input = [
{ id: 1, items: ['item1'] },
{ id: 1, items: ['item2'] },
{ id: 2, items: ['item3'] },
];
const result = aggregate(input, 'id', 'items');
expect(result).toHaveLength(2);
expect(result[0].items).toEqual(['item1', 'item2']);
expect(result[1].items).toEqual(['item3']);
});
});
describe('complex entries', () => {
it('should aggregate entries containing objects', () => {
const input = [
{ invoiceId: 'INV-001', entries: [{ itemId: 1, quantity: 2 }] },
{ invoiceId: 'INV-002', entries: [{ itemId: 2, quantity: 1 }] },
{ invoiceId: 'INV-001', entries: [{ itemId: 3, quantity: 5 }] },
];
const result = aggregate(input, 'invoiceId', 'entries');
expect(result).toHaveLength(2);
expect(result[0].entries).toEqual([
{ itemId: 1, quantity: 2 },
{ itemId: 3, quantity: 5 },
]);
expect(result[1].entries).toEqual([{ itemId: 2, quantity: 1 }]);
});
it('should aggregate entries with multiple items in each entry', () => {
const input = [
{ id: 1, entries: ['a', 'b'] },
{ id: 1, entries: ['c', 'd'] },
{ id: 2, entries: ['e'] },
];
const result = aggregate(input, 'id', 'entries');
expect(result).toHaveLength(2);
expect(result[0].entries).toEqual(['a', 'b', 'c', 'd']);
expect(result[1].entries).toEqual(['e']);
});
});
describe('numeric comparator values', () => {
it('should correctly compare numeric values', () => {
const input = [
{ id: 1, entries: ['a'] },
{ id: 2, entries: ['b'] },
{ id: 1, entries: ['c'] },
];
const result = aggregate(input, 'id', 'entries');
expect(result).toHaveLength(2);
expect(result.find((r) => r.id === 1).entries).toEqual(['a', 'c']);
expect(result.find((r) => r.id === 2).entries).toEqual(['b']);
});
it('should treat 0 as a valid comparator value', () => {
const input = [
{ id: 0, entries: ['a'] },
{ id: 1, entries: ['b'] },
{ id: 0, entries: ['c'] },
];
const result = aggregate(input, 'id', 'entries');
expect(result).toHaveLength(2);
expect(result[0].entries).toEqual(['a', 'c']);
expect(result[1].entries).toEqual(['b']);
});
});
describe('preserving other properties', () => {
it('should preserve all properties from the first matching entry', () => {
const input = [
{ id: 1, name: 'First', extra: 'data1', entries: ['a'] },
{ id: 1, name: 'Second', extra: 'data2', entries: ['b'] },
];
const result = aggregate(input, 'id', 'entries');
expect(result).toHaveLength(1);
expect(result[0].name).toBe('First');
expect(result[0].extra).toBe('data1');
expect(result[0].entries).toEqual(['a', 'b']);
});
});
describe('empty entries arrays', () => {
it('should handle empty entries arrays', () => {
const input = [
{ id: 1, entries: [] },
{ id: 1, entries: ['a'] },
];
const result = aggregate(input, 'id', 'entries');
expect(result).toHaveLength(1);
expect(result[0].entries).toEqual(['a']);
});
it('should handle all empty entries arrays', () => {
const input = [
{ id: 1, entries: [] },
{ id: 1, entries: [] },
];
const result = aggregate(input, 'id', 'entries');
expect(result).toHaveLength(1);
expect(result[0].entries).toEqual([]);
});
});
});

View File

@@ -253,28 +253,28 @@ export const getResourceColumns = (resourceColumns: {
}) => {
const mapColumn =
(group: string) =>
([fieldKey, { name, importHint, required, order, ...field }]: [
string,
IModelMetaField2,
]) => {
const extra: Record<string, any> = {};
const key = fieldKey;
([fieldKey, { name, importHint, required, order, ...field }]: [
string,
IModelMetaField2,
]) => {
const extra: Record<string, any> = {};
const key = fieldKey;
if (group) {
extra.group = group;
}
if (field.fieldType === 'collection') {
extra.fields = mapColumns(field.fields, key);
}
return {
key,
name,
required,
hint: importHint,
order,
...extra,
if (group) {
extra.group = group;
}
if (field.fieldType === 'collection') {
extra.fields = mapColumns(field.fields, key);
}
return {
key,
name,
required,
hint: importHint,
order,
...extra,
};
};
};
const sortColumn = (a, b) =>
a.order && b.order ? a.order - b.order : a.order ? -1 : b.order ? 1 : 0;
@@ -284,52 +284,54 @@ export const getResourceColumns = (resourceColumns: {
return R.compose(transformInputToGroupedFields, mapColumns)(resourceColumns);
};
export type ModelResolver = (modelName: string) => any;
// Prases the given object value based on the field key type.
export const valueParser =
(fields: ResourceMetaFieldsMap, tenantModels: any, trx?: Knex.Transaction) =>
async (value: any, key: string, group = '') => {
let _value = value;
(fields: ResourceMetaFieldsMap, modelResolver: ModelResolver, trx?: Knex.Transaction) =>
async (value: any, key: string, group = '') => {
let _value = value;
const fieldKey = key.includes('.') ? key.split('.')[0] : key;
const field = group ? fields[group]?.fields[fieldKey] : fields[fieldKey];
const fieldKey = key.includes('.') ? key.split('.')[0] : key;
const field = group ? fields[group]?.fields[fieldKey] : fields[fieldKey];
// Parses the boolean value.
if (field.fieldType === 'boolean') {
_value = parseBoolean(value);
// Parses the boolean value.
if (field.fieldType === 'boolean') {
_value = parseBoolean(value);
// Parses the enumeration value.
} else if (field.fieldType === 'enumeration') {
const option = get(field, 'options', []).find(
(option) => option.label?.toLowerCase() === value?.toLowerCase(),
);
_value = get(option, 'key');
// Parses the numeric value.
} else if (field.fieldType === 'number') {
_value = multiNumberParse(value);
// Parses the relation value.
} else if (field.fieldType === 'relation') {
const RelationModel = tenantModels[field.relationModel];
// Parses the enumeration value.
} else if (field.fieldType === 'enumeration') {
const option = get(field, 'options', []).find(
(option) => option.label?.toLowerCase() === value?.toLowerCase(),
);
_value = get(option, 'key');
// Parses the numeric value.
} else if (field.fieldType === 'number') {
_value = multiNumberParse(value);
// Parses the relation value.
} else if (field.fieldType === 'relation') {
const RelationModel = modelResolver(field.relationModel);
if (!RelationModel) {
throw new Error(`The relation model of ${key} field is not exist.`);
}
const relationQuery = RelationModel.query(trx);
const relationKeys = castArray(field?.relationImportMatch);
if (!RelationModel) {
throw new Error(`The relation model of ${key} field is not exist.`);
}
const relationQuery = RelationModel.query(trx);
const relationKeys = castArray(field?.relationImportMatch);
relationQuery.where(function () {
relationKeys.forEach((relationKey: string) => {
this.orWhereRaw('LOWER(??) = LOWER(?)', [relationKey, value]);
relationQuery.where(function () {
relationKeys.forEach((relationKey: string) => {
this.orWhereRaw('LOWER(??) = LOWER(?)', [relationKey, value]);
});
});
});
const result = await relationQuery.first();
_value = get(result, 'id');
} else if (field.fieldType === 'collection') {
const ObjectFieldKey = key.includes('.') ? key.split('.')[1] : key;
const _valueParser = valueParser(fields, tenantModels);
_value = await _valueParser(value, ObjectFieldKey, fieldKey);
}
return _value;
};
const result = await relationQuery.first();
_value = get(result, 'id');
} else if (field.fieldType === 'collection') {
const ObjectFieldKey = key.includes('.') ? key.split('.')[1] : key;
const _valueParser = valueParser(fields, modelResolver);
_value = await _valueParser(value, ObjectFieldKey, fieldKey);
}
return _value;
};
/**
* Parses the field key and detarmines the key path.
@@ -402,12 +404,17 @@ export function aggregate(
groupOn: string,
): Array<Record<string, any>> {
return input.reduce((acc, curr) => {
// Skip aggregation if the current item doesn't have the comparator attribute
if (curr[comparatorAttr] === undefined || curr[comparatorAttr] === null) {
acc.push({ ...curr });
return acc;
}
const existingEntry = acc.find(
(entry) => entry[comparatorAttr] === curr[comparatorAttr],
);
if (existingEntry) {
existingEntry[groupOn].push(...curr.entries);
existingEntry[groupOn].push(...curr[groupOn]);
} else {
acc.push({ ...curr });
}

View File

@@ -93,7 +93,7 @@ export class InventoryComputeCostService {
*/
async scheduleComputeItemCost(itemId: number, startingDate: Date | string) {
const debounceKey = `inventory-cost-compute-debounce:${itemId}`;
const debounceTime = 1000 * 60; // 1 minute
const debounceTime = 1000 * 10; // 10 seconds
// Generate a unique job ID or use a custom identifier
const jobId = `task-${Date.now()}-${Math.random().toString(36).substring(2)}`;

View File

@@ -2,7 +2,8 @@ import { EventEmitter2 } from '@nestjs/event-emitter';
import { Processor, WorkerHost } from '@nestjs/bullmq';
import { Scope } from '@nestjs/common';
import { Job } from 'bullmq';
import { ClsService } from 'nestjs-cls';
import { ClsService, UseCls } from 'nestjs-cls';
import * as moment from 'moment';
import { TenantJobPayload } from '@/interfaces/Tenant';
import { InventoryComputeCostService } from '../commands/InventoryComputeCost.service';
import { events } from '@/common/events/events';
@@ -14,7 +15,7 @@ import { Process } from '@nestjs/bull';
interface ComputeItemCostJobPayload extends TenantJobPayload {
itemId: number;
startingDate: Date;
startingDate: Date | string;
}
@Processor({
name: ComputeItemCostQueue,
@@ -39,28 +40,34 @@ export class ComputeItemCostProcessor extends WorkerHost {
* @param {Job<ComputeItemCostJobPayload>} job - The job to process
*/
@Process(ComputeItemCostQueueJob)
@UseCls()
async process(job: Job<ComputeItemCostJobPayload>) {
const { itemId, startingDate, organizationId, userId } = job.data;
console.log(`Compute item cost for item ${itemId} started`);
// Parse startingDate using moment to handle both Date and string formats
const startingDateObj = moment(startingDate).toDate();
console.log(`[info] Compute item cost for item ${itemId} started`, {
payload: job.data,
jobId: job.id
});
this.clsService.set('organizationId', organizationId);
this.clsService.set('userId', userId);
try {
await this.inventoryComputeCostService.computeItemCost(
startingDate,
startingDateObj,
itemId,
);
// Emit job completed event
await this.eventEmitter.emitAsync(
events.inventory.onComputeItemCostJobCompleted,
{ startingDate, itemId, organizationId, userId },
{ startingDate: startingDateObj, itemId, organizationId, userId },
);
console.log(`Compute item cost for item ${itemId} completed`);
console.log(`[info] Compute item cost for item ${itemId} completed successfully`);
} catch (error) {
console.error('Error computing item cost:', error);
console.error(`[error] Error computing item cost for item ${itemId}:`, error);
console.error('Error stack:', error instanceof Error ? error.stack : 'No stack trace');
throw error;
}
}

View File

@@ -267,28 +267,28 @@ export const ItemMeta = {
fieldType: 'relation',
relationModel: 'Account',
relationImportMatch: ['name', 'code'],
importHint: 'Matches the account name or code.',
importHint: 'account.field.account_hint',
},
sellAccountId: {
name: 'item.field.sell_account',
fieldType: 'relation',
relationModel: 'Account',
relationImportMatch: ['name', 'code'],
importHint: 'Matches the account name or code.',
importHint: 'account.field.account_hint',
},
inventoryAccountId: {
name: 'item.field.inventory_account',
fieldType: 'relation',
relationModel: 'Account',
relationImportMatch: ['name', 'code'],
importHint: 'Matches the account name or code.',
importHint: 'account.field.account_hint',
},
sellDescription: {
name: 'Sell Description',
name: 'item.field.sell_description',
fieldType: 'text',
},
purchaseDescription: {
name: 'Purchase Description',
name: 'item.field.purchase_description',
fieldType: 'text',
},
note: {
@@ -300,7 +300,7 @@ export const ItemMeta = {
fieldType: 'relation',
relationModel: 'ItemCategory',
relationImportMatch: ['name'],
importHint: 'Matches the category name.',
importHint: 'item.field.category_hint',
},
active: {
name: 'item.field.active',

View File

@@ -74,6 +74,9 @@ export class PaymentReceivedResponseDto {
@ApiProperty({ description: 'The formatted amount', example: '100.00' })
formattedAmount: string;
@ApiProperty({ description: 'The formatted total', example: '100.00 USD' })
formattedTotal: string;
@ApiProperty({ description: 'The currency code', example: 'USD' })
currencyCode: string;

View File

@@ -165,12 +165,12 @@ export const PaymentReceivedMeta = {
relationModel: 'Account',
relationImportMatch: ['name', 'code'],
required: true,
importHint: 'Matches the account name or code.',
importHint: 'account.field.account_hint',
},
paymentReceiveNo: {
name: 'payment_receive.field.payment_receive_no',
fieldType: 'text',
importHint: 'The payment number should be unique.',
importHint: 'payment_receive.field.payment_no_hint',
},
statement: {
name: 'payment_receive.field.statement',
@@ -189,7 +189,7 @@ export const PaymentReceivedMeta = {
relationModel: 'SaleInvoice',
relationImportMatch: 'invoiceNo',
required: true,
importHint: 'Matches the invoice number.',
importHint: 'payment_receive.field.invoice_hint',
},
paymentAmount: {
name: 'payment_receive.field.entries.payment_amount',
@@ -199,7 +199,7 @@ export const PaymentReceivedMeta = {
},
},
branchId: {
name: 'Branch',
name: 'invoice.field.branch',
fieldType: 'relation',
relationModel: 'Branch',
relationImportMatch: ['name', 'code'],

View File

@@ -11,6 +11,7 @@ export class PaymentReceiveTransfromer extends Transformer {
public includeAttributes = (): string[] => {
return [
'subtotalFormatted',
'formatttedTotal',
'formattedPaymentDate',
'formattedCreatedAt',
'formattedAmount',
@@ -45,7 +46,18 @@ export class PaymentReceiveTransfromer extends Transformer {
protected subtotalFormatted = (payment: PaymentReceived): string => {
return this.formatNumber(payment.amount, {
currencyCode: payment.currencyCode,
money: false,
});
};
/**
* Retrieves the formatted total.
* @param {PaymentReceived} payment
* @returns {string}
*/
protected formatttedTotal = (payment: PaymentReceived): string => {
return this.formatNumber(payment.amount, {
currencyCode: payment.currencyCode,
money: true,
});
};
@@ -66,7 +78,7 @@ export class PaymentReceiveTransfromer extends Transformer {
* @returns {string}
*/
protected formattedExchangeRate = (payment: PaymentReceived): string => {
return this.formatNumber(payment.exchangeRate, { money: false });
return this.formatNumber(payment.exchangeRate);
};
/**

View File

@@ -1,5 +1,6 @@
import { ModuleRef } from '@nestjs/core';
import { pickBy } from 'lodash';
import { pickBy, mapValues } from 'lodash';
import { I18nService } from 'nestjs-i18n';
import { WarehousesSettings } from '../Warehouses/WarehousesSettings';
import { Injectable } from '@nestjs/common';
import { BranchesSettingsService } from '../Branches/BranchesSettings';
@@ -20,7 +21,8 @@ export class ResourceService {
private readonly branchesSettings: BranchesSettingsService,
private readonly warehousesSettings: WarehousesSettings,
private readonly moduleRef: ModuleRef,
) {}
private readonly i18nService: I18nService,
) { }
/**
* Retrieve resource model object.
@@ -96,7 +98,45 @@ export class ResourceService {
};
/**
* Retrieve the resource fields.
* Localizes a single field by translating its name and importHint.
* @param {IModelMetaField2} field - The field to localize.
* @returns {IModelMetaField2} - The localized field.
*/
private localizeField(field: IModelMetaField2): IModelMetaField2 {
const localizedField = {
...field,
name: this.i18nService.t(field.name, { defaultValue: field.name }),
} as IModelMetaField2;
if (field.importHint) {
localizedField.importHint = this.i18nService.t(field.importHint, {
defaultValue: field.importHint,
});
}
// Recursively localize nested fields (for collection types)
if (field.fields) {
localizedField.fields = this.localizeFields(
field.fields as unknown as Record<string, IModelMetaField2>,
) as unknown as typeof field.fields;
}
return localizedField;
}
/**
* Localizes all fields in a fields map.
* @param {Record<string, IModelMetaField2>} fields - The fields to localize.
* @returns {Record<string, IModelMetaField2>} - The localized fields.
*/
private localizeFields(
fields: Record<string, IModelMetaField2>,
): Record<string, IModelMetaField2> {
return mapValues(fields, (field) => this.localizeField(field));
}
/**
* Retrieve the resource fields with localized names and hints.
* @param {string} modelName
* @returns {IModelMetaField2}
*/
@@ -104,8 +144,11 @@ export class ResourceService {
[key: string]: IModelMetaField2;
} {
const meta = this.getResourceMeta(modelName);
const filteredFields = this.filterSupportFeatures(meta.fields2);
return this.filterSupportFeatures(meta.fields2);
return this.localizeFields(
filteredFields as Record<string, IModelMetaField2>,
);
}
/**

View File

@@ -191,52 +191,52 @@ export const SaleEstimateMeta = {
},
fields2: {
customerId: {
name: 'Customer',
name: 'estimate.field.customer',
fieldType: 'relation',
relationModel: 'Contact',
relationImportMatch: ['displayName'],
required: true,
},
estimateDate: {
name: 'Estimate Date',
name: 'estimate.field.estimate_date',
fieldType: 'date',
required: true,
},
expirationDate: {
name: 'Expiration Date',
name: 'estimate.field.expiration_date',
fieldType: 'date',
required: true,
},
estimateNumber: {
name: 'Estimate No.',
name: 'estimate.field.estimate_number',
fieldType: 'text',
},
reference: {
name: 'Reference No.',
name: 'estimate.field.reference_no',
fieldType: 'text',
},
exchangeRate: {
name: 'Exchange Rate',
name: 'estimate.field.exchange_rate',
fieldType: 'number',
},
currencyCode: {
name: 'Currency',
name: 'estimate.field.currency',
fieldType: 'text',
},
note: {
name: 'Note',
name: 'estimate.field.note',
fieldType: 'text',
},
termsConditions: {
name: 'Terms & Conditions',
name: 'estimate.field.terms_conditions',
fieldType: 'text',
},
delivered: {
name: 'Delivered',
name: 'estimate.field.delivered',
type: 'boolean',
},
entries: {
name: 'Entries',
name: 'estimate.field.entries',
fieldType: 'collection',
collectionOf: 'object',
collectionMinLength: 1,
@@ -248,7 +248,7 @@ export const SaleEstimateMeta = {
relationModel: 'Item',
relationImportMatch: ['name', 'code'],
required: true,
importHint: 'Matches the item name or code.',
importHint: 'invoice.field.item_hint',
},
rate: {
name: 'invoice.field.rate',
@@ -261,13 +261,13 @@ export const SaleEstimateMeta = {
required: true,
},
description: {
name: 'Line Description',
name: 'invoice.field.description',
fieldType: 'text',
},
},
},
branchId: {
name: 'Branch',
name: 'invoice.field.branch',
fieldType: 'relation',
relationModel: 'Branch',
relationImportMatch: ['name', 'code'],
@@ -275,7 +275,7 @@ export const SaleEstimateMeta = {
required: true,
},
warehouseId: {
name: 'Warehouse',
name: 'invoice.field.warehouse',
fieldType: 'relation',
relationModel: 'Warehouse',
relationImportMatch: ['name', 'code'],

View File

@@ -17,7 +17,7 @@ export class SaleEstimateTransfromer extends Transformer {
'formattedDeliveredAtDate',
'formattedApprovedAtDate',
'formattedRejectedAtDate',
'discountAmountFormatted',
'discountPercentageFormatted',
'adjustmentFormatted',
@@ -135,7 +135,7 @@ export class SaleEstimateTransfromer extends Transformer {
* @returns {string}
*/
protected adjustmentFormatted = (estimate: SaleEstimate): string => {
return this.formatMoney(estimate.adjustment, {
return this.formatNumber(estimate.adjustment, {
currencyCode: estimate.currencyCode,
excerptZero: true,
});

View File

@@ -19,7 +19,7 @@ export class SaleInvoiceCostGLEntries {
private readonly inventoryCostLotTracker: TenantModelProxy<
typeof InventoryCostLotTracker
>,
) {}
) { }
/**
* Writes journal entries from sales invoices.

View File

@@ -5,10 +5,10 @@ import { Importable } from '@/modules/Import/Importable';
import { CreateSaleInvoiceDto } from '../dtos/SaleInvoice.dto';
import { SaleInvoicesSampleData } from '../constants';
import { ImportableService } from '@/modules/Import/decorators/Import.decorator';
import { ManualJournal } from '@/modules/ManualJournals/models/ManualJournal';
import { SaleInvoice } from '../models/SaleInvoice';
@Injectable()
@ImportableService({ name: ManualJournal.name })
@ImportableService({ name: SaleInvoice.name })
export class SaleInvoicesImportable extends Importable {
constructor(private readonly createInvoiceService: CreateSaleInvoice) {
super();

View File

@@ -259,7 +259,7 @@ export const SaleInvoiceMeta = {
relationModel: 'Item',
relationImportMatch: ['name', 'code'],
required: true,
importHint: 'Matches the item name or code.',
importHint: 'invoice.field.item_hint',
},
rate: {
name: 'invoice.field.rate',
@@ -283,7 +283,7 @@ export const SaleInvoiceMeta = {
printable: false,
},
branchId: {
name: 'Branch',
name: 'invoice.field.branch',
fieldType: 'relation',
relationModel: 'Branch',
relationImportMatch: ['name', 'code'],
@@ -291,7 +291,7 @@ export const SaleInvoiceMeta = {
required: true,
},
warehouseId: {
name: 'Warehouse',
name: 'invoice.field.warehouse',
fieldType: 'relation',
relationModel: 'Warehouse',
relationImportMatch: ['name', 'code'],

View File

@@ -70,6 +70,7 @@ export class SaleInvoiceTransformer extends Transformer {
protected dueAmountFormatted = (invoice: SaleInvoice): string => {
return this.formatNumber(invoice.dueAmount, {
currencyCode: invoice.currencyCode,
money: true
});
};
@@ -113,7 +114,6 @@ export class SaleInvoiceTransformer extends Transformer {
protected subtotalFormatted = (invoice: SaleInvoice): string => {
return this.formatNumber(invoice.subtotal, {
currencyCode: this.context.organization.baseCurrency,
money: false,
});
};
@@ -170,6 +170,7 @@ export class SaleInvoiceTransformer extends Transformer {
protected totalFormatted = (invoice: SaleInvoice): string => {
return this.formatNumber(invoice.total, {
currencyCode: invoice.currencyCode,
money: true
});
};
@@ -212,7 +213,7 @@ export class SaleInvoiceTransformer extends Transformer {
* @returns {string}
*/
protected adjustmentFormatted = (invoice: SaleInvoice): string => {
return this.formatMoney(invoice.adjustment, {
return this.formatNumber(invoice.adjustment, {
currencyCode: invoice.currencyCode,
})
}

View File

@@ -10,7 +10,7 @@ import { events } from '@/common/events/events';
@Injectable()
export class InvoiceGLEntriesSubscriber {
constructor(public readonly saleInvoiceGLEntries: SaleInvoiceGLEntries) {}
constructor(public readonly saleInvoiceGLEntries: SaleInvoiceGLEntries) { }
/**
* Records journal entries of the non-inventory invoice.

View File

@@ -186,42 +186,42 @@ export const SaleReceiptMeta = {
},
fields2: {
receiptDate: {
name: 'Receipt Date',
name: 'receipt.field.receipt_date',
fieldType: 'date',
required: true,
},
customerId: {
name: 'Customer',
name: 'receipt.field.customer',
fieldType: 'relation',
relationModel: 'Contact',
relationImportMatch: 'displayName',
required: true,
},
depositAccountId: {
name: 'Deposit Account',
name: 'receipt.field.deposit_account',
fieldType: 'relation',
relationModel: 'Account',
relationImportMatch: ['name', 'code'],
required: true,
},
exchangeRate: {
name: 'Exchange Rate',
name: 'receipt.field.exchange_rate',
fieldType: 'number',
},
receiptNumber: {
name: 'Receipt Number',
name: 'receipt.field.receipt_number',
fieldType: 'text',
},
referenceNo: {
name: 'Reference No.',
name: 'receipt.field.reference_no',
fieldType: 'text',
},
closed: {
name: 'Closed',
name: 'receipt.field.closed',
fieldType: 'boolean',
},
entries: {
name: 'Entries',
name: 'receipt.field.entries',
fieldType: 'collection',
collectionOf: 'object',
collectionMinLength: 1,
@@ -233,7 +233,7 @@ export const SaleReceiptMeta = {
relationModel: 'Item',
relationImportMatch: ['name', 'code'],
required: true,
importHint: 'Matches the item name or code.',
importHint: 'invoice.field.item_hint',
},
rate: {
name: 'invoice.field.rate',
@@ -252,15 +252,15 @@ export const SaleReceiptMeta = {
},
},
statement: {
name: 'Statement',
name: 'receipt.field.statement',
fieldType: 'text',
},
receiptMessage: {
name: 'Receipt Message',
name: 'receipt.field.receipt_message',
fieldType: 'text',
},
branchId: {
name: 'Branch',
name: 'invoice.field.branch',
fieldType: 'relation',
relationModel: 'Branch',
relationImportMatch: ['name', 'code'],
@@ -268,7 +268,7 @@ export const SaleReceiptMeta = {
required: true,
},
warehouseId: {
name: 'Warehouse',
name: 'invoice.field.warehouse',
fieldType: 'relation',
relationModel: 'Warehouse',
relationImportMatch: ['name', 'code'],

View File

@@ -107,4 +107,4 @@ const modelProviders = models.map((model) => RegisterTenancyModel(model));
imports: [...modelProviders],
exports: [...modelProviders],
})
export class TenancyModelsModule {}
export class TenancyModelsModule { }

View File

@@ -26,7 +26,7 @@ export class TransactionsLockingService {
constructor(
private readonly transactionsLockingRepo: TransactionsLockingRepository,
private readonly eventPublisher: EventEmitter2,
) {}
) { }
/**
* Enable/disable all transacations locking.

View File

@@ -203,6 +203,7 @@ export class Transformer<T = {}, ExtraContext = {}> {
protected formatMoney(money, options?) {
return formatNumber(money, {
currencyCode: this.context.organization.baseCurrency,
money: true,
...options,
});
}

View File

@@ -177,70 +177,70 @@ export const VendorCreditMeta = {
},
fields2: {
vendorId: {
name: 'Vendor',
name: 'vendor_credit.field.vendor',
fieldType: 'relation',
relationModel: 'Contact',
relationImportMatch: 'displayName',
required: true,
},
exchangeRate: {
name: 'Echange Rate',
name: 'vendor_credit.field.exchange_rate',
fieldType: 'text',
},
vendorCreditNumber: {
name: 'Vendor Credit No.',
name: 'vendor_credit.field.vendor_credit_number',
fieldType: 'text',
},
referenceNo: {
name: 'Refernece No.',
name: 'vendor_credit.field.reference_no',
fieldType: 'text',
},
vendorCreditDate: {
name: 'Vendor Credit Date',
name: 'vendor_credit.field.vendor_credit_date',
fieldType: 'date',
required: true,
},
note: {
name: 'Note',
name: 'vendor_credit.field.note',
fieldType: 'text',
},
open: {
name: 'Open',
name: 'vendor_credit.field.open',
fieldType: 'boolean',
},
entries: {
name: 'Entries',
name: 'vendor_credit.field.entries',
fieldType: 'collection',
collectionOf: 'object',
collectionMinLength: 1,
required: true,
fields: {
itemId: {
name: 'Item Name',
name: 'vendor_credit.field.item',
fieldType: 'relation',
relationModel: 'Item',
relationImportMatch: ['name', 'code'],
required: true,
importHint: 'Matches the item name or code.',
importHint: 'invoice.field.item_hint',
},
rate: {
name: 'Rate',
name: 'vendor_credit.field.rate',
fieldType: 'number',
required: true,
},
quantity: {
name: 'Quantity',
name: 'vendor_credit.field.quantity',
fieldType: 'number',
required: true,
},
description: {
name: 'Description',
name: 'vendor_credit.field.description',
fieldType: 'text',
},
},
},
branchId: {
name: 'Branch',
name: 'invoice.field.branch',
fieldType: 'relation',
relationModel: 'Branch',
relationImportMatch: ['name', 'code'],
@@ -248,7 +248,7 @@ export const VendorCreditMeta = {
required: true
},
warehouseId: {
name: 'Warehouse',
name: 'invoice.field.warehouse',
fieldType: 'relation',
relationModel: 'Warehouse',
relationImportMatch: ['name', 'code'],

View File

@@ -2,19 +2,35 @@ import { Injectable } from '@nestjs/common';
import { DeleteRefundVendorCreditService } from './commands/DeleteRefundVendorCredit.service';
import { RefundVendorCredit } from './models/RefundVendorCredit';
import { CreateRefundVendorCredit } from './commands/CreateRefundVendorCredit.service';
import { IRefundVendorCreditDTO } from './types/VendorCreditRefund.types';
import { RefundVendorCreditDto } from './dtos/RefundVendorCredit.dto';
import { GetRefundVendorCreditsService } from './queries/GetRefundVendorCredits.service';
import { IRefundVendorCreditPOJO } from './types/VendorCreditRefund.types';
@Injectable()
export class VendorCreditsRefundApplication {
/**
* @param {CreateRefundVendorCredit} createRefundVendorCreditService
* @param {DeleteRefundVendorCreditService} deleteRefundVendorCreditService
* @param {GetRefundVendorCreditsService} getRefundVendorCreditsService
*/
constructor(
private readonly createRefundVendorCreditService: CreateRefundVendorCredit,
private readonly deleteRefundVendorCreditService: DeleteRefundVendorCreditService,
) {}
private readonly getRefundVendorCreditsService: GetRefundVendorCreditsService,
) { }
/**
* Retrieve the vendor credit refunds graph.
* @param {number} vendorCreditId - Vendor credit id.
* @returns {Promise<IRefundVendorCreditPOJO[]>}
*/
public getVendorCreditRefunds(
vendorCreditId: number,
): Promise<IRefundVendorCreditPOJO[]> {
return this.getRefundVendorCreditsService.getVendorCreditRefunds(
vendorCreditId,
);
}
/**
* Creates a refund vendor credit.

View File

@@ -1,4 +1,4 @@
import { Body, Controller, Delete, Param, Post } from '@nestjs/common';
import { Body, Controller, Delete, Get, Param, Post } from '@nestjs/common';
import { VendorCreditsRefundApplication } from './VendorCreditsRefund.application';
import { RefundVendorCredit } from './models/RefundVendorCredit';
import { ApiOperation, ApiTags } from '@nestjs/swagger';
@@ -9,7 +9,22 @@ import { RefundVendorCreditDto } from './dtos/RefundVendorCredit.dto';
export class VendorCreditsRefundController {
constructor(
private readonly vendorCreditsRefundApplication: VendorCreditsRefundApplication,
) {}
) { }
/**
* Retrieve the vendor credit refunds graph.
* @param {number} vendorCreditId - Vendor credit id.
* @returns {Promise<IRefundVendorCreditPOJO[]>}
*/
@Get(':vendorCreditId/refund')
@ApiOperation({ summary: 'Retrieve the vendor credit refunds graph.' })
public getVendorCreditRefunds(
@Param('vendorCreditId') vendorCreditId: string,
) {
return this.vendorCreditsRefundApplication.getVendorCreditRefunds(
Number(vendorCreditId),
);
}
/**
* Creates a refund vendor credit.
@@ -17,7 +32,7 @@ export class VendorCreditsRefundController {
* @param {IRefundVendorCreditDTO} refundVendorCreditDTO
* @returns {Promise<RefundVendorCredit>}
*/
@Post(':vendorCreditId/refunds')
@Post(':vendorCreditId/refund')
@ApiOperation({ summary: 'Create a refund for the given vendor credit.' })
public async createRefundVendorCredit(
@Param('vendorCreditId') vendorCreditId: string,

View File

@@ -1,10 +1,12 @@
import { IsOptional, ToNumber } from '@/common/decorators/Validators';
import { ApiProperty } from '@nestjs/swagger';
import { Min } from 'class-validator';
import { IsDateString, Min } from 'class-validator';
import { IsString } from 'class-validator';
import { IsDate } from 'class-validator';
import { IsNotEmpty, IsNumber, IsOptional, IsPositive } from 'class-validator';
import { IsNotEmpty, IsNumber, IsPositive } from 'class-validator';
export class RefundVendorCreditDto {
@ToNumber()
@IsNumber()
@IsNotEmpty()
@Min(0)
@@ -32,6 +34,7 @@ export class RefundVendorCreditDto {
})
depositAccountId: number;
@IsOptional()
@IsString()
@IsNotEmpty()
@ApiProperty({
@@ -40,7 +43,7 @@ export class RefundVendorCreditDto {
})
description: string;
@IsDate()
@IsDateString()
@IsNotEmpty()
@ApiProperty({
description: 'The date of the refund',

View File

@@ -1,116 +1,115 @@
import { Injectable } from '@nestjs/common';
import { AccountNormal } from '@/interfaces/Account';
import { ILedgerEntry } from '@/modules/Ledger/types/Ledger.types';
import { Ledger } from '@/modules/Ledger/Ledger';
import { Vendor } from './models/Vendor';
// import { Service } from 'typedi';
// import { IVendor, AccountNormal, ILedgerEntry } from '@/interfaces';
// import Ledger from '@/services/Accounting/Ledger';
@Injectable()
export class VendorGLEntries {
/**
* Retrieves the opening balance GL common entry.
* @param {Vendor} vendor -
*/
private getOpeningBalanceGLCommonEntry = (vendor: Vendor) => {
return {
exchangeRate: vendor.openingBalanceExchangeRate,
currencyCode: vendor.currencyCode,
// @Service()
// export class VendorGLEntries {
// /**
// * Retrieves the opening balance GL common entry.
// * @param {IVendor} vendor -
// */
// private getOpeningBalanceGLCommonEntry = (vendor: IVendor) => {
// return {
// exchangeRate: vendor.openingBalanceExchangeRate,
// currencyCode: vendor.currencyCode,
transactionType: 'VendorOpeningBalance',
transactionId: vendor.id,
// transactionType: 'VendorOpeningBalance',
// transactionId: vendor.id,
date: vendor.openingBalanceAt,
contactId: vendor.id,
// date: vendor.openingBalanceAt,
// userId: vendor.userId,
// contactId: vendor.id,
credit: 0,
debit: 0,
// credit: 0,
// debit: 0,
branchId: vendor.openingBalanceBranchId,
};
};
// branchId: vendor.openingBalanceBranchId,
// };
// };
/**
* Retrieves the opening balance GL debit entry.
* @param {number} costAccountId -
* @param {Vendor} vendor
* @returns {ILedgerEntry}
*/
private getOpeningBalanceGLDebitEntry = (
costAccountId: number,
vendor: Vendor
): ILedgerEntry => {
const commonEntry = this.getOpeningBalanceGLCommonEntry(vendor);
// /**
// * Retrieves the opening balance GL debit entry.
// * @param {number} costAccountId -
// * @param {IVendor} vendor
// * @returns {ILedgerEntry}
// */
// private getOpeningBalanceGLDebitEntry = (
// costAccountId: number,
// vendor: IVendor
// ): ILedgerEntry => {
// const commonEntry = this.getOpeningBalanceGLCommonEntry(vendor);
return {
...commonEntry,
accountId: costAccountId,
accountNormal: AccountNormal.DEBIT,
debit: vendor.localOpeningBalance,
credit: 0,
index: 2,
};
};
// return {
// ...commonEntry,
// accountId: costAccountId,
// accountNormal: AccountNormal.DEBIT,
// debit: vendor.localOpeningBalance,
// credit: 0,
// index: 2,
// };
// };
/**
* Retrieves the opening balance GL credit entry.
* @param {number} APAccountId
* @param {Vendor} vendor
* @returns {ILedgerEntry}
*/
private getOpeningBalanceGLCreditEntry = (
APAccountId: number,
vendor: Vendor
): ILedgerEntry => {
const commonEntry = this.getOpeningBalanceGLCommonEntry(vendor);
// /**
// * Retrieves the opening balance GL credit entry.
// * @param {number} APAccountId
// * @param {IVendor} vendor
// * @returns {ILedgerEntry}
// */
// private getOpeningBalanceGLCreditEntry = (
// APAccountId: number,
// vendor: IVendor
// ): ILedgerEntry => {
// const commonEntry = this.getOpeningBalanceGLCommonEntry(vendor);
return {
...commonEntry,
accountId: APAccountId,
accountNormal: AccountNormal.CREDIT,
credit: vendor.localOpeningBalance,
index: 1,
};
};
// return {
// ...commonEntry,
// accountId: APAccountId,
// accountNormal: AccountNormal.CREDIT,
// credit: vendor.localOpeningBalance,
// index: 1,
// };
// };
/**
* Retrieves the opening balance GL entries.
* @param {number} APAccountId
* @param {number} costAccountId -
* @param {Vendor} vendor
* @returns {ILedgerEntry[]}
*/
public getOpeningBalanceGLEntries = (
APAccountId: number,
costAccountId: number,
vendor: Vendor
): ILedgerEntry[] => {
const debitEntry = this.getOpeningBalanceGLDebitEntry(
costAccountId,
vendor
);
const creditEntry = this.getOpeningBalanceGLCreditEntry(
APAccountId,
vendor
);
return [debitEntry, creditEntry];
};
// /**
// * Retrieves the opening balance GL entries.
// * @param {number} APAccountId
// * @param {number} costAccountId -
// * @param {IVendor} vendor
// * @returns {ILedgerEntry[]}
// */
// public getOpeningBalanceGLEntries = (
// APAccountId: number,
// costAccountId: number,
// vendor: IVendor
// ): ILedgerEntry[] => {
// const debitEntry = this.getOpeningBalanceGLDebitEntry(
// costAccountId,
// vendor
// );
// const creditEntry = this.getOpeningBalanceGLCreditEntry(
// APAccountId,
// vendor
// );
// return [debitEntry, creditEntry];
// };
/**
* Retrieves the opening balance ledger.
* @param {number} APAccountId
* @param {number} costAccountId -
* @param {Vendor} vendor
* @returns {Ledger}
*/
public getOpeningBalanceLedger = (
APAccountId: number,
costAccountId: number,
vendor: Vendor
) => {
const entries = this.getOpeningBalanceGLEntries(
APAccountId,
costAccountId,
vendor
);
return new Ledger(entries);
};
}
// /**
// * Retrieves the opening balance ledger.
// * @param {number} APAccountId
// * @param {number} costAccountId -
// * @param {IVendor} vendor
// * @returns {Ledger}
// */
// public getOpeningBalanceLedger = (
// APAccountId: number,
// costAccountId: number,
// vendor: IVendor
// ) => {
// const entries = this.getOpeningBalanceGLEntries(
// APAccountId,
// costAccountId,
// vendor
// );
// return new Ledger(entries);
// };
// }

View File

@@ -1,86 +1,88 @@
import { Knex } from 'knex';
import { Inject, Injectable } from '@nestjs/common';
import { LedgerStorageService } from '@/modules/Ledger/LedgerStorage.service';
import { AccountRepository } from '@/modules/Accounts/repositories/Account.repository';
import { VendorGLEntries } from './VendorGLEntries';
import { Vendor } from './models/Vendor';
import { TenantModelProxy } from '@/modules/System/models/TenantBaseModel';
// import { Knex } from 'knex';
// import { Service, Inject } from 'typedi';
// import LedgerStorageService from '@/services/Accounting/LedgerStorageService';
// import HasTenancyService from '@/services/Tenancy/TenancyService';
// import { VendorGLEntries } from './VendorGLEntries';
@Injectable()
export class VendorGLEntriesStorage {
constructor(
private readonly ledgerStorage: LedgerStorageService,
private readonly accountRepository: AccountRepository,
private readonly vendorGLEntries: VendorGLEntries,
// @Service()
// export class VendorGLEntriesStorage {
// @Inject()
// private tenancy: HasTenancyService;
@Inject(Vendor.name)
private readonly vendorModel: TenantModelProxy<typeof Vendor>,
) { }
// @Inject()
// private ledegrRepository: LedgerStorageService;
/**
* Vendor opening balance journals.
* @param {number} vendorId
* @param {Knex.Transaction} trx
*/
public writeVendorOpeningBalance = async (
vendorId: number,
trx?: Knex.Transaction,
) => {
const vendor = await this.vendorModel()
.query(trx)
.findById(vendorId);
// @Inject()
// private vendorGLEntries: VendorGLEntries;
// Finds the expense account.
const expenseAccount = await this.accountRepository.findOrCreateOtherExpensesAccount(
{},
trx,
);
// Find or create the A/P account.
const APAccount =
await this.accountRepository.findOrCreateAccountsPayable(
vendor.currencyCode,
{},
trx,
);
// Retrieves the vendor opening balance ledger.
const ledger = this.vendorGLEntries.getOpeningBalanceLedger(
APAccount.id,
expenseAccount.id,
vendor,
);
// Commits the ledger entries to the storage.
await this.ledgerStorage.commit(ledger, trx);
};
// /**
// * Vendor opening balance journals.
// * @param {number} tenantId
// * @param {number} vendorId
// * @param {Knex.Transaction} trx
// */
// public writeVendorOpeningBalance = async (
// tenantId: number,
// vendorId: number,
// trx?: Knex.Transaction
// ) => {
// const { Vendor } = this.tenancy.models(tenantId);
// const { accountRepository } = this.tenancy.repositories(tenantId);
/**
* Reverts the vendor opening balance GL entries.
* @param {number} vendorId
* @param {Knex.Transaction} trx
*/
public revertVendorOpeningBalance = async (
vendorId: number,
trx?: Knex.Transaction,
) => {
await this.ledgerStorage.deleteByReference(
vendorId,
'VendorOpeningBalance',
trx,
);
};
// const vendor = await Vendor.query(trx).findById(vendorId);
/**
* Writes the vendor opening balance GL entries.
* @param {number} vendorId
* @param {Knex.Transaction} trx
*/
public rewriteVendorOpeningBalance = async (
vendorId: number,
trx?: Knex.Transaction,
) => {
// Reverts the vendor opening balance entries first.
await this.revertVendorOpeningBalance(vendorId, trx);
// // Finds the expense account.
// const expenseAccount = await accountRepository.findOne({
// slug: 'other-expenses',
// });
// // Find or create the A/P account.
// const APAccount = await accountRepository.findOrCreateAccountsPayable(
// vendor.currencyCode,
// {},
// trx
// );
// // Retrieves the vendor opening balance ledger.
// const ledger = this.vendorGLEntries.getOpeningBalanceLedger(
// APAccount.id,
// expenseAccount.id,
// vendor
// );
// // Commits the ledger entries to the storage.
// await this.ledegrRepository.commit(tenantId, ledger, trx);
// };
// Write the vendor opening balance entries.
await this.writeVendorOpeningBalance(vendorId, trx);
};
}
// /**
// * Reverts the vendor opening balance GL entries.
// * @param {number} tenantId
// * @param {number} vendorId
// * @param {Knex.Transaction} trx
// */
// public revertVendorOpeningBalance = async (
// tenantId: number,
// vendorId: number,
// trx?: Knex.Transaction
// ) => {
// await this.ledegrRepository.deleteByReference(
// tenantId,
// vendorId,
// 'VendorOpeningBalance',
// trx
// );
// };
// /**
// * Writes the vendor opening balance GL entries.
// * @param {number} tenantId
// * @param {number} vendorId
// * @param {Knex.Transaction} trx
// */
// public rewriteVendorOpeningBalance = async (
// tenantId: number,
// vendorId: number,
// trx?: Knex.Transaction
// ) => {
// await this.writeVendorOpeningBalance(tenantId, vendorId, trx);
// await this.revertVendorOpeningBalance(tenantId, vendorId, trx);
// };
// }

View File

@@ -9,7 +9,10 @@ import {
Query,
} from '@nestjs/common';
import { VendorsApplication } from './VendorsApplication.service';
import { VendorOpeningBalanceEditDto } from './dtos/VendorOpeningBalanceEdit.dto';
import {
IVendorOpeningBalanceEditDTO,
IVendorsFilter,
} from './types/Vendors.types';
import {
ApiOperation,
ApiResponse,
@@ -65,7 +68,7 @@ export class VendorsController {
@ApiOperation({ summary: 'Edit the given vendor opening balance.' })
editOpeningBalance(
@Param('id') vendorId: number,
@Body() openingBalanceDTO: VendorOpeningBalanceEditDto,
@Body() openingBalanceDTO: IVendorOpeningBalanceEditDTO,
) {
return this.vendorsApplication.editOpeningBalance(
vendorId,

View File

@@ -18,14 +18,9 @@ import { VendorsExportable } from './VendorsExportable';
import { VendorsImportable } from './VendorsImportable';
import { BulkDeleteVendorsService } from './BulkDeleteVendors.service';
import { ValidateBulkDeleteVendorsService } from './ValidateBulkDeleteVendors.service';
import { LedgerModule } from '../Ledger/Ledger.module';
import { AccountsModule } from '../Accounts/Accounts.module';
import { VendorGLEntries } from './VendorGLEntries';
import { VendorGLEntriesStorage } from './VendorGLEntriesStorage';
import { VendorsWriteGLOpeningSubscriber } from './subscribers/VendorGLEntriesSubscriber';
@Module({
imports: [TenancyDatabaseModule, DynamicListModule, LedgerModule, AccountsModule],
imports: [TenancyDatabaseModule, DynamicListModule],
controllers: [VendorsController],
providers: [
ActivateVendorService,
@@ -43,10 +38,7 @@ import { VendorsWriteGLOpeningSubscriber } from './subscribers/VendorGLEntriesSu
TransformerInjectable,
TenancyContext,
VendorsExportable,
VendorsImportable,
VendorGLEntries,
VendorGLEntriesStorage,
VendorsWriteGLOpeningSubscriber,
VendorsImportable
],
})
export class VendorsModule { }
export class VendorsModule {}

View File

@@ -5,7 +5,10 @@ import { EditVendorService } from './commands/EditVendor.service';
import { DeleteVendorService } from './commands/DeleteVendor.service';
import { EditOpeningBalanceVendorService } from './commands/EditOpeningBalanceVendor.service';
import { GetVendorService } from './queries/GetVendor';
import { VendorOpeningBalanceEditDto } from './dtos/VendorOpeningBalanceEdit.dto';
import {
IVendorOpeningBalanceEditDTO,
IVendorsFilter,
} from './types/Vendors.types';
import { GetVendorsService } from './queries/GetVendors.service';
import { CreateVendorDto } from './dtos/CreateVendor.dto';
import { EditVendorDto } from './dtos/EditVendor.dto';
@@ -55,14 +58,14 @@ export class VendorsApplication {
}
/**
* Changes the opening balance of the given vendor.
* @param {number} vendorId
* @param {VendorOpeningBalanceEditDto} openingBalanceEditDTO
* Changes the opening balance of the given customer.
* @param {number} vendorId
* @param {IVendorOpeningBalanceEditDTO} openingBalanceEditDTO
* @returns {Promise<IVendor>}
*/
public editOpeningBalance(
vendorId: number,
openingBalanceEditDTO: VendorOpeningBalanceEditDto,
openingBalanceEditDTO: IVendorOpeningBalanceEditDTO,
) {
return this.editOpeningBalanceService.editOpeningBalance(
vendorId,
@@ -92,7 +95,10 @@ export class VendorsApplication {
vendorIds: number[],
options?: { skipUndeletable?: boolean },
) {
return this.bulkDeleteVendorsService.bulkDeleteVendors(vendorIds, options);
return this.bulkDeleteVendorsService.bulkDeleteVendors(
vendorIds,
options,
);
}
public validateBulkDeleteVendors(vendorIds: number[]) {

View File

@@ -2,10 +2,10 @@ import { Knex } from 'knex';
import { Inject, Injectable } from '@nestjs/common';
import { EventEmitter2 } from '@nestjs/event-emitter';
import {
IVendorOpeningBalanceEditDTO,
IVendorOpeningBalanceEditedPayload,
IVendorOpeningBalanceEditingPayload,
} from '../types/Vendors.types';
import { VendorOpeningBalanceEditDto } from '../dtos/VendorOpeningBalanceEdit.dto';
import { UnitOfWork } from '@/modules/Tenancy/TenancyDB/UnitOfWork.service';
import { Vendor } from '../models/Vendor';
import { events } from '@/common/events/events';
@@ -29,12 +29,12 @@ export class EditOpeningBalanceVendorService {
/**
* Changes the opening balance of the given customer.
* @param {number} vendorId
* @param {VendorOpeningBalanceEditDto} openingBalanceEditDTO
* @param {IVendorOpeningBalanceEditDTO} openingBalanceEditDTO
* @returns {Promise<IVendor>}
*/
public async editOpeningBalance(
vendorId: number,
openingBalanceEditDTO: VendorOpeningBalanceEditDto,
openingBalanceEditDTO: IVendorOpeningBalanceEditDTO,
) {
// Retrieves the old vendor or throw not found error.
const oldVendor = await this.vendorModel()

View File

@@ -2,13 +2,11 @@ import { ApiProperty } from '@nestjs/swagger';
import {
IsISO8601,
IsInt,
IsNotEmpty,
IsNumber,
Min,
IsBoolean,
IsEmail,
IsString,
ValidateIf,
} from 'class-validator';
import { ContactAddressDto } from '@/modules/Customers/dtos/ContactAddress.dto';
import { IsOptional, ToNumber } from '@/common/decorators/Validators';
@@ -32,12 +30,8 @@ export class CreateVendorDto extends ContactAddressDto {
@ToNumber()
openingBalanceExchangeRate?: number;
@ApiProperty({
required: false,
description: 'Date of the opening balance (required when openingBalance is provided)',
})
@ValidateIf((o) => o.openingBalance != null)
@IsNotEmpty({ message: 'openingBalanceAt is required when openingBalance is provided' })
@ApiProperty({ required: false, description: 'Date of the opening balance' })
@IsOptional()
@IsISO8601()
openingBalanceAt?: Date;

View File

@@ -1,44 +0,0 @@
import { IsNotEmpty, IsNumber, IsString } from 'class-validator';
import { ApiProperty } from '@nestjs/swagger';
import { IsOptional, ToNumber } from '@/common/decorators/Validators';
export class VendorOpeningBalanceEditDto {
@ApiProperty({
required: true,
description: 'Opening balance',
example: 5000.0,
})
@IsNumber()
@IsNotEmpty()
@ToNumber()
openingBalance: number;
@ApiProperty({
required: false,
description: 'Opening balance date',
example: '2024-01-01',
})
@IsOptional()
@IsString()
openingBalanceAt?: string;
@ApiProperty({
required: false,
description: 'Opening balance exchange rate',
example: 1.0,
})
@IsOptional()
@IsNumber()
@ToNumber()
openingBalanceExchangeRate?: number;
@ApiProperty({
required: false,
description: 'Opening balance branch ID',
example: 101,
})
@IsOptional()
@IsNumber()
@ToNumber()
openingBalanceBranchId?: number;
}

View File

@@ -36,7 +36,6 @@ export class Vendor extends TenantBaseModel {
openingBalance: number;
openingBalanceExchangeRate: number;
openingBalanceAt: Date | string;
openingBalanceBranchId?: number;
salutation: string;
firstName: string;

View File

@@ -1,71 +1,91 @@
import { Injectable } from '@nestjs/common';
import { OnEvent } from '@nestjs/event-emitter';
import { events } from '@/common/events/events';
import { VendorGLEntriesStorage } from '../VendorGLEntriesStorage';
import {
IVendorEventCreatedPayload,
IVendorEventDeletedPayload,
IVendorOpeningBalanceEditedPayload,
} from '../types/Vendors.types';
// import { Inject, Service } from 'typedi';
// import events from '@/subscribers/events';
// import { VendorGLEntriesStorage } from '../VendorGLEntriesStorage';
// import {
// IVendorEventCreatedPayload,
// IVendorEventDeletedPayload,
// IVendorOpeningBalanceEditedPayload,
// } from '@/interfaces';
@Injectable()
export class VendorsWriteGLOpeningSubscriber {
constructor(
private readonly vendorGLEntriesStorage: VendorGLEntriesStorage,
) {}
// @Service()
// export class VendorsWriteGLOpeningSubscriber {
// @Inject()
// private vendorGLEntriesStorage: VendorGLEntriesStorage;
/**
* Writes the open balance journal entries once the vendor created.
* @param {IVendorEventCreatedPayload} payload -
*/
@OnEvent(events.vendors.onCreated)
public async handleWriteOpeningBalanceEntries({
vendor,
trx,
}: IVendorEventCreatedPayload) {
// Writes the vendor opening balance journal entries.
if (vendor.openingBalance) {
await this.vendorGLEntriesStorage.writeVendorOpeningBalance(
vendor.id,
trx,
);
}
}
// /**
// * Constructor method.
// */
// public attach(bus) {
// bus.subscribe(
// events.vendors.onCreated,
// this.handleWriteOpeningBalanceEntries
// );
// bus.subscribe(
// events.vendors.onDeleted,
// this.handleRevertOpeningBalanceEntries
// );
// bus.subscribe(
// events.vendors.onOpeningBalanceChanged,
// this.handleRewriteOpeningEntriesOnChanged
// );
// }
/**
* Revert the opening balance journal entries once the vendor deleted.
* @param {IVendorEventDeletedPayload} payload -
*/
@OnEvent(events.vendors.onDeleted)
public async handleRevertOpeningBalanceEntries({
vendorId,
trx,
}: IVendorEventDeletedPayload) {
await this.vendorGLEntriesStorage.revertVendorOpeningBalance(
vendorId,
trx,
);
}
// /**
// * Writes the open balance journal entries once the vendor created.
// * @param {IVendorEventCreatedPayload} payload -
// */
// private handleWriteOpeningBalanceEntries = async ({
// tenantId,
// vendor,
// trx,
// }: IVendorEventCreatedPayload) => {
// // Writes the vendor opening balance journal entries.
// if (vendor.openingBalance) {
// await this.vendorGLEntriesStorage.writeVendorOpeningBalance(
// tenantId,
// vendor.id,
// trx
// );
// }
// };
/**
* Handles the rewrite opening balance entries once opening balance changed.
* @param {IVendorOpeningBalanceEditedPayload} payload -
*/
@OnEvent(events.vendors.onOpeningBalanceChanged)
public async handleRewriteOpeningEntriesOnChanged({
vendor,
trx,
}: IVendorOpeningBalanceEditedPayload) {
if (vendor.openingBalance) {
await this.vendorGLEntriesStorage.rewriteVendorOpeningBalance(
vendor.id,
trx,
);
} else {
await this.vendorGLEntriesStorage.revertVendorOpeningBalance(
vendor.id,
trx,
);
}
}
}
// /**
// * Revert the opening balance journal entries once the vendor deleted.
// * @param {IVendorEventDeletedPayload} payload -
// */
// private handleRevertOpeningBalanceEntries = async ({
// tenantId,
// vendorId,
// trx,
// }: IVendorEventDeletedPayload) => {
// await this.vendorGLEntriesStorage.revertVendorOpeningBalance(
// tenantId,
// vendorId,
// trx
// );
// };
// /**
// * Handles the rewrite opening balance entries once opening balnace changed.
// * @param {ICustomerOpeningBalanceEditedPayload} payload -
// */
// private handleRewriteOpeningEntriesOnChanged = async ({
// tenantId,
// vendor,
// trx,
// }: IVendorOpeningBalanceEditedPayload) => {
// if (vendor.openingBalance) {
// await this.vendorGLEntriesStorage.rewriteVendorOpeningBalance(
// tenantId,
// vendor.id,
// trx
// );
// } else {
// await this.vendorGLEntriesStorage.revertVendorOpeningBalance(
// tenantId,
// vendor.id,
// trx
// );
// }
// };
// }

View File

@@ -7,7 +7,6 @@ import { IDynamicListFilter } from '@/modules/DynamicListing/DynamicFilter/Dynam
import { IFilterMeta, IPaginationMeta } from '@/interfaces/Model';
import { CreateVendorDto } from '../dtos/CreateVendor.dto';
import { EditVendorDto } from '../dtos/EditVendor.dto';
import { VendorOpeningBalanceEditDto } from '../dtos/VendorOpeningBalanceEdit.dto';
// ----------------------------------
export interface IVendorNewDTO extends IContactAddressDTO {
@@ -93,16 +92,23 @@ export interface IVendorEventEditedPayload {
trx?: Knex.Transaction;
}
export interface IVendorOpeningBalanceEditDTO {
openingBalance: number;
openingBalanceAt: Date | string;
openingBalanceExchangeRate: number;
openingBalanceBranchId?: number;
}
export interface IVendorOpeningBalanceEditingPayload {
oldVendor: Vendor;
openingBalanceEditDTO: VendorOpeningBalanceEditDto;
openingBalanceEditDTO: IVendorOpeningBalanceEditDTO;
trx?: Knex.Transaction;
}
export interface IVendorOpeningBalanceEditedPayload {
vendor: Vendor;
oldVendor: Vendor;
openingBalanceEditDTO: VendorOpeningBalanceEditDto;
openingBalanceEditDTO: IVendorOpeningBalanceEditDTO;
trx: Knex.Transaction;
}

Some files were not shown because too many files have changed in this diff Show More