}
+ */
+ public async sendMail(
+ tenantId: number,
+ saleInvoiceId: number,
+ messageOptions: SendInvoiceMailDTO
+ ) {
+ const localMessageOpts = await this.getMailOption(tenantId, saleInvoiceId);
+
+ const messageOpts = parseAndValidateMailOptions(
+ localMessageOpts,
+ messageOptions
+ );
+ const mail = new Mail()
+ .setSubject(messageOpts.subject)
+ .setTo(messageOpts.to)
+ .setContent(messageOpts.body);
+
+ if (messageOpts.attachInvoice) {
+ // Retrieves document buffer of the invoice pdf document.
+ const invoicePdfBuffer = await this.invoicePdf.saleInvoicePdf(
+ tenantId,
+ saleInvoiceId
+ );
+ mail.setAttachments([
+ { filename: 'invoice.pdf', content: invoicePdfBuffer },
+ ]);
+ }
+ // Triggers the event `onSaleInvoiceSend`.
+ await this.eventPublisher.emitAsync(events.saleInvoice.onMailReminderSend, {
+ saleInvoiceId,
+ messageOptions,
+ } as ISaleInvoiceMailSend);
+
+ await mail.send();
+
+ // Triggers the event `onSaleInvoiceSent`.
+ await this.eventPublisher.emitAsync(events.saleInvoice.onMailReminderSent, {
+ saleInvoiceId,
+ messageOptions,
+ } as ISaleInvoiceMailSent);
+ }
+}
diff --git a/packages/server/src/services/Sales/Invoices/SendSaleInvoiceMailReminderJob.ts b/packages/server/src/services/Sales/Invoices/SendSaleInvoiceMailReminderJob.ts
new file mode 100644
index 000000000..6570a153f
--- /dev/null
+++ b/packages/server/src/services/Sales/Invoices/SendSaleInvoiceMailReminderJob.ts
@@ -0,0 +1,32 @@
+import Container, { Service } from 'typedi';
+import { SendInvoiceMailReminder } from './SendSaleInvoiceMailReminder';
+
+@Service()
+export class SendSaleInvoiceReminderMailJob {
+ /**
+ * Constructor method.
+ */
+ constructor(agenda) {
+ agenda.define(
+ 'sale-invoice-reminder-mail-send',
+ { priority: 'high', concurrency: 1 },
+ this.handler
+ );
+ }
+
+ /**
+ * Triggers sending invoice mail.
+ */
+ private handler = async (job, done: Function) => {
+ const { tenantId, saleInvoiceId, messageOptions } = job.attrs.data;
+ const sendInvoiceMail = Container.get(SendInvoiceMailReminder);
+
+ try {
+ await sendInvoiceMail.sendMail(tenantId, saleInvoiceId, messageOptions);
+ done();
+ } catch (error) {
+ console.log(error);
+ done(error);
+ }
+ };
+}
diff --git a/packages/server/src/services/Sales/Invoices/constants.ts b/packages/server/src/services/Sales/Invoices/constants.ts
index 018dec027..404b7e613 100644
--- a/packages/server/src/services/Sales/Invoices/constants.ts
+++ b/packages/server/src/services/Sales/Invoices/constants.ts
@@ -1,3 +1,35 @@
+export const DEFAULT_INVOICE_MAIL_SUBJECT =
+ 'Invoice {InvoiceNumber} from {CompanyName}';
+export const DEFAULT_INVOICE_MAIL_CONTENT = `
+Dear {CustomerName}
+Thank you for your business, You can view or print your invoice from attachements.
+
+Invoice #{InvoiceNumber}
+Due Date : {InvoiceDueDate}
+Amount : {InvoiceAmount}
+
+
+
+Regards
+{CompanyName}
+
+`;
+
+export const DEFAULT_INVOICE_REMINDER_MAIL_SUBJECT =
+ 'Invoice {InvoiceNumber} reminder from {CompanyName}';
+export const DEFAULT_INVOICE_REMINDER_MAIL_CONTENT = `
+Dear {CustomerName}
+You might have missed the payment date and the invoice is now overdue by {OverdueDays} days.
+Invoice #{InvoiceNumber}
+Due Date : {InvoiceDueDate}
+Amount : {InvoiceAmount}
+
+
+Regards
+{CompanyName}
+
+`;
+
export const ERRORS = {
INVOICE_NUMBER_NOT_UNIQUE: 'INVOICE_NUMBER_NOT_UNIQUE',
SALE_INVOICE_NOT_FOUND: 'SALE_INVOICE_NOT_FOUND',
@@ -16,6 +48,7 @@ export const ERRORS = {
PAYMENT_ACCOUNT_CURRENCY_INVALID: 'PAYMENT_ACCOUNT_CURRENCY_INVALID',
SALE_INVOICE_ALREADY_WRITTEN_OFF: 'SALE_INVOICE_ALREADY_WRITTEN_OFF',
SALE_INVOICE_NOT_WRITTEN_OFF: 'SALE_INVOICE_NOT_WRITTEN_OFF',
+ NO_INVOICE_CUSTOMER_EMAIL_ADDR: 'NO_INVOICE_CUSTOMER_EMAIL_ADDR',
};
export const DEFAULT_VIEW_COLUMNS = [];
diff --git a/packages/server/src/services/Sales/Invoices/subscribers/InvoiceChangeStatusOnMailSentSubscriber.ts b/packages/server/src/services/Sales/Invoices/subscribers/InvoiceChangeStatusOnMailSentSubscriber.ts
new file mode 100644
index 000000000..fc4392777
--- /dev/null
+++ b/packages/server/src/services/Sales/Invoices/subscribers/InvoiceChangeStatusOnMailSentSubscriber.ts
@@ -0,0 +1,49 @@
+import { Inject, Service } from 'typedi';
+import events from '@/subscribers/events';
+import { ISaleInvoiceMailSent } from '@/interfaces';
+import { DeliverSaleInvoice } from '../DeliverSaleInvoice';
+import { ServiceError } from '@/exceptions';
+import { ERRORS } from '../constants';
+
+@Service()
+export class InvoiceChangeStatusOnMailSentSubscriber {
+ @Inject()
+ private markInvoiceDelivedService: DeliverSaleInvoice;
+
+ /**
+ * Attaches events.
+ */
+ public attach(bus) {
+ bus.subscribe(events.saleInvoice.onPreMailSend, this.markInvoiceDelivered);
+ bus.subscribe(
+ events.saleInvoice.onMailReminderSent,
+ this.markInvoiceDelivered
+ );
+ }
+
+ /**
+ * Marks the invoice delivered once the invoice mail sent.
+ * @param {ISaleInvoiceMailSent}
+ * @returns {Promise}
+ */
+ private markInvoiceDelivered = async ({
+ tenantId,
+ saleInvoiceId,
+ messageOptions,
+ }: ISaleInvoiceMailSent) => {
+ try {
+ await this.markInvoiceDelivedService.deliverSaleInvoice(
+ tenantId,
+ saleInvoiceId
+ );
+ } catch (error) {
+ if (
+ error instanceof ServiceError &&
+ error.errorType === ERRORS.SALE_INVOICE_ALREADY_DELIVERED
+ ) {
+ } else {
+ throw error;
+ }
+ }
+ };
+}
diff --git a/packages/server/src/services/Sales/PaymentReceives/EditPaymentReceive.ts b/packages/server/src/services/Sales/PaymentReceives/EditPaymentReceive.ts
index b99413748..635f48946 100644
--- a/packages/server/src/services/Sales/PaymentReceives/EditPaymentReceive.ts
+++ b/packages/server/src/services/Sales/PaymentReceives/EditPaymentReceive.ts
@@ -61,7 +61,8 @@ export class EditPaymentReceive {
// Validate the payment receive existance.
const oldPaymentReceive = await PaymentReceive.query()
.withGraphFetched('entries')
- .findById(paymentReceiveId);
+ .findById(paymentReceiveId)
+ .throwIfNotFound();
// Validates the payment existance.
this.validators.validatePaymentExistance(oldPaymentReceive);
diff --git a/packages/server/src/services/Sales/PaymentReceives/GetPaymentReeceivePdf.ts b/packages/server/src/services/Sales/PaymentReceives/GetPaymentReeceivePdf.ts
index e05937f76..e3d3cfb26 100644
--- a/packages/server/src/services/Sales/PaymentReceives/GetPaymentReeceivePdf.ts
+++ b/packages/server/src/services/Sales/PaymentReceives/GetPaymentReeceivePdf.ts
@@ -1,7 +1,7 @@
import { Inject, Service } from 'typedi';
import { ChromiumlyTenancy } from '@/services/ChromiumlyTenancy/ChromiumlyTenancy';
import { TemplateInjectable } from '@/services/TemplateInjectable/TemplateInjectable';
-import { IPaymentReceive } from '@/interfaces';
+import { GetPaymentReceive } from './GetPaymentReceive';
@Service()
export default class GetPaymentReceivePdf {
@@ -11,6 +11,9 @@ export default class GetPaymentReceivePdf {
@Inject()
private templateInjectable: TemplateInjectable;
+ @Inject()
+ private getPaymentService: GetPaymentReceive;
+
/**
* Retrieve sale invoice pdf content.
* @param {number} tenantId -
@@ -19,8 +22,12 @@ export default class GetPaymentReceivePdf {
*/
async getPaymentReceivePdf(
tenantId: number,
- paymentReceive: IPaymentReceive
+ paymentReceiveId: number
): Promise {
+ const paymentReceive = await this.getPaymentService.getPaymentReceive(
+ tenantId,
+ paymentReceiveId
+ );
const htmlContent = await this.templateInjectable.render(
tenantId,
'modules/payment-receive-standard',
diff --git a/packages/server/src/services/Sales/PaymentReceives/PaymentReceiveEntryTransformer.ts b/packages/server/src/services/Sales/PaymentReceives/PaymentReceiveEntryTransformer.ts
index fe9fe9b67..7a7af28c1 100644
--- a/packages/server/src/services/Sales/PaymentReceives/PaymentReceiveEntryTransformer.ts
+++ b/packages/server/src/services/Sales/PaymentReceives/PaymentReceiveEntryTransformer.ts
@@ -8,7 +8,7 @@ export class PaymentReceiveEntryTransfromer extends Transformer {
* @returns {Array}
*/
public includeAttributes = (): string[] => {
- return ['paymentAmountFormatted', 'entry'];
+ return ['paymentAmountFormatted', 'invoice'];
};
/**
diff --git a/packages/server/src/services/Sales/PaymentReceives/PaymentReceiveMailNotification.ts b/packages/server/src/services/Sales/PaymentReceives/PaymentReceiveMailNotification.ts
new file mode 100644
index 000000000..bd8d4fa64
--- /dev/null
+++ b/packages/server/src/services/Sales/PaymentReceives/PaymentReceiveMailNotification.ts
@@ -0,0 +1,141 @@
+import { Inject, Service } from 'typedi';
+import {
+ PaymentReceiveMailOpts,
+ PaymentReceiveMailOptsDTO,
+ PaymentReceiveMailPresendEvent,
+ SendInvoiceMailDTO,
+} from '@/interfaces';
+import Mail from '@/lib/Mail';
+import HasTenancyService from '@/services/Tenancy/TenancyService';
+import {
+ DEFAULT_PAYMENT_MAIL_CONTENT,
+ DEFAULT_PAYMENT_MAIL_SUBJECT,
+} from './constants';
+import { GetPaymentReceive } from './GetPaymentReceive';
+import { ContactMailNotification } from '@/services/MailNotification/ContactMailNotification';
+import { parseAndValidateMailOptions } from '@/services/MailNotification/utils';
+import { EventPublisher } from '@/lib/EventPublisher/EventPublisher';
+import events from '@/subscribers/events';
+
+@Service()
+export class SendPaymentReceiveMailNotification {
+ @Inject()
+ private tenancy: HasTenancyService;
+
+ @Inject()
+ private getPaymentService: GetPaymentReceive;
+
+ @Inject()
+ private contactMailNotification: ContactMailNotification;
+
+ @Inject('agenda')
+ private agenda: any;
+
+ @Inject()
+ private eventPublisher: EventPublisher;
+
+ /**
+ * Sends the mail of the given payment receive.
+ * @param {number} tenantId
+ * @param {number} paymentReceiveId
+ * @param {PaymentReceiveMailOptsDTO} messageDTO
+ * @returns {Promise}
+ */
+ public async triggerMail(
+ tenantId: number,
+ paymentReceiveId: number,
+ messageDTO: PaymentReceiveMailOptsDTO
+ ): Promise {
+ const payload = {
+ tenantId,
+ paymentReceiveId,
+ messageDTO,
+ };
+ await this.agenda.now('payment-receive-mail-send', payload);
+
+ // Triggers `onPaymentReceivePreMailSend` event.
+ await this.eventPublisher.emitAsync(events.paymentReceive.onPreMailSend, {
+ tenantId,
+ paymentReceiveId,
+ messageOptions: messageDTO,
+ } as PaymentReceiveMailPresendEvent);
+ }
+
+ /**
+ * Retrieves the default payment mail options.
+ * @param {number} tenantId - Tenant id.
+ * @param {number} paymentReceiveId - Payment receive id.
+ * @returns {Promise}
+ */
+ public getMailOptions = async (
+ tenantId: number,
+ paymentId: number
+ ): Promise => {
+ const { PaymentReceive } = this.tenancy.models(tenantId);
+
+ const paymentReceive = await PaymentReceive.query()
+ .findById(paymentId)
+ .throwIfNotFound();
+
+ const formatterData = await this.textFormatter(tenantId, paymentId);
+
+ return this.contactMailNotification.getMailOptions(
+ tenantId,
+ paymentReceive.customerId,
+ DEFAULT_PAYMENT_MAIL_SUBJECT,
+ DEFAULT_PAYMENT_MAIL_CONTENT,
+ formatterData
+ );
+ };
+
+ /**
+ * Retrieves the formatted text of the given sale invoice.
+ * @param {number} tenantId - Tenant id.
+ * @param {number} invoiceId - Sale invoice id.
+ * @param {string} text - The given text.
+ * @returns {Promise}
+ */
+ public textFormatter = async (
+ tenantId: number,
+ invoiceId: number
+ ): Promise> => {
+ const payment = await this.getPaymentService.getPaymentReceive(
+ tenantId,
+ invoiceId
+ );
+ return {
+ CustomerName: payment.customer.displayName,
+ PaymentNumber: payment.payment_receive_no,
+ PaymentDate: payment.formattedPaymentDate,
+ PaymentAmount: payment.formattedAmount,
+ };
+ };
+
+ /**
+ * Triggers the mail invoice.
+ * @param {number} tenantId
+ * @param {number} saleInvoiceId
+ * @param {SendInvoiceMailDTO} messageDTO
+ * @returns {Promise}
+ */
+ public async sendMail(
+ tenantId: number,
+ paymentReceiveId: number,
+ messageDTO: SendInvoiceMailDTO
+ ): Promise {
+ const defaultMessageOpts = await this.getMailOptions(
+ tenantId,
+ paymentReceiveId
+ );
+ // Parsed message opts with default options.
+ const parsedMessageOpts = parseAndValidateMailOptions(
+ defaultMessageOpts,
+ messageDTO
+ );
+ await new Mail()
+ .setSubject(parsedMessageOpts.subject)
+ .setTo(parsedMessageOpts.to)
+ .setContent(parsedMessageOpts.body)
+ .send();
+ }
+}
diff --git a/packages/server/src/services/Sales/PaymentReceives/PaymentReceiveMailNotificationJob.ts b/packages/server/src/services/Sales/PaymentReceives/PaymentReceiveMailNotificationJob.ts
new file mode 100644
index 000000000..b29570d42
--- /dev/null
+++ b/packages/server/src/services/Sales/PaymentReceives/PaymentReceiveMailNotificationJob.ts
@@ -0,0 +1,32 @@
+import Container, { Service } from 'typedi';
+import { SendPaymentReceiveMailNotification } from './PaymentReceiveMailNotification';
+
+@Service()
+export class PaymentReceiveMailNotificationJob {
+ /**
+ * Constructor method.
+ */
+ constructor(agenda) {
+ agenda.define(
+ 'payment-receive-mail-send',
+ { priority: 'high', concurrency: 2 },
+ this.handler
+ );
+ }
+
+ /**
+ * Triggers sending payment notification via mail.
+ */
+ private handler = async (job, done: Function) => {
+ const { tenantId, paymentReceiveId, messageDTO } = job.attrs.data;
+ const paymentMail = Container.get(SendPaymentReceiveMailNotification);
+
+ try {
+ await paymentMail.sendMail(tenantId, paymentReceiveId, messageDTO);
+ done();
+ } catch (error) {
+ console.log(error);
+ done(error);
+ }
+ };
+}
diff --git a/packages/server/src/services/Sales/PaymentReceives/PaymentReceiveTransformer.ts b/packages/server/src/services/Sales/PaymentReceives/PaymentReceiveTransformer.ts
index afce4203b..5ca84db07 100644
--- a/packages/server/src/services/Sales/PaymentReceives/PaymentReceiveTransformer.ts
+++ b/packages/server/src/services/Sales/PaymentReceives/PaymentReceiveTransformer.ts
@@ -1,7 +1,6 @@
import { IPaymentReceive, IPaymentReceiveEntry } from '@/interfaces';
import { Transformer } from '@/lib/Transformer/Transformer';
import { formatNumber } from 'utils';
-import { SaleInvoiceTransformer } from '../Invoices/SaleInvoiceTransformer';
import { PaymentReceiveEntryTransfromer } from './PaymentReceiveEntryTransformer';
export class PaymentReceiveTransfromer extends Transformer {
@@ -11,6 +10,7 @@ export class PaymentReceiveTransfromer extends Transformer {
*/
public includeAttributes = (): string[] => {
return [
+ 'subtotalFormatted',
'formattedPaymentDate',
'formattedAmount',
'formattedExchangeRate',
@@ -27,6 +27,18 @@ export class PaymentReceiveTransfromer extends Transformer {
return this.formatDate(payment.paymentDate);
};
+ /**
+ * Retrieve the formatted payment subtotal.
+ * @param {IPaymentReceive} payment
+ * @returns {string}
+ */
+ protected subtotalFormatted = (payment: IPaymentReceive): string => {
+ return formatNumber(payment.amount, {
+ currencyCode: payment.currencyCode,
+ money: false,
+ });
+ };
+
/**
* Retrieve formatted payment amount.
* @param {ISaleInvoice} invoice
diff --git a/packages/server/src/services/Sales/PaymentReceives/PaymentReceivesApplication.ts b/packages/server/src/services/Sales/PaymentReceives/PaymentReceivesApplication.ts
index afeca6010..0d5669bf8 100644
--- a/packages/server/src/services/Sales/PaymentReceives/PaymentReceivesApplication.ts
+++ b/packages/server/src/services/Sales/PaymentReceives/PaymentReceivesApplication.ts
@@ -7,6 +7,7 @@ import {
IPaymentReceiveSmsDetails,
IPaymentReceivesFilter,
ISystemUser,
+ PaymentReceiveMailOptsDTO,
} from '@/interfaces';
import { Inject, Service } from 'typedi';
import { CreatePaymentReceive } from './CreatePaymentReceive';
@@ -17,7 +18,7 @@ import { GetPaymentReceive } from './GetPaymentReceive';
import { GetPaymentReceiveInvoices } from './GetPaymentReceiveInvoices';
import { PaymentReceiveNotifyBySms } from './PaymentReceiveSmsNotify';
import GetPaymentReceivePdf from './GetPaymentReeceivePdf';
-import { PaymentReceive } from '@/models';
+import { SendPaymentReceiveMailNotification } from './PaymentReceiveMailNotification';
@Service()
export class PaymentReceivesApplication {
@@ -42,6 +43,9 @@ export class PaymentReceivesApplication {
@Inject()
private paymentSmsNotify: PaymentReceiveNotifyBySms;
+ @Inject()
+ private paymentMailNotify: SendPaymentReceiveMailNotification;
+
@Inject()
private getPaymentReceivePdfService: GetPaymentReceivePdf;
@@ -176,18 +180,47 @@ export class PaymentReceivesApplication {
};
/**
- * Retrieve PDF content of the given payment receive.
+ * Notify customer via mail about payment receive details.
+ * @param {number} tenantId
+ * @param {number} paymentReceiveId
+ * @param {IPaymentReceiveMailOpts} messageOpts
+ * @returns {Promise}
+ */
+ public notifyPaymentByMail(
+ tenantId: number,
+ paymentReceiveId: number,
+ messageOpts: PaymentReceiveMailOptsDTO
+ ): Promise {
+ return this.paymentMailNotify.triggerMail(
+ tenantId,
+ paymentReceiveId,
+ messageOpts
+ );
+ }
+
+ /**
+ * Retrieves the default mail options of the given payment transaction.
+ * @param {number} tenantId
+ * @param {number} paymentReceiveId
+ * @returns {Promise}
+ */
+ public getPaymentMailOptions(tenantId: number, paymentReceiveId: number) {
+ return this.paymentMailNotify.getMailOptions(tenantId, paymentReceiveId);
+ }
+
+ /**
+ * Retrieve pdf content of the given payment receive.
* @param {number} tenantId
* @param {PaymentReceive} paymentReceive
* @returns
*/
public getPaymentReceivePdf = (
tenantId: number,
- paymentReceive: PaymentReceive
+ paymentReceiveId: number
) => {
return this.getPaymentReceivePdfService.getPaymentReceivePdf(
tenantId,
- paymentReceive
+ paymentReceiveId
);
};
}
diff --git a/packages/server/src/services/Sales/PaymentReceives/constants.ts b/packages/server/src/services/Sales/PaymentReceives/constants.ts
index ccd8d75ee..405939617 100644
--- a/packages/server/src/services/Sales/PaymentReceives/constants.ts
+++ b/packages/server/src/services/Sales/PaymentReceives/constants.ts
@@ -1,3 +1,18 @@
+export const DEFAULT_PAYMENT_MAIL_SUBJECT = 'Payment Received by {CompanyName}';
+export const DEFAULT_PAYMENT_MAIL_CONTENT = `
+
