npm - @stamhoofd/backend - Versions diffs - 2.140.0 → 2.141.0 - Mend

@stamhoofd/backend 2.140.0 → 2.141.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (61) hide show

package/package.json +17 -17
package/src/crons/fake-settlements.test.ts +129 -8
package/src/crons/fake-settlements.ts +256 -9
package/src/crons/index.ts +1 -1
package/src/crons/invoices.ts +13 -8
package/src/crons/settlement-sync.test.ts +39 -0
package/src/crons/settlement-sync.ts +109 -0
package/src/crons/stripe-invoices.ts +19 -13
package/src/crons.ts +1 -5
package/src/endpoints/organization/dashboard/balance-items/GetBalanceItemBreakdownEndpoint.test.ts +4 -4
package/src/endpoints/organization/dashboard/mollie/ConnectMollieEndpoint.ts +2 -2
package/src/endpoints/organization/dashboard/organization/PatchOrganizationEndpoint.ts +1 -1
package/src/endpoints/organization/dashboard/payments/GetPaymentBreakdownEndpoint.test.ts +3 -3
package/src/endpoints/organization/dashboard/payments/GetPaymentsEndpoint.test.ts +150 -2
package/src/endpoints/organization/dashboard/{stripe/GetStripePayoutsExportStatusEndpoint.ts → settlements/GetSettlementsSyncStatusEndpoint.ts} +9 -7
package/src/endpoints/organization/dashboard/settlements/SettlementsExportEndpoint.test.ts +157 -0
package/src/endpoints/organization/dashboard/settlements/SettlementsExportEndpoint.ts +140 -0
package/src/endpoints/organization/dashboard/settlements/SettlementsSyncEndpoint.test.ts +110 -0
package/src/endpoints/organization/dashboard/settlements/SettlementsSyncEndpoint.ts +104 -0
package/src/excel-loaders/payments.ts +18 -1
package/src/helpers/ApplicationFeeDetails.ts +66 -0
package/src/helpers/ApplicationFeeInvoicer.test.ts +285 -0
package/src/helpers/ApplicationFeeInvoicer.ts +419 -0
package/src/helpers/AuthenticatedStructures.ts +14 -1
package/src/helpers/MollieSettlementSync.test.ts +361 -0
package/src/helpers/MollieSettlementSync.ts +323 -0
package/src/helpers/MollieSettlementSyncRunner.ts +53 -0
package/src/helpers/ProviderSettlementSyncRunner.ts +37 -0
package/src/helpers/SettlementExporter.test.ts +366 -0
package/src/helpers/SettlementExporter.ts +583 -0
package/src/helpers/SettlementSyncRunner.test.ts +165 -0
package/src/helpers/SettlementSyncRunner.ts +64 -0
package/src/helpers/StripeHelper.ts +2 -1
package/src/helpers/StripeSettlementSync.test.ts +828 -0
package/src/helpers/StripeSettlementSync.ts +947 -0
package/src/helpers/StripeSettlementSyncRunner.test.ts +66 -0
package/src/helpers/StripeSettlementSyncRunner.ts +152 -0
package/src/helpers/WebmasterReport.test.ts +109 -0
package/src/helpers/WebmasterReport.ts +115 -0
package/src/helpers/getPaymentIdForStripeCharge.test.ts +91 -0
package/src/helpers/getPaymentIdForStripeCharge.ts +71 -0
package/src/services/ApplicationFeeService.test.ts +256 -0
package/src/services/ApplicationFeeService.ts +283 -0
package/src/services/InvoiceService.ts +18 -1
package/src/services/SettlementService.test.ts +559 -0
package/src/services/SettlementService.ts +607 -0
package/src/sql-filters/payment-settlement.test.ts +2 -2
package/src/sql-filters/payments.ts +73 -0
package/tests/helpers/MollieMocker.ts +64 -6
package/tests/helpers/StripeMocker.ts +209 -17
package/src/crons/stripe-payout-reports.ts +0 -69
package/src/endpoints/organization/dashboard/stripe/StripePayoutsExportEndpoint.test.ts +0 -103
package/src/endpoints/organization/dashboard/stripe/StripePayoutsExportEndpoint.ts +0 -125
package/src/helpers/CheckSettlements.test.ts +0 -190
package/src/helpers/CheckSettlements.ts +0 -237
package/src/helpers/StripeInvoicer.ts +0 -419
package/src/helpers/StripePayoutChecker.ts +0 -193
package/src/helpers/StripePayoutExportData.ts +0 -195
package/src/helpers/StripePayoutExportExcel.ts +0 -280
package/src/helpers/StripePayoutReporter.test.ts +0 -419
package/src/helpers/StripePayoutReporter.ts +0 -585

package/src/endpoints/organization/dashboard/stripe/StripePayoutsExportEndpoint.ts DELETED Viewed

@@ -1,125 +0,0 @@
-import type { Decoder } from '@simonbackx/simple-encoding';
-import { AutoEncoder, DateDecoder, field, IntegerDecoder } from '@simonbackx/simple-encoding';
-import type { DecodedRequest, Request } from '@simonbackx/simple-endpoints';
-import { Endpoint, Response } from '@simonbackx/simple-endpoints';
-import { SimpleError } from '@simonbackx/simple-errors';
-import { Platform } from '@stamhoofd/models';
-import { QueueHandler } from '@stamhoofd/queues';
-import { Context } from '../../../../helpers/Context.js';
-import { StripePayoutReporter } from '../../../../helpers/StripePayoutReporter.js';
-export class PayoutExportStatus extends AutoEncoder {
-    @field({ decoder: DateDecoder })
-    start: Date;
-    @field({ decoder: DateDecoder })
-    end: Date;
-    @field({ decoder: IntegerDecoder })
-    count = 0;
-}
-type Params = Record<string, never>;
-class Body extends AutoEncoder {
-    @field({ decoder: DateDecoder })
-    start: Date;
-    @field({ decoder: DateDecoder })
-    end: Date;
-}
-type Query = undefined;
-type ResponseBody = undefined;
-/**
- * Manually build a Stripe payout report for a given period and email it (to check whether
- * everything we charged via Stripe application fees was invoiced correctly).
- */
-export class StripePayoutsExportEndpoint extends Endpoint<Params, Query, Body, ResponseBody> {
-    bodyDecoder = Body as Decoder<Body>;
-    static queue: PayoutExportStatus[] = [];
-    protected doesMatch(request: Request): [true, Params] | [false] {
-        if (request.method !== 'POST') {
-            return [false];
-        }
-        const params = Endpoint.parseParameters(request.url, '/stripe/payouts', {});
-        if (params) {
-            return [true, params as Params];
-        }
-        return [false];
-    }
-    static async authenticate() {
-        const organization = await Context.setOrganizationScope();
-        const { user } = await Context.authenticate();
-        if (!Context.auth.hasPlatformFullAccess()) {
-            throw Context.auth.error();
-        }
-        const platform = await Platform.getShared();
-        if (!platform.membershipOrganizationId || platform.membershipOrganizationId !== organization.id) {
-            throw new SimpleError({
-                code: 'not_available',
-                message: 'Stripe payout exports are only available for the platform membership organization',
-                statusCode: 400,
-            });
-        }
-        return { organization, user };
-    }
-    async handle(request: DecodedRequest<Params, Query, Body>) {
-        const { organization, user } = await StripePayoutsExportEndpoint.authenticate();
-        if (!STAMHOOFD.STRIPE_SECRET_KEY) {
-            throw new SimpleError({
-                code: 'not_configured',
-                message: 'Stripe is not configured',
-                statusCode: 400,
-            });
-        }
-        const secretKey = STAMHOOFD.STRIPE_SECRET_KEY;
-        const start = request.body.start;
-        const end = request.body.end;
-        const item = PayoutExportStatus.create({
-            start,
-            end,
-            count: 0,
-        });
-        StripePayoutsExportEndpoint.queue.push(item);
-        // Schedule
-        QueueHandler.schedule('stripe-payout-export', async () => {
-            try {
-                const reporter = new StripePayoutReporter({
-                    secretKey,
-                    sellingOrganization: organization,
-                });
-                let count = 0;
-                reporter.callback = () => {
-                    count++;
-                    item.count = count;
-                };
-                await reporter.build(start, end);
-                // Send the report to the user that requested it
-                await reporter.sendEmail({
-                    to: [{ email: user.email, name: user.name }],
-                });
-            } finally {
-                // Remove from queue
-                StripePayoutsExportEndpoint.queue.splice(StripePayoutsExportEndpoint.queue.indexOf(item), 1);
-            }
-        }).catch(console.error);
-        return new Response(undefined);
-    }
-}

package/src/helpers/CheckSettlements.test.ts DELETED Viewed

@@ -1,190 +0,0 @@
-import { MolliePayment, OrganizationFactory, Payment } from '@stamhoofd/models';
-import { PaymentMethod, PaymentProvider, PaymentStatus, PaymentType } from '@stamhoofd/structures';
-import type { MollieMockPayment, MollieMockRefund } from '../../tests/helpers/MollieMocker.js';
-import { MollieMocker } from '../../tests/helpers/MollieMocker.js';
-import { checkMollieSettlementsFor } from './CheckSettlements.js';
-describe('Helper.CheckSettlements', () => {
-    let mollieMocker: MollieMocker;
-    beforeAll(() => {
-        mollieMocker = new MollieMocker();
-        mollieMocker.start();
-    });
-    afterAll(() => {
-        mollieMocker.stop();
-    });
-    beforeEach(() => {
-        mollieMocker.reset();
-    });
-    /**
-     * Create an organization with a Mollie token, a succeeded Mollie payment and a Mollie refund
-     * payment reversing it. Both are linked to their Mollie ids (tr_... / re_...) like the real crons do.
-     */
-    const init = async () => {
-        const organization = await new OrganizationFactory({}).create();
-        const token = await mollieMocker.setupToken(organization);
-        // Source payment
-        const payment = new Payment();
-        payment.organizationId = organization.id;
-        payment.method = PaymentMethod.Bancontact;
-        payment.provider = PaymentProvider.Mollie;
-        payment.status = PaymentStatus.Succeeded;
-        payment.type = PaymentType.Payment;
-        payment.price = 50_0000;
-        payment.paidAt = new Date();
-        await payment.save();
-        const mockPayment: MollieMockPayment = {
-            id: mollieMocker.createId('tr'),
-            status: 'paid',
-            amount: { currency: 'EUR', value: '50.00' },
-            internalPaymentId: payment.id,
-            redirectUrl: null,
-            sequenceType: 'oneoff',
-            customerId: null,
-            mandateId: null,
-            isCancelable: false,
-            details: null,
-        };
-        mollieMocker.payments.push(mockPayment);
-        const paymentLink = new MolliePayment();
-        paymentLink.paymentId = payment.id;
-        paymentLink.mollieId = mockPayment.id;
-        await paymentLink.save();
-        // Refund payment reversing the source payment
-        const refundPayment = new Payment();
-        refundPayment.organizationId = organization.id;
-        refundPayment.method = PaymentMethod.Bancontact;
-        refundPayment.provider = PaymentProvider.Mollie;
-        refundPayment.status = PaymentStatus.Succeeded;
-        refundPayment.type = PaymentType.Refund;
-        refundPayment.price = -20_0000;
-        refundPayment.reversingPaymentId = payment.id;
-        refundPayment.paidAt = new Date();
-        await refundPayment.save();
-        const mockRefund = mollieMocker.createRefund(mockPayment, { value: '20.00', status: 'refunded' });
-        const refundLink = new MolliePayment();
-        refundLink.paymentId = refundPayment.id;
-        refundLink.mollieId = mockRefund.id;
-        await refundLink.save();
-        return { organization, token, payment, refundPayment, mockPayment, mockRefund };
-    };
-    const runCron = async (token: { accessToken: string }) => {
-        await checkMollieSettlementsFor(token.accessToken, true);
-    };
-    /**
-     * Add a Mollie chargeback payment reversing the given source payment, linked to its Mollie
-     * chargeback id (chb_...) like the mollie-chargebacks cron does.
-     */
-    const addChargeback = async (organizationId: string, sourcePayment: Payment, mockPayment: MollieMockPayment) => {
-        const chargebackPayment = new Payment();
-        chargebackPayment.organizationId = organizationId;
-        chargebackPayment.method = PaymentMethod.Bancontact;
-        chargebackPayment.provider = PaymentProvider.Mollie;
-        chargebackPayment.status = PaymentStatus.Succeeded;
-        chargebackPayment.type = PaymentType.Chargeback;
-        chargebackPayment.price = -sourcePayment.price;
-        chargebackPayment.reversingPaymentId = sourcePayment.id;
-        chargebackPayment.paidAt = new Date();
-        await chargebackPayment.save();
-        const mockChargeback = mollieMocker.createChargeback(mockPayment);
-        const chargebackLink = new MolliePayment();
-        chargebackLink.paymentId = chargebackPayment.id;
-        chargebackLink.mollieId = mockChargeback.id;
-        await chargebackLink.save();
-        return { chargebackPayment, mockChargeback };
-    };
-    test('The settlement of a refund settled at Mollie is stored on the refund payment', async () => {
-        const { token, payment, refundPayment, mockPayment, mockRefund } = await init();
-        const settlement = mollieMocker.createSettlement({
-            payments: [mockPayment],
-            refunds: [mockRefund],
-            value: '100.00',
-        });
-        await runCron(token);
-        // The source payment gets the settlement metadata (existing behaviour)
-        const updatedPayment = await Payment.getByID(payment.id);
-        expect(updatedPayment!.settlement).toMatchObject({
-            id: settlement.id,
-            reference: settlement.reference,
-        });
-        // The refund payment gets the same settlement metadata (new behaviour)
-        const updatedRefund = await Payment.getByID(refundPayment.id);
-        expect(updatedRefund!.settlement).toMatchObject({
-            id: settlement.id,
-            reference: settlement.reference,
-            amount: 100_0000,
-        });
-    });
-    test('A refund that is not part of any settlement keeps no settlement', async () => {
-        const { token, refundPayment, mockPayment } = await init();
-        // A settlement that only contains the source payment, not the refund
-        mollieMocker.createSettlement({ payments: [mockPayment], value: '50.00' });
-        await runCron(token);
-        const updatedRefund = await Payment.getByID(refundPayment.id);
-        expect(updatedRefund!.settlement).toBeNull();
-    });
-    test('The settlement of a chargeback settled at Mollie is stored on the chargeback payment', async () => {
-        const { organization, token, payment, mockPayment } = await init();
-        const { chargebackPayment, mockChargeback } = await addChargeback(organization.id, payment, mockPayment);
-        const settlement = mollieMocker.createSettlement({
-            payments: [mockPayment],
-            chargebacks: [mockChargeback],
-            value: '100.00',
-        });
-        await runCron(token);
-        const updatedChargeback = await Payment.getByID(chargebackPayment.id);
-        expect(updatedChargeback!.settlement).toMatchObject({
-            id: settlement.id,
-            reference: settlement.reference,
-            amount: 100_0000,
-        });
-    });
-    test('An unlinked refund entry in a settlement is skipped without affecting the known refund', async () => {
-        const { token, refundPayment, mockPayment, mockRefund } = await init();
-        // A refund that belongs to a different system: it exists at Mollie but has no MolliePayment link
-        const unlinkedRefund: MollieMockRefund = mollieMocker.createRefund(mockPayment, { value: '5.00', status: 'refunded' });
-        const settlement = mollieMocker.createSettlement({
-            payments: [mockPayment],
-            refunds: [unlinkedRefund, mockRefund],
-            value: '100.00',
-        });
-        await runCron(token);
-        // The known refund still gets its settlement, the unlinked one is silently ignored
-        const updatedRefund = await Payment.getByID(refundPayment.id);
-        expect(updatedRefund!.settlement).toMatchObject({ id: settlement.id });
-    });
-});

package/src/helpers/CheckSettlements.ts DELETED Viewed

@@ -1,237 +0,0 @@
-import { MolliePayment, MollieToken, Order, Organization, PayconiqPayment, Payment, StripeAccount } from '@stamhoofd/models';
-import { Settlement } from '@stamhoofd/structures';
-import axios from 'axios';
-import { StripePayoutChecker } from './StripePayoutChecker.js';
-type MollieSettlement = {
-    id: string;
-    reference: string;
-    createdAt: string;
-    settledAt: string;
-    status: 'open' | 'pending' | 'paidout' | 'failed';
-    amount: {
-        currenty: string;
-        value: string;
-    };
-};
-/**
- * Both payments (tr_...) and refunds (re_...) settled in a settlement are matched to a local
- * payment through the mollieId of their MolliePayment link, so we only need their id here.
- */
-type MollieSettlementEntryJSON = {
-    id: string;
-};
-let lastSettlementCheck: Date | null = null;
-export async function checkAllStripePayouts(checkAll = false) {
-    if (STAMHOOFD.environment !== 'production' || !STAMHOOFD.STRIPE_SECRET_KEY) {
-        console.log('Skip settlement check');
-        return;
-    }
-    // Stripe payouts
-    const stripeAccounts = await StripeAccount.where({ status: 'active' });
-    for (const account of stripeAccounts) {
-        try {
-            console.log('Checking settlements for ', account.accountId);
-            const checker = new StripePayoutChecker({
-                secretKey: STAMHOOFD.STRIPE_SECRET_KEY,
-                stripeAccount: account.accountId,
-            });
-            await checker.checkSettlements(checkAll);
-        } catch (e) {
-            console.error(e);
-        }
-    }
-}
-export async function checkSettlements(checkAll = false) {
-    if (STAMHOOFD.environment !== 'production') {
-        return;
-    }
-    if (!checkAll && lastSettlementCheck && (lastSettlementCheck > new Date(new Date().getTime() - 24 * 60 * 60 * 1000))) {
-        console.log('Skip settlement check');
-        return;
-    }
-    console.log('Checking settlements...');
-    lastSettlementCheck = new Date();
-    // Mollie payment is required
-    const token = STAMHOOFD.MOLLIE_ORGANIZATION_TOKEN;
-    if (!token) {
-        console.error('Missing mollie organization token');
-    } else {
-        await checkMollieSettlementsFor(token, checkAll);
-    }
-    // Loop all mollie tokens created after given date (when settlement permission was added)
-    try {
-        // Stripe payouts
-        await checkAllStripePayouts(checkAll);
-        const mollieTokens = await MollieToken.all();
-        for (const token of mollieTokens) {
-            if (token.createdAt < new Date(2021, 8 /* september! */, 8)) {
-                console.log('Skipped mollie token that is too old');
-            } else {
-                try {
-                    await token.refreshIfNeeded();
-                    await checkMollieSettlementsFor(token.accessToken, checkAll);
-                } catch (e) {
-                    console.error(e);
-                }
-            }
-        }
-    } catch (e) {
-        console.error(e);
-    }
-}
-// Check settlements once a week on tuesday morning/night
-export async function checkMollieSettlementsFor(token: string, checkAll = false) {
-    // Check last 2 weeks + 3 day margin, unless we check them all
-    const d = new Date();
-    d.setDate(d.getDate() - 17);
-    console.log('Checking settlements for given token...');
-    // Loop all organizations with online paymetns the last week
-    try {
-        const request = await axios.get('https://api.mollie.com/v2/settlements?limit=' + (checkAll ? 250 : 14), {
-            headers: {
-                Authorization: 'Bearer ' + token,
-            },
-        });
-        if (request.status === 200) {
-            // get data
-            try {
-                const data = request.data;
-                // Read the data
-                if (data._embedded?.settlements) {
-                    const settlements = data._embedded.settlements as MollieSettlement[];
-                    for (const settlement of settlements) {
-                        if (settlement.settledAt === null) {
-                            // Skip: this is the open settlement
-                            continue;
-                        }
-                        const settledAt = new Date(settlement.settledAt);
-                        if (isNaN(settledAt.getTime())) {
-                            console.error('Received an invalid settledAt from Mollie', settlement, 'for token', token);
-                            continue;
-                        }
-                        if (checkAll || settledAt > d) {
-                            await updateSettlement(token, settlement);
-                        }
-                    }
-                } else {
-                    console.error('Unreadable settlements');
-                }
-            } catch (e) {
-                console.error(request.data);
-                throw e;
-            }
-        } else {
-            console.error('Failed to fetch settlements');
-            console.error(request.data);
-        }
-    } catch (e) {
-        console.error(e);
-    }
-}
-async function updateSettlement(token: string, settlement: MollieSettlement) {
-    // Regular payments settled in this settlement
-    await updateSettlementResource(token, settlement, 'payments');
-    // Refunds settled in this settlement. These are negative entries linked to a refund payment
-    // (created by the mollie-refunds cron), so we can set their settlement metadata too.
-    await updateSettlementResource(token, settlement, 'refunds');
-    // Chargebacks settled in this settlement. Like refunds, these are negative entries linked to a
-    // chargeback payment (created by the mollie-chargebacks cron).
-    await updateSettlementResource(token, settlement, 'chargebacks');
-}
-/**
- * Loop over all entries (payments, refunds or chargebacks) that are part of a settlement and set the
- * settlement metadata on the matching local payment. Every resource exposes its entries under
- * `_embedded[resource]` and uses the same pagination, so they share this logic.
- */
-async function updateSettlementResource(token: string, settlement: MollieSettlement, resource: 'payments' | 'refunds' | 'chargebacks', fromId?: string) {
-    const limit = 250;
-    const request = await axios.get('https://api.mollie.com/v2/settlements/' + settlement.id + '/' + resource + '?limit=' + limit + (fromId ? ('&from=' + encodeURIComponent(fromId)) : ''), {
-        headers: {
-            Authorization: 'Bearer ' + token,
-        },
-    });
-    if (request.status === 200) {
-        const entries = request.data._embedded[resource] as MollieSettlementEntryJSON[];
-        for (const entry of entries) {
-            await applySettlementToPayment(settlement, entry.id);
-        }
-        // Check next page
-        if (request.data._links.next && entries.length > 0) {
-            await updateSettlementResource(token, settlement, resource, entries[entries.length - 1].id);
-        }
-    } else {
-        console.error(request.data);
-    }
-}
-/**
- * Find the local payment linked to a Mollie payment or refund id and store the settlement metadata.
- */
-async function applySettlementToPayment(settlement: MollieSettlement, mollieId: string) {
-    // Search payment
-    const mps = await MolliePayment.where({ mollieId });
-    if (mps.length === 1) {
-        const mp = mps[0];
-        const payment = await Payment.getByID(mp.paymentId);
-        if (payment) {
-            payment.settlement = Settlement.create({
-                id: settlement.id,
-                reference: settlement.reference,
-                settledAt: new Date(settlement.settledAt),
-                amount: Math.round(parseFloat(settlement.amount.value) * 100) * 100,
-            });
-            const saved = await payment.save();
-            if (saved) {
-                // Mark order as 'updated', or the frontend won't pull in the updates
-                const order = await Order.getForPayment(null, payment.id);
-                if (order) {
-                    order.updatedAt = new Date();
-                    order.forceSaveProperty('updatedAt');
-                    await order.save();
-                }
-                // TODO: Mark registrations as 'saved'
-            }
-            if (STAMHOOFD.environment === 'development') {
-                console.log('Updated settlement of payment ' + payment.id);
-                console.log(payment.settlement);
-            }
-        } else {
-            console.log('Missing payment ' + mp.paymentId);
-        }
-    } else {
-        // Probably a payment in a different system/platform
-        // console.log("No mollie payment found for id "+mollieId)
-    }
-}