@erp-galoper/main-package 1.0.303 → 1.0.305

package/openapi.ts

@@ -4123,7 +4123,7 @@ export interface paths {
         };
         /**
          * Get Items Quantity
-         * @description Endpoint for List Items Quantity in Warehouse and Branch with UOM-based Batch/Serial breakdown
+         * @description Endpoint for List Items Quantity in Warehouse and Branch with UOM-based Batch/Serial breakdown and Location details
          *
          *     Query Parameters:
          *     - warehouses: List of warehouse IDs to filter by (required), it should be filtered by selected branch and warehouses assigned to the user
@@ -4137,7 +4137,7 @@ export interface paths {
          *         - If provided, overrides packed parameter and shows only specified packages
          *
          *     Responses:
-         *     - 200: Items quantity with UOM breakdown
+         *     - 200: Items quantity with UOM breakdown, batch/serial details, and location information
          *     - 400:
          *     - 403: "permissionDenied"
          *         - "noBranchAccess"
@@ -21709,7 +21709,10 @@ export interface components {
              */
             alertDate?: number | null;
             commissionCalculation?: components["schemas"]["CommissionCalculation"];
-            /** Packages */
+            /**
+             * Packages
+             * @description package and unit of measure should be unique
+             */
             packages: components["schemas"]["CreateOrUpdatePackageItemSchema"][];
             /**
              * Children
@@ -21729,9 +21732,9 @@ export interface components {
             id?: string | null;
             /**
              * Package
-             * @description ID of the package item (for update only)
+             * Format: uuid
              */
-            package?: string | null;
+            package: string;
             /** @description Type of barcode used for the package */
             barcodeType?: components["schemas"]["BarcodeTypeValues"];
             /**
@@ -21948,6 +21951,7 @@ export interface components {
             alertDate?: number | null;
             /**
              * Packages
+             * @description package and unit of measure should be unique
              * @default []
              */
             packages: components["schemas"]["CreateOrUpdatePackageItemSchema"][];
@@ -23151,7 +23155,7 @@ export interface components {
             /** Documentname */
             documentName: string;
             /** Serialnumber */
-            serialNumber: number;
+            serialNumber?: number;
             /** Approvaltrackingid */
             approvalTrackingId: number;
         };
@@ -24349,12 +24353,60 @@ export interface components {
             /** Expirydate */
             expiryDate?: string | null;
         };
+        /** ItemPackageSummarySchema */
+        ItemPackageSummarySchema: {
+            /**
+             * Id
+             * Format: uuid
+             */
+            id: string;
+            /**
+             * Barcode
+             * @description Barcode of the item
+             */
+            barcode: string;
+            /**
+             * Quantity
+             * @description Quantity of the item
+             */
+            quantity: number;
+            /** @description Package of the item */
+            package: components["schemas"]["PackageSummarySchema"];
+            /** Returnable */
+            returnable: boolean;
+        };
         /** ItemQuantityResponseSchema */
         ItemQuantityResponseSchema: {
-            item: components["schemas"]["ItemMinimalSchema"];
             /** Uomgroups */
-            uomGroups: components["schemas"]["UOMGroupSchema"][];
+            uomGroups: components["schemas"]["UOMGroupingSchema"][];
         };
+        /** LocationInfoSchema */
+        LocationInfoSchema: {
+            warehouse: components["schemas"]["WarehouseSummaryInfo"];
+            unitOfMeasure?: components["schemas"]["UnitOfMeasureSummaryInfo"] | null;
+            itemPackage?: components["schemas"]["ItemPackageSummarySchema"] | null;
+            /** Stockquantity */
+            stockQuantity: number;
+            /** Availableforsale */
+            availableForSale: number;
+            /** Ispackage */
+            isPackage: boolean;
+            /**
+             * Batches
+             * @default []
+             */
+            batches: components["schemas"]["BatchInfoSchema"][];
+            /**
+             * Serials
+             * @default []
+             */
+            serials: components["schemas"]["SerialInfoSchema"][];
+        };
+        /**
+         * PackageCategory
+         * @enum {string}
+         */
+        PackageCategory: "primary" | "secondary" | "tertiary" | "disposable" | "sustainable" | "retail" | "luxury" | "flexible" | "rigid" | "custom";
         /** PackageInfoSchema */
         PackageInfoSchema: {
             /**
@@ -24384,6 +24436,11 @@ export interface components {
              * @default []
              */
             serials: components["schemas"]["SerialInfoSchema"][];
+            /**
+             * Locations
+             * @default []
+             */
+            locations: components["schemas"]["LocationInfoSchema"][];
         };
         /** SerialInfoSchema */
         SerialInfoSchema: {
@@ -24403,53 +24460,34 @@ export interface components {
             /** Expirydate */
             expiryDate?: string | null;
         };
-        /** UOMGroupSchema */
-        UOMGroupSchema: {
-            unitOfMeasure: components["schemas"]["UnitOfMeasureSchema"];
-            unpacked: components["schemas"]["UnpackedInventorySchema"];
-            /**
-             * Packed
-             * @default []
-             */
-            packed: components["schemas"]["PackedInventorySchema"][];
-            /**
-             * Totalstockquantity
-             * @default 0
-             */
-            totalStockQuantity: number;
-            /**
-             * Totalreservedquantity
-             * @default 0
-             */
-            totalReservedQuantity: number;
-            /**
-             * Totalavailablequantity
-             * @default 0
-             */
-            totalAvailableQuantity: number;
+        /** UOMGroupingSchema */
+        UOMGroupingSchema: {
+            unitOfMeasure: components["schemas"]["UnitOfMeasureSummaryInfo"];
+            unpacked: components["schemas"]["UnPackedInventoryItemSchema"];
+            /** Packed */
+            packed: components["schemas"]["PackedInventoryItemSchema"][];
         };
-        /** UnpackedInventorySchema */
-        UnpackedInventorySchema: {
-            /**
-             * Stockquantity
-             * @default 0
-             */
+        /** UnPackedInventoryItemSchema */
+        UnPackedInventoryItemSchema: {
+            /** Stockquantity */
             stockQuantity: number;
+            /** Availableforsale */
+            availableForSale: number;
             /**
-             * Reservedquantity
-             * @default 0
+             * Batches
+             * @default []
              */
-            reservedQuantity: number;
+            batches: components["schemas"]["BatchInfoSchema"][];
             /**
-             * Availablequantity
-             * @default 0
+             * Serials
+             * @default []
              */
-            availableQuantity: number;
+            serials: components["schemas"]["SerialInfoSchema"][];
             /**
              * Locations
              * @default []
              */
-            locations: components["schemas"]["ItemLocationSchema"][];
+            locations: components["schemas"]["LocationInfoSchema"][];
         };
         /**
          * AdjustmentTypeOption
@@ -24489,33 +24527,6 @@ export interface components {
          * @enum {string}
          */
         InternalStatusOnReturnValueChoices: "draft" | "submitted" | "canceled";
-        /** ItemPackageSummarySchema */
-        ItemPackageSummarySchema: {
-            /**
-             * Id
-             * Format: uuid
-             */
-            id: string;
-            /**
-             * Barcode
-             * @description Barcode of the item
-             */
-            barcode: string;
-            /**
-             * Quantity
-             * @description Quantity of the item
-             */
-            quantity: number;
-            /** @description Package of the item */
-            package: components["schemas"]["PackageSummarySchema"];
-            /** Returnable */
-            returnable: boolean;
-        };
-        /**
-         * PackageCategory
-         * @enum {string}
-         */
-        PackageCategory: "primary" | "secondary" | "tertiary" | "disposable" | "sustainable" | "retail" | "luxury" | "flexible" | "rigid" | "custom";
         /** Reason */
         Reason: {
             /** Id */
@@ -26274,6 +26285,8 @@ export interface components {
             modifiedBy: components["schemas"]["RecordUserSchema"] | null;
             /** Id */
             id: number;
+            /** Name */
+            name: string;
             /** Firstname */
             firstName?: string | null;
             /** Lastname */
@@ -27558,7 +27571,7 @@ export interface components {
             /**
              * Id
              * Format: uuid
-             * @example bc00a372-9db7-498d-870f-f110b6a269dc
+             * @example 173f3737-c896-45ea-9499-beb048575148
              */
             id: string;
             /**
@@ -36461,11 +36474,13 @@ export interface components {
             /**
              * Startdate
              * Format: date-time
+             * @description user should select time when promotion type is timeSensitiveOffers
              */
             startDate: string;
             /**
              * Enddate
              * Format: date-time
+             * @description user should select time when promotion type is timeSensitiveOffers
              */
             endDate: string;
             /**
@@ -36833,11 +36848,13 @@ export interface components {
             /**
              * Startdate
              * Format: date-time
+             * @description user should select time when promotion type is timeSensitiveOffers
              */
             startDate: string;
             /**
              * Enddate
              * Format: date-time
+             * @description user should select time when promotion type is timeSensitiveOffers
              */
             endDate: string;
             /**
@@ -37143,8 +37160,11 @@ export interface components {
             country: components["schemas"]["CountryCodes"];
             /** Postalcode */
             postalCode?: string;
-            /** City Id */
-            "city id"?: number;
+            /**
+             * City
+             * @description city id
+             */
+            city?: number;
             /** Address */
             address?: string;
             /** Website */
@@ -38258,6 +38278,7 @@ 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 */
             calculation: components["schemas"]["CommissionCalculation"];
             /** @description
              *             In all structures user should specify commission value and commission value type
@@ -38416,6 +38437,7 @@ 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 */
             calculation: components["schemas"]["CommissionCalculation"];
             /** @description
              *             In all structures user should specify comiision value and commission value type
@@ -39761,6 +39783,18 @@ export interface components {
             packageDepositCharge?: string;
             /**
              * Promotionsandoffers
+             * @description
+             *                     API Endpoints For Document Item Offers and Promotions Retrieval:
+             *                     - Use the API: /api/v1/sales/offers-and-promotions/,
+             *                     Filters :
+             *                     - customers equals to {customer id} or customerGroups equals to {customer group id}
+             *                     & promotion_type equals to "percentage"  or "buy_one_get_one" or "time_sensitive_offers"
+             *                     | promotion_type equals to "volume_based" and items.quantity equals to  {quantity}
+             *                     | promotion_type equals to "bundle_offers" and items.quantity equals to  {quantity} and items.item equals to {item id} or items.itemPackage equals to {item package id}
+             *                     | appliesOn equals to "all_items"
+             *                     | appliesOn equals to "specific_items" and ( items.item equals to {item id} or items.itemPackage equals to {item package id} ) or
+             *                     (items.brand equals to {item brand id} or items.category equals to {item category id} or items.tag in item tags)
+             *
              * @default []
              */
             promotionsAndOffers: string[];
@@ -39822,14 +39856,11 @@ export interface components {
              *             API Endpoints For Document Header Offers and Promotions Retrieval:
              *             - Use the API: /api/v1/sales/offers-and-promotions/,
              *             Filters :
-             *                     - offer_and_promotion.branch equals to {branch-id}
-             *                     & offer_and_promotion.customers equals to {customer id} or customerGroups equals to {customer group id}
-             *                     & offer_and_promotion.startDate less than or equal {date with  00:00:00} and offer_and_promotion.endDate greater than or equal {date with 23:59:59}
-             *                     & offer_and_promotion.approval_status equals to approved or not_required
-             *                     & offer_and_promotion.status equals to submitted
-             *                     & offer_and_promotion.promotion_type equals to order_value or fixed amount and currency equals to company currency and minOrderValue less than or equal to {company-total}
-             *                     | offer_and_promotion.promotion_type equals to order_value or fixed amount and currency equals to usd currency and minOrderValue less than or equal to {usd-total}
-             *
+             *                     - customers equals to {customer id} or customerGroups equals to {customer group id}
+             *                     & offer_and_promotion.promotion_type equals to "order_value" or "fixed_amount" and
+             *                     items.currency equals to company currency and minOrderValue less than or equal to {primary_total}
+             *                     | offer_and_promotion.promotion_type equals to "order_value" or "fixed_amount"
+             *                      and items.currency equals to secondary currency and minOrderValue less than or equal to {secondary_total}
              *
              * @default []
              */
@@ -40441,7 +40472,7 @@ export interface components {
              *             - supplier id
              *             API Endpoints for Suppliers Retrieval:
              *             - Use the API: /api/v1/suppliers/
-             *             - Query Parameters: documentType = purchaseRefundVoucher, type = children
+             *             - Query Parameters: documentType = purchaseRefundVoucher, type = children, branch = {branch-id}
              *
              */
             supplier: number;
@@ -40751,7 +40782,7 @@ export interface components {
              *             - supplier id
              *             API Endpoints for Suppliers Retrieval:
              *             - Use the API: /api/v1/suppliers/
-             *             - Query Parameters: documentType = purchaseRefundVoucher, type = children
+             *             - Query Parameters: documentType = purchaseRefundVoucher, type = children, branch = {branch-id}
              *
              */
             supplier: number;
@@ -41969,18 +42000,13 @@ export interface components {
              *                     API Endpoints For Document Item Offers and Promotions Retrieval:
              *                     - Use the API: /api/v1/sales/offers-and-promotions/,
              *                     Filters :
-             *                             - offer_and_promotion.branch equals to {branch-id}
-             *                             & offer_and_promotion.customers equals to {customer id} or customerGroups equals to {customer group id}
-             *                             & offer_and_promotion.startDate less than or equal {date with  00:00:00} and offer_and_promotion.endDate greater than or equal {date with 23:59:59}
-             *                             & offer_and_promotion.approval_status equals to approved or not_required
-             *                             & offer_and_promotion.status equals to submitted
-             *                             & offers_and_promotions.promotion_type equals to percentage  or buy_one_get_one or timeSensitiveOffers
-             *                             | offers_and_promotions.promotion_type equals to volume_based and quantity equals to  {quantity}
-             *                             | offers_and_promotions.promotion_type equals to bundle_offers and quantity equals to  {quantity} and item equals to {item id} or itemPackage equals to {item package id}
-             *                             | offers_and_promotions.appliesOn equals to allItems
-             *                             | offers_and_promotions.appliesOn equals to specificItems and ( item equals to {item id} or itemPackage equals to {item package id} ) or
-             *                             (brand equals to {item brand id} or category equals to {item category id} or tag in item tags)
-             *
+             *                     - customers equals to {customer id} or customerGroups equals to {customer group id}
+             *                     & promotion_type equals to "percentage"  or "buy_one_get_one" or "time_sensitive_offers"
+             *                     | promotion_type equals to "volume_based" and items.quantity equals to  {quantity}
+             *                     | promotion_type equals to "bundle_offers" and items.quantity equals to  {quantity} and items.item equals to {item id} or items.itemPackage equals to {item package id}
+             *                     | appliesOn equals to "all_items"
+             *                     | appliesOn equals to "specific_items" and ( items.item equals to {item id} or items.itemPackage equals to {item package id} ) or
+             *                     (items.brand equals to {item brand id} or items.category equals to {item category id} or items.tag in item tags)
              *
              * @default []
              */
@@ -42054,13 +42080,11 @@ export interface components {
              *             API Endpoints For Document Header Offers and Promotions Retrieval:
              *             - Use the API: /api/v1/sales/offers-and-promotions/,
              *             Filters :
-             *                     - offer_and_promotion.branch equals to {branch-id}
-             *                     & offer_and_promotion.customers equals to {customer id} or customerGroups equals to {customer group id}
-             *                     & offer_and_promotion.startDate less than or equal {date with  00:00:00} and offer_and_promotion.endDate greater than or equal {date with 23:59:59}
-             *                     & offer_and_promotion.approval_status equals to approved or not_required
-             *                     & offer_and_promotion.status equals to submitted
-             *                     & offer_and_promotion.promotion_type equals to order_value or fixed amount and currency equals to company currency and minOrderValue less than or equal to {company-total}
-             *                     | offer_and_promotion.promotion_type equals to order_value or fixed amount and currency equals to usd currency and minOrderValue less than or equal to {usd-total}
+             *                     - customers equals to {customer id} or customerGroups equals to {customer group id}
+             *                     & offer_and_promotion.promotion_type equals to "order_value" or "fixed_amount" and
+             *                     items.currency equals to company currency and minOrderValue less than or equal to {primary_total}
+             *                     | offer_and_promotion.promotion_type equals to "order_value" or "fixed_amount"
+             *                      and items.currency equals to secondary currency and minOrderValue less than or equal to {secondary_total}
              *
              * @default []
              */
@@ -43633,18 +43657,13 @@ export interface components {
              *             API Endpoints For Document Item Offers and Promotions Retrieval:
              *             - Use the API: /api/v1/sales/offers-and-promotions/,
              *             Filters :
-             *                     - offer_and_promotion.branch equals to {branch-id}
-             *                     & offer_and_promotion.customers equals to {customer id} or customerGroups equals to {customer group id}
-             *                     & offer_and_promotion.startDate less than or equal {date with  00:00:00} and offer_and_promotion.endDate greater than or equal {date with 23:59:59}
-             *                     & offer_and_promotion.approval_status equals to approved or not_required
-             *                     & offer_and_promotion.status equals to submitted
-             *                     & offers_and_promotions.promotion_type equals to percentage  or buy_one_get_one or timeSensitiveOffers
-             *                     | offers_and_promotions.promotion_type equals to volume_based and quantity equals to  {quantity}
-             *                     | offers_and_promotions.promotion_type equals to bundle_offers and quantity equals to  {quantity} and item equals to {item id} or itemPackage equals to {item package id}
-             *                     | offers_and_promotions.appliesOn equals to allItems
-             *                     | offers_and_promotions.appliesOn equals to specificItems and ( item equals to {item id} or itemPackage equals to {item package id} ) or
-             *                     (brand equals to {item brand id} or category equals to {item category id} or tag in item tags)
-             *
+             *                     - customers equals to {customer id} or customerGroups equals to {customer group id}
+             *                     & promotion_type equals to "percentage"  or "buy_one_get_one" or "time_sensitive_offers"
+             *                     | promotion_type equals to "volume_based" and items.quantity equals to  {quantity}
+             *                     | promotion_type equals to "bundle_offers" and items.quantity equals to  {quantity} and items.item equals to {item id} or items.itemPackage equals to {item package id}
+             *                     | appliesOn equals to "all_items"
+             *                     | appliesOn equals to "specific_items" and ( items.item equals to {item id} or items.itemPackage equals to {item package id} ) or
+             *                     (items.brand equals to {item brand id} or items.category equals to {item category id} or items.tag in item tags)
              *
              * @default []
              */
@@ -43756,14 +43775,11 @@ export interface components {
              *             API Endpoints For Document Header Offers and Promotions Retrieval:
              *             - Use the API: /api/v1/sales/offers-and-promotions/,
              *             Filters :
-             *                     - offer_and_promotion.branch equals to {branch-id}
-             *                     & offer_and_promotion.customers equals to {customer id} or customerGroups equals to {customer group id}
-             *                     & offer_and_promotion.startDate less than or equal {date with  00:00:00} and offer_and_promotion.endDate greater than or equal {date with 23:59:59}
-             *                     & offer_and_promotion.approval_status equals to approved or not_required
-             *                     & offer_and_promotion.status equals to submitted
-             *                     & offer_and_promotion.promotion_type equals to order_value or fixed amount and currency equals to company currency and minOrderValue less than or equal to {company-total}
-             *                     | offer_and_promotion.promotion_type equals to order_value or fixed amount and currency equals to usd currency and minOrderValue less than or equal to {usd-total}
-             *
+             *                     - customers equals to {customer id} or customerGroups equals to {customer group id}
+             *                     & offer_and_promotion.promotion_type equals to "order_value" or "fixed_amount" and
+             *                     items.currency equals to company currency and minOrderValue less than or equal to {primary_total}
+             *                     | offer_and_promotion.promotion_type equals to "order_value" or "fixed_amount"
+             *                      and items.currency equals to secondary currency and minOrderValue less than or equal to {secondary_total}
              *
              * @default []
              */
@@ -45766,6 +45782,11 @@ export interface components {
             unitPackage: number | null;
             /** Quantity */
             quantity: number;
+            /**
+             * Quantityordered
+             * @description Quantity ordered from the linked sales order or invoice
+             */
+            quantityOrdered?: number | null;
             /**
              * Tracking
              * @description Tracking details (serial numbers, batches, or quantities)
@@ -45891,6 +45912,11 @@ export interface components {
             unitPackage?: number;
             /** Quantity */
             quantity: number;
+            /**
+             * Quantityordered
+             * @description Quantity of the item ordered (if applicable)
+             */
+            quantityOrdered?: number | null;
             /**
              * Tracking
              * @description Get the tracking from the item
@@ -47185,6 +47211,54 @@ export interface components {
              */
             locations: components["schemas"]["ItemLocationSchema"][];
         };
+        /** UOMGroupSchema */
+        UOMGroupSchema: {
+            unitOfMeasure: components["schemas"]["UnitOfMeasureSchema"];
+            unpacked: components["schemas"]["UnpackedInventorySchema"];
+            /**
+             * Packed
+             * @default []
+             */
+            packed: components["schemas"]["PackedInventorySchema"][];
+            /**
+             * Totalstockquantity
+             * @default 0
+             */
+            totalStockQuantity: number;
+            /**
+             * Totalreservedquantity
+             * @default 0
+             */
+            totalReservedQuantity: number;
+            /**
+             * Totalavailablequantity
+             * @default 0
+             */
+            totalAvailableQuantity: number;
+        };
+        /** UnpackedInventorySchema */
+        UnpackedInventorySchema: {
+            /**
+             * Stockquantity
+             * @default 0
+             */
+            stockQuantity: number;
+            /**
+             * Reservedquantity
+             * @default 0
+             */
+            reservedQuantity: number;
+            /**
+             * Availablequantity
+             * @default 0
+             */
+            availableQuantity: number;
+            /**
+             * Locations
+             * @default []
+             */
+            locations: components["schemas"]["ItemLocationSchema"][];
+        };
     };
     responses: never;
     parameters: never;

package/package.json

@@ -1,5 +1,5 @@
 {
   "name": "@erp-galoper/main-package",
-  "version": "1.0.303",
+  "version": "1.0.305",
   "main": "openapi.ts"
 }