@stamhoofd/backend 2.121.0 → 2.122.0

package/src/services/InvoiceService.ts

@@ -1,22 +1,17 @@
 import { SimpleError } from '@simonbackx/simple-errors';
-import { Image, Organization, Platform} from '@stamhoofd/models';
-import { BalanceItem, Invoice, InvoicedBalanceItem, Payment } from '@stamhoofd/models';
-import { render } from '@stamhoofd/models/helpers/Handlebars.js';
+import { Email } from '@stamhoofd/email';
+import { BalanceItem, Invoice, InvoicedBalanceItem, Organization, Payment, sendEmailTemplate } from '@stamhoofd/models';
 import { InvoiceCounter } from '@stamhoofd/models/helpers/InvoiceCounter.js';
-import type { Address, Invoice as InvoiceStruct } from '@stamhoofd/structures';
-import { CountryHelper, File, getVATExcemptInvoiceNote, getVATExcemptReasonName, PaymentMethod, PaymentMethodHelper, PaymentStatus } from '@stamhoofd/structures';
-import type { OrganizationInvoiceSettings } from '@stamhoofd/structures/OrganizationInvoiceSettings.js';
+import type { Invoice as InvoiceStruct } from '@stamhoofd/structures';
+import { EmailTemplateType, PaymentStatus, Recipient, Replacement } from '@stamhoofd/structures';
 import { Formatter } from '@stamhoofd/utility';
-import fs from 'fs/promises';
 import { ViesHelper } from '../helpers/ViesHelper.js';
 import { BalanceItemService } from './BalanceItemService.js';
-import { VERSION } from 'luxon';
-import {v4 as uuidv4} from 'uuid'
-import { PutObjectCommand } from '@aws-sdk/client-s3';
-import { signInternal } from '@stamhoofd/backend-env';
+import { InvoicePdfService } from './InvoicePdfService.js';
+import { InvoiceXMlService } from './InvoiceXMLService.js';
 
 export class InvoiceService {
-    static async createFrom(organization: { id: string, privateMeta: {invoiceSettings: OrganizationInvoiceSettings} }, struct: InvoiceStruct, options?: { payments?: Payment[]; balanceItems?: BalanceItem[] }) {
+    static async createFrom(organization: Organization, struct: InvoiceStruct, options?: { payments?: Payment[]; balanceItems?: BalanceItem[] }) {
         if (struct.number) {
             throw new SimpleError({
                 code: 'invalid_field',
@@ -46,7 +41,7 @@ export class InvoiceService {
             throw new SimpleError({
                 code: 'invalid_invoiced_amount',
                 message: 'Unexpected 0 totalBalanceInvoicedAmount',
-                statusCode: 400
+                statusCode: 400,
             });
         }
 
@@ -83,7 +78,8 @@ export class InvoiceService {
         model.stripeAccountId = struct.stripeAccountId;
         model.reference = struct.reference;
 
-        model.negativeInvoiceId = struct.negativeInvoiceId;
+        // todo: permission checks
+        // model.negativeInvoiceId = struct.negativeInvoiceId;
 
         if (Math.abs(model.payableRoundingAmount) > 10_00) {
             throw new SimpleError({
@@ -118,6 +114,14 @@ export class InvoiceService {
                     message: 'You cannot invoice a payment multiple times',
                 });
             }
+
+            if (payment.status === PaymentStatus.Failed) {
+                throw new SimpleError({
+                    code: 'failed_payment',
+                    message: 'You cannot invoice failed payments',
+                    human: $t('%1ZW'),
+                });
+            }
         }
 
         const balanceItemIds = Formatter.uniqueArray(struct.items.map(i => i.balanceItemId));
@@ -129,7 +133,7 @@ export class InvoiceService {
             // Force update
             options!.balanceItems = undefined;
         }
-        
+
         const balanceItems = options?.balanceItems ?? await BalanceItem.getByIDs(...balanceItemIds);
         await model.save();
 
@@ -146,18 +150,18 @@ export class InvoiceService {
                 }
 
                 // Todo: check we are not invoicing more than maximum invoiceable for these items
-                const maximumInvoiceable = balanceItem.priceTotal; // € - 10
+                const maximumInvoiceable = balanceItem.priceDue; // € - 10
                 const alreadyInvoiced = balanceItem.priceInvoiced; // € 5
                 const left = maximumInvoiceable - alreadyInvoiced; // € -15
                 const goingToInvoice = item.balanceInvoicedAmount;
 
                 if (item.quantity === 0) {
                     // should not be saved!
-                     throw new SimpleError({
+                    throw new SimpleError({
                         statusCode: 400,
                         code: 'zero_quantity',
                         message: 'Cannot invoice a quantity of zero',
-                        human: $t('%1RZ')
+                        human: $t('%1RZ'),
                     });
                 }
 
@@ -171,8 +175,8 @@ export class InvoiceService {
                                 'a-euro': Formatter.price(goingToInvoice),
                                 'name': balanceItem.getStructure().itemTitle,
                                 'left-euro': Formatter.price(-left),
-                            })
-                        })
+                            }),
+                        });
                     }
 
                     if (goingToInvoice < left) {
@@ -184,21 +188,22 @@ export class InvoiceService {
                                 'a-euro': Formatter.price(-goingToInvoice),
                                 'name': balanceItem.getStructure().itemTitle,
                                 'left-euro': Formatter.price(-left),
-                            })
-                        })
+                            }),
+                        });
                     }
                 }
 
                 if (left === 0) {
                     if (goingToInvoice < 0) {
+                        console.log(item);
                         throw new SimpleError({
                             code: 'error',
                             message: 'Cannot invoice',
                             human: $t('%1R7', {
                                 'a-euro': Formatter.price(-goingToInvoice),
                                 'name': balanceItem.getStructure().itemTitle,
-                            })
-                        })
+                            }),
+                        });
                     } else if (goingToInvoice > 0) {
                         throw new SimpleError({
                             code: 'error',
@@ -206,8 +211,8 @@ export class InvoiceService {
                             human: $t('%1QE', {
                                 'a-euro': Formatter.price(-goingToInvoice),
                                 'name': balanceItem.getStructure().itemTitle,
-                            })
-                        })
+                            }),
+                        });
                     }
                 }
 
@@ -220,8 +225,8 @@ export class InvoiceService {
                                 'a-euro': Formatter.price(-goingToInvoice),
                                 'name': balanceItem.getStructure().itemTitle,
                                 'left-euro': Formatter.price(left),
-                            })
-                        })
+                            }),
+                        });
                     } else if (goingToInvoice > left) {
                         throw new SimpleError({
                             code: 'error',
@@ -230,8 +235,8 @@ export class InvoiceService {
                                 'a-euro': Formatter.price(-goingToInvoice),
                                 'name': balanceItem.getStructure().itemTitle,
                                 'left-euro': Formatter.price(left),
-                            })
-                        })
+                            }),
+                        });
                     }
                 }
 
@@ -267,16 +272,19 @@ export class InvoiceService {
             await InvoiceCounter.assignNextNumber(model, organization.privateMeta.invoiceSettings);
 
             // Update invoiced cache
-            await BalanceItemService.updateInvoiced(struct.items.map(i => i.balanceItemId))
+            await BalanceItemService.updateInvoiced(struct.items.map(i => i.balanceItemId));
 
             // Create PDF
-            await this.generatePdf(model)
-        }
-        catch (e) {
+            await InvoicePdfService.generatePdf(model);
+            await InvoiceXMlService.generateXml(model);
+
+            if (!await this.forwardInvoice(model, organization)) {
+                await this.sendCustomerEmail(model, organization);
+            }
+        } catch (e) {
             try {
                 await model.delete();
-            }
-            catch (ee) {
+            } catch (ee) {
                 console.error('Error while trying to delete invoice because of fail save', ee, 'Deleting because of error', e);
             }
             throw e;
@@ -285,244 +293,189 @@ export class InvoiceService {
         return model;
     }
 
-    static async generateHtml(invoice: Invoice) {
-        const organization = await Organization.getByID(invoice.organizationId, true)
-        const platform = await Platform.getShared()
-        const payments = await Payment.select().where('invoiceId', invoice.id).fetch();
-        const payment = payments[0] ?? null;
-
-        const invoicedItems = await InvoicedBalanceItem.select().where('invoiceId', invoice.id).fetch();
-
-        const seller = invoice.seller;
-        const customer = invoice.customer;
-        const company = customer.company;
+    private static shouldForwardInvoice(invoice: Invoice, organization: Organization) {
+        if (invoice.didSendPeppol) {
+            return {
+                value: false,
+            };
+        }
 
-        const formatAddress = (address: Address | null, includeCountry = false): string => {
-            if (!address) {
-                return '';
-            }
-            const arr = [
-                `${address.street} ${address.number}, ${address.city}`,
-            ];
-            if (includeCountry) {
-                arr.push(CountryHelper.getName(address.country))
-            }
-            return arr.join('\n');
-        };
+        if (!invoice.customer.company?.peppolEndpointId) {
+            return {
+                value: false,
+                reason: 'No customer peppol endpoint id found for this invoice',
+            };
+        }
 
-        const totalPrice = invoice.totalWithVAT;
-        const isCreditNote = totalPrice < 0;
-
-        const date = invoice.invoicedAt ?? invoice.createdAt;
-        const isPaid = payment?.status === PaymentStatus.Succeeded;
-        const dueDate = isPaid
-            ? date
-            : (invoice.dueAt ?? new Date(date.getTime() + 30 * 24 * 60 * 60 * 1000));
-
-        const VATTotal = invoice.VATTotal.map(subtotal => ({
-            VATPercentage: subtotal.VATPercentage,
-            percentageLabel: Formatter.percentage(subtotal.VATPercentage * 100),
-            taxablePrice: subtotal.taxablePrice,
-            VAT: subtotal.VAT,
-            VATExcempt: subtotal.VATExcempt,
-            VATExcemptName: subtotal.VATExcempt ? getVATExcemptReasonName(subtotal.VATExcempt) : null,
-        }));
-
-        const hasMultipleVATRates = VATTotal.length > 1;
-        const firstVATSubtotal = invoice.VATTotal[0] ?? null;
-        const singleVATRateLabel = !hasMultipleVATRates && firstVATSubtotal
-            ? Formatter.percentage(firstVATSubtotal.VATPercentage * 100)
-            : '';
-
-        let vatExcemptNote: string | null = null;
-        if (!hasMultipleVATRates && firstVATSubtotal) {
-            if (firstVATSubtotal.VATExcempt) {
-                vatExcemptNote = getVATExcemptInvoiceNote(firstVATSubtotal.VATExcempt);
-            }
-            else if (firstVATSubtotal.VATPercentage === 0) {
-                vatExcemptNote = $t('%1Q3');
+        // Legally sending an invoice via PEPPOL is not always required.
+        // Logic: send if required or a custom peppol endpoint id is set
+        if (organization.privateMeta.invoiceSettings.forwardOnlyVAT) {
+            if (!invoice.customer.company?.customPeppolEndpointId) {
+                if (!invoice.customer?.company?.VATNumber || !invoice.customer?.company?.VATNumber.startsWith('BE')) {
+                    return {
+                        value: false,
+                        reason: 'Skipping PEPPOL for invoice ' + invoice.id + ', recipient no Belgian VAT number and no custom peppol endpoint id set',
+                    };
+                }
             }
         }
 
-        const trimmedVATNumber = company?.VATNumber?.replace(/\D+/g, '').replace(/^\d{0,2}/, '');
-        const showCompanyNumber = !!company?.companyNumber
-            && (!company?.VATNumber || company.companyNumber.replace(/\D+/g, '') !== trimmedVATNumber);
-
-        const showDueDate = !!invoice.number && totalPrice >= 0;
-        const hasRoundingAmount = invoice.payableRoundingAmount !== 0;
-
-        const showPaidMessage = !!payment && payment.method !== null && payment.status === PaymentStatus.Succeeded && totalPrice >= 0;
-        const showTransferMessage = !!payment && payment.method === PaymentMethod.Transfer && payment.status !== PaymentStatus.Succeeded && totalPrice >= 0;
-        const showDirectDebitMessage = !!payment && payment.method === PaymentMethod.DirectDebit && payment.status !== PaymentStatus.Succeeded && totalPrice >= 0;
-        const showStripeMessage = !payment && !!invoice.stripeAccountId && totalPrice >= 0;
-
-        const customerName = customer.firstName && customer.lastName
-            ? `${customer.firstName} ${customer.lastName}`
-            : (customer.firstName ?? customer.lastName ?? '');
-
-        const context = {
-            // TODO: replace with hosted asset URLs
-            logoUrl: organization.meta.horizontalLogo?.getPathForSize(400, undefined),
-            firstPageBackgroundUrl: organization.privateMeta.invoiceSettings.background?.getPublicPath(),
-            otherPageBackgroundUrl: organization.privateMeta.invoiceSettings.secondBackground?.getPublicPath() ?? organization.privateMeta.invoiceSettings.background?.getPublicPath(),
-            fontSemiBoldUrl: '',
-            fontMediumUrl: '',
-            colors: {
-                primary: organization.meta.color ?? platform.config.color ?? '#0053ff',
-            },
-
-            sender: {
-                name: seller.name,
-                address: formatAddress(seller.address, false),
-                vatNumber: seller.VATNumber ?? '',
-                bankAccount: organization.meta.registrationPaymentConfiguration.transferSettings.iban ?? '',
-            },
-
-            invoice: {
-                id: invoice.id,
-                number: invoice.number,
-                meta: {
-                    date,
-                    items: invoicedItems.map(item => ({
-                        amount: item.quantity / 1_00_00,
-                        name: item.name,
-                        description: item.description,
-                        unitPriceExclVAT: item.unitPrice,
-                        priceExclVAT: item.totalWithoutVAT,
-                        percentageLabel: Formatter.percentage(item.VATPercentage * 100),
-                    })),
-                    priceWithoutVAT: invoice.totalWithoutVAT,
-                    VAT: invoice.VATTotalAmount,
-                    VATTotal,
-                    hasMultipleVATRates,
-                    singleVATRateLabel,
-                    vatExcemptNote,
-                    payableRoundingAmount: invoice.payableRoundingAmount,
-                    totalPrice,
-                },
-                customer: {
-                    name: customer.dynamicName,
-                    contactName: !!customer.company && !!customer.name ? customer.name : null,
-                    address: company?.address ? formatAddress(company.address ?? null, seller.address?.country !== company.address.country ) : null,
-                    companyNumber: company?.companyNumber ?? '',
-                    VATNumber: company?.VATNumber ?? '',
-                },
-            },
-
-            payment: payment
-                ? {
-                    methodName: payment.method ? PaymentMethodHelper.getName(payment.method) : '',
-                    transferDescription: payment.transferDescription ?? '',
-                }
-                : null,
-
-            isCreditNote,
-            showDueDate,
-            dueDate,
-            showCompanyNumber,
-            hasRoundingAmount,
-            showPaidMessage,
-            showTransferMessage,
-            showDirectDebitMessage,
-            showStripeMessage,
+        return {
+            value: true,
         };
-
-        const file = await fs.readFile(import.meta.dirname+'/data/invoice.hbs.html', 'utf-8')
-        const renderedHtml = await render(file , context);
-        return renderedHtml;
     }
 
-    static async uploadPdf(invoice: Invoice, fileContent: Buffer) {
-        const fileId = uuidv4();
+    /**
+     * This is used for PEPPOL.
+     * Invoice is forwarded to an external invoicing tool which will send it via PEPPOL.
+     */
+    static async forwardInvoice(invoice: Invoice, organization: Organization) {
+        const { value, reason } = this.shouldForwardInvoice(invoice, organization);
 
-         let prefix = (STAMHOOFD.SPACES_PREFIX ?? '');
-        if (prefix.length > 0) {
-            prefix += '/';
+        if (!value) {
+            if (reason) {
+                console.log('Skipped sending PEPPOL: ', reason);
+            }
+            return;
         }
 
-        const envPrefix = STAMHOOFD.environment !== 'production' ? STAMHOOFD.environment : null;
-
-        if (envPrefix && envPrefix !== (STAMHOOFD.SPACES_PREFIX ?? '')) {
-            prefix += envPrefix + '/';
+        if (!organization.privateMeta.invoiceSettings.forwardEmailHandlers.length) {
+            console.error('PEPPOL email handlers NOT CONFIGURED');
+            return;
         }
 
-        const key = prefix + 'invoices/' + fileId + '.pdf';
+        const xml = await invoice.xml?.withSignedUrl();
 
-        const fileStruct = new File({
-            id: fileId,
-            server: 'https://' + STAMHOOFD.SPACES_BUCKET + '.' + STAMHOOFD.SPACES_ENDPOINT,
-            path: key,
-            size: fileContent.byteLength,
-            name: (invoice.number ?? invoice.id),
-            isPrivate: true,
-            contentType: 'application/pdf',
-        });
+        if (!xml) {
+            console.error('Could not send PEPPOL for invoice ' + invoice.id + ', xml not set');
+            return;
+        }
 
-        const cmd = new PutObjectCommand({
-            Bucket: STAMHOOFD.SPACES_BUCKET,
-            Key: key,
-            Body: fileContent,
-            ContentType: 'application/pdf',
-            ACL: 'private'
+        // Send the e-mail
+        Email.send({
+            // From address is fixed for sender validation
+            from: Email.getWebmasterFromEmail(),
+            to: organization.privateMeta.invoiceSettings.forwardEmailHandlers.map((d) => {
+                return {
+                    email: d,
+                };
+            }),
+            subject: $t('%1Zw') + ' ' + invoice.number,
+            text: $t('%1X5'),
+            attachments: [
+                {
+                    filename: invoice.generateCustomerFilename('xml'),
+                    href: xml.getPublicPath(),
+                    contentType: 'application/xml',
+                },
+            ],
         });
-        await Image.getS3Client().send(cmd);
 
-        // Sign the structure so it is accessible
-        if (!await fileStruct.sign()) {
-            throw new SimpleError({
-                code: 'failed_to_sign',
-                message: 'Failed to sign file',
-                human: $t('%B6'),
-                statusCode: 500,
-            });
-        }
-        
-        return fileStruct
+        invoice.didSendPeppol = true;
+        await invoice.save();
+        return true;
     }
 
-    static async generatePdf(invoice: Invoice) {
-        const html = await this.generateHtml(invoice);
-        if (!html) {
-            throw new Error('Failed to render invoice ' + invoice.id)
-        }
-        const form = new FormData();
+    static async sendCustomerEmail(invoice: Invoice, organization: Organization) {
+        let email = (invoice.customer.email || invoice.customer.company?.administrationEmail) ?? undefined;
+        let bcc = invoice.customer.company?.administrationEmail;
 
-        // File field
+        if (!email && invoice.payingOrganizationId) {
+            const payingOrganization = await Organization.getByID(invoice.payingOrganizationId);
+            if (payingOrganization) {
+                email = (await payingOrganization.getInvoicingToEmail()) ?? undefined;
+            }
+        }
 
-        // Sign fields
-        const cacheId = 'invoice-' + invoice.id;
-        console.log('html length:', html.length);
-        form.append('html', new Blob([html], { type: 'text/html' }));
-        form.append('cacheId', cacheId);
-        form.append('signature', signInternal(cacheId, invoice.updatedAt.getTime().toString(), html));
-        form.append('timestamp', invoice.updatedAt.getTime().toString());
+        if (bcc === email) {
+            bcc = undefined;
+        }
 
-        const controller = new AbortController();
-        const timeout = setTimeout(() => controller.abort(), 30_000);
+        if (!email) {
+            console.log('Skipped sending invoice email: no email address found for ' + invoice.id);
+            return;
+        }
 
-        try {
-            // Issue with system trusted CA in development
-            const result = await fetch((STAMHOOFD.environment === 'development' ? 'http://' : 'https://')+ STAMHOOFD.domains.rendererApi + '/v'+VERSION+'/html-to-pdf', {
-                method: 'POST',
-                body: form,
-                signal: controller.signal,
-            });
-            if (result.status === 200) {
-                // todo
-                const buffer = Buffer.from(await result.arrayBuffer())
-                const file = await this.uploadPdf(invoice, buffer);
-                invoice.pdf = file;
-                await invoice.save();
-            } else {
-                // todo
-            }
-        } catch (err) {
-            if (err instanceof DOMException && err.name === 'AbortError') {
-                throw new Error('Request timed out after 30s');
-            }
-            console.error(err);
-        } finally {
-            clearTimeout(timeout);
+        const payments = await Payment.select().where('invoiceId', invoice.id).fetch();
+        const isPaid = payments.every(p => p.status === PaymentStatus.Succeeded);
+
+        const pdf = await invoice.pdf?.withSignedUrl();
+        const xml = await invoice.xml?.withSignedUrl();
+
+        const recipients = [
+            Recipient.create({
+                email,
+                replacements: [
+                    Replacement.create({
+                        token: 'invoiceNumber',
+                        value: invoice.number ?? '',
+                    }),
+                    Replacement.create({
+                        token: 'totalPrice',
+                        value: Formatter.price(Math.abs(invoice.totalWithVAT)),
+                    }),
+                ],
+            }),
+        ];
+
+        if (bcc) {
+            recipients.push(Recipient.create({
+                email: bcc,
+                replacements: [
+                    Replacement.create({
+                        token: 'invoiceNumber',
+                        value: invoice.number ?? '',
+                    }),
+                    Replacement.create({
+                        token: 'totalPrice',
+                        value: Formatter.price(Math.abs(invoice.totalWithVAT)),
+                    }),
+                ],
+            }));
         }
+
+        await sendEmailTemplate(organization, {
+            recipients: [
+                Recipient.create({
+                    email,
+                    replacements: [
+                        Replacement.create({
+                            token: 'invoiceNumber',
+                            value: invoice.number ?? '',
+                        }),
+                        Replacement.create({
+                            token: 'totalPrice',
+                            value: Formatter.price(Math.abs(invoice.totalWithVAT)),
+                        }),
+                    ],
+                }),
+            ],
+            template: {
+                type: isPaid
+                    ? (invoice.totalWithVAT >= 0 ? EmailTemplateType.InvoicePaid : EmailTemplateType.CreditNotePaid)
+                    : (invoice.totalWithVAT >= 0 ? EmailTemplateType.InvoiceUnpaid : EmailTemplateType.CreditNoteUnpaid),
+            },
+            type: 'transactional',
+            attachments: [
+                ...(pdf
+                    ? [
+                            {
+                                filename: invoice.generateCustomerFilename('pdf'),
+                                href: pdf.getPublicPath(),
+                                contentType: 'application/pdf',
+                            },
+                        ]
+                    : []),
+                ...(xml
+                    ? [
+                            {
+                                filename: invoice.generateCustomerFilename('xml'),
+                                href: xml.getPublicPath(),
+                                contentType: 'application/xml',
+                            },
+                        ]
+                    : []),
+            ],
+        });
     }
 }