@erp-galoper/types 1.0.1933 → 1.0.1934

package/openapi.ts

@@ -26776,11 +26776,6 @@ export interface components {
              */
             default: boolean;
         };
-        /**
-         * ItemCommissionCalculation
-         * @enum {string}
-         */
-        ItemCommissionCalculation: "netSale" | "profitMargin";
         /** ItemListSchema */
         ItemListSchema: {
             info: components["schemas"]["PageInfoSchema"];
@@ -27127,7 +27122,6 @@ export interface components {
              */
             openingStock?: components["schemas"]["OpeningStockGroupSchema"][] | null;
             costStrategy: components["schemas"]["GetCostStrategy"] | null;
-            commissionCalculation: components["schemas"]["ItemCommissionCalculation"] | null;
             inventoryMovementMethod?: components["schemas"]["INVENTORY_MOVEMENT_METHOD"] | null;
             /**
              * Candelete
@@ -27390,7 +27384,6 @@ export interface components {
              */
             openingStock?: components["schemas"]["OpeningStockGroupSchema"][] | null;
             costStrategy: components["schemas"]["GetCostStrategy"] | null;
-            commissionCalculation: components["schemas"]["ItemCommissionCalculation"] | null;
             inventoryMovementMethod?: components["schemas"]["INVENTORY_MOVEMENT_METHOD"] | null;
             /**
              * Candelete
@@ -28358,14 +28351,6 @@ export interface components {
              *         - visible when hasExpiryDate is true
              */
             alertDate?: number | null;
-            /**
-             * @description Hint: description for each option should be  visible to users in the UI
-             *         - Net Sales: Commission is calculated on the item price after discount, excluding tax and cost.
-             *             - Formula (per item): (Price -  Discount) × Commission Rate
-             *         - Profit Margin: Commission is calculated on the profit of each item, after deducting both the discount and the cost of goods sold (COGS).
-             *             - Formula (per item): (Price - Discount - Cost) × Commission Rate
-             */
-            commissionCalculation?: components["schemas"]["ItemCommissionCalculation"] | null;
             /**
              * Packages
              * @description Not applicable for service items - always empty list for type=service. Package and unit of measure should be unique
@@ -28883,14 +28868,6 @@ export interface components {
             children: components["schemas"]["UpdateChildrenItemSchema"] | null;
             /** @description if canDelete for the item is false then this field should be disabled */
             costStrategy?: components["schemas"]["CostStrategy"] | null;
-            /**
-             * @description Hint: description for each option should be  visible to users in the UI
-             *         - Net Sales: Commission is calculated on the item price after discount, excluding tax and cost.
-             *             - Formula (per item): (Price -  Discount) × Commission Rate
-             *         - Profit Margin: Commission is calculated on the profit of each item, after deducting both the discount and the cost of goods sold (COGS).
-             *             - Formula (per item): (Price - Discount - Cost) × Commission Rate
-             */
-            commissionCalculation?: components["schemas"]["ItemCommissionCalculation"] | null;
             /**
              * @description - fifo(First In, First Out): Items purchased or produced first are sold or used first
              *             - lifo(Last In, First Out): Items purchased or produced most recently are sold or used first
@@ -29188,14 +29165,6 @@ export interface components {
             children: components["schemas"]["UpdateChildrenItemSchema"] | null;
             /** @description if canDelete for the item is false then this field should be disabled */
             costStrategy?: components["schemas"]["CostStrategy"] | null;
-            /**
-             * @description Hint: description for each option should be  visible to users in the UI
-             *         - Net Sales: Commission is calculated on the item price after discount, excluding tax and cost.
-             *             - Formula (per item): (Price -  Discount) × Commission Rate
-             *         - Profit Margin: Commission is calculated on the profit of each item, after deducting both the discount and the cost of goods sold (COGS).
-             *             - Formula (per item): (Price - Discount - Cost) × Commission Rate
-             */
-            commissionCalculation?: components["schemas"]["ItemCommissionCalculation"] | null;
             /**
              * @description - fifo(First In, First Out): Items purchased or produced first are sold or used first
              *             - lifo(Last In, First Out): Items purchased or produced most recently are sold or used first
@@ -35899,6 +35868,29 @@ export interface components {
          * @enum {string}
          */
         SessionStatus: "opened" | "closed";
+        /** RelatedPartyInfo */
+        RelatedPartyInfo: {
+            /** Id */
+            id: number | string;
+            /** Name */
+            name: string;
+            /** Accountnumber */
+            accountNumber: string;
+            currency: components["schemas"]["CurrencySummaryInfo"];
+            /** Banks */
+            banks: components["schemas"]["BankAccountsSharedSchema"][];
+        };
+        /** SalesPersonSharedSchema */
+        SalesPersonSharedSchema: {
+            /**
+             * Id
+             * Format: uuid
+             */
+            id: string;
+            /** Name */
+            name: string;
+            relatedParty: components["schemas"]["RelatedPartyInfo"];
+        };
         /** SessionListSchema */
         SessionListSchema: {
             info: components["schemas"]["PageInfoSchema"];
@@ -35924,6 +35916,7 @@ export interface components {
             /** Name */
             name: string;
             user: components["schemas"]["UserSummaryInfo"];
+            defaultSalesPerson?: components["schemas"]["SalesPersonSharedSchema"] | null;
             /**
              * Startdate
              * Format: date-time
@@ -36122,6 +36115,19 @@ export interface components {
             type: string;
             accountType: components["schemas"]["AccountModelType"];
         };
+        /** CommissionLevelSharedSchema */
+        CommissionLevelSharedSchema: {
+            /**
+             * Id
+             * Format: uuid
+             */
+            id: string;
+            /** Name */
+            name: string;
+            /** Commissionvalue */
+            commissionValue: number;
+            currency: components["schemas"]["CurrencySummaryInfo"] | null;
+        };
         /** CustomerSharedSchema */
         CustomerSharedSchema: {
             /** Phone1 */
@@ -36334,6 +36340,8 @@ export interface components {
              * @default []
              */
             promotionsAndOffers: components["schemas"]["PromotionsAndOffersSharedSchema"][];
+            /** @description Applicable commission level for this line item. */
+            commission?: components["schemas"]["CommissionLevelSharedSchema"] | null;
         };
         /** POSInvoiceSchema */
         POSInvoiceSchema: {
@@ -36364,6 +36372,9 @@ export interface components {
             barcode: string;
             type: components["schemas"]["InvoiceType"];
             session: components["schemas"]["SessionSummarySchema"];
+            salesPerson?: components["schemas"]["SalesPersonSharedSchema"] | null;
+            /** @description Applicable commission level for this invoice. */
+            commission?: components["schemas"]["CommissionLevelSharedSchema"] | null;
             relatedInvoice?: components["schemas"]["PosInvoiceSummarySchema"] | null;
             giftReceipt?: components["schemas"]["GiftReceiptSummarySchema"] | null;
             /**
@@ -36624,6 +36635,7 @@ export interface components {
             /** Enddate */
             endDate?: string | null;
             status: components["schemas"]["SessionStatus"];
+            defaultSalesPerson?: components["schemas"]["SalesPersonSharedSchema"] | null;
         };
         /** GiftReceiptItemSchema */
         GiftReceiptItemSchema: {
@@ -47057,18 +47069,6 @@ export interface components {
              */
             cost: number;
         };
-        /** RelatedPartyInfo */
-        RelatedPartyInfo: {
-            /** Id */
-            id: number | string;
-            /** Name */
-            name: string;
-            /** Accountnumber */
-            accountNumber: string;
-            currency: components["schemas"]["CurrencySummaryInfo"];
-            /** Banks */
-            banks: components["schemas"]["BankAccountsSharedSchema"][];
-        };
         /**
          * RelatedPartyType
          * @enum {string}
@@ -48278,17 +48278,6 @@ export interface components {
             code: string;
             data: components["schemas"]["ClosingCommissionDetailWithInvoicesSchema"];
         };
-        /** SalesPersonSharedSchema */
-        SalesPersonSharedSchema: {
-            /**
-             * Id
-             * Format: uuid
-             */
-            id: string;
-            /** Name */
-            name: string;
-            relatedParty: components["schemas"]["RelatedPartyInfo"];
-        };
         /** CreateClosingCommission */
         CreateClosingCommission: {
             /** Password */
@@ -49029,7 +49018,7 @@ export interface components {
          * CommissionCalculation
          * @enum {string}
          */
-        CommissionCalculation: "billed" | "received";
+        CommissionCalculation: "onBilling" | "onCollection";
         /** CommissionDetailWithLevelsSchema */
         CommissionDetailWithLevelsSchema: {
             /**
@@ -49061,7 +49050,6 @@ export interface components {
              */
             files: string[];
             calculation: components["schemas"]["CommissionCalculation"];
-            structure: components["schemas"]["CommissionStructureEnum"];
             /**
              * Startdate
              * Format: date
@@ -49078,6 +49066,11 @@ export interface components {
             /** Commissionlevels */
             commissionLevels: components["schemas"]["CommissionLevelsDetailSchema"][];
         };
+        /**
+         * CommissionLevelCalculation
+         * @enum {string}
+         */
+        CommissionLevelCalculation: "netSale" | "profitMargin";
         /** CommissionLevelsDetailSchema */
         CommissionLevelsDetailSchema: {
             /**
@@ -49085,15 +49078,20 @@ export interface components {
              * Format: uuid
              */
             id: string;
+            structure: components["schemas"]["CommissionStructureEnum"];
+            commissionCalculation: components["schemas"]["CommissionLevelCalculation"];
             /** Products */
             products: components["schemas"]["ItemSummaryInfo"][];
             /** Categories */
             categories: components["schemas"]["ItemCategorySummaryInfo"][];
+            /** Brands */
+            brands: components["schemas"]["CommonBrandSchema"][];
+            /** Families */
+            families: components["schemas"]["CommonFamilySchema"][];
             /** Customer Groups */
             customer_groups: components["schemas"]["ContactSegmentationSharedSchema"][];
             /** Customers */
             customers: components["schemas"]["AccountSummaryInfo"][];
-            paymentMethod: components["schemas"]["PaymentMethodSharedSchema"] | null;
             /** Commissionvalue */
             commissionValue: number;
             /** Salesvolumevalue */
@@ -49116,7 +49114,7 @@ export interface components {
          * CommissionStructureEnum
          * @enum {string}
          */
-        CommissionStructureEnum: "fixed" | "category" | "tiered" | "productBased" | "paymentBased";
+        CommissionStructureEnum: "fixed" | "tiered" | "product" | "category" | "family" | "brand";
         /** ItemCategorySummaryInfo */
         ItemCategorySummaryInfo: {
             /**
@@ -49129,9 +49127,9 @@ export interface components {
         };
         /**
          * SalesTierType
-         * @enum {string}
+         * @constant
          */
-        SalesTierType: "upTo" | "above";
+        SalesTierType: "above";
         /**
          * TargetPeriod
          * @enum {string}
@@ -49139,6 +49137,22 @@ export interface components {
         TargetPeriod: "weekly" | "monthly" | "quarterly" | "biAnnual" | "annual";
         /** CreateCommissionLevels */
         CreateCommissionLevels: {
+            /**
+             * @description In all structures user should specify commission value
+             *                 - if structure is product user should select item(s)
+             *                 - if structure is tiered user should select salesTierType -> salesVolumeValue -> currency
+             *                 - if structure is category user should select category
+             *                 - if structure is brand user should select brand(s)
+             *                 - if structure is family user should select family(ies)
+             *             Note that if inventory off allowed structures are fixed and tiered with salesVolumeValue and its related fields
+             */
+            structure: components["schemas"]["CommissionStructureEnum"];
+            /**
+             * @description - Net Sales: Commission is calculated on the item price after discount, excluding tax and cost.
+             *             - Profit Margin: Commission is calculated on the profit of each item, after deducting both the discount and the cost of goods sold (COGS).
+             * @default netSale
+             */
+            commissionCalculation: components["schemas"]["CommissionLevelCalculation"];
             /**
              * Commissionvalue
              * @description if commissionValueType is percentage, commissionValue should be greater than zero and less than or equal 100
@@ -49146,34 +49160,52 @@ export interface components {
             commissionValue: number;
             /**
              * Salesvolumevalue
-             * @description visible when structure = tiered, required when salesTierType exist
+             * @description visible when structure = tiered, required when structure = tiered
              */
             salesVolumeValue?: number;
             /**
              * Currency
              * Format: uuid
-             * @description currency id, visible when structure = tiered, required when salesTierType exist
+             * @description currency id, visible when structure = tiered, required when structure = tiered
              */
             currency?: string;
             /** @description visible when structure = tiered */
             salesTierType?: components["schemas"]["SalesTierType"];
             /**
              * Products
-             * @description - visible when structure is productBased
+             * @description - visible when structure is product
              *             - to get products use route /api/v1/inventory/items/ and filter by active=true
              *             - product should be unique across commission levels
              * @default []
              */
-            products: number[];
+            products: string[];
             /**
              * Categories
-             * @description - visible when structure is category or productBased or tiered
+             * @description - visible when structure is category
              *             - required when structure is category
              *             - to get categories use route /api/v1/inventory/categories?type=item'
              *             - category should be unique across commission levels
              * @default []
              */
             categories: string[];
+            /**
+             * Brands
+             * @description - visible when structure is brand
+             *             - required when structure is brand
+             *             - to get brands use route /api/v1/inventory/brands/
+             *             - brand should be unique across commission levels
+             * @default []
+             */
+            brands: string[];
+            /**
+             * Families
+             * @description - visible when structure is family
+             *             - required when structure is family
+             *             - to get families use route /api/v1/inventory/families/
+             *             - family should be unique across commission levels
+             * @default []
+             */
+            families: string[];
             /**
              * Customergroups
              * @description both customers and customerGroups can be left empty to include all active debtor child customers
@@ -49191,12 +49223,6 @@ export interface components {
              * @default []
              */
             customers: string[];
-            /**
-             * Paymentmethod
-             * Format: uuid
-             * @description visible and required when structure = paymentBased, to get payment methods use route /api/v1/payment-methods/
-             */
-            paymentMethod?: string;
             /** Target */
             target?: number;
             targetPeriod?: components["schemas"]["TargetPeriod"];
@@ -49226,17 +49252,8 @@ export interface components {
              * @description When upload file the type in payload should be commission
              */
             attachments: string[];
-            /** @description when structure is paymentBased, calculation should be billed */
+            /** @description onBilling refers to fully paid invoices and onCollection refers to sales invoices where payment is not tracked */
             calculation: components["schemas"]["CommissionCalculation"];
-            /**
-             * @description In all structures user should specify commission value and commission value type
-             *                 - if structure is productBased user can select item(s) or categories
-             *                 - if structure is tiered user can select categories or salesTierType -> salesVolumeValue -> currency
-             *                 - if structure is paymentMethod user should select paymentMethod
-             *                 - if structure is category use should select category
-             *             Note that if inventory off allowed structures are fixed, paymentBased and tiered  with salesVolumeValue and its related fields
-             */
-            structure: components["schemas"]["CommissionStructureEnum"];
             /**
              * Startdate
              * Format: date
@@ -49249,7 +49266,7 @@ export interface components {
             endDate?: string;
             /**
              * Commissionlevels
-             * @description when structure is paymentBased or fixed, only one commission level is allowed
+             * @description when structure is fixed, only one commission level is allowed
              */
             commissionLevels?: components["schemas"]["CreateCommissionLevels"][];
         };
@@ -49284,7 +49301,6 @@ export interface components {
              */
             files: string[];
             calculation: components["schemas"]["CommissionCalculation"];
-            structure: components["schemas"]["CommissionStructureEnum"];
             /**
              * Startdate
              * Format: date
@@ -49312,24 +49328,35 @@ export interface components {
              * Format: uuid
              */
             id?: string;
+            /**
+             * @description In all structures user should specify commission value
+             *                 - if structure is product user should select item(s)
+             *                 - if structure is tiered user should select salesTierType -> salesVolumeValue -> currency
+             *                 - if structure is category user should select category
+             *                 - if structure is brand user should select brand(s)
+             *                 - if structure is family user should select family(ies)
+             */
+            structure: components["schemas"]["CommissionStructureEnum"];
+            /** @default netSale */
+            commissionCalculation: components["schemas"]["CommissionLevelCalculation"];
             /** Commissionvalue */
             commissionValue: number;
             /**
              * Salesvolumevalue
-             * @description visible when structure = tiered, required when salesTierType exist
+             * @description visible when structure = tiered, required when structure = tiered
              */
             salesVolumeValue?: number;
             /**
              * Currency
              * Format: uuid
-             * @description currency id, visible when structure = tiered, required when salesTierType exist
+             * @description currency id, visible when structure = tiered, required when structure = tiered
              */
             currency?: string;
             /** @description visible when structure = tiered */
             salesTierType?: components["schemas"]["SalesTierType"];
             /**
              * Products
-             * @description - visible when structure is productBased
+             * @description - visible when structure is product
              *             - to get products use route /api/v1/inventory/items/ and filter by active=true
              *             - product should be unique across commission levels
              * @default []
@@ -49337,13 +49364,29 @@ export interface components {
             products: number[];
             /**
              * Categories
-             * @description - visible when structure is category or productBased or tiered
+             * @description - visible when structure is category
              *         - required when structure is category
              *         - to get categories use route /api/v1/inventory/categories?type=item
              *         - category should be unique across commission levels
              * @default []
              */
             categories: string[];
+            /**
+             * Brands
+             * @description - visible when structure is brand
+             *             - required when structure is brand
+             *             - to get brands use route /api/v1/inventory/brands/
+             * @default []
+             */
+            brands: string[];
+            /**
+             * Families
+             * @description - visible when structure is family
+             *             - required when structure is family
+             *             - to get families use route /api/v1/inventory/families/
+             * @default []
+             */
+            families: string[];
             /**
              * Customergroups
              * @description both customers and customerGroups can be left empty to include all active debtor child customers
@@ -49361,12 +49404,6 @@ export interface components {
              * @default []
              */
             customers: string[];
-            /**
-             * Paymentmethod
-             * Format: uuid
-             * @description visible and required when structure = paymentBased, to get payment methods use route /api/v1/payment-methods/
-             */
-            paymentMethod?: string;
             /** Target */
             target?: number;
             targetPeriod?: components["schemas"]["TargetPeriod"];
@@ -49387,17 +49424,8 @@ export interface components {
              * @description When upload file the type in payload should be commission
              */
             attachments: string[];
-            /** @description when structure is paymentBased, calculation should be billed */
+            /** @description onBilling refers to fully paid invoices and onCollection refers to sales invoices where payment is not tracked */
             calculation: components["schemas"]["CommissionCalculation"];
-            /**
-             * @description In all structures user should specify comiision value and commission value type
-             *                 - if structure is productBased user can select item(s) or categories
-             *                 - if structure is tiered user can select categories or salesTierType -> salesVolumeValue -> currency
-             *                 - if structure is paymentMethod user should select paymentMethod
-             *                 - if structure is category use should select category
-             *             Note that if inventory off allowed structures are fixed, paymentBased and tiered  with salesVolumeValue and its related fields
-             */
-            structure: components["schemas"]["CommissionStructureEnum"];
             /**
              * Startdate
              * Format: date
@@ -49410,7 +49438,7 @@ export interface components {
             endDate?: string;
             /**
              * Commissionlevels
-             * @description when structure is paymentBased or fixed, only one commission level is allowed
+             * @description when structure is fixed, only one commission level is allowed
              */
             commissionLevels?: components["schemas"]["UpdateCommissionLevels"][];
         };
@@ -54953,19 +54981,6 @@ export interface components {
             /** Password */
             password?: string;
         };
-        /** CommissionLevelSharedSchema */
-        CommissionLevelSharedSchema: {
-            /**
-             * Id
-             * Format: uuid
-             */
-            id: string;
-            /** Name */
-            name: string;
-            /** Commissionvalue */
-            commissionValue: number;
-            currency: components["schemas"]["CurrencySummaryInfo"] | null;
-        };
         /**
          * OnlineOrderSummarySchema
          * @description Summary of online order linked to a sales invoice

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@erp-galoper/types",
-  "version": "1.0.1933",
+  "version": "1.0.1934",
   "main": "openapi.ts",
   "types": "openapi.ts",
   "files": ["openapi.ts"],