Transfer Order

docs/docs/api/schema.md

@@ -7,7 +7,7 @@ The API schema as documented below is generated using the [drf-spectactular](htt
 
 ## API Version
 
-This documentation is for API version: `449`
+This documentation is for API version: `459`
 
 !!! tip "API Schema History"
     We track API schema changes, and provide a snapshot of each API schema version in the [API schema repository](https://github.com/inventree/schema/).

docs/docs/concepts/custom_states.md

@@ -17,3 +17,4 @@ Custom states can be defined for the following models:
 - [Purchase Order](../purchasing/purchase_order.md)
 - [Sales Order](../sales/sales_order.md)
 - [Return Order](../sales/return_order.md)
+- [Transfer Order](../stock/transfer_order.md)

docs/docs/settings/global.md

@@ -236,6 +236,10 @@ Refer to the [sales order settings](../sales/sales_order.md#sales-order-settings
 
 Refer to the [return order settings](../sales/return_order.md#return-order-settings).
 
+### Transfer Orders
+
+Refer to the [transfer order settings](../stock/transfer_order.md#transfer-order-settings).
+
 ### Plugin Settings
 
 | Name | Description | Default | Units |

docs/docs/stock/transfer_order.md

@@ -0,0 +1,150 @@
+
+---
+title: Transfer Orders
+---
+
+## Transfer Orders
+
+Transfer orders provide a method for requesting stock to be moved from one location to another. It does not replace the existing on-demand stock transaction options, but lets you "document" many transactions from a single view.
+
+### View Transfer Orders
+
+To navigate to the Transfer Order display, select *Stock* from the main navigation menu, and *Transfer Orders* from the sidebar:
+
+{{ image("stock/transfer_order_display.png", "Transfer Order display") }}
+
+The following view modes are available:
+
+#### Table View
+
+*Table View* provides a list of Transfer Orders, which can be filtered to display a subset of orders according to user supplied parameters.
+
+{{ image("stock/transfer_order_list.png", "Transfer Order list") }}
+
+#### Calendar View
+
+*Calendar View* shows a calendar display with outstanding transfer orders.
+
+{{ image("stock/transfer_order_calendar.png", "Transfer Order calendar") }}
+
+### Transfer Order Status Codes
+
+Each Transfer Order has a specific status code, which represents the state of the order:
+
+| Status | Description |
+| --- | --- |
+| Pending | The transfer order has been created, but has not been finalized or submitted |
+| Issued | The transfer order has been issued, and is in progress |
+| On Hold | The transfer order has been placed on hold, but is still active |
+| Complete | The transfer order is fully completed, and is now closed |
+| Cancelled | The transfer order was cancelled, and is now closed |
+
+**Source Code**
+
+Refer to the source code for the Transfer Order status codes:
+
+::: order.status_codes.TransferOrderStatus
+    options:
+        show_bases: False
+        show_root_heading: False
+        show_root_toc_entry: False
+        show_source: True
+        members: []
+
+Transfer Order Status supports [custom states](../concepts/custom_states.md).
+
+### Transfer Order Parameters
+
+The following parameters are available for each Transfer Order, and can be edited by the user:
+
+| Parameter | Description |
+| --- | --- |
+| Reference | Transfer Order reference e.g. '001' |
+| Description | Description of the Transfer Order |
+| Project Code | Project Code of the Transfer Order |
+| Source Location | Stock location to source stock items from (blank = all locations) |
+| Destination Location | Stock location where the stock will be transferred |
+| Consume Stock | Rather than transfer the stock to the destination, "consume" it by removing the specified quantity from the allocated stock item
+| Start Date | The scheduled start date for the transfer |
+| Target Date | Target date for transfer completion |
+| External Link | Link to external webpage |
+| Responsible | User (or group of users) who is responsible for the transfer |
+| Notes | Transfer notes, supports markdown |
+
+## Create a Transfer Order
+
+Once the transfer order page is loaded, click on <span class="badge inventree add">{{ icon("plus-circle") }} New Transfer Order</span> which opens the "Create Transfer Order" form.
+
+Fill out the rest of the form with the transfer order information then click on <span class="badge inventree confirm">Submit</span> to create the order.
+
+### Transfer Order Reference
+
+Each Transfer Order is uniquely identified by its *Reference* field. Read more about [reference fields](../settings/reference.md).
+
+### Add Line Items
+
+On the transfer order detail page, user can link parts to the transfer order selecting the <span class="badge inventree nav side">{{ icon("list") }}</span> Line Items</span> tab then clicking on the <span class="badge inventree add">{{ icon("plus-circle") }} Add Line Item</span> button.
+
+Once the "Add Line Item" form opens, select a part in the list.
+
+!!! warning
+    Only parts that have the "Virtual" attribute disabled will be shown and can be selected.
+
+Fill out the rest of the form then click on <span class="badge inventree confirm">Submit</span>
+
+### Allocate Stock Items
+
+After line items were created, user can either:
+
+* Allocate stock items for that part to the transfer order (click on {{ icon("arrow-right") }} button)
+* Create a build order for that part to cover the quantity of the transfer order (click on {{ icon("tools") }} button)
+
+### Complete Order
+
+Once all items in the transfer order have been allocated, click on <span class="badge inventree add">{{ icon("circle-check", color="green") }} Complete Order</span> to mark the transfer order as complete. Confirm then click on <span class="badge inventree confirm">Submit</span> to complete the order.
+
+### Transferred Stock
+
+After completing the transfer order, a <span class="badge inventree nav side">{{ icon("list") }}</span> Transferred Stock</span> tab will appear showing which stock was affected.
+
+!!! warning
+    Similar to received stock on purchase orders, this tab will only be accurate while the affected stock items still exist. Furthermore, if the stock item is depleted while using the "consume" parameter, it will not appear here unless "delete on deplete" is turned off for this stock item
+
+### Cancel Order
+
+To cancel the order, click on the {{ icon("tools") }} menu button next to the <span class="badge inventree add">{{ icon("circle-check", color="green") }} Complete Order</span> button, then click on the "{{ icon("tools") }} Cancel Order" menu option. Confirm then click on the <span class="badge inventree confirm">Submit</span> to cancel the order.
+
+## Order Scheduling
+
+Transfer orders can be scheduled for a future date, to allow for order scheduling.
+
+### Start Date
+
+The *Start Date* of the transfer order is the date on which the order is scheduled to be issued, allowing work to begin on the order.
+
+### Target Date
+
+The *Target Date* of the transfer order is the date on which the order is scheduled to be completed.
+
+### Overdue Orders
+
+If the *Target Date* of the transfer order has passed, the order will be marked as *overdue*.
+
+## Calendar view
+
+Using the button to the top right of the list of Transfer Orders, the view can be switched to a calendar view using the button {{ icon("calendar") }}. This view shows orders with a defined target date only.
+
+This view can be accessed externally as an ICS calendar using a URL like the following:
+`http://inventree.example.org/api/order/calendar/transfer-order/calendar.ics`
+
+By default, completed orders are not exported. These can be included by appending `?include_completed=True` to the URL.
+
+## Transfer Order Settings
+
+The following [global settings](../settings/global.md) are available for transfer orders:
+
+| Name | Description | Default | Units |
+| ---- | ----------- | ------- | ----- |
+{{ globalsetting("TRANSFERORDER_ENABLED") }}
+{{ globalsetting("TRANSFERORDER_REFERENCE_PATTERN") }}
+{{ globalsetting("TRANSFERORDER_REQUIRE_RESPONSIBLE") }}

docs/mkdocs.yml

@@ -145,6 +145,7 @@ nav:
     - Stock Expiry: stock/expiry.md
     - Stock Ownership: stock/owner.md
     - Test Results: stock/test.md
+    - Transfer Orders: stock/transfer_order.md
   - Manufacturing:
     - Manufacturing: manufacturing/index.md
     - Bill of Materials: manufacturing/bom.md

src/backend/InvenTree/InvenTree/api_version.py

@@ -1,11 +1,14 @@
 """InvenTree API version information."""
 
 # InvenTree API version
-INVENTREE_API_VERSION = 483
+INVENTREE_API_VERSION = 484
 """Increment this API version number whenever there is a significant change to the API that any clients need to know about."""
 
 INVENTREE_API_TEXT = """
 
+v484 -> 2026-03-25 : https://github.com/inventree/InvenTree/pull/11281
+    - Add Transfer Order model and associated API endpoint
+
 v483 -> 2026-05-04 : https://github.com/inventree/InvenTree/pull/11861
     - Enable bulk-update operations on the BomItem API endpoint, allowing multiple BOM items to be updated in a single API call
 

src/backend/InvenTree/common/setting/system.py

@@ -910,6 +910,26 @@ class SystemSetId:
         'default': False,
         'validator': bool,
     },
+    'TRANSFERORDER_ENABLED': {
+        'name': _('Enable Transfer Orders'),
+        'description': _('Enable transfer order functionality in the user interface'),
+        'validator': bool,
+        'default': False,
+    },
+    'TRANSFERORDER_REFERENCE_PATTERN': {
+        'name': _('Transfer Order Reference Pattern'),
+        'description': _(
+            'Required pattern for generating Transfer Order reference field'
+        ),
+        'default': 'TO-{ref:04d}',
+        'validator': order.validators.validate_transfer_order_reference_pattern,
+    },
+    'TRANSFERORDER_REQUIRE_RESPONSIBLE': {
+        'name': _('Require Responsible Owner'),
+        'description': _('A responsible owner must be assigned to each order'),
+        'default': False,
+        'validator': bool,
+    },
     'PURCHASEORDER_REFERENCE_PATTERN': {
         'name': _('Purchase Order Reference Pattern'),
         'description': _(

src/backend/InvenTree/generic/states/tests.py

@@ -232,8 +232,8 @@ def test_all_states(self):
         """Test the API endpoint for listing all status models."""
         response = self.get(reverse('api-status-all'))
 
-        # 10 built-in state classes, plus the added GeneralState class
-        self.assertEqual(len(response.data), 11)
+        # 11 built-in state classes, plus the added GeneralState class
+        self.assertEqual(len(response.data), 12)
 
         # Test the BuildStatus model
         build_status = response.data['BuildStatus']
@@ -273,7 +273,7 @@ def test_all_states(self):
         )
         response = self.get(reverse('api-status-all'))
 
-        self.assertEqual(len(response.data), 11)
+        self.assertEqual(len(response.data), 12)
 
         stock_status_cstm = response.data['StockStatus']
         self.assertEqual(stock_status_cstm['status_class'], 'StockStatus')

src/backend/InvenTree/order/admin.py

@@ -170,3 +170,41 @@ class ReturnOrderLineItemAdmin(admin.ModelAdmin):
 @admin.register(models.ReturnOrderExtraLine)
 class ReturnOrdeerExtraLineAdmin(GeneralExtraLineAdmin, admin.ModelAdmin):
     """Admin class for the ReturnOrderExtraLine model."""
+
+
+class TransferOrderLineItemInlineAdmin(admin.StackedInline):
+    """Inline admin class for the TransferOrderLineItem model."""
+
+    autocomplete_fields = ['part']
+
+    model = models.TransferOrderLineItem
+    extra = 0
+
+
+@admin.register(models.TransferOrder)
+class TransferOrderAdmin(admin.ModelAdmin):
+    """Admin class for the TransferOrder model."""
+
+    exclude = ['reference_int', 'address', 'contact']
+
+    list_display = (
+        'reference',
+        'status',
+        'description',
+        'take_from',
+        'destination',
+        'consume',
+        'creation_date',
+    )
+
+    search_fields = ['reference', 'description']
+
+    inlines = [TransferOrderLineItemInlineAdmin]
+
+    autocomplete_fields = [
+        'created_by',
+        'take_from',
+        'destination',
+        'project_code',
+        'responsible',
+    ]