@erp-galoper/types 1.0.2066 → 1.0.2068

package/openapi.ts

@@ -19735,16 +19735,20 @@ export interface paths {
         };
         /**
          * List Inventory Movements
-         * @description List return documents. Explicit filters support quick filtering; `search` handles free text
+         * @description List inventory movements. Explicit filters support quick filtering; `search` handles free text
          *     and `apply_filters_to_queryset` supports advanced filter payloads.
          *
-         *     Permission key: `returndocument = ['view']`
+         *     Permission keys (depends on movementType / movementTypes):
+         *     - goodsDelivery: goodsdeliverynote: ["view"]
+         *     - goodsReceipt: goodsreceiptnote: ["view"]
+         *     - salesReturn: salesreturndocument: ["view"]
+         *     - purchaseReturn: purchasereturndocument: ["view"]
          */
         get: operations["inventory_inventory_movement_views_list_inventory_movements"];
         put?: never;
         /**
          * Create Inventory Movement
-         * @description Create a return document (return delivery or return shipment).
+         * @description Create an inventory movement (goods delivery, goods receipt, sales return, or purchase return).
          *
          *     Responses:
          *     - 201: InventoryMovementSchema
@@ -19755,7 +19759,11 @@ export interface paths {
          *         noBranchAccess, noWarehouseAccess
          *     - 500: serverError
          *
-         *     Permission key: `returndocument = ['add']`
+         *     Permission keys (depends on movementType):
+         *     - goodsDelivery: goodsdeliverynote: ["add"]
+         *     - goodsReceipt: goodsreceiptnote: ["add"]
+         *     - salesReturn: salesreturndocument: ["add"]
+         *     - purchaseReturn: purchasereturndocument: ["add"]
          */
         post: operations["inventory_inventory_movement_views_create_inventory_movement"];
         delete?: never;
@@ -19773,10 +19781,15 @@ export interface paths {
         };
         /**
          * Get Inventory Movement Source Lines
-         * @description Fetch eligible source lines and party for creating/updating a return document.
-         *     Use each line `id` as `sourceLineId` in the create/update payload.
+         * @description Fetch eligible source lines and party for creating/updating an inventory movement.
+         *     For salesReturn and purchaseReturn, use each line `id` as `sourceLineId` in the payload.
+         *     For goodsDelivery and goodsReceipt, use each line to build the movement `lines` payload.
          *
-         *     Permission key: `returndocument = ['view']`
+         *     Permission keys (depends on resolved source document type):
+         *     - sales order / invoice: goodsdeliverynote: ["view"]
+         *     - purchase order / invoice: goodsreceiptnote: ["view"]
+         *     - sales return invoice / order: salesreturndocument: ["view"]
+         *     - purchase return invoice / order: purchasereturndocument: ["view"]
          */
         get: operations["inventory_inventory_movement_views_get_inventory_movement_source_lines"];
         put?: never;
@@ -19794,7 +19807,16 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
-        /** Get Inventory Movement */
+        /**
+         * Get Inventory Movement
+         * @description Get a single inventory movement by ID.
+         *
+         *     Permission keys (depends on movementType):
+         *     - goodsDelivery: goodsdeliverynote: ["view"]
+         *     - goodsReceipt: goodsreceiptnote: ["view"]
+         *     - salesReturn: salesreturndocument: ["view"]
+         *     - purchaseReturn: purchasereturndocument: ["view"]
+         */
         get: operations["inventory_inventory_movement_views_get_inventory_movement"];
         /** Update Inventory Movement */
         put: operations["inventory_inventory_movement_views_update_inventory_movement"];
@@ -21321,7 +21343,7 @@ export interface paths {
         };
         /**
          * Get Sales Dashboard Cash Flow Trend
-         * @description Cash flow trend time series with configurable granularity.
+         * @description Cash flow inflows/outflows over time for the selected report window.
          */
         get: operations["reports_salesdashboard_views_get_sales_dashboard_cash_flow_trend"];
         put?: never;
@@ -62625,16 +62647,10 @@ export interface components {
             id: string;
             /** Serialnumber */
             serialNumber: string;
-            /**
-             * Movementtype
-             * @description Movement type of the document.
-             */
-            movementType: string;
-            /**
-             * Sourcedocumenttype
-             * @description Linked source document type when applicable.
-             */
-            sourceDocumentType?: string | null;
+            /** @description Movement type of the document. */
+            movementType: components["schemas"]["MovementTypeEnum"];
+            /** @description Linked source document type when applicable. */
+            sourceDocumentType?: components["schemas"]["SourceDocumentTypeEnum"] | null;
             /**
              * Sourcedocumentid
              * @description Linked source document UUID when applicable.
@@ -62655,6 +62671,14 @@ export interface components {
             purchaseOrder?: components["schemas"]["DocumentCommonSchema"] | null;
             /** @description Linked purchase invoice for goodsReceipt movements. */
             purchaseInvoice?: components["schemas"]["DocumentCommonSchema"] | null;
+            /** @description Linked sales return invoice for salesReturn movements. */
+            salesReturnInvoice?: components["schemas"]["DocumentCommonSchema"] | null;
+            /** @description Linked sales return order for salesReturn movements. */
+            salesReturnOrder?: components["schemas"]["DocumentCommonSchema"] | null;
+            /** @description Linked purchase return invoice for purchaseReturn movements. */
+            purchaseReturnInvoice?: components["schemas"]["DocumentCommonSchema"] | null;
+            /** @description Linked purchase return order for purchaseReturn movements. */
+            purchaseReturnOrder?: components["schemas"]["DocumentCommonSchema"] | null;
             /** Referencenumber */
             referenceNumber?: string | null;
             /** @description Shipment status for goodsDelivery movements. */
@@ -62682,6 +62706,11 @@ export interface components {
              * @description List of attachment file paths linked to the inventory movement.
              */
             attachments?: string[] | null;
+            /**
+             * Candelete
+             * @description Indicates if the inventory movement can be deleted.
+             */
+            canDelete: boolean;
             /**
              * Items
              * @description List of inventory movement lines.
@@ -62754,11 +62783,21 @@ export interface components {
              */
             quantity: number | null;
         };
+        /**
+         * MovementTypeEnum
+         * @enum {string}
+         */
+        MovementTypeEnum: "goodsDelivery" | "goodsReceipt" | "salesReturn" | "purchaseReturn";
         /**
          * PartyTypeEnum
          * @enum {string}
          */
         PartyTypeEnum: "customer" | "supplier";
+        /**
+         * SourceDocumentTypeEnum
+         * @enum {string}
+         */
+        SourceDocumentTypeEnum: "salesOrder" | "salesInvoice" | "purchaseOrder" | "purchaseInvoice" | "returnInvoice" | "returnOrder" | "purchaseReturn" | "purchaseReturnOrder";
         /**
          * CreateOrUpdateInventoryMovementSchema
          * @description Schema for creating or updating an inventory movement.
@@ -62819,6 +62858,7 @@ export interface components {
              *             - Child customers only.
              *             - If linked to a sales order or invoice, customer must match the linked document.
              *             - Otherwise filter customers by document_type='goodsDeliveryNote'.
+             *             For salesReturn: do not send. Customer is derived from sourceDocumentId.
              */
             customer?: string | null;
             /**
@@ -62826,6 +62866,7 @@ export interface components {
              * @description Required for goodsReceipt.
              *             - If linked to a purchase order or invoice, supplier must match the linked document.
              *             - Otherwise filter suppliers by document_type='goodsReceiptNote'.
+             *             For purchaseReturn: do not send. Supplier is derived from sourceDocumentId.
              */
             supplier?: string | null;
             /**
@@ -62835,7 +62876,7 @@ export interface components {
              *             - goodsDelivery: sales order or sales invoice, depending on goods_delivery_note_source.
              *             - goodsReceipt: purchase order or purchase invoice, depending on goods_receipt_note_source.
              *             - salesReturn / purchaseReturn: return invoice or return order, depending on settings.
-             *             Fetch eligible return lines from GET /api/v1/inventory/item-movements/source-lines/.
+             *             Fetch eligible lines from GET /api/v1/inventory/item-movements/source-lines/.
              */
             sourceDocumentId?: string | null;
             /**
@@ -62853,7 +62894,7 @@ export interface components {
             id?: string | null;
             /**
              * Sourcelineid
-             * @description Required for salesReturn and purchaseReturn. Fetch eligible lines from GET /api/v1/inventory/item-movements/source-lines/ using sourceDocumentId, then use each line id as sourceLineId.
+             * @description Required for salesReturn and purchaseReturn. Required for salesReturn and purchaseReturn. Fetch eligible lines from GET /api/v1/inventory/item-movements/source-lines/ using sourceDocumentId, then use each line id as sourceLineId.
              */
             sourceLineId?: string | null;
             /**
@@ -62952,11 +62993,6 @@ export interface components {
              */
             expiryDate?: string | null;
         };
-        /**
-         * MovementTypeEnum
-         * @enum {string}
-         */
-        MovementTypeEnum: "goodsDelivery" | "goodsReceipt" | "salesReturn" | "purchaseReturn";
         /**
          * StockStatusEnum
          * @enum {string}
@@ -62978,25 +63014,25 @@ export interface components {
             /**
              * Id
              * Format: uuid
-             * @description Use this value as sourceLineId in the create/update payload.
+             * @description Source document line id. Use as sourceLineId for salesReturn and purchaseReturn. For goodsDelivery and goodsReceipt, use item, unitOfMeasure, and itemPackage from the line.
              */
             id: string;
             /**
              * Quantity
-             * @description Remaining quantity that can be returned on this source line.
+             * @description Remaining quantity that can be moved on this source line.
              */
             quantity: number;
             /**
              * Sourcequantity
-             * @description Original quantity on the source return line.
+             * @description Original quantity on the source document line.
              */
             sourceQuantity: number;
             /**
              * Stockquantity
-             * @description Quantity stocked via goods note for this source line.
+             * @description For returns: quantity stocked via goods note. For goods delivery/receipt: quantity already delivered or received.
              */
             stockQuantity: number;
-            /** @description Item on the source return line. */
+            /** @description Item on the source document line. */
             item?: components["schemas"]["ItemSharedSchema"] | null;
             /** @description Item package on the source return line. */
             itemPackage?: components["schemas"]["ItemPackageSummarySchema"] | null;
@@ -63028,7 +63064,7 @@ export interface components {
             party?: components["schemas"]["InventoryMovementSourcePartySchema"] | null;
             /**
              * Lines
-             * @description Eligible source lines for the selected source document.
+             * @description Eligible source lines for the selected source document (sales/purchase order or invoice, or return invoice/order).
              */
             lines: components["schemas"]["InventoryMovementSourceLineSchema"][];
         };
@@ -109079,7 +109115,9 @@ export interface operations {
                 movementTypes?: string | null;
                 status?: string | null;
                 warehouse?: string | null;
+                /** @description Filter by customer. Use when movementType or movementTypes includes salesReturn or goodsDelivery. */
                 customer?: string | null;
+                /** @description Filter by supplier. Use when movementType or movementTypes includes purchaseReturn or goodsReceipt. */
                 supplier?: string | null;
                 /** @description By default periodType is set to date filtration in user settings. */
                 periodType?: components["schemas"]["PeriodType"] | null;
@@ -112184,7 +112222,7 @@ export interface operations {
                 endDate?: string | null;
                 sources?: components["schemas"]["SalesReportSourceType"][] | null;
                 branchesIds?: string[] | null;
-                /** @description Daily, weekly, or monthly buckets within the selected period */
+                /** @description Bucket size for cashFlowTrend.periods within periodStart–periodEnd (from periodType or startDate/endDate). Daily: one bucket per calendar day. Weekly: ISO-style weeks (Monday start), clipped to the report range. Monthly: calendar months, clipped to the report range. Every bucket is returned; buckets with no activity use zero amounts and zero transaction counts. */
                 granularity?: "daily" | "weekly" | "monthly";
             };
             header?: never;

package/package.json

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