@erp-galoper/types 1.0.583 → 1.0.585

package/openapi.ts

@@ -11818,9 +11818,11 @@ export interface paths {
          *     Responses:
          *     - 200: GoodsReceiptNoteSchema
          *     - 400: - itemDoesNotExist
-         *         - itemNotInPurchaseOrder
-         *         - itemNotInPurchaseInvoice
+         *         - itemWithUOMNotInPurchaseOrder
+         *         - itemWithUOMNotInPurchaseInvoice
          *         - quantityOrderedMismatch
+         *         - itemPackageMismatch
+         *         - unitOfMeasureMismatch
          *         - expiryDateRequired
          *         - serialNumbersQuantityMismatch
          *         - serialNumberRequiredForEachUnit
@@ -11892,9 +11894,11 @@ export interface paths {
          *     Responses:
          *     - 200: GoodsReceiptNoteSchema
          *     - 400: itemDoesNotExist
-         *         - itemNotInPurchaseOrder
-         *         - itemNotInPurchaseInvoice
+         *         - itemWithUOMNotInPurchaseOrder
+         *         - itemWithUOMNotInPurchaseInvoice
          *         - quantityOrderedMismatch
+         *         - itemPackageMismatch
+         *         - unitOfMeasureMismatch
          *         - expiryDateRequired
          *         - serialNumbersQuantityMismatch
          *         - serialNumberRequiredForEachUnit
@@ -17270,6 +17274,10 @@ export interface paths {
          *     Responses:
          *     - 201: GoodsDeliveryNoteSchema
          *     - 400:
+         *         - itemWithUOMNotInSalesOrder
+         *         - itemWithUOMNotInSalesInvoice
+         *         - quantityOrderedMismatch
+         *         - itemPackageMismatch
          *         - quantityExceeded
          *         - trackingQuantityMismatch
          *         - batchDoesNotExist
@@ -17338,6 +17346,10 @@ export interface paths {
          *     Responses:
          *     - 200: GoodsDeliveryNoteSchema
          *     - 400:
+         *         - itemWithUOMNotInSalesOrder
+         *         - itemWithUOMNotInSalesInvoice
+         *         - quantityOrderedMismatch
+         *         - itemPackageMismatch
          *         - quantityExceeded
          *         - trackingQuantityMismatch
          *         - batchDoesNotExist
@@ -18373,6 +18385,40 @@ 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;
+    };
 }
 export type webhooks = Record<string, never>;
 export interface components {
@@ -27422,7 +27468,7 @@ export interface components {
             /**
              * Id
              * Format: uuid
-             * @example cdb9d277-b222-4798-8b87-9c99f28c7e97
+             * @example 301e2c9b-c65a-4d8c-b516-cc5e0f04d79c
              */
             id: string;
             /**
@@ -35675,6 +35721,8 @@ export interface components {
              */
             id: string;
             item: components["schemas"]["ItemSharedSchema"];
+            /** @description The unit of measure selected from the item's options */
+            unitOfMeasure: components["schemas"]["UnitOfMeasureSummaryInfo"] | null;
             /** @description Tracking method: serial_number, batch, or quantity */
             trackInventoryBy?: components["schemas"]["TrackingMethodChoices"] | null;
             itemPackage: components["schemas"]["ItemPackageSummarySchema"] | null;
@@ -35781,7 +35829,11 @@ export interface components {
             unitPackage?: number | null;
             /**
              * Quantity
-             * @description if tracked by serial number, quantity must be 1, if tracked by quantity, quantity must be equal to quantity received, if tracked by batch, quantity can be any number but the sum of all quantities must be equal to quantity received, if unit_package is selected, quantity must be equal to unit_package * item_package quantity
+             * @description
+             *             - if tracked by serial number, quantity must be 1
+             *             - if tracked by quantity, quantity must be equal to quantity received,
+             *             - if tracked by batch, quantity can be any number but the sum of all quantities must be equal to quantity received,
+             *             - if unit_package is selected, quantity must be equal to unit_package * item_package quantity
              * @default 1
              */
             quantity: number | null;
@@ -35800,6 +35852,16 @@ export interface components {
             id?: string | null;
             /** Item */
             item: number;
+            /**
+             * Unitofmeasure
+             * @description
+             *             - case where only item selected:
+             *                 - get data from api/v1/inventory/items/{item-id}/ field unitOfMeasures, get default value from field defaultPurchaseUnitOfMeasure if applicable
+             *             - case where item package selected:
+             *                 - input should be disabled, get unit of measure from itemPackage
+             *
+             */
+            unitOfMeasure: number;
             /**
              * Itempackage
              * Format: uuid
@@ -35820,7 +35882,14 @@ export interface components {
             quantityOrdered?: number | null;
             /**
              * Tracking
-             * @description get the tracking from the item
+             * @description
+             *             - if trackInventoryBy is serial_number, tracking must be a list of serial numbers with
+             *               quantity = 1 for each serial number, in case there is itemPackage selected, no of tracking must be equal to quantity received
+             *             - if trackInventoryBy is batch, tracking must be a list of batch numbers with
+             *               quantity = quantity received for each batch number
+             *             - if trackInventoryBy is quantity, tracking must be a list of quantities with
+             *               quantity = quantity received for each quantity
+             *
              */
             tracking: components["schemas"]["CreateOrUpdateGoodsReceiptNoteItemTrackingSchema"][];
         };
@@ -35832,11 +35901,6 @@ export interface components {
          *     - Either purchaseOrder or purchaseInvoice must be provided.
          */
         CreateOrUpdateGoodsReceiptSchema: {
-            /**
-             * Branch
-             * @description Branch ID for the goods receipt
-             */
-            branch: number;
             /** Password */
             password?: string | null;
             /**
@@ -45452,6 +45516,8 @@ export interface components {
              */
             id: string;
             item: components["schemas"]["ItemSharedSchema"];
+            /** @description The unit of measure selected from the item's options */
+            unitOfMeasure: components["schemas"]["UnitOfMeasureSummaryInfo"] | null;
             itemPackage: components["schemas"]["ItemPackageSummarySchema"] | null;
             /** Unitpackage */
             unitPackage: number | null;
@@ -45559,6 +45625,16 @@ export interface components {
              * @description If there is a linked invoice or order in the GDN, the item should be associated with that specific invoice or order.
              */
             item: number;
+            /**
+             * Unitofmeasure
+             * @description
+             *             - case where only item selected:
+             *                 - get data from api/v1/inventory/items/{item-id}/ field unitOfMeasures, get default value from field defaultSalesUnitOfMeasure if applicable
+             *             - case where item package selected:
+             *                 - input should be disabled, get unit of measure from itemPackage
+             *
+             */
+            unitOfMeasure: number;
             /**
              * Itempackage
              * Format: uuid
@@ -45647,53 +45723,7 @@ export interface components {
         GoodsDeliveryNoteListSchema: {
             info: components["schemas"]["PageInfoSchema"];
             /** Results */
-            results: components["schemas"]["GoodsDeliveryNoteWithItemForListSchema"][];
-        };
-        /** GoodsDeliveryNoteWithItemForListSchema */
-        GoodsDeliveryNoteWithItemForListSchema: {
-            /**
-             * Id
-             * Format: uuid
-             */
-            id: string;
-            /** Serialnumber */
-            serialNumber: string;
-            /**
-             * Date
-             * Format: date
-             */
-            date: string;
-            customer: components["schemas"]["ChildSupplierSharedSchema"];
-            warehouse: components["schemas"]["WarehouseSummaryInfo"];
-            /** @description Linked sales order ID */
-            salesOrder?: components["schemas"]["DocumentCommonSchema"] | null;
-            /** @description Linked sales invoice ID */
-            salesInvoice?: components["schemas"]["DocumentCommonSchema"] | null;
-            /** Referencenumber */
-            referenceNumber?: string | null;
-            /**
-             * Description
-             * @description A description of the delivery note
-             */
-            description: string | null;
-            status: components["schemas"]["InternalStatusOnReturnValueChoices"];
-            approvalStatus: components["schemas"]["ApprovalValueChoices"];
-            /**
-             * Attachments
-             * @description A list of attachment file paths linked to the delivery note
-             */
-            attachments: string[] | null;
-            /**
-             * Notes
-             * @description Additional notes regarding the delivery note
-             */
-            notes: string | null;
-            /**
-             * Items
-             * @description List of items in the goods delivery note
-             * @default []
-             */
-            items: components["schemas"]["GoodsDeliveryNoteItemsSchema"][];
+            results: components["schemas"]["GoodsDeliveryNoteSchema"][];
         };
         /** DefaultSubsidiaryAccountDetailSchema */
         DefaultSubsidiaryAccountDetailSchema: {
@@ -46623,6 +46653,149 @@ 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"][];
+        };
     };
     responses: never;
     parameters: never;
@@ -70756,12 +70929,11 @@ export interface operations {
     };
     inventory_receipt_note_views_list_goods_receipt_notes: {
         parameters: {
-            query: {
+            query?: {
                 page?: number;
                 pageSize?: number;
                 /** @description fields to search: reference_number, supplier name, serial_number, date, item name, supplier account number */
                 search?: string | null;
-                branchId: number;
                 /** @description Period type: thisMonth, thisYear, lastMonth, custom, ... */
                 periodType?: "thisMonth" | "lastMonth" | "thisQuarter" | "lastQuarter" | "thisFiscalYear" | "lastFiscalYear" | "custom" | "today" | "all";
                 /** @description Start date for custom range (YYYY-MM-DD), this required if the period type is custom */
@@ -70826,8 +70998,8 @@ export interface operations {
             };
         };
         responses: {
-            /** @description OK */
-            200: {
+            /** @description Created */
+            201: {
                 headers: {
                     [name: string]: unknown;
                 };
@@ -83536,4 +83708,74 @@ 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"];
+                };
+            };
+        };
+    };
 }

package/package.json

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