@stamhoofd/models 2.106.0 → 2.107.0

package/src/models/BalanceItem.ts

@@ -1,5 +1,5 @@
 import { column, Database } from '@simonbackx/simple-database';
-import { BalanceItemPaymentWithPayment, BalanceItemPaymentWithPrivatePayment, BalanceItemRelation, BalanceItemRelationType, BalanceItemStatus, BalanceItem as BalanceItemStruct, BalanceItemType, BalanceItemWithPayments, BalanceItemWithPrivatePayments, Payment as PaymentStruct, PrivatePayment } from '@stamhoofd/structures';
+import { BalanceItemPaymentWithPayment, BalanceItemPaymentWithPrivatePayment, BalanceItemRelation, BalanceItemRelationType, BalanceItemStatus, BalanceItem as BalanceItemStruct, BalanceItemType, BalanceItemWithPayments, BalanceItemWithPrivatePayments, Payment as PaymentStruct, PrivatePayment, VATExcemptReason } from '@stamhoofd/structures';
 import { Formatter } from '@stamhoofd/utility';
 import { v4 as uuidv4 } from 'uuid';
 
@@ -72,25 +72,81 @@ export class BalanceItem extends QueryableModel {
     amount = 1;
 
     /**
-     * Total prices
+     * Price per piece
+     *
+     * NOTE: We store an integer of the price up to 4 digits after the comma.
+     * 1 euro = 10000.
+     * 0,01 euro = 100
+     * 0,0001 euro = 1
+     *
+     * This is required for correct VAT calculations without intermediate rounding.
      */
     @column({ type: 'integer' })
     unitPrice: number;
 
+    @column({ type: 'integer', nullable: true })
+    VATPercentage: number | null = null;
+
+    @column({ type: 'boolean' })
+    VATIncluded = true;
+
+    /**
+     * Whether there is a VAT excempt reason.
+     * Note: keep the original VAT in these cases. On time of payment or invoicing, the VAT excemption will be revalidated.
+     * If that fails, we can still charge the VAT.
+     */
+    @column({ type: 'string', nullable: true })
+    VATExcempt: VATExcemptReason | null = null;
+
+    /**
+     * This is a cached value for storing in the database.
+     * It stores the calculated price with VAT.
+     * 
+     * price should = pricePaid + pricePending + priceOpen
+     */
+    @column({ 
+        type: 'integer',
+        beforeSave: function () {
+            return this.priceWithVAT;
+        },
+    })
+    priceTotal = 0;
+
     /**
      * Cached value, for optimizations
+     *
+     * NOTE: We store an integer of the price up to 4 digits after the comma.
+     * 1 euro = 10000.
+     * 0,01 euro = 100
+     * 0,0001 euro = 1
+     *
+     * This is required for correct VAT calculations without intermediate rounding.
      */
     @column({ type: 'integer' })
     pricePaid = 0;
 
     /**
      * Cached value, for optimizations
+     *
+     * NOTE: We store an integer of the price up to 4 digits after the comma.
+     * 1 euro = 10000.
+     * 0,01 euro = 100
+     * 0,0001 euro = 1
+     *
+     * This is required for correct VAT calculations without intermediate rounding.
      */
     @column({ type: 'integer' })
     pricePending = 0;
 
     /**
      * Cached value, for optimizations
+     *
+     * NOTE: We store an integer of the price up to 4 digits after the comma.
+     * 1 euro = 10000.
+     * 0,01 euro = 100
+     * 0,0001 euro = 1
+     *
+     * This is required for correct VAT calculations without intermediate rounding.
      */
     @column({
         type: 'integer',
@@ -143,7 +199,67 @@ export class BalanceItem extends QueryableModel {
     })
     updatedAt: Date;
 
+    /**
+     * @deprecated: use priceWithVAT
+     * NOTE: This contains an integer of the price up to 4 digits after the comma.
+     * 1 euro = 10000.
+     * 0,01 euro = 100
+     * 0,0001 euro = 1
+     *
+     * This is required for correct VAT calculations without intermediate rounding.
+     */
     get price() {
+        return this.priceWithVAT;
+    }
+
+    /**
+     * Difference here is that when the VAT is excempt, this is still set, while VAT will be zero.
+     */
+    get calculatedVAT() {
+        if (!this.VATPercentage) {
+            // VAT percentage not set, so treat as 0%
+            return 0;
+        }
+
+        if (this.VATIncluded) {
+            // Calculate VAT on price incl. VAT, which is not 100% correct and causes roudning issues
+            return this.unitPrice * this.amount - Math.round(this.unitPrice * this.amount * 100 / (100 + this.VATPercentage));
+        }
+
+        // Note: the rounding is only to avoid floating point errors in software, this should not cause any actual rounding
+        // That is the reason why we store it up to 4 digits after comma
+        return Math.round(this.VATPercentage * this.unitPrice * this.amount / 100);
+    }
+
+    /**
+     * Note, this is not 100% accurate.
+     * Legally we most often need to calculate the VAT on invoice level and round it there.
+     * Technically we cannot pass infinite accurate numbers around in a system to avoid rounding. The returned number is
+     * therefore rounded up to 4 digits after the comma. On normal amounts, with only 2 digits after the comma, this won't lose accuracy.
+     * So the VAT calculation needs to happen at the end again before payment.
+     */
+    get VAT() {
+        if (this.VATExcempt) {
+            // Exempt from VAT
+            return 0;
+        }
+
+        return this.calculatedVAT;
+    }
+
+    get priceWithVAT() {
+        return this.priceWithoutVAT + this.VAT;
+    }
+
+    /**
+     * Note: when the VAT is already included, the result of this will be unreliable because of rounding issues.
+     * Do not use this in calculations!
+     */
+    get priceWithoutVAT() {
+        if (this.VATIncluded) {
+            return this.unitPrice * this.amount - this.calculatedVAT;
+        }
+
         return this.unitPrice * this.amount;
     }
 
@@ -168,18 +284,26 @@ export class BalanceItem extends QueryableModel {
         return this.isAfterDueDate;
     }
 
+    /**
+     * NOTE: This contains an integer of the price up to 4 digits after the comma.
+     * 1 euro = 10000.
+     * 0,01 euro = 100
+     * 0,0001 euro = 1
+     *
+     * This is required for correct VAT calculations without intermediate rounding.
+     */
     get calculatedPriceOpen() {
         if (this.status !== BalanceItemStatus.Due) {
             return -this.pricePaid - this.pricePending;
         }
-        return this.price - this.pricePaid - this.pricePending;
+        return this.priceWithVAT - this.pricePaid - this.pricePending;
     }
 
     /**
      * price minus pricePaid
      */
     get priceUnpaid() {
-        return this.price - this.pricePaid;
+        return this.priceWithVAT - this.pricePaid;
     }
 
     get isPaid() {
@@ -374,7 +498,7 @@ export class BalanceItem extends QueryableModel {
         SET balance_items.pricePaid = coalesce(paid.price, 0),
             balance_items.pricePending = coalesce(pending.price, 0),
             balance_items.priceOpen = (CASE
-                WHEN balance_items.status = '${BalanceItemStatus.Due}' THEN (balance_items.unitPrice * balance_items.amount - balance_items.pricePaid - balance_items.pricePending)
+                WHEN balance_items.status = '${BalanceItemStatus.Due}' THEN (balance_items.priceTotal - balance_items.pricePaid - balance_items.pricePending)
                 ELSE (-balance_items.pricePaid - balance_items.pricePending)
             END)
         ${secondWhere}`;

package/src/models/EmailVerificationCode.ts

@@ -222,7 +222,7 @@ export class EmailVerificationCode extends QueryableModel {
             });
         }
 
-        if (verificationCode.code === code || (code === '111111' && STAMHOOFD.environment === 'development')) {
+        if (verificationCode.code === code || (code === '111111' && (STAMHOOFD.environment === 'development' || STAMHOOFD.environment === 'test'))) {
             // Delete all remaining information!
             // To avoid leaving information about the existince of this user (tries)
             await verificationCode.delete();

package/src/models/Event.ts

@@ -118,7 +118,8 @@ export class Event extends QueryableModel {
             if (waitingList) {
                 if (group.settings.allowRegistrationsByOrganization) {
                     waitingList.settings.allowRegistrationsByOrganization = true;
-                } else {
+                }
+                else {
                     waitingList.settings.allowRegistrationsByOrganization = false;
                 }
                 await this.syncGroupRequirements(waitingList);

package/src/models/Order.ts

@@ -67,12 +67,17 @@ export class Order extends QueryableModel {
     @column({ type: 'string' })
     status = OrderStatus.Created;
 
-    // #region generated columns for filtering
+    /**
+     * Cached value for faster in database filtering
+     */
     @column({ type: 'integer', nullable: true, beforeSave(this: Order) {
         return this.data.totalPrice;
     } })
     totalPrice: number = 0;
 
+    /**
+     * Cached value for faster in database filtering
+     */
     @column({ type: 'integer', nullable: true, beforeSave(this: Order) {
         return this.data.amount;
     } })
@@ -82,7 +87,6 @@ export class Order extends QueryableModel {
         return this.data.timeSlot?.timeIndex ?? null;
     } })
     timeSlotTime: string | null = null;
-    // #endregion
 
     static webshop = new ManyToOneRelation(Webshop, 'webshop');
     static payment = new ManyToOneRelation(Payment, 'payment');

package/src/models/PayconiqPayment.ts

@@ -92,7 +92,7 @@ export class PayconiqPayment extends QueryableModel {
 
         // Check and save amount
         if (typeof response.amount === 'number' && status === PaymentStatus.Succeeded) {
-            const amount = response.amount;
+            const amount = response.amount * 100; // Convert from integer with 2 decimal places to 4 places
             if (amount < payment.price) {
                 // We do NOT allow lower prices
                 console.error('Manual price change detected by Payconiq user. Failing the payment');
@@ -157,7 +157,7 @@ export class PayconiqPayment extends QueryableModel {
 
         const response = await this.request('POST', '/v3/payments', {
             reference: payment.id.replaceAll('-', ''), // 36 chars, max length is 35.... The actual id is also in the description
-            amount: payment.price,
+            amount: Math.round(payment.price / 100), // 4 decimals to 2 decimals
             currency: 'EUR',
             callbackUrl: callbackUrl ?? 'https://' + organization.getApiHost() + '/v' + Version + '/payments/' + encodeURIComponent(payment.id) + '?exchange=true',
             returnUrl,

package/src/models/Payment.ts

@@ -3,7 +3,7 @@ import { BalanceItemDetailed, BalanceItemPaymentDetailed, PaymentCustomer, Payme
 import { Formatter } from '@stamhoofd/utility';
 import { v4 as uuidv4 } from 'uuid';
 
-import { Organization } from './';
+import { BalanceItem, Organization } from './';
 import { QueryableModel } from '@stamhoofd/sql';
 
 export class Payment extends QueryableModel {
@@ -165,6 +165,10 @@ export class Payment extends QueryableModel {
         this.transferDescription = settings.generateDescription(reference, organization.address.country, replacements);
     }
 
+    static roundPrice(price: number) {
+        return Math.round(price / 100) * 100;
+    }
+
     static async getGeneralStructure(payments: Payment[], includeSettlements = false): Promise<PaymentGeneral[]> {
         if (payments.length === 0) {
             return [];

package/src/models/STInvoice.ts

@@ -81,6 +81,9 @@ export class STInvoice extends QueryableModel {
     @column({ type: 'string', nullable: true })
     reference: string | null = null;
 
+    @column({ type: 'boolean' })
+    didSendPeppol = false;
+
     // static organization = new ManyToOneRelation(Organization, 'organization');
     // static payment = new ManyToOneRelation(Payment, 'payment');
 

package/src/models/STPackage.ts

@@ -194,7 +194,7 @@ export class STPackage extends QueryableModel {
             pack.meta.serviceFeeFixed = 0;
             pack.meta.serviceFeePercentage = 2_00;
             pack.meta.serviceFeeMinimum = 0;
-            pack.meta.serviceFeeMaximum = 20;
+            pack.meta.serviceFeeMaximum = 2000; // 20 cent
 
             pack.meta.unitPrice = 0;
             pack.meta.pricingType = STPricingType.Fixed;
@@ -207,7 +207,7 @@ export class STPackage extends QueryableModel {
             pack.meta.serviceFeeMinimum = 0;
             pack.meta.serviceFeeMaximum = 0;
 
-            pack.meta.unitPrice = 100;
+            pack.meta.unitPrice = 1_0000; // 1 euro
             pack.meta.pricingType = STPricingType.PerMember;
         }