Transfer Order (#11281)

* initial skel commit for transfer orders * initial transfer order backend model * add some serializers, rename PLACED to ISSUED for TransferOrders * adding from admin console works * simple table list almost working, but we need to add order line items.... * add other cols to table * add Transfer Order from table view * moving towards a detail view * wip: adding detail view * add take from and destination serializer details * add other detail grid items * edit/duplicate transfer order * more action buttons * first crack at adding line items * add to line item * add filters * starting work on row actions * more action buttons for line items * fix copy lines in duplicate * basic allocation works * allocations table actions * allocate serials * allocated serial row expansion * add transferred qty to serializers * move items on complete, show in tracking * change panel to transferred stock upon complete * allow incomplete line items * disable edit allocations when completed * add ref pattern and to settings * add admin to line item inline * add calendar and parametric view * basic transfer order report * add transfer order ruleset * starting allocation buisness logic throughout for TOs * disable accept incomplete logic, which was incorrect, until I fix * fix incomplete allocation option * add transferred col to default report * add transfer order to calendar ics view * chain condition for readability * add transfer order allocations table to stockitem view * don't account TO allocations in availability * add transfer orders table for a part * 'consume' option by doing take_stock * squash migrations * starting to test transfer order * more transfer order tests * add transfer order consume test * wip, more tests * more transfer order tests * had to refresh_from_db * switch "to" to "transfer-order" in url paths * only select non-virtual parts from transfer order * add transfer order docs * deconflict migrations * fix frontend build error * fix validation on transfer order reference pattern * add oath2 scope for transfer order * fix state test to include transfer order state * add barcode_model_type_code for transfer order * bump api version * check view role for transfer order, remove debug/commented out lines * add serialized allocation test * Fix migrations * Frontend fixes * Implement required 'company' attribute * transfer order report context * attempt to fix tests * delete transfer order allocations on cancel * add a few playwright tests, more incoming * more playwright * add source and destination locations to table * deconflict migrations * Fix build issue * attempt to fix flaky transfer order test * duplicate transfer order before running tests * Adjust playwright tests * Fix migration dependency order --------- Co-authored-by: Oliver <oliver.henry.walters@gmail.com> Co-authored-by: Matthias Mair <code@mjmair.com>
2026-05-28 11:59:23 +00:00 · 2026-05-22 01:08:40 -06:00
parent 5489656016
commit 74d9ab6d11
53 changed files with 6178 additions and 35 deletions
@@ -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/).
@@ -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)
@@ -240,6 +240,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 |
@@ -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") }}