mirror of
https://github.com/bigcapitalhq/bigcapital.git
synced 2026-02-15 20:30:33 +00:00
282 lines
7.2 KiB
TypeScript
282 lines
7.2 KiB
TypeScript
import isEmpty from 'lodash/isEmpty';
|
|
import { Box } from '../lib/layout/Box';
|
|
import { Text } from '../lib/text/Text';
|
|
import { Stack } from '../lib/layout/Stack';
|
|
import { Group } from '../lib/layout/Group';
|
|
import {
|
|
PaperTemplate,
|
|
PaperTemplateProps,
|
|
PaperTemplateTotalBorder,
|
|
} from './PaperTemplate';
|
|
import {
|
|
DefaultPdfTemplateTerms,
|
|
DefaultPdfTemplateItemDescription,
|
|
DefaultPdfTemplateStatement,
|
|
DefaultPdfTemplateItemName,
|
|
DefaultPdfTemplateAddressBilledTo,
|
|
DefaultPdfTemplateAddressBilledFrom,
|
|
} from './_constants';
|
|
import { theme } from '../constants';
|
|
|
|
export interface ReceiptPaperTemplateProps extends PaperTemplateProps {
|
|
// # Company logo
|
|
showCompanyLogo?: boolean;
|
|
companyLogoUri?: string;
|
|
|
|
// # Company name
|
|
companyName?: string;
|
|
|
|
// Addresses
|
|
showCustomerAddress?: boolean;
|
|
customerAddress?: string;
|
|
|
|
showCompanyAddress?: boolean;
|
|
companyAddress?: string;
|
|
|
|
billedToLabel?: string;
|
|
|
|
// # Subtotal
|
|
subtotal?: string;
|
|
showSubtotal?: boolean;
|
|
subtotalLabel?: string;
|
|
|
|
// # Discount
|
|
discount?: string;
|
|
showDiscount?: boolean;
|
|
discountLabel?: string;
|
|
|
|
// # Adjustment
|
|
adjustment?: string;
|
|
showAdjustment?: boolean;
|
|
adjustmentLabel?: string;
|
|
|
|
// Total
|
|
total?: string;
|
|
showTotal?: boolean;
|
|
totalLabel?: string;
|
|
|
|
// Customer Note
|
|
showCustomerNote?: boolean;
|
|
customerNote?: string;
|
|
customerNoteLabel?: string;
|
|
|
|
// Terms & Conditions
|
|
showTermsConditions?: boolean;
|
|
termsConditions?: string;
|
|
termsConditionsLabel?: string;
|
|
|
|
// Lines
|
|
lines?: Array<{
|
|
item: string;
|
|
description: string;
|
|
rate: string;
|
|
quantity: string;
|
|
total: string;
|
|
}>;
|
|
|
|
// Receipt Date.
|
|
receiptDateLabel?: string;
|
|
showReceiptDate?: boolean;
|
|
receiptDate?: string;
|
|
|
|
// Receipt Number
|
|
receiptNumebr?: string;
|
|
receiptNumberLabel?: string;
|
|
showReceiptNumber?: boolean;
|
|
|
|
// Entries
|
|
lineItemLabel?: string;
|
|
lineQuantityLabel?: string;
|
|
lineRateLabel?: string;
|
|
lineTotalLabel?: string;
|
|
}
|
|
|
|
export function ReceiptPaperTemplate({
|
|
// # Colors
|
|
primaryColor,
|
|
secondaryColor,
|
|
|
|
// # Company logo
|
|
showCompanyLogo = true,
|
|
companyLogoUri,
|
|
|
|
// # Company name
|
|
companyName = 'Bigcapital Technology, Inc.',
|
|
|
|
// # Address
|
|
showCustomerAddress = true,
|
|
customerAddress = DefaultPdfTemplateAddressBilledTo,
|
|
|
|
showCompanyAddress = true,
|
|
companyAddress = DefaultPdfTemplateAddressBilledFrom,
|
|
|
|
billedToLabel = 'Billed To',
|
|
|
|
// # Total
|
|
total = '$1000.00',
|
|
totalLabel = 'Total',
|
|
showTotal = true,
|
|
|
|
// # Discount
|
|
discount = '',
|
|
discountLabel = 'Discount',
|
|
showDiscount = true,
|
|
|
|
// # Adjustment
|
|
adjustment = '',
|
|
adjustmentLabel = 'Adjustment',
|
|
showAdjustment = true,
|
|
|
|
// # Subtotal
|
|
subtotal = '1000/00',
|
|
subtotalLabel = 'Subtotal',
|
|
showSubtotal = true,
|
|
|
|
showCustomerNote = true,
|
|
customerNoteLabel = 'Customer Note',
|
|
customerNote = DefaultPdfTemplateStatement,
|
|
|
|
showTermsConditions = true,
|
|
termsConditionsLabel = 'Terms & Conditions',
|
|
termsConditions = DefaultPdfTemplateTerms,
|
|
|
|
lines = [
|
|
{
|
|
item: DefaultPdfTemplateItemName,
|
|
description: DefaultPdfTemplateItemDescription,
|
|
rate: '1',
|
|
quantity: '1000',
|
|
total: '$1000.00',
|
|
},
|
|
],
|
|
|
|
// Receipt Number
|
|
showReceiptNumber = true,
|
|
receiptNumberLabel = 'Receipt Number',
|
|
receiptNumebr = '346D3D40-0001',
|
|
|
|
// Receipt Date
|
|
receiptDate = 'September 3, 2024',
|
|
showReceiptDate = true,
|
|
receiptDateLabel = 'Receipt Date',
|
|
|
|
// Entries
|
|
lineItemLabel = 'Item',
|
|
lineQuantityLabel = 'Qty',
|
|
lineRateLabel = 'Rate',
|
|
lineTotalLabel = 'Total',
|
|
}: ReceiptPaperTemplateProps) {
|
|
return (
|
|
<PaperTemplate primaryColor={primaryColor} secondaryColor={secondaryColor}>
|
|
<Stack spacing={24}>
|
|
<Group align={'start'} spacing={10}>
|
|
<Stack flex={1}>
|
|
<PaperTemplate.BigTitle title={'Receipt'} />
|
|
|
|
<PaperTemplate.TermsList>
|
|
{showReceiptNumber && (
|
|
<PaperTemplate.TermsItem label={receiptNumberLabel}>
|
|
{receiptNumebr}
|
|
</PaperTemplate.TermsItem>
|
|
)}
|
|
{showReceiptDate && (
|
|
<PaperTemplate.TermsItem label={receiptDateLabel}>
|
|
{receiptDate}
|
|
</PaperTemplate.TermsItem>
|
|
)}
|
|
</PaperTemplate.TermsList>
|
|
</Stack>
|
|
|
|
{companyLogoUri && showCompanyLogo && (
|
|
<PaperTemplate.Logo logoUri={companyLogoUri} />
|
|
)}
|
|
</Group>
|
|
|
|
<PaperTemplate.AddressesGroup>
|
|
{showCompanyAddress && (
|
|
<PaperTemplate.Address>
|
|
<Box dangerouslySetInnerHTML={{ __html: companyAddress }} />
|
|
</PaperTemplate.Address>
|
|
)}
|
|
|
|
{showCustomerAddress && (
|
|
<PaperTemplate.Address>
|
|
<strong>{billedToLabel}</strong>
|
|
<Box dangerouslySetInnerHTML={{ __html: customerAddress }} />
|
|
</PaperTemplate.Address>
|
|
)}
|
|
</PaperTemplate.AddressesGroup>
|
|
|
|
<Stack spacing={0}>
|
|
<PaperTemplate.Table
|
|
columns={[
|
|
{
|
|
label: lineItemLabel,
|
|
accessor: (data) => (
|
|
<Stack spacing={2}>
|
|
<Text>{data.item}</Text>
|
|
<Text
|
|
fontSize={'12px'}
|
|
color={theme.colors['cool-gray-500']}
|
|
>
|
|
{data.description}
|
|
</Text>
|
|
</Stack>
|
|
),
|
|
},
|
|
{ label: lineQuantityLabel, accessor: 'quantity' },
|
|
{ label: lineRateLabel, accessor: 'rate', align: 'right' },
|
|
{ label: lineTotalLabel, accessor: 'total', align: 'right' },
|
|
]}
|
|
data={lines}
|
|
/>
|
|
<PaperTemplate.Totals>
|
|
{showSubtotal && (
|
|
<PaperTemplate.TotalLine
|
|
label={subtotalLabel}
|
|
amount={subtotal}
|
|
border={PaperTemplateTotalBorder.Gray}
|
|
style={{ fontWeight: 500 }}
|
|
/>
|
|
)}
|
|
{showDiscount && discount && (
|
|
<PaperTemplate.TotalLine
|
|
label={discountLabel}
|
|
amount={discount}
|
|
/>
|
|
)}
|
|
{showAdjustment && adjustment && (
|
|
<PaperTemplate.TotalLine
|
|
label={adjustmentLabel}
|
|
amount={adjustment}
|
|
/>
|
|
)}
|
|
{showTotal && (
|
|
<PaperTemplate.TotalLine
|
|
label={totalLabel}
|
|
amount={total}
|
|
border={PaperTemplateTotalBorder.Dark}
|
|
style={{ fontWeight: 500 }}
|
|
/>
|
|
)}
|
|
</PaperTemplate.Totals>
|
|
</Stack>
|
|
|
|
<Stack spacing={0}>
|
|
{showCustomerNote && !isEmpty(customerNote) && (
|
|
<PaperTemplate.Statement label={customerNoteLabel}>
|
|
{customerNote}
|
|
</PaperTemplate.Statement>
|
|
)}
|
|
|
|
{showTermsConditions && !isEmpty(termsConditions) && (
|
|
<PaperTemplate.Statement label={termsConditionsLabel}>
|
|
{termsConditions}
|
|
</PaperTemplate.Statement>
|
|
)}
|
|
</Stack>
|
|
</Stack>
|
|
</PaperTemplate>
|
|
);
|
|
}
|