@stamhoofd/structures 2.118.1 → 2.120.0

package/dist/BalanceItem.d.ts

@@ -0,0 +1,275 @@
+import { AutoEncoder } from '@simonbackx/simple-encoding';
+import { Payment, PrivatePayment } from './members/Payment.js';
+import type { PriceBreakdown } from './PriceBreakdown.js';
+import { TranslatedString } from './TranslatedString.js';
+export declare enum BalanceItemStatusV352 {
+    Hidden = "Hidden",
+    Pending = "Pending",
+    Paid = "Paid"
+}
+export declare enum BalanceItemStatus {
+    /**
+     * The balance is not yet due, but it can be paid. As soon as it is paid, it will transform into 'Due' and automatic status changes can happen to connected resources.
+     */
+    Hidden = "Hidden",
+    /**
+     * This means payment of the amount is a requirement.
+    */
+    Due = "Due",
+    /**
+     * This means the balance is no longer due. If there is any paid amount, it is refundable.
+     * In case you don't want to refund the amount, you should change the status to 'Due' and change the amount to the amount that is not refundable.
+    */
+    Canceled = "Canceled"
+}
+export declare enum VATExcemptReason {
+    /**
+     * Btw verlegd: Art. 39 bis – intracommunautaire levering
+     */
+    IntraCommunity = "IntraCommunity"
+}
+export declare function getVATExcemptReasonName(reason: VATExcemptReason): string;
+export declare function getVATExcemptInvoiceNote(reason: VATExcemptReason): string;
+export declare enum BalanceItemType {
+    Registration = "Registration",
+    AdministrationFee = "AdministrationFee",
+    FreeContribution = "FreeContribution",
+    Order = "Order",
+    Other = "Other",
+    PlatformMembership = "PlatformMembership",
+    CancellationFee = "CancellationFee",
+    RegistrationBundleDiscount = "RegistrationBundleDiscount",
+    /**
+     * Small differences that occurred when creating a payment or invoice
+     */
+    Rounding = "Rounding",
+    /**
+     * Platform package activation (features)
+     */
+    STPackage = "STPackage"
+}
+export declare function getBalanceItemStatusName(type: BalanceItemStatus): string;
+export declare function getBalanceItemTypeName(type: BalanceItemType): string;
+export declare function getBalanceItemTypeIcon(type: BalanceItemType): string | null;
+export declare enum BalanceItemRelationType {
+    Webshop = "Webshop",// Contains the name of the webshop
+    Group = "Group",// Contains the name of the group you registered for
+    GroupPrice = "GroupPrice",// Contains the price of the group you registered for
+    GroupOptionMenu = "GroupOptionMenu",// Contains the option menu that was chosen for the group
+    GroupOption = "GroupOption",// Contains the option that was chosen for the group
+    Member = "Member",// Contains the name of the member you registered
+    MembershipType = "MembershipType",
+    Discount = "Discount",// Name and id of the related discount
+    STPackage = "STPackage"
+}
+export declare function getBalanceItemRelationTypeName(type: BalanceItemRelationType): string;
+export declare function getBalanceItemRelationTypeDescription(type: BalanceItemRelationType): string;
+/**
+ * Return true if it is allowed to group balance items if they have a different value for this relation type
+ */
+export declare function shouldAggregateOnRelationType(type: BalanceItemRelationType, item: {
+    type: BalanceItemType;
+    relations: Map<BalanceItemRelationType, BalanceItemRelation>;
+}): boolean;
+/**
+ * Helps you understand what a balance item is for. It can be for multiple things at the same time, e.g. when it is an option to buy a ticket, it is also a ticket.
+ */
+export declare class BalanceItemRelation extends AutoEncoder {
+    id: string;
+    name: TranslatedString;
+}
+export declare function doBalanceItemRelationsMatch(a: Map<BalanceItemRelationType, BalanceItemRelation>, b: Map<BalanceItemRelationType, BalanceItemRelation>, allowedDifference?: number): boolean;
+export declare class BalanceItem extends AutoEncoder {
+    id: string;
+    type: BalanceItemType;
+    relations: Map<BalanceItemRelationType, BalanceItemRelation>;
+    description: string;
+    /**
+     * quantity, should be renamed to quantity in the future
+     */
+    amount: number;
+    get quantity(): number;
+    set quantity(value: number);
+    /**
+     * 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.
+     */
+    unitPrice: number;
+    VATPercentage: number | null;
+    VATIncluded: boolean;
+    /**
+     * 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.
+     */
+    VATExcempt: VATExcemptReason | null;
+    /**
+     * @deprecated use priceWithVAT in combination with isDue
+     *
+     * 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.
+     */
+    get price(): number;
+    /**
+     * Total price that needs to be paid, not including already paid or pending payments.
+     *
+     * The difference with priceWithVAT is that it takes into account canceled and hidden balance items
+     */
+    get payablePriceWithVAT(): number;
+    /**
+     * Difference here is that when the VAT is excempt, this is still set, while VAT will be zero.
+     */
+    get calculatedVAT(): number;
+    /**
+     * 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(): number;
+    get priceWithVAT(): number;
+    /**
+     * 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(): number;
+    get unitPriceWithVAT(): number;
+    /**
+     * 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.
+     */
+    get priceOpen(): number;
+    /**
+     * 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.
+     */
+    pricePaid: number;
+    /**
+     * 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.
+     */
+    pricePending: number;
+    /**
+     * How much has been invoiced
+     */
+    dueAt: Date | null;
+    createdAt: Date;
+    status: BalanceItemStatus;
+    get isPaid(): boolean;
+    get isDue(): boolean;
+    get isOverDue(): boolean;
+    organizationId: string;
+    memberId: string | null;
+    userId: string | null;
+    registrationId: string | null;
+    payingOrganizationId: string | null;
+    orderId: string | null;
+    static getDueOffset(from?: Date): Date;
+    static getOutstandingBalance(items: BalanceItem[]): {
+        priceWithVAT: number;
+        payablePriceWithVAT: number;
+        pricePending: number;
+        priceOpen: number;
+        pricePaid: number;
+    };
+    static filterBalanceItems(items: BalanceItem[]): BalanceItem[];
+    get paymentShortDescription(): string;
+    /**
+     * To help split payments in categories: return a more detailed category than purely the type
+     */
+    get category(): string;
+    get groupTitle(): string;
+    get groupDescription(): string | null;
+    get priceBreakown(): PriceBreakdown;
+    /**
+     * Unique identifier whithing a reporting group
+     */
+    get groupCode(): string;
+    /**
+     * When displayed as a single item
+     */
+    get itemTitle(): string;
+    /**
+     * When displayed as a single item
+     */
+    get itemDescription(): string | null;
+    static getDetailsHTMLTable(items: BalanceItem[]): string;
+}
+export declare class BalanceItemPayment extends AutoEncoder {
+    id: string;
+    price: number;
+}
+export declare class BalanceItemPaymentWithPayment extends BalanceItemPayment {
+    payment: Payment;
+}
+export declare class BalanceItemPaymentWithPrivatePayment extends BalanceItemPayment {
+    payment: PrivatePayment;
+}
+export declare class BalanceItemWithPayments extends BalanceItem {
+    payments: BalanceItemPaymentWithPayment[];
+    updatePricePaid(): void;
+    /**
+     * Return whether a payment has been initiated for this balance item
+     */
+    get hasPendingPayment(): boolean;
+}
+export declare class BalanceItemWithPrivatePayments extends BalanceItemWithPayments {
+    payments: BalanceItemPaymentWithPrivatePayment[];
+}
+export declare class GroupedBalanceItems {
+    items: BalanceItem[];
+    constructor();
+    get id(): string;
+    add(item: BalanceItem): void;
+    get balanceItem(): BalanceItem;
+    /**
+     * Only shows amount open
+     */
+    get amount(): number;
+    get status(): BalanceItemStatus;
+    /**
+     * Only shows outstanding price
+     */
+    get priceOpen(): number;
+    get price(): number;
+    get unitPriceWithVAT(): number;
+    get pricePending(): number;
+    get pricePaid(): number;
+    get itemTitle(): string;
+    get itemDescription(): string | null;
+    get unitPrice(): number;
+    get unitPriceWithAT(): number;
+    get dueAt(): Date | null;
+    get isDue(): boolean;
+    get isOverDue(): boolean;
+    get type(): BalanceItemType;
+    static group(items: BalanceItem[]): GroupedBalanceItems[];
+}
+//# sourceMappingURL=BalanceItem.d.ts.map

package/dist/BalanceItem.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BalanceItem.d.ts","sourceRoot":"","sources":["../src/BalanceItem.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,WAAW,EAA8F,MAAM,6BAA6B,CAAC;AAIpK,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAGzD,oBAAY,qBAAqB;IAC7B,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,IAAI,SAAS;CAChB;AAED,oBAAY,iBAAiB;IACzB;;OAEG;IACH,MAAM,WAAW;IAEjB;;MAEE;IACF,GAAG,QAAQ;IAEX;;;MAGE;IACF,QAAQ,aAAa;CACxB;AAED,oBAAY,gBAAgB;IACxB;;OAEG;IACH,cAAc,mBAAmB;CACpC;AAED,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,gBAAgB,GAAG,MAAM,CAIxE;AAED,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,gBAAgB,GAAG,MAAM,CAIzE;AAED,oBAAY,eAAe;IACvB,YAAY,iBAAiB;IAC7B,iBAAiB,sBAAsB;IACvC,gBAAgB,qBAAqB;IACrC,KAAK,UAAU;IACf,KAAK,UAAU;IACf,kBAAkB,uBAAuB;IACzC,eAAe,oBAAoB;IACnC,0BAA0B,+BAA+B;IACzD;;OAEG;IACH,QAAQ,aAAa;IAErB;;OAEG;IACH,SAAS,cAAc;CAC1B;AAED,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,iBAAiB,GAAG,MAAM,CAMxE;AAED,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,eAAe,GAAG,MAAM,CAapE;AAED,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,eAAe,GAAG,MAAM,GAAG,IAAI,CAa3E;AAED,oBAAY,uBAAuB;IAC/B,OAAO,YAAY,CAAE,mCAAmC;IACxD,KAAK,UAAU,CAAE,oDAAoD;IACrE,UAAU,eAAe,CAAE,qDAAqD;IAChF,eAAe,oBAAoB,CAAE,yDAAyD;IAC9F,WAAW,gBAAgB,CAAE,oDAAoD;IACjF,MAAM,WAAW,CAAE,iDAAiD;IACpE,cAAc,mBAAmB;IACjC,QAAQ,aAAa,CAAE,sCAAsC;IAE7D,SAAS,cAAc;CAC1B;AAED,wBAAgB,8BAA8B,CAAC,IAAI,EAAE,uBAAuB,GAAG,MAAM,CAYpF;AAED,wBAAgB,qCAAqC,CAAC,IAAI,EAAE,uBAAuB,GAAG,MAAM,CAY3F;AAED;;GAEG;AACH,wBAAgB,6BAA6B,CAAC,IAAI,EAAE,uBAAuB,EAAE,IAAI,EAAE;IAAE,IAAI,EAAE,eAAe,CAAC;IAAC,SAAS,EAAE,GAAG,CAAC,uBAAuB,EAAE,mBAAmB,CAAC,CAAA;CAAE,GAAG,OAAO,CAenL;AAED;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,WAAW;IAEhD,EAAE,EAAE,MAAM,CAAC;IAIX,IAAI,mBAA0B;CACjC;AAED,wBAAgB,2BAA2B,CAAC,CAAC,EAAE,GAAG,CAAC,uBAAuB,EAAE,mBAAmB,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,uBAAuB,EAAE,mBAAmB,CAAC,EAAE,iBAAiB,SAAI,WAuC5K;AAED,qBAAa,WAAY,SAAQ,WAAW;IAExC,EAAE,EAAE,MAAM,CAAC;IAGX,IAAI,kBAAyB;IAG7B,SAAS,EAAE,GAAG,CAAC,uBAAuB,EAAE,mBAAmB,CAAC,CAAa;IAGzE,WAAW,SAAM;IAEjB;;OAEG;IAEH,MAAM,SAAK;IAEX,IAAI,QAAQ,IAIQ,MAAM,CAFzB;IAED,IAAI,QAAQ,CAAC,KAAK,EAAE,MAAM,EAEzB;IAED;;;;;;;;;OASG;IAIH,SAAS,SAAK;IAGd,aAAa,EAAE,MAAM,GAAG,IAAI,CAAQ;IAGpC,WAAW,UAAQ;IAEnB;;;;OAIG;IAEH,UAAU,EAAE,gBAAgB,GAAG,IAAI,CAAQ;IAE3C;;;;;;;;;OASG;IACH,IAAI,KAAK,WAKR;IAED;;;;OAIG;IACH,IAAI,mBAAmB,WAKtB;IAED;;OAEG;IACH,IAAI,aAAa,WAchB;IAED;;;;;;OAMG;IACH,IAAI,GAAG,WAON;IAED,IAAI,YAAY,WAEf;IAED;;;OAGG;IACH,IAAI,eAAe,WAMlB;IAED,IAAI,gBAAgB,WAKnB;IAED;;;;;;;OAOG;IACH,IAAI,SAAS,WAKZ;IAED;;;;;;;;;OASG;IAGH,SAAS,SAAK;IAEd;;;;;;;;;OASG;IAGH,YAAY,SAAK;IAEjB;;OAEG;IAKH,KAAK,EAAE,IAAI,GAAG,IAAI,CAAQ;IAG1B,SAAS,OAAc;IAmBvB,MAAM,EAAE,iBAAiB,CAAyB;IAElD,IAAI,MAAM,YAET;IAED,IAAI,KAAK,YAUR;IAED,IAAI,SAAS,YAEZ;IAGD,cAAc,SAAM;IAGpB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAQ;IAG/B,MAAM,EAAE,MAAM,GAAG,IAAI,CAAQ;IAG7B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAQ;IAGrC,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAQ;IAG3C,OAAO,EAAE,MAAM,GAAG,IAAI,CAAQ;IAE9B,MAAM,CAAC,YAAY,CAAC,IAAI,GAAE,IAAiB;IAU3C,MAAM,CAAC,qBAAqB,CAAC,KAAK,EAAE,WAAW,EAAE;;;;;;;IAiBjD,MAAM,CAAC,kBAAkB,CAAC,KAAK,EAAE,WAAW,EAAE;IAO9C,IAAI,uBAAuB,IAAI,MAAM,CA6CpC;IAED;;OAEG;IACH,IAAI,QAAQ,IAAI,MAAM,CAkBrB;IAED,IAAI,UAAU,IAAI,MAAM,CAEvB;IAED,IAAI,gBAAgB,kBAsBnB;IAED,IAAI,aAAa,IAAI,cAAc,CAwClC;IAED;;OAEG;IACH,IAAI,SAAS,WAuBZ;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,MAAM,CAiCtB;IAED;;OAEG;IACH,IAAI,eAAe,kBAoDlB;IAED,MAAM,CAAC,mBAAmB,CAAC,KAAK,EAAE,WAAW,EAAE,GAAG,MAAM;CA0E3D;AAED,qBAAa,kBAAmB,SAAQ,WAAW;IAE/C,EAAE,EAAE,MAAM,CAAC;IAIX,KAAK,EAAE,MAAM,CAAC;CACjB;AAED,qBAAa,6BAA8B,SAAQ,kBAAkB;IAEjE,OAAO,EAAE,OAAO,CAAC;CACpB;AAED,qBAAa,oCAAqC,SAAQ,kBAAkB;IAExE,OAAO,EAAE,cAAc,CAAC;CAC3B;AAED,qBAAa,uBAAwB,SAAQ,WAAW;IAEpD,QAAQ,EAAE,6BAA6B,EAAE,CAAM;IAE/C,eAAe;IAIf;;OAEG;IACH,IAAI,iBAAiB,YAEpB;CACJ;AAED,qBAAa,8BAA+B,SAAQ,uBAAuB;IAEvE,QAAQ,EAAE,oCAAoC,EAAE,CAAM;CACzD;AAED,qBAAa,mBAAmB;IAC5B,KAAK,EAAE,WAAW,EAAE,CAAC;;IAMrB,IAAI,EAAE,WAEL;IAED,GAAG,CAAC,IAAI,EAAE,WAAW;IAIrB,IAAI,WAAW,gBAEd;IAED;;OAEG;IACH,IAAI,MAAM,WAET;IAED,IAAI,MAAM,sBAET;IAED;;OAEG;IACH,IAAI,SAAS,WAEZ;IAED,IAAI,KAAK,WAER;IAED,IAAI,gBAAgB,WAKnB;IAED,IAAI,YAAY,WAEf;IAED,IAAI,SAAS,WAEZ;IAED,IAAI,SAAS,WAMZ;IAED,IAAI,eAAe,kBAMlB;IAED,IAAI,SAAS,WAEZ;IAED,IAAI,eAAe,WAElB;IAED,IAAI,KAAK,gBAER;IAED,IAAI,KAAK,YAER;IAED,IAAI,SAAS,YAEZ;IAED,IAAI,IAAI,oBAEP;IAED,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,WAAW,EAAE,GAAG,mBAAmB,EAAE;CAc5D"}