@erp-galoper/types 1.0.626 → 1.0.628

package/openapi.ts

@@ -4087,54 +4087,65 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/api/v1/inventory/items-quantity/": {
+    "/api/v1/inventory/items/batches-or-serials/distribution/": {
         parameters: {
             query?: never;
             header?: never;
             path?: never;
             cookie?: never;
         };
+        get?: never;
+        put?: never;
         /**
-         * Get Items Quantity
-         * @description Endpoint for List Items Quantity in Warehouse and Branch
+         * Allocate Batches Or Serials
+         * @description API to allocate batches or serials for an item based on FIFO or LIFO settings.
+         *
          *     Responses:
-         *     - 200: ItemsWarehouseQuantityListSchema
-         *     - 400: "invalidFilterFormat"
-         *         - "paginationError"
-         *     - 403: "permissionDenied"
-         *         - "noBranchAccess"
-         *     - 500: "serverError"
+         *
+         *     200: list[AllocationResponse]]
+         *     400: - "inventoryMovementMethodNotSet"
+         *         - "quatityExceeded"
+         *     500: "serverError"
          */
-        get: operations["inventory_views_get_items_quantity"];
-        put?: never;
-        post?: never;
+        post: operations["inventory_views_allocate_batches_or_serials"];
         delete?: never;
         options?: never;
         head?: never;
         patch?: never;
         trace?: never;
     };
-    "/api/v1/inventory/items/batches-or-serials/distribution/": {
+    "/api/v1/inventory/items-quantity/": {
         parameters: {
             query?: never;
             header?: never;
             path?: never;
             cookie?: never;
         };
-        get?: never;
-        put?: never;
         /**
-         * Allocate Batches Or Serials
-         * @description API to allocate batches or serials for an item based on FIFO or LIFO settings.
+         * Get Items Quantity
+         * @description Endpoint for List Items Quantity in Warehouse and Branch with UOM-based Batch/Serial breakdown
          *
-         *     Responses:
+         *     Query Parameters:
+         *     - warehouses: List of warehouse IDs to filter by (required), it should be filtered by selected branch and warehouses assigned to the user
+         *     - branchId: Branch ID to filter by (optional), it should be filtered by assigned branches
+         *     - items: List of item IDs to filter by (optional)
+         *     - unit_of_measures: List of unit of measure IDs to filter by (optional)
+         *     - packed: Filter by packed status (optional)
+         *         - True or None (default): Show all items (both packed and unpacked)
+         *         - False: Show only unpacked items (items without packages)
+         *     - item_packages: List of item package IDs to filter by (optional)
+         *         - If provided, overrides packed parameter and shows only specified packages
          *
-         *     200: list[AllocationResponse]]
-         *     400: - "inventoryMovementMethodNotSet"
-         *         - "quatityExceeded"
-         *     500: "serverError"
+         *     Responses:
+         *     - 200: Items quantity with UOM breakdown
+         *     - 400:
+         *     - 403: "permissionDenied"
+         *         - "noBranchAccess"
+         *     - 500: "serverError"
          */
-        post: operations["inventory_views_allocate_batches_or_serials"];
+        get: operations["inventory_views_get_items_quantity"];
+        put?: never;
+        post?: never;
         delete?: never;
         options?: never;
         head?: never;
@@ -4181,6 +4192,7 @@ export interface paths {
          *         - serialItemMismatch - Serial does not belong to the selected item
          *         - serialNotAvailable - Serial is not in available status
          *         - serialNotInWarehouse - Serial is not present in warehouse
+         *         - item+warehouse+branch+unitOfMeasure+itemPackageConflict
          *         - serialDoesNotExist - The selected serial does not exist
          *     - 403: permissionDenied
          *         - noBranchAccess
@@ -4529,6 +4541,7 @@ export interface paths {
          *         - serialNotAvailable - Serial is not in available status
          *         - serialNotInWarehouse - Serial is not present in source warehouse
          *         - serialDoesNotExist - The selected serial does not exist
+         *         - item+warehouse+branch+unitOfMeasure+itemPackageConflict
          *
          *     - 403: permissionDenied
          *         - noBranchAccess
@@ -24440,15 +24453,6 @@ export interface components {
              */
             children: components["schemas"]["profitAndLossSchema"][] | null;
         };
-        /** ItemsWarehouseQuantityListSchema */
-        ItemsWarehouseQuantityListSchema: {
-            info: components["schemas"]["PageInfoSchema"];
-            /**
-             * Results
-             * @default []
-             */
-            results: components["schemas"]["ItemsWarehouseQuantitySchema"][];
-        };
         /** AllocationResponse */
         AllocationResponse: {
             /**
@@ -24483,6 +24487,124 @@ export interface components {
          * @enum {string}
          */
         ResourceType: "batch" | "serial";
+        /** BatchInfoSchema */
+        BatchInfoSchema: {
+            /**
+             * Id
+             * Format: uuid
+             */
+            id: string;
+            /** Number */
+            number: string;
+            /** Stockquantity */
+            stockQuantity: number;
+            /** Availableforsale */
+            availableForSale: number;
+            /** Expirydate */
+            expiryDate?: string | null;
+        };
+        /** ItemQuantityResponseSchema */
+        ItemQuantityResponseSchema: {
+            item: components["schemas"]["ItemMinimalSchema"];
+            /** Uomgroups */
+            uomGroups: components["schemas"]["UOMGroupSchema"][];
+        };
+        /** PackageInfoSchema */
+        PackageInfoSchema: {
+            /**
+             * Id
+             * Format: uuid
+             */
+            id: string;
+            /** Name */
+            name: string;
+            /** Quantity */
+            quantity: number;
+        };
+        /** PackedInventoryItemSchema */
+        PackedInventoryItemSchema: {
+            package?: components["schemas"]["PackageInfoSchema"] | null;
+            /** Stockquantity */
+            stockQuantity: number;
+            /** Availableforsale */
+            availableForSale: number;
+            /**
+             * Batches
+             * @default []
+             */
+            batches: components["schemas"]["BatchInfoSchema"][];
+            /**
+             * Serials
+             * @default []
+             */
+            serials: components["schemas"]["SerialInfoSchema"][];
+        };
+        /** SerialInfoSchema */
+        SerialInfoSchema: {
+            /**
+             * Id
+             * Format: uuid
+             */
+            id: string;
+            /** Number */
+            number: string;
+            /** Status */
+            status: string;
+            /** Stockquantity */
+            stockQuantity: number;
+            /** Availableforsale */
+            availableForSale: number;
+            /** 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;
+        };
+        /** UnpackedInventorySchema */
+        UnpackedInventorySchema: {
+            /**
+             * Stockquantity
+             * @default 0
+             */
+            stockQuantity: number;
+            /**
+             * Reservedquantity
+             * @default 0
+             */
+            reservedQuantity: number;
+            /**
+             * Availablequantity
+             * @default 0
+             */
+            availableQuantity: number;
+            /**
+             * Locations
+             * @default []
+             */
+            locations: components["schemas"]["ItemLocationSchema"][];
+        };
         /**
          * AdjustmentTypeOption
          * @enum {string}
@@ -24624,9 +24746,7 @@ export interface components {
             /**
              * Item
              * @description
-             *             - Select only active items
-             *             - Get item's tracking method for validation rules
-             *             - System will check current warehouse quantities
+             *             - /api/v1/inventory/items/ and filter by active=true
              *
              */
             item: number;
@@ -24656,6 +24776,7 @@ export interface components {
              *             - Required if item is tracked by batch
              *             - Must belong to the selected item
              *             - Must exist in the warehouse for decrease/replace adjustments
+             *             -  /api/v1/inventory/items-quantity/ use this route to check availability (availableForSale)
              *
              */
             batch?: string | null;
@@ -24665,7 +24786,7 @@ export interface components {
              *             - Required if item is tracked by serial number
              *             - Must belong to the selected item
              *             - For decrease, serial must exist in warehouse
-             *             - For increase, new serial or inactive serial can be used
+             *             - /api/v1/inventory/items-quantity/ use this route to check availability (availableForSale)
              *
              */
             serial?: string | null;
@@ -24697,7 +24818,6 @@ export interface components {
              * Warehouse
              * @description
              *             - Select from user's assigned warehouses
-             *             - Must be an active warehouse
              *             - User must have permission to adjust inventory in this warehouse
              *
              */
@@ -24707,12 +24827,6 @@ export interface components {
              * @description Optional notes explaining the purpose of this adjustment
              */
             description?: string | null;
-            /** @description
-             *             - draft: Initial state, can be modified
-             *             - pending: Submitted for approval
-             *             - approved: Inventory effects applied
-             *             - rejected: Adjustment denied
-             *              */
             status: components["schemas"]["InternalStatusOnCreateValueChoices"];
             /**
              * Details
@@ -24766,11 +24880,6 @@ export interface components {
              * @description Optional notes explaining the purpose of this adjustment
              */
             description?: string | null;
-            /** @description
-             *             - draft: Can be modified
-             *             - pending: Submitted for approval
-             *             - Cannot be updated if already approved
-             *              */
             status: components["schemas"]["InternalStatusOnCreateValueChoices"];
             /**
              * Details
@@ -24786,9 +24895,7 @@ export interface components {
             /**
              * Item
              * @description
-             *             - Select only active items
-             *             - Get item's tracking method for validation rules
-             *             - System will check current warehouse quantities
+             *             - /api/v1/inventory/items/ and filter by active=true
              *
              */
             item: number;
@@ -24818,6 +24925,7 @@ export interface components {
              *             - Required if item is tracked by batch
              *             - Must belong to the selected item
              *             - Must exist in the warehouse for decrease/replace adjustments
+             *             -  /api/v1/inventory/items-quantity/ use this route to check availability (availableForSale)
              *
              */
             batch?: string | null;
@@ -24827,7 +24935,7 @@ export interface components {
              *             - Required if item is tracked by serial number
              *             - Must belong to the selected item
              *             - For decrease, serial must exist in warehouse
-             *             - For increase, new serial or inactive serial can be used
+             *             - /api/v1/inventory/items-quantity/ use this route to check availability (availableForSale)
              *
              */
             serial?: string | null;
@@ -25249,6 +25357,7 @@ export interface components {
              * @description
              *             - Must be greater than zero
              *             - Maximum is determined by source warehouse availability
+             *             -   /api/v1/inventory/items-quantity/ use this route to check availability (availableForSale)
              *             - For serial items, must be 1
              *
              */
@@ -25390,6 +25499,7 @@ export interface components {
              * @description
              *             - Must be greater than zero
              *             - Maximum is determined by source warehouse availability
+             *             -   /api/v1/inventory/items-quantity/ use this route to check availability (availableForSale)
              *             - For serial items, must be 1
              *
              */
@@ -27582,7 +27692,7 @@ export interface components {
             /**
              * Id
              * Format: uuid
-             * @example ff4eb945-b1cd-4e50-b88b-b2721518c4d5
+             * @example b25b268e-2aef-4918-9504-5c9e52884fea
              */
             id: string;
             /**
@@ -47141,54 +47251,6 @@ 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;
@@ -56021,20 +56083,18 @@ export interface operations {
             };
         };
     };
-    inventory_views_get_items_quantity: {
+    inventory_views_allocate_batches_or_serials: {
         parameters: {
-            query: {
-                /** @description Page number */
-                page?: number;
-                /** @description Page size */
-                pageSize?: number;
-                branch: number;
-            };
+            query?: never;
             header?: never;
             path?: never;
             cookie?: never;
         };
-        requestBody?: never;
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["BatchAllocationRequest"];
+            };
+        };
         responses: {
             /** @description OK */
             200: {
@@ -56042,7 +56102,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["ItemsWarehouseQuantityListSchema"];
+                    "application/json": components["schemas"]["AllocationResponse"][];
                 };
             };
             /** @description Bad Request */
@@ -56051,25 +56111,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["MessageWithCode"];
-                };
-            };
-            /** @description Forbidden */
-            403: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["MessageWithCode"];
-                };
-            };
-            /** @description Not Found */
-            404: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["MessageWithCode"];
+                    "application/json": components["schemas"]["ErrorMessages"];
                 };
             };
             /** @description Internal Server Error */
@@ -56083,18 +56125,27 @@ export interface operations {
             };
         };
     };
-    inventory_views_allocate_batches_or_serials: {
+    inventory_views_get_items_quantity: {
         parameters: {
-            query?: never;
+            query: {
+                /** @description Branch ID to filter by (optional), it should be filtered by assigned branches to the user */
+                branchId?: number | null;
+                /** @description List of item IDs to filter by (optional) */
+                items?: number[] | null;
+                /** @description List of warehouse IDs to filter by (required), it should be filtered by selected branch and warehouses assigned to the user */
+                warehouses: number[];
+                /** @description Filter by packed (true) or unpacked (false) items */
+                isPacked?: boolean | null;
+                /** @description List of item package IDs to filter by */
+                itemPackages?: string[] | null;
+                /** @description List of unit of measure IDs to filter by (optional) */
+                unitOfMeasures?: number[] | null;
+            };
             header?: never;
             path?: never;
             cookie?: never;
         };
-        requestBody: {
-            content: {
-                "application/json": components["schemas"]["BatchAllocationRequest"];
-            };
-        };
+        requestBody?: never;
         responses: {
             /** @description OK */
             200: {
@@ -56102,7 +56153,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["AllocationResponse"][];
+                    "application/json": components["schemas"]["ItemQuantityResponseSchema"][];
                 };
             };
             /** @description Bad Request */
@@ -56111,7 +56162,25 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["ErrorMessages"];
+                    "application/json": components["schemas"]["MessageWithCode"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MessageWithCode"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MessageWithCode"];
                 };
             };
             /** @description Internal Server Error */

package/package.json

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