Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: print template for payment entries #1110

Merged
merged 5 commits into from
Jan 31, 2025
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions models/baseModels/Payment/Payment.ts
Original file line number Diff line number Diff line change
Expand Up @@ -502,6 +502,14 @@ export class Payment extends Transactional {
date: () => new Date(),
};

async getTotalTax() {
const taxArr = await this.getTaxSummary();

return taxArr
.map(({ amount }) => amount)
.reduce((a, b) => a.add(b), this.fyo.pesa(0));
}

async _getAccountsMap(): Promise<AccountTypeMap> {
if (this._accountsMap) {
return this._accountsMap;
Expand Down
51 changes: 39 additions & 12 deletions src/utils/printTemplates.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import {
} from './ui';
import { Money } from 'pesa';
import { SalesInvoice } from 'models/baseModels/SalesInvoice/SalesInvoice';
import { Payment } from 'models/baseModels/Payment/Payment';

export type PrintTemplateHint = {
[key: string]: string | PrintTemplateHint | PrintTemplateHint[];
Expand Down Expand Up @@ -44,28 +45,54 @@ export async function getPrintTemplatePropValues(
doc: Doc
): Promise<PrintValues> {
const fyo = doc.fyo;
let paymentId;
let sinvDoc;

const values: PrintValues = { doc: {}, print: {} };
values.doc = await getPrintTemplateDocValues(doc);

const totalTax = await (doc as Invoice)?.getTotalTax();
const paymentId = await (doc as SalesInvoice).getPaymentIds();
if (values.doc.entryType !== ModelNameEnum.Payment) {
paymentId = await (doc as SalesInvoice).getPaymentIds();

if (paymentId && paymentId.length) {
const paymentDoc = await fyo.doc.getDoc(
ModelNameEnum.Payment,
paymentId[0]
);

(values.doc as PrintTemplateData).paymentMethod =
paymentDoc.paymentMethod;

if (paymentId.length) {
const paymentDoc = await fyo.doc.getDoc(
ModelNameEnum.Payment,
paymentId[0]
(values.doc as PrintTemplateData).paidAmount = doc.fyo.format(
paymentDoc.amount as Money,
ModelNameEnum.Currency
);
}
}

if (doc.referenceType == ModelNameEnum.SalesInvoice) {
sinvDoc = await fyo.doc.getDoc(
ModelNameEnum.SalesInvoice,
(doc as Payment)?.for![0].referenceName
);

(values.doc as PrintTemplateData).paymentMethod = paymentDoc.paymentMethod;
if (sinvDoc.taxes) {
(values.doc as PrintTemplateData).taxes = sinvDoc.taxes;
}
}

const totalTax = await (
(sinvDoc as Invoice) ?? (doc as Payment)
)?.getTotalTax();

(values.doc as PrintTemplateData).paidAmount = doc.fyo.format(
paymentDoc.amount as Money,
ModelNameEnum.Currency
if (doc.schema.name == ModelNameEnum.Payment) {
(values.doc as PrintTemplateData).amountPaidInWords = getGrandTotalInWords(
(doc.amountPaid as Money)?.float
);
}

(values.doc as PrintTemplateData).subTotal = doc.fyo.format(
(doc.grandTotal as Money).sub(totalTax),
((doc.grandTotal as Money) ?? (doc.amount as Money)).sub(totalTax),
ModelNameEnum.Currency
);

Expand Down Expand Up @@ -95,7 +122,7 @@ export async function getPrintTemplatePropValues(
}

(values.doc as PrintTemplateData).grandTotalInWords = getGrandTotalInWords(
(doc.grandTotal as Money).float
((doc.grandTotal as Money) ?? (doc.amount as Money)).float
);

(values.doc as PrintTemplateData).date = getDate(doc.date as string);
Expand Down
124 changes: 124 additions & 0 deletions templates/Business.Payment.template.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
<main class="bg-white h-full" :style="{ 'font-family': print.font }">
<!-- Invoice Header -->
<header class="bg-gray-100 px-12 py-10">
<!-- Company Details -->
<section class="flex items-center">
<img
v-if="print.displayLogo"
class="h-12 max-w-32 object-contain mr-4"
:src="print.logo"
/>

<div>
<p class="font-semibold text-xl" :style="{ color: print.color }">
{{ print.companyName }}
</p>

<p class="text-sm text-gray-800" v-if="print.address">
{{ print.links.address.addressDisplay }}
</p>

<p class="text-sm text-gray-800" v-if="print.gstin">
GSTIN: {{ print.gstin }}
</p>
</div>
</section>

<!-- Sub Heading Section -->
<div class="mt-8 text-lg">
<!-- Doc Details -->
<section class="flex">
<h3 class="w-1/3 font-semibold">{{t`Bill`}}</h3>
<div class="w-2/3 text-gray-800">
<p class="font-semibold">{{ doc.name }}</p>

<div class="flex gap-2">
<p>{{ doc.date }}</p>
<p>{{doc?.time }}</p>
</div>
</div>
</section>

<!-- Party Details -->
<section class="mt-4 flex">
<h3 class="w-1/3 font-semibold">{{t`party`}}</h3>

<div class="w-2/3 text-gray-800" v-if="doc.party">
<p class="font-semibold">{{ doc.party }}</p>

<p v-if="doc.links.party.address">
{{ doc.links.party.links.address.addressDisplay }}
</p>

<p v-if="doc.links.party.gstin">GSTIN: {{ doc.links.party.gstin }}</p>
</div>
</section>
</div>
</header>

<!-- Payment Details -->
<section class="px-12 py-12 text-lg">
<div class="w-3/4 grid grid-cols-7 grid-rows-2 p-2 gap-3">
<div class="col-span-2 font-bold"><p>{{t`Payment Type`}}</p></div>
<div class="col-start-3">:</div>
<div class="col-span-4 col-start-4">{{ doc.paymentType }}</div>

<div class="col-span-2 row-start-2 font-bold">{{t`Payment Method`}}</div>
<div class="col-start-3 row-start-2">:</div>
<div class="col-span-4 col-start-4 row-start-2">
{{ doc.paymentMethod }}
</div>
</div>
</section>

<section class="w-1/2 px-12 pb-6 text-lg" v-if="doc.taxes.length">
<p class="flex justify-center font-semibold text-lg mt-2">Tax Summary</p>
AbleKSaju marked this conversation as resolved.
Show resolved Hide resolved

<div
class="flex justify-between pl-5 text-base"
v-for="tax in doc?.taxes"
:key="tax.name"
>
<p>{{ tax.account }}</p>
<p>{{ tax.amount }}</p>
</div>

<div class="flex justify-between pl-5 text-base">
<p>Total Ex.Vat</p>
<p>{{doc.subTotal}}</p>
</div>
</section>
<!-- Invoice Footer -->
<footer class="px-12 text-lg">
<section class="pt-5 text-lg">
<div class="w-full grid grid-cols-7 grid-rows-5 p-2 gap-3">
<div class="col-span-2 font-bold">
<p>{{t`Grand Total`}}</p>
</div>

<div class="col-start-3">:</div>

<div class="col-span-4 col-start-4 font-bold">
<p>{{ doc.amount }}</p>
<p class="font-normal">{{ doc.grandTotalInWords }}</p>
</div>

<div class="col-span-2 row-start-2 font-bold">{{t`Amount Paid`}}</div>

<div class="col-start-3 row-start-2">:</div>

<div class="col-span-4 col-start-4 row-start-2 font-bold">
<p>{{ doc.amountPaid }}</p>
<p class="font-normal">{{ doc.amountPaidInWords }}</p>
</div>
</div>
</section>

<!-- Invoice Terms -->
<section class="mt-12" v-if="doc.terms">
<h3 class="text-lg font-semibold">Notes</h3>
AbleKSaju marked this conversation as resolved.
Show resolved Hide resolved

<p class="mt-4 text-lg whitespace-pre-line">{{ doc.terms }}</p>
</section>
</footer>
</main>