inventree/InvenTree
2
0
Fork 0
mirror of https://github.com/inventree/InvenTree.git synced 2025-04-27 19:16:44 +00:00
Code

Add context variables for sales order to the docs (#9390)

Browse Source 
* Add part full name to supplier part table

* Add context variables for sales order report to the docs

* Added more context variables on orders to the docs
This commit is contained in:
Michael 2025-03-26 15:26:59 +01:00 committed by GitHub
parent 99ec486b79
commit e1d6d15ae7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 13 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
docs/docs/report/context_variables.md
View File

@ -86,6 +86,9 @@ When printing a report or label against a [Build Order](../build/build.md) objec
| quantity | The total quantity of the part being assembled |
| reference | The reference field of the BuildOrder |
| title | The title field of the BuildOrder |
| build.creation_date | The date when the build was created |
| build.target_date | The given target date of the build order |
| build.completion_date | The date when the build was completed |
::: build.models.Build.report_context
options:
@ -123,6 +126,9 @@ When printing a report or label against a [SalesOrder](../order/sales_order.md)
| order | The SalesOrder instance itself |
| reference | The reference field of the SalesOrder |
| title | The title (string representation) of the SalesOrder |
| order.creation_date | The date when the order was created |
| order.target_date | The given target date |
| order.shipment_date | The date when the order was shipped to the customer |
::: order.models.Order.report_context
options:
@ -141,6 +147,9 @@ When printing a report or label against a [ReturnOrder](../order/return_order.md
| order | The ReturnOrder instance itself |
| reference | The reference field of the ReturnOrder |
| title | The title (string representation) of the ReturnOrder |
| order.creation_date | The date when the order was created |
| order.target_date | The given target date |
| order.issue_date | The date when the return order was issued |
### Purchase Order
@ -155,6 +164,10 @@ When printing a report or label against a [PurchaseOrder](../order/purchase_orde
| reference | The reference field of the PurchaseOrder |
| supplier | The supplier object associated with the PurchaseOrder |
| title | The title (string representation) of the PurchaseOrder |
| order.creation_date | The date when the order was created |
| order.target_date | The given target date |
| order.issue_date | The date then the order was issued |
| order.complete_date | The date then the order was received and completed |
### Stock Item
@ -408,36 +421,6 @@ Each part object has access to a lot of context variables about the part. The fo
| has_price_breaks | Whether this [SupplierPart](./context_variables.md#supplierpart) has price breaks |
| manufacturer_string | Format a MPN string for this [SupplierPart](./context_variables.md#supplierpart). Concatenates manufacture name and part number. |
### Orders
#### Purchase Order
!!! note "TODO"
This section is incomplete
#### SalesOrder
A [Sales Order](../order/sales_order.md) object has the following context variables available.
| Variable | Description |
|----------|-------------|
| customer | An object with information about the customer |
| description | The order description |
| lines | The lines in the Sales Order |
| reference | The reference number |
#### Return Order
A [Return Order](../order/return_order.md) object has the following context variables available.
| Variable | Description |
| --- | --- |
| customer | An object with information about the customer |
| description | The order description |
| lines | The lines in the Sales Order |
| reference | The reference number |
### User
| Variable | Description |