@erp-galoper/types 1.0.1950 → 1.0.1951

package/openapi.ts

@@ -621,6 +621,12 @@ export interface paths {
          *     - ``only``: return only landed cost service items
          *     - ``include``: return every item
          *
+         *     ``priceListIds``: enriches each item with per-UoM/package ``prices`` for the given lists.
+         *     ``filterByPriceList`` (default ``true``): when ``priceListIds`` is set, only items on those
+         *     lists are returned. Set to ``false`` to return every item matching other filters; items not
+         *     on a list get ``prices: []``, items on a list get calculated prices (including pending
+         *     values on draft/unapproved lists).
+         *
          *     Responses:
          *     - 200: ItemListSchema
          *     - 400: {"message": "Error applying filter {error}", "code": "invalidFilterFormat"}
@@ -14958,14 +14964,16 @@ export interface paths {
          * @description Partially update a price list without resending the full payload.
          *
          *     Header fields (any combination):
-         *     - `name`
-         *     - `description`
-         *     - `notes`
+         *     - `name`, `description`, `notes`
+         *     - `branch`, `status`, `currency`
+         *     - `regions`, `customers`, `customerGroups`
+         *     - `startDate`, `endDate`
+         *     - `attachments`
          *
          *     Item operations (optional):
          *     - **Create**: omit `id`
          *     - **Update**: include `id` with a positive `unitPrice`
-         *     - **Delete**: include `id` with `unitPrice` set to 0 or null
+         *     - **Delete**: include `id` with all pricing fields (`unitPrice`, `minPrice`, `maxPrice`, `profit`, `minProfit`, `maxProfit`) unset, null, or 0
          *
          *     Permission key: `salespricelist = ['change']`
          *
@@ -27793,10 +27801,16 @@ export interface components {
              * @default []
              */
             taxes: components["schemas"]["TaxSharedSchema"][];
-            /** Minprice */
-            minPrice: number | null;
-            /** Maxprice */
-            maxPrice: number | null;
+            /**
+             * Minprice
+             * @description Database value: approved minimum price. For calculated effective prices based on pricing type/method, use the min_price field at the prices array level.
+             */
+            minPrice?: number | null;
+            /**
+             * Maxprice
+             * @description Database value: approved maximum price. For calculated effective prices based on pricing type/method, use the max_price field at the prices array level.
+             */
+            maxPrice?: number | null;
             /** Pendingminprice */
             pendingMinPrice: number | null;
             /** Pendingmaxprice */
@@ -27821,6 +27835,16 @@ export interface components {
              * Format: uuid
              */
             priceListId: string;
+            /**
+             * Minprice
+             * @description Calculated minimum price based on pricing type/method for this price list
+             */
+            minPrice?: number | null;
+            /**
+             * Maxprice
+             * @description Calculated maximum price based on pricing type/method for this price list
+             */
+            maxPrice?: number | null;
             priceListItem?: components["schemas"]["PriceListItemSchema"] | null;
         };
         /** QuantityGroupSchema */
@@ -50625,9 +50649,9 @@ export interface components {
             secondaryRate?: string;
             /**
              * Unitprice
-             * @description The manually set unit price for the item. Required when using the 'manual' pricing method with 'fixed' pricing type.
+             * @description The manually set unit price for the item (this field is a number). Required when using the 'manual' pricing method with 'fixed' pricing type.
              */
-            unitPrice?: number;
+            unitPrice?: string;
             /**
              * Taxes
              * @description Only visible when price list type is retail, list of tax ids to be applied to the item
@@ -50636,29 +50660,29 @@ export interface components {
             taxes: string[];
             /**
              * Minprice
-             * @description The minimum price of the item. Required when using the 'manual' pricing method with 'range' pricing type.
+             * @description The minimum price of the item (this field is a number). Required when using the 'manual' pricing method with 'range' pricing type.
              */
-            minPrice?: number;
+            minPrice?: string;
             /**
              * Maxprice
-             * @description The maximum price of the item. Required when using the 'manual' pricing method with 'range' pricing type.
+             * @description The maximum price of the item (this field is a number). Required when using the 'manual' pricing method with 'range' pricing type.
              */
-            maxPrice?: number;
+            maxPrice?: string;
             /**
              * Minprofit
-             * @description The minimum profit margin percentage for the item. Required when using the 'profit-based' pricing method with 'range' pricing type.
+             * @description The minimum profit margin percentage for the item (this field is a number). Required when using the 'profit-based' pricing method with 'range' pricing type.
              */
-            minProfit?: number;
+            minProfit?: string;
             /**
              * Maxprofit
-             * @description The maximum profit margin percentage for the item. Required when using the 'profit-based' pricing method with 'range' pricing type.
+             * @description The maximum profit margin percentage for the item (this field is a number). Required when using the 'profit-based' pricing method with 'range' pricing type.
              */
-            maxProfit?: number;
+            maxProfit?: string;
             /**
              * Profit
-             * @description The profit margin percentage for the item. Required when using the 'profit-based' pricing method with 'fixed' pricing type.
+             * @description The profit margin percentage for the item (this field is a number). Required when using the 'profit-based' pricing method with 'fixed' pricing type.
              */
-            profit?: number;
+            profit?: string;
             /** Cost */
             cost?: number | null;
         };
@@ -50853,24 +50877,39 @@ export interface components {
             secondaryRate?: string;
             /**
              * Unitprice
-             * @description Unit price. When updating an existing line (id provided), 0 or null deletes the line.
+             * @description Unit price (this field is a number). When updating an existing line (id provided), the line is deleted only when unitPrice, minPrice, maxPrice, profit, minProfit, and maxProfit are all unset, null, or 0.
              */
-            unitPrice?: number;
+            unitPrice?: string;
             /**
              * Taxes
              * @description Tax IDs applied to the item (retail price lists only).
              */
             taxes?: string[] | null;
-            /** Minprice */
-            minPrice?: number;
-            /** Maxprice */
-            maxPrice?: number;
-            /** Minprofit */
-            minProfit?: number;
-            /** Maxprofit */
-            maxProfit?: number;
-            /** Profit */
-            profit?: number;
+            /**
+             * Minprice
+             * @description This field is a number.
+             */
+            minPrice?: string;
+            /**
+             * Maxprice
+             * @description This field is a number.
+             */
+            maxPrice?: string;
+            /**
+             * Minprofit
+             * @description This field is a number.
+             */
+            minProfit?: string;
+            /**
+             * Maxprofit
+             * @description This field is a number.
+             */
+            maxProfit?: string;
+            /**
+             * Profit
+             * @description This field is a number.
+             */
+            profit?: string;
             /** Cost */
             cost?: number | null;
         };
@@ -50881,6 +50920,46 @@ export interface components {
              * @description Name of the price list.
              */
             name?: string | null;
+            status?: components["schemas"]["InternalStatusOnCreateValueChoices"] | null;
+            /**
+             * Currency
+             * @description ID of the currency in which the prices are defined, needed when multicurrency is enabled, should be in company's currency or usd
+             */
+            currency?: string | null;
+            /**
+             * Regions
+             * @description List of region IDs where the price list applies.
+             *             Mutually exclusive with customers and customer groups — only one option can be selected.
+             *             If type is retail, this field should be hidden and not required.
+             */
+            regions?: number[] | null;
+            /**
+             * Customers
+             * @description "
+             *             List of customer IDs to whom this price list applies.
+             *             Mutually exclusive with regions and customer groups — only one option can be selected.
+             *             If type is retail, this field should be hidden and not required.
+             */
+            customers?: string[] | null;
+            /**
+             * Customergroups
+             * @description List of segmentation group IDs to which the price list applies, should be filtered by type customer.
+             *             Mutually exclusive with regions and customers — only one option can be selected.
+             *             If type is retail, this field should be hidden and not required.
+             */
+            customerGroups?: string[] | null;
+            /**
+             * Startdate
+             * @description - Start date from which the price list becomes valid- visible when price list type not equal to retail
+             */
+            startDate?: string | null;
+            /**
+             * Enddate
+             * @description - End date until which the price list is valid. Leave blank if the price list does not have an expiration date.- visible when price list type not equal to retail
+             */
+            endDate?: string | null;
+            /** Attachments */
+            attachments?: string[] | null;
             /** Description */
             description?: string | null;
             /** Notes */
@@ -50891,7 +50970,7 @@ export interface components {
              *
              *             - **Create**: omit `id`
              *             - **Update**: include `id` with a positive `unitPrice`
-             *             - **Delete**: include `id` with `unitPrice` set to 0 or null
+             *             - **Delete**: include `id` with all pricing fields unset, null, or 0
              */
             items?: components["schemas"]["PatchSalesPriceListItemSchema"][] | null;
         };
@@ -66088,6 +66167,8 @@ export interface operations {
                 include?: components["schemas"]["ItemIncludeOption"][] | null;
                 /** @description used to get prices of items in offers and promotoins feature or sales features(quotation,order, invoice) */
                 priceListIds?: string[];
+                /** @description When priceListIds is provided: true (default) returns only items on those price lists; false returns all items matching other filters and enriches each with prices (empty array if not on the list). */
+                filterByPriceList?: boolean;
                 /** @description required when price list ids is provided, should be sales if called in sales features or offers if called in offers and promotions feature */
                 type?: "sales" | "offers";
                 /** @description Required when priceListIds is provided and type is sales, or when retrieving default selling/purchase price with customerId/supplierId respectively. Rate is taken from the document itself. */

package/package.json

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