feat: add adjustment total in estimates, invoices, and receipts pdf templates

shared/pdf-templates/src/components/EstimatePaperTemplate.tsx

@@ -43,7 +43,7 @@ export interface EstimatePaperTemplateProps extends PaperTemplateProps {
   companyAddress?: string;
   billedToLabel?: string;
 
-  // Totals
+  // Total
   total?: string;
   showTotal?: boolean;
   totalLabel?: string;
@@ -53,6 +53,11 @@ export interface EstimatePaperTemplateProps extends PaperTemplateProps {
   showDiscount?: boolean;
   discountLabel?: string;
 
+  // # Adjustment
+  adjustment?: string;
+  showAdjustment?: boolean;
+  adjustmentLabel?: string;
+
   // # Subtotal
   subtotal?: string;
   showSubtotal?: boolean;
@@ -117,6 +122,11 @@ export function EstimatePaperTemplate({
   subtotalLabel = 'Subtotal',
   showSubtotal = true,
 
+  // # Adjustment
+  adjustment = '',
+  showAdjustment = true,
+  adjustmentLabel = 'Adjustment',
+
   // # Customer Note
   showCustomerNote = true,
   customerNote = DefaultPdfTemplateStatement,
@@ -240,6 +250,12 @@ export function EstimatePaperTemplate({
                 amount={discount}
               />
             )}
+            {showAdjustment && adjustment && (
+              <PaperTemplate.TotalLine
+                label={adjustmentLabel}
+                amount={adjustment}
+              />
+            )}
             {showTotal && (
               <PaperTemplate.TotalLine label={totalLabel} amount={total} />
             )}

shared/pdf-templates/src/components/InvoicePaperTemplate.tsx

@@ -1,3 +1,4 @@
+import { isEmpty } from 'lodash';
 import {
   PaperTemplate,
   PaperTemplateProps,
@@ -33,17 +34,21 @@ export interface InvoicePaperTemplateProps extends PaperTemplateProps {
   primaryColor?: string;
   secondaryColor?: string;
 
+  // Company
   showCompanyLogo?: boolean;
   companyLogoUri?: string;
 
+  // Invoice number
   showInvoiceNumber?: boolean;
   invoiceNumber?: string;
   invoiceNumberLabel?: string;
 
+  // Date of issue
   showDateIssue?: boolean;
   dateIssue?: string;
   dateIssueLabel?: string;
 
+  // Due date
   showDueDate?: boolean;
   dueDate?: string;
   dueDateLabel?: string;
@@ -66,7 +71,7 @@ export interface InvoicePaperTemplateProps extends PaperTemplateProps {
   lineRateLabel?: string;
   lineTotalLabel?: string;
 
-  // Totals
+  // Total
   showTotal?: boolean;
   totalLabel?: string;
   total?: string;
@@ -76,11 +81,17 @@ export interface InvoicePaperTemplateProps extends PaperTemplateProps {
   discountLabel?: string;
   discount?: string;
 
+  // Adjustment
+  showAdjustment?: boolean;
+  adjustmentLabel?: string;
+  adjustment?: string;
+
   // Subtotal
   showSubtotal?: boolean;
   subtotalLabel?: string;
   subtotal?: string;
 
+  // Payment made
   showPaymentMade?: boolean;
   paymentMadeLabel?: string;
   paymentMade?: string;
@@ -97,6 +108,7 @@ export interface InvoicePaperTemplateProps extends PaperTemplateProps {
   showTermsConditions?: boolean;
   termsConditions?: string;
 
+  // Statement
   statementLabel?: string;
   showStatement?: boolean;
   statement?: string;
@@ -145,20 +157,24 @@ export function InvoicePaperTemplate({
   totalLabel = 'Total',
   subtotalLabel = 'Subtotal',
   discountLabel = 'Discount',
+  adjustmentLabel = 'Adjustment',
   paymentMadeLabel = 'Payment Made',
   dueAmountLabel = 'Balance Due',
 
   // Totals
   showTotal = true,
+  total = '$662.75',
+
   showSubtotal = true,
   showDiscount = true,
   showTaxes = true,
   showPaymentMade = true,
   showDueAmount = true,
+  showAdjustment = true,
 
-  total = '$662.75',
   subtotal = '630.00',
   discount = '0.00',
+  adjustment = '',
   paymentMade = '100.00',
   dueAmount = '$562.75',
 
@@ -243,17 +259,18 @@ export function InvoicePaperTemplate({
                 accessor: (data) => (
                   <Stack spacing={2}>
                     <Text>{data.item}</Text>
-                    <Text
-                      color={'#5f6b7c'}
-                      fontSize={12}
-                    >
+                    <Text color={'#5f6b7c'} fontSize={12}>
                       {data.description}
                     </Text>
                   </Stack>
                 ),
                 thStyle: { width: '60%' },
               },
-              { label: lineQuantityLabel, accessor: 'quantity', align: 'right' },
+              {
+                label: lineQuantityLabel,
+                accessor: 'quantity',
+                align: 'right',
+              },
               { label: lineRateLabel, accessor: 'rate', align: 'right' },
               { label: lineTotalLabel, accessor: 'total', align: 'right' },
             ]}
@@ -267,12 +284,18 @@ export function InvoicePaperTemplate({
                 border={PaperTemplateTotalBorder.Gray}
               />
             )}
-            {showDiscount && (
+            {showDiscount && !isEmpty(discount) && (
               <PaperTemplate.TotalLine
                 label={discountLabel}
                 amount={discount}
               />
             )}
+            {showAdjustment && !isEmpty(adjustment) && (
+              <PaperTemplate.TotalLine
+                label={adjustmentLabel}
+                amount={adjustment}
+              />
+            )}
             {showTaxes && (
               <>
                 {taxes.map((tax, index) => (

shared/pdf-templates/src/components/ReceiptPaperTemplate.tsx

@@ -39,6 +39,11 @@ export interface ReceiptPaperTemplateProps extends PaperTemplateProps {
   showDiscount?: boolean;
   discountLabel?: string;
 
+  // # Adjustment
+  adjustment?: string;
+  showAdjustment?: boolean;
+  adjustmentLabel?: string;
+
   // Total
   total?: string;
   showTotal?: boolean;
@@ -111,6 +116,11 @@ export function ReceiptPaperTemplate({
   discountLabel = 'Discount',
   showDiscount = true,
 
+  // # Adjustment
+  adjustment = '',
+  adjustmentLabel = 'Adjustment',
+  showAdjustment = true,
+
   // # Subtotal
   subtotal = '1000/00',
   subtotalLabel = 'Subtotal',
@@ -228,6 +238,12 @@ export function ReceiptPaperTemplate({
                 amount={discount}
               />
             )}
+            {showAdjustment && adjustment && (
+              <PaperTemplate.TotalLine
+                label={adjustmentLabel}
+                amount={adjustment}
+              />
+            )}
             {showTotal && (
               <PaperTemplate.TotalLine label={totalLabel} amount={total} />
             )}

shared/pdf-templates/src/renders/render-invoice-paper-template.tsx

@@ -8,8 +8,6 @@ export const renderInvoicePaperTemplateHtml = (
   props: InvoicePaperTemplateProps
 ) => {
   return renderSSR(
-    <InvoicePaperTemplate
-      {...props}
-    />
+    <InvoicePaperTemplate {...props} />
   );
 };