@erp-galoper/types 1.0.1719 → 1.0.1720

package/openapi.ts

@@ -20022,6 +20022,61 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/api/v1/reports/inventory/valuation-report/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get Inventory Valuation Report
+         * @description Generate an Inventory Valuation Report as of a specific period end date.
+         *
+         *     The report calculates the total monetary value of inventory stock on hand
+         *     by applying cost calculation to net movements from ItemMovement records.
+         *
+         *     **Period Types:**
+         *     - all: All historical movements up to now
+         *     - this_fiscal_year: Current fiscal year end
+         *     - last_fiscal_year: Previous fiscal year end
+         *     - this_month: End of current month
+         *     - last_month: End of previous month
+         *     - this_quarter: End of current fiscal quarter
+         *     - last_quarter: End of previous fiscal quarter
+         *     - today: Current date
+         *
+         *     **Filters:**
+         *     - branches: Filter by specific branch(es)
+         *     - warehouses: Filter by specific warehouse(s)
+         *     - categories: Filter by item category
+         *     - brands: Filter by item brand
+         *     - families: Filter by item family
+         *     - items: Filter by specific item(s)
+         *     - search: Search by item name, short name, barcode, SKU code, serial number, batch number, category, brand, or family
+         *     - paginated: Enable pagination (default: true). Set to false to return all records.
+         *     - includeNegativeStock: Include items with negative quantities (default: false)
+         *
+         *     **Responses:**
+         *     - 200: Inventory Valuation Report with total value and item breakdown
+         *     - 400: "invalidPeriodType"
+         *         - "paginationError"
+         *     - 403: "permissionDenied"
+         *         - "noModuleAccess"
+         *         - "noBranchAccess"
+         *     - 500: "serverError"
+         *
+         *     **Permission key:** inventoryreport: ["view"]
+         */
+        get: operations["reports_inventoryreport_views_get_inventory_valuation_report"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/api/v1/reports/by-item/": {
         parameters: {
             query?: never;
@@ -57481,6 +57536,92 @@ export interface components {
              */
             locations: components["schemas"]["ItemLocationSchema"][];
         };
+        /**
+         * CurrencyAmountSchema
+         * @description Amount in both primary and secondary currencies
+         */
+        CurrencyAmountSchema: {
+            /** Primary */
+            primary: number;
+            /** Secondary */
+            secondary: number;
+        };
+        /**
+         * IUOMGroupValuationSchema
+         * @description UOM group with packed/unpacked inventory valuation
+         */
+        IUOMGroupValuationSchema: {
+            unitOfMeasure: components["schemas"]["UnitOfMeasureSchema"];
+            unpacked: components["schemas"]["UnpackedInventoryValuationSchema"] | null;
+            packed: components["schemas"]["PackedInventoryValuationSchema"] | null;
+            /** Quantity */
+            quantity: number;
+            cost: components["schemas"]["CurrencyAmountSchema"];
+        };
+        /**
+         * InventoryValuationLineSchema
+         * @description Individual line item in the valuation report
+         */
+        InventoryValuationLineSchema: {
+            item: components["schemas"]["ItemDetailSchemaForReport"];
+            /** Unitofmeasures */
+            unitOfMeasures: components["schemas"]["IUOMGroupValuationSchema"][];
+            /** Quantity */
+            quantity: number;
+            cost: components["schemas"]["CurrencyAmountSchema"];
+        };
+        /**
+         * InventoryValuationLocationSchema
+         * @description Location-specific inventory valuation data
+         */
+        InventoryValuationLocationSchema: {
+            branch: components["schemas"]["BranchSummaryInfo"];
+            warehouse: components["schemas"]["WarehouseSummaryInfo"];
+            /** Quantity */
+            quantity: number;
+            cost: components["schemas"]["CurrencyAmountSchema"];
+        };
+        /**
+         * InventoryValuationReportResponse
+         * @description Inventory valuation report response with pagination
+         */
+        InventoryValuationReportResponse: {
+            info: components["schemas"]["PageInfoSchema"];
+            /** Results */
+            results: components["schemas"]["InventoryValuationLineSchema"][];
+            totals: components["schemas"]["InventoryValuationTotalsSchema"];
+        };
+        /**
+         * InventoryValuationTotalsSchema
+         * @description Grand totals for inventory valuation across all pages
+         */
+        InventoryValuationTotalsSchema: {
+            /** Totalquantity */
+            totalQuantity: number;
+            totalValue: components["schemas"]["CurrencyAmountSchema"];
+        };
+        /**
+         * PackedInventoryValuationSchema
+         * @description Packed inventory UOM valuation data
+         */
+        PackedInventoryValuationSchema: {
+            /** Quantity */
+            quantity: number;
+            cost: components["schemas"]["CurrencyAmountSchema"];
+            /** Locations */
+            locations: components["schemas"]["InventoryValuationLocationSchema"][];
+        };
+        /**
+         * UnpackedInventoryValuationSchema
+         * @description Unpacked inventory UOM valuation data
+         */
+        UnpackedInventoryValuationSchema: {
+            /** Quantity */
+            quantity: number;
+            cost: components["schemas"]["CurrencyAmountSchema"];
+            /** Locations */
+            locations: components["schemas"]["InventoryValuationLocationSchema"][];
+        };
         /**
          * SalesReportPeriodType
          * @enum {string}
@@ -57505,16 +57646,6 @@ export interface components {
             /** Name */
             name: string;
         };
-        /**
-         * CurrencyAmountSchema
-         * @description Amount in both primary and secondary currencies
-         */
-        CurrencyAmountSchema: {
-            /** Primary */
-            primary: number;
-            /** Secondary */
-            secondary: number;
-        };
         /** FamilySummarySchema */
         FamilySummarySchema: {
             /** Id */
@@ -99927,6 +100058,73 @@ export interface operations {
             };
         };
     };
+    reports_inventoryreport_views_get_inventory_valuation_report: {
+        parameters: {
+            query: {
+                periodType: "thisMonth" | "lastMonth" | "thisQuarter" | "lastQuarter" | "thisFiscalYear" | "lastFiscalYear" | "custom" | "today" | "all";
+                /** @description List of branch IDs */
+                branchIds?: number[] | null;
+                /** @description List of warehouse IDs */
+                warehouseIds?: number[] | null;
+                /** @description List of category IDs */
+                categoryIds?: number[] | null;
+                /** @description List of brand IDs */
+                brandIds?: number[] | null;
+                /** @description List of family IDs */
+                familyIds?: number[] | null;
+                /** @description List of item IDs */
+                itemIds?: number[] | null;
+                /** @description Search by item name, short name, barcode, SKU code, serial number, batch number, category, brand, or family */
+                search?: string | null;
+                /** @description Enable pagination (default: true) */
+                paginated?: boolean;
+                /** @description Include negative stock items */
+                includeNegativeStock?: boolean;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["InventoryValuationReportResponse"];
+                };
+            };
+            /** @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_salesreport_views_get_sales_by_item_report: {
         parameters: {
             query?: {

package/package.json

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