@erp-galoper/types 1.0.584 → 1.0.586

package/openapi.ts

@@ -18385,6 +18385,73 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/reports/inventory/item-movement-report/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get Item Movement Report
+         * @description Generate an Item Movement Report for the specified filters and date range.
+         *
+         *     The report tracks and summarizes all movements of inventory items, providing visibility
+         *     into how inventory is flowing through the organization.
+         *
+         *     Responses:
+         *     - 200: Item Movement Report results
+         *     - 400: "customPeriodError"
+         *         - "invalidFilterFormat"
+         *     - 403: "noModuleAccess"
+         *         - "permissionDenied"
+         *         - "noBranchAccess"
+         *     - 500: "serverError"
+         *
+         *     Permission key: inventoryreport: ["view"]
+         */
+        get: operations["reports_inventoryreport_views_get_item_movement_report"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/v1/reports/inventory/item-availability-report/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get Item Availability Report
+         * @description Generate an Item Availability Report for the specified filters.
+         *
+         *     The report provides real-time insights into the quantity of each item currently in stock,
+         *     on order, committed to sales, and expected from suppliers.
+         *
+         *     Responses:
+         *     - 200: Item Availability Report results
+         *     - 400: "invalidFilterFormat"
+         *     - 403: "noModuleAccess"
+         *         - "permissionDenied"
+         *         - "noBranchAccess"
+         *     - 500: "serverError"
+         *
+         *     Permission key: inventoryreport: ["view"]
+         */
+        get: operations["reports_inventoryreport_views_get_item_availability_report"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
 }
 export type webhooks = Record<string, never>;
 export interface components {
@@ -27434,7 +27501,7 @@ export interface components {
             /**
              * Id
              * Format: uuid
-             * @example aeda4601-7deb-4fe6-8a1b-87504974771a
+             * @example 58fdb5f5-fc3d-4b19-aa2e-a4d6441d0b15
              */
             id: string;
             /**
@@ -46619,6 +46686,343 @@ export interface components {
             /** Results */
             results: components["schemas"]["PosRoleSchema"][];
         };
+        /** DetailedMovementSummarySchema */
+        DetailedMovementSummarySchema: {
+            /**
+             * Openingbalance
+             * @default 0
+             */
+            openingBalance: number;
+            /**
+             * Inwardmovements
+             * @default 0
+             */
+            inwardMovements: number;
+            /**
+             * Outwardmovements
+             * @default 0
+             */
+            outwardMovements: number;
+            /**
+             * Closingbalance
+             * @default 0
+             */
+            closingBalance: number;
+        };
+        /** ItemDetailSchemaForReport */
+        ItemDetailSchemaForReport: {
+            /** Id */
+            id: number;
+            /** Name */
+            name: string;
+            /** Barcode */
+            barcode?: string | null;
+            /** Skucode */
+            skuCode?: string | null;
+            family?: components["schemas"]["CommonFamilySchema"] | null;
+            brand?: components["schemas"]["CommonBrandSchema"] | null;
+            category?: components["schemas"]["CommonCategorySchema"] | null;
+            /** Tags */
+            tags?: components["schemas"]["TagSchema"][] | null;
+            /**
+             * Unitofmeasure
+             * @default []
+             */
+            unitOfMeasure: components["schemas"]["UnitOfMeasureSchema"][];
+        };
+        /** ItemMovementReportSchema */
+        ItemMovementReportSchema: {
+            item: components["schemas"]["ItemDetailSchemaForReport"];
+            /**
+             * Unpackedmovements
+             * @default []
+             */
+            unpackedMovements: components["schemas"]["UnpackedMovementsGroupSchema"][];
+            /**
+             * Packedmovements
+             * @default []
+             */
+            packedMovements: components["schemas"]["PackedMovementsGroupSchema"][];
+            summary: components["schemas"]["ItemMovementSummarySchema"];
+        };
+        /** ItemMovementSummarySchema */
+        ItemMovementSummarySchema: {
+            /**
+             * Openingbalance
+             * @default 0
+             */
+            openingBalance: number;
+            /** @default {
+             *       "opening_balance": 0,
+             *       "inward_movements": 0,
+             *       "outward_movements": 0,
+             *       "closing_balance": 0
+             *     } */
+            unpacked: components["schemas"]["DetailedMovementSummarySchema"];
+            /** @default {
+             *       "opening_balance": 0,
+             *       "inward_movements": 0,
+             *       "outward_movements": 0,
+             *       "closing_balance": 0
+             *     } */
+            packed: components["schemas"]["DetailedMovementSummarySchema"];
+            /**
+             * Closingbalance
+             * @default 0
+             */
+            closingBalance: number;
+            /**
+             * Totalinward
+             * @default 0
+             */
+            totalInward: number;
+            /**
+             * Totaloutward
+             * @default 0
+             */
+            totalOutward: number;
+        };
+        /** MovementTransactionSchema */
+        MovementTransactionSchema: {
+            documentType?: components["schemas"]["CombinedModelName"] | null;
+            /**
+             * Movementdate
+             * Format: date
+             */
+            movementDate: string;
+            /** Quantity */
+            quantity: number;
+            branch: components["schemas"]["BranchSummaryInfo"];
+            warehouse: components["schemas"]["WarehouseSummaryInfo"];
+            /** Serialnumber */
+            serialNumber?: string | null;
+            movementType: components["schemas"]["MovementType"];
+            /** Batchnumber */
+            batchNumber?: string | null;
+            unitOfMeasure?: components["schemas"]["UnitOfMeasureSchema"] | null;
+            /**
+             * Actualquantity
+             * @description just display incase of item package
+             */
+            actualQuantity?: number | null;
+        };
+        /**
+         * MovementType
+         * @enum {string}
+         */
+        MovementType: "IN" | "OUT";
+        /** PackedMovementsGroupSchema */
+        PackedMovementsGroupSchema: {
+            itemPackage?: components["schemas"]["ItemPackageSummarySchema"] | null;
+            /**
+             * Movements
+             * @default []
+             */
+            movements: components["schemas"]["MovementTransactionSchema"][];
+        };
+        /** UnpackedMovementsGroupSchema */
+        UnpackedMovementsGroupSchema: {
+            unitOfMeasure: components["schemas"]["UnitOfMeasureSchema"];
+            /**
+             * Movements
+             * @default []
+             */
+            movements: components["schemas"]["MovementTransactionSchema"][];
+        };
+        /** ItemAvailabilityReportSchema */
+        ItemAvailabilityReportSchema: {
+            item: components["schemas"]["ItemDetailSchemaForReport"];
+            /** Barcode */
+            barcode?: string | null;
+            /** Sku */
+            sku?: string | null;
+            /** Description */
+            description?: string | null;
+            /** Name */
+            name: string;
+            /** Category */
+            category?: string | null;
+            /** Family */
+            family?: string | null;
+            /** Brand */
+            brand?: string | null;
+            /**
+             * Tags
+             * @default []
+             */
+            tags: string[];
+            /**
+             * Uomgroups
+             * @default []
+             */
+            uomGroups: components["schemas"]["UOMGroupSchema"][];
+            /**
+             * Totalstockquantity
+             * @default 0
+             */
+            totalStockQuantity: number;
+            /**
+             * Totalreservedquantity
+             * @default 0
+             */
+            totalReservedQuantity: number;
+            /**
+             * Totalavailablequantity
+             * @default 0
+             */
+            totalAvailableQuantity: number;
+            /**
+             * Onorderquantity
+             * @default 0
+             */
+            onOrderQuantity: number;
+            /**
+             * Safetystocklevel
+             * @default 0
+             */
+            safetyStockLevel: number | null;
+            /**
+             * Reorderpoint
+             * @default 0
+             */
+            reorderPoint: number | null;
+            /**
+             * Leadtime
+             * @default 0
+             */
+            leadTime: number | null;
+            /** Lastsaledate */
+            lastSaleDate?: string | null;
+        };
+        /** ItemLocationSchema */
+        ItemLocationSchema: {
+            branch?: components["schemas"]["BranchSummaryInfo"] | null;
+            warehouse?: components["schemas"]["WarehouseSummaryInfo"] | null;
+            unitOfMeasure?: components["schemas"]["UnitOfMeasureSchema"] | null;
+            itemPackage?: components["schemas"]["ItemPackageSummarySchema"] | null;
+            /**
+             * Stockquantity
+             * @default 0
+             */
+            stockQuantity: number;
+            /**
+             * Reservedquantity
+             * @default 0
+             */
+            reservedQuantity: number;
+            /**
+             * Availablequantity
+             * @default 0
+             */
+            availableQuantity: number;
+            /**
+             * Ispackage
+             * @default false
+             */
+            isPackage: boolean;
+            /**
+             * Batches
+             * @default []
+             */
+            batches: components["schemas"]["BatchSerialSummarySchema"][];
+            /**
+             * Serials
+             * @default []
+             */
+            serials: components["schemas"]["BatchSerialSummarySchema"][];
+        };
+        /** PackedInventorySchema */
+        PackedInventorySchema: {
+            package: components["schemas"]["ItemPackageSummarySchema"];
+            /**
+             * Packagequantity
+             * @default 0
+             */
+            packageQuantity: number;
+            /**
+             * Stockquantity
+             * @default 0
+             */
+            stockQuantity: number;
+            /**
+             * Reservedquantity
+             * @default 0
+             */
+            reservedQuantity: number;
+            /**
+             * Availablequantity
+             * @default 0
+             */
+            availableQuantity: number;
+            /**
+             * Totalunits
+             * @default 0
+             */
+            totalUnits: number;
+            /**
+             * Totalreserved
+             * @default 0
+             */
+            totalReserved: number;
+            /**
+             * Totalavailable
+             * @default 0
+             */
+            totalAvailable: number;
+            /**
+             * Locations
+             * @default []
+             */
+            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;
@@ -83531,4 +83935,140 @@ export interface operations {
             };
         };
     };
+    reports_inventoryreport_views_get_item_movement_report: {
+        parameters: {
+            query: {
+                /** @description Start date for custom range (YYYY-MM-DD) */
+                startDate: string;
+                /** @description End date for custom range (YYYY-MM-DD) */
+                endDate: string;
+                /** @description List of branch IDs */
+                branches?: number[] | null;
+                /** @description List of warehouse IDs */
+                warehouses?: number[] | null;
+                /** @description List of family IDs */
+                families?: number[] | null;
+                /** @description List of brand IDs */
+                brands?: number[] | null;
+                /** @description List of tag IDs */
+                tags?: number[] | null;
+                /** @description List of category IDs */
+                categories?: number[] | null;
+                /** @description List of item IDs */
+                items?: number[] | null;
+                /** @description List of package IDs */
+                packages?: string[] | null;
+                /** @description List of UOM IDs */
+                unit_of_measure?: number[] | null;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ItemMovementReportSchema"][];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorMessages"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MessageWithCode"];
+                };
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MessageWithCode"];
+                };
+            };
+        };
+    };
+    reports_inventoryreport_views_get_item_availability_report: {
+        parameters: {
+            query?: {
+                /** @description List of branch IDs */
+                branches?: number[] | null;
+                /** @description List of warehouse IDs */
+                warehouses?: number[] | null;
+                /** @description List of family IDs */
+                families?: number[] | null;
+                /** @description List of brand IDs */
+                brands?: number[] | null;
+                /** @description List of tag IDs */
+                tags?: number[] | null;
+                /** @description List of category IDs */
+                categories?: number[] | null;
+                /** @description List of item IDs */
+                items?: number[] | null;
+                /** @description List of package IDs */
+                packages?: string[] | null;
+                /** @description List of UOM IDs */
+                unit_of_measure?: number[] | null;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ItemAvailabilityReportSchema"][];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorMessages"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MessageWithCode"];
+                };
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MessageWithCode"];
+                };
+            };
+        };
+    };
 }

package/package.json

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