@erp-galoper/types 1.0.585 → 1.0.587

package/openapi.ts

@@ -7973,34 +7973,49 @@ export interface paths {
         };
         /**
          * Get Pos Settings
-         * @description Get POS settings
-         *     possible responses:
-         *     - 200:
-         *         - data
-         *     - 403:
-         *         - permissionDenied
-         *     - 404:
-         *         - posSettingsDoesNotExists
+         * @description Endpoint for retrieving POS settings
+         *     Response:
+         *     - 200: RetrievePosSettings
+         *     - 403: permissionDenied
+         *     - 404: posSettingsDoNotExist
+         *     - 500: serverError
+         *
+         *     This endpoint is used in standalone mode to retrieve POS settings
+         *
+         *     permissions: pos_settings : [view]
          */
         get: operations["erp_settings_pos_settings_views_get_pos_settings"];
-        put?: never;
+        /**
+         * Update Pos Settings
+         * @description Endpoint for updating POS settings
+         *     Response:
+         *     - 200: RetrievePosSettings
+         *     - 400: ErrorMessages
+         *     - 403: permissionDenied
+         *     - 404: posSettingsDoNotExist
+         *     - 500: serverError
+         *
+         *     permissions: pos_settings : [change]
+         */
+        put: operations["erp_settings_pos_settings_views_update_pos_settings"];
         /**
          * Create Pos Settings
-         * @description Create POS settings
-         *     possible responses:
-         *     - 200:
-         *         - posSettingsCreated , id
-         *     - 403:
-         *         - permissionDenied
-         *     - 400:
-         *         - posSettingsDoesNotExists
+         * @description Endpoint for creating POS settings
+         *     Response:
+         *     - 201: RetrievePosSettings
+         *     - 400: defaultCurrencyDoesNotExist
+         *     - 403: permissionDenied
+         *     - 500: serverError
+         *
+         *     This endpoint is used in standalone mode to create POS settings
+         *
+         *     permissions: pos_settings : [add]
          */
         post: operations["erp_settings_pos_settings_views_create_pos_settings"];
         delete?: never;
         options?: never;
         head?: never;
-        /** Update Pos Settings */
-        patch: operations["erp_settings_pos_settings_views_update_pos_settings"];
+        patch?: never;
         trace?: never;
     };
     "/api/v1/settings/appointment/": {
@@ -18419,6 +18434,39 @@ export interface paths {
         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 {
@@ -20389,6 +20437,11 @@ export interface components {
          * @enum {string}
          */
         FullPermissionAction: "view" | "add" | "change" | "delete";
+        /**
+         * FullPermissionActionWithoutDelete
+         * @enum {string}
+         */
+        FullPermissionActionWithoutDelete: "view" | "add" | "change";
         /**
          * InvoicePermissionAction
          * @enum {string}
@@ -20461,17 +20514,17 @@ export interface components {
              * Possettings
              * @default []
              */
-            posSettings: components["schemas"]["FullPermissionAction"][];
+            posSettings: components["schemas"]["FullPermissionActionWithoutDelete"][];
             /**
              * Financialperiod
              * @default []
              */
-            financialPeriod: components["schemas"]["FullPermissionAction"][];
+            financialPeriod: components["schemas"]["FullPermissionActionWithoutDelete"][];
             /**
              * Systemsettings
              * @default []
              */
-            systemSettings: components["schemas"]["FullPermissionAction"][];
+            systemSettings: components["schemas"]["FullPermissionActionWithoutDelete"][];
             /**
              * Zreport
              * @default []
@@ -27468,7 +27521,7 @@ export interface components {
             /**
              * Id
              * Format: uuid
-             * @example 301e2c9b-c65a-4d8c-b516-cc5e0f04d79c
+             * @example 172c4db8-170f-4a0e-9ac8-8145c423d88d
              */
             id: string;
             /**
@@ -30642,21 +30695,82 @@ export interface components {
              */
             paymentInAdvanceAccountNonResident?: number;
         };
-        /** PosSettingsResponse */
-        PosSettingsResponse: {
+        /** CurrencySummarySchema */
+        CurrencySummarySchema: {
+            /** Id */
+            id: number;
+            /** Code */
+            code: string;
+            /** Name */
+            name: string;
+        };
+        /**
+         * ReportGroupBy
+         * @enum {string}
+         */
+        ReportGroupBy: "category" | "item";
+        /** RetrievePosSettings */
+        RetrievePosSettings: {
             /**
-             * Dailyrate
-             * @description Daily rate for POS
+             * Datecreated
+             * Format: date-time
              */
-            dailyRate: number;
-        };
-        /** PosSettingsPayload */
-        PosSettingsPayload: {
+            dateCreated: string;
+            /** Datemodified */
+            dateModified: string | null;
+            createdBy: components["schemas"]["RecordUserSchema"];
+            modifiedBy: components["schemas"]["RecordUserSchema"] | null;
+            /** Id */
+            id: number;
+            /** Dailyrate */
+            dailyRate: number | string;
+            defaultCurrency: components["schemas"]["CurrencySummarySchema"];
+            /** Allowlowerexchangevalue */
+            allowLowerExchangeValue: boolean;
+            /** Paymentdifferencethreshold */
+            paymentDifferenceThreshold: number;
+            /** Invoiceheader */
+            invoiceHeader: string | null;
+            /** Invoicefooter */
+            invoiceFooter: string | null;
+            reportGroupBy: components["schemas"]["ReportGroupBy"] | null;
+            /** Printcount */
+            printCount: number | null;
+            /** Printonhold */
+            printOnHold: boolean | null;
+            /** Currenciesoninvoice */
+            currenciesOnInvoice: components["schemas"]["CurrencySummarySchema"][];
+        };
+        /** CreateUpdatePosSettings */
+        CreateUpdatePosSettings: {
+            /** Dailyrate */
+            dailyRate: number | string;
+            /** Defaultcurrency */
+            defaultCurrency: number;
+            /**
+             * Allowlowerexchangevalue
+             * @default false
+             */
+            allowLowerExchangeValue: boolean | null;
+            /**
+             * Paymentdifferencethreshold
+             * @default 0.01
+             */
+            paymentDifferenceThreshold: number | null;
+            /** Invoiceheader */
+            invoiceHeader: string | null;
+            /** Invoicefooter */
+            invoiceFooter: string | null;
+            reportGroupBy: components["schemas"]["ReportGroupBy"] | null;
+            /** Printcount */
+            printCount: number | null;
+            /** Printonhold */
+            printOnHold: boolean | null;
             /**
-             * Dailyrate
-             * @description Daily rate for POS
+             * Currenciesoninvoice
+             * @default []
              */
-            dailyRate: number;
+            currenciesOnInvoice: number[] | null;
         };
         /** RetrieveAppointmentSettingSchema */
         RetrieveAppointmentSettingSchema: {
@@ -38244,15 +38358,6 @@ export interface components {
             /** Commissionlevels */
             commissionLevels?: components["schemas"]["UpdateCommissionLevels"][];
         };
-        /** CurrencySummarySchema */
-        CurrencySummarySchema: {
-            /** Id */
-            id: number;
-            /** Code */
-            code: string;
-            /** Name */
-            name: string;
-        };
         /**
          * PRICE_LIST_TYPE_CHOICES
          * @enum {string}
@@ -46607,17 +46712,17 @@ export interface components {
              * Possettings
              * @default []
              */
-            posSettings: components["schemas"]["FullPermissionAction"][];
+            posSettings: components["schemas"]["FullPermissionActionWithoutDelete"][];
             /**
              * Financialperiod
              * @default []
              */
-            financialPeriod: components["schemas"]["FullPermissionAction"][];
+            financialPeriod: components["schemas"]["FullPermissionActionWithoutDelete"][];
             /**
              * Systemsettings
              * @default []
              */
-            systemSettings: components["schemas"]["FullPermissionAction"][];
+            systemSettings: components["schemas"]["FullPermissionActionWithoutDelete"][];
             /**
              * Zreport
              * @default []
@@ -46796,6 +46901,200 @@ export interface components {
              */
             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;
@@ -63080,7 +63379,16 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["PosSettingsResponse"];
+                    "application/json": components["schemas"]["RetrievePosSettings"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ErrorMessages"];
                 };
             };
             /** @description Forbidden */
@@ -63089,7 +63397,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["MessageWithCode"];
+                    "application/json": components["schemas"]["MessageResponse"];
                 };
             };
             /** @description Not Found */
@@ -63098,12 +63406,21 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["MessageWithCode"];
+                    "application/json": components["schemas"]["MessageResponse"];
+                };
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MessageResponse"];
                 };
             };
         };
     };
-    erp_settings_pos_settings_views_create_pos_settings: {
+    erp_settings_pos_settings_views_update_pos_settings: {
         parameters: {
             query?: never;
             header?: never;
@@ -63112,7 +63429,7 @@ export interface operations {
         };
         requestBody: {
             content: {
-                "application/json": components["schemas"]["PosSettingsPayload"];
+                "application/json": components["schemas"]["CreateUpdatePosSettings"];
             };
         };
         responses: {
@@ -63122,7 +63439,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["MessageWithCode"];
+                    "application/json": components["schemas"]["RetrievePosSettings"];
                 };
             };
             /** @description Bad Request */
@@ -63140,7 +63457,7 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["MessageWithCode"];
+                    "application/json": components["schemas"]["MessageResponse"];
                 };
             };
             /** @description Not Found */
@@ -63149,12 +63466,21 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["MessageWithCode"];
+                    "application/json": components["schemas"]["MessageResponse"];
+                };
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["MessageResponse"];
                 };
             };
         };
     };
-    erp_settings_pos_settings_views_update_pos_settings: {
+    erp_settings_pos_settings_views_create_pos_settings: {
         parameters: {
             query?: never;
             header?: never;
@@ -63163,17 +63489,17 @@ export interface operations {
         };
         requestBody: {
             content: {
-                "application/json": components["schemas"]["PosSettingsPayload"];
+                "application/json": components["schemas"]["CreateUpdatePosSettings"];
             };
         };
         responses: {
-            /** @description OK */
-            200: {
+            /** @description Created */
+            201: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["MessageWithCode"];
+                    "application/json": components["schemas"]["RetrievePosSettings"];
                 };
             };
             /** @description Bad Request */
@@ -63191,16 +63517,16 @@ export interface operations {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["MessageWithCode"];
+                    "application/json": components["schemas"]["MessageResponse"];
                 };
             };
-            /** @description Not Found */
-            404: {
+            /** @description Internal Server Error */
+            500: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    "application/json": components["schemas"]["MessageWithCode"];
+                    "application/json": components["schemas"]["MessageResponse"];
                 };
             };
         };
@@ -83778,4 +84104,70 @@ export interface operations {
             };
         };
     };
+    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.585",
+  "version": "1.0.587",
   "main": "openapi.ts",
   "types": "openapi.ts",
   "files": ["openapi.ts"],