inventree/inventree-app
2
0
Fork 0
mirror of https://github.com/inventree/inventree-app.git synced 2025-06-16 12:15:31 +00:00
Code Activity

Sales order support (#438)

Browse Source 
* Add new models for SalesOrder

- Create generic Order and OrderLine models with common functionality

* Refactor

- Move some widgets around
- Cleanup directory structure

* Add link to home screen and nav drawer

* Add SalesOrder list widget

* Linting fixes

* Fix string

* Refactor PurchaseOrderDetailWidget

* Tweaks to existing code

* linting

* Fixes for drawer widget

* Add "detail" page for SalesOrder

* Add more tiles to SalesOrder detail

* Allow editing of salesorder

* add list filters for sales orders

* Display list of line items

* Customer updates

- Display customer icon on home screen
- Fetch sales orders for customer detail page

* Cleanup company detail view

* Create new sales order from list

* Stricter typing for formFields method

* Create new PurchaseOrder and SalesOrder from company deatil

* Status code updates

- Add function for name comparison
- Remove hard-coded values

* Update view permission checks for home widget

* Add ability to manually add SalesOrderLineItem

* Add nice progress bar widgets

* Display detail view for sales order line item

* edit SalesOrderLineItem

* Fix unused import

* Hide "shipped items" tab

- Will be added in a future update
This commit is contained in:
Oliver
2023-11-12 23:13:22 +11:00
committed by GitHub
parent c1c0d46957
commit bdd5470e68
45 changed files with 1565 additions and 284 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
lib/inventree/company.dart
View File

@ -22,7 +22,7 @@ class InvenTreeCompany extends InvenTreeModel {
List<String> get rolesRequired => ["purchase_order", "sales_order", "return_order"];
@override
Map<String, dynamic> formFields() {
Map<String, Map<String, dynamic>> formFields() {
return {
"name": {},
"description": {},
@ -121,8 +121,8 @@ class InvenTreeSupplierPart extends InvenTreeModel {
List<String> get rolesRequired => ["part", "purchase_order"];
@override
Map<String, dynamic> formFields() {
Map<String, dynamic> fields = {
Map<String, Map<String, dynamic>> formFields() {
Map<String, Map<String, dynamic>> fields = {
"supplier": {},
"SKU": {},
"link": {},

2
lib/inventree/model.dart
View File

@ -230,7 +230,7 @@ class InvenTreeModel {
// Fields for editing / creating this model
// Override per-model
Map<String, dynamic> formFields() {
Map<String, Map<String, dynamic>> formFields() {
return {};
}

107
lib/inventree/orders.dart Normal file
View File

@ -0,0 +1,107 @@
/*
* Base model for various "orders" which share common properties
*/
import "package:inventree/inventree/model.dart";
import "package:inventree/inventree/part.dart";
/*
* Generic class representing an "order"
*/
class InvenTreeOrder extends InvenTreeModel {
InvenTreeOrder() : super();
InvenTreeOrder.fromJson(Map<String, dynamic> json) : super.fromJson(json);
String get issueDate => getString("issue_date");
String get completeDate => getString("complete_date");
String get creationDate => getString("creation_date");
String get targetDate => getString("target_date");
int get lineItemCount => getInt("line_items", backup: 0);
bool get overdue => getBool("overdue");
String get reference => getString("reference");
int get responsibleId => getInt("responsible");
// Project code information
int get projectCodeId => getInt("project_code");
String get projectCode => getString("code", subKey: "project_code_detail");
String get projectCodeDescription => getString("description", subKey: "project_code_detail");
bool get hasProjectCode => projectCode.isNotEmpty;
int get status => getInt("status");
String get statusText => getString("status_text");
double? get totalPrice {
String price = getString("total_price");
if (price.isEmpty) {
return null;
} else {
return double.tryParse(price);
}
}
// Return the currency for this order
// Note that the nomenclature in the API changed at some point
String get totalPriceCurrency {
if (jsondata.containsKey("order_currency")) {
return getString("order_currency");
} else if (jsondata.containsKey("total_price_currency")) {
return getString("total_price_currency");
} else {
return "";
}
}
}
/*
* Generic class representing an "order line"
*/
class InvenTreeOrderLine extends InvenTreeModel {
InvenTreeOrderLine() : super();
InvenTreeOrderLine.fromJson(Map<String, dynamic> json) : super.fromJson(json);
bool get overdue => getBool("overdue");
double get quantity => getDouble("quantity");
String get reference => getString("reference");
int get orderId => getInt("order");
InvenTreePart? get part {
dynamic part_detail = jsondata["part_detail"];
if (part_detail == null) {
return null;
} else {
return InvenTreePart.fromJson(part_detail as Map<String, dynamic>);
}
}
int get partId => getInt("pk", subKey: "part_detail");
String get partName => getString("name", subKey: "part_detail");
String get partImage => getString("thumbnail", subKey: "part_detail");
// TODO: Perhaps parse this as an actual date?
String get targetDate => getString("target_date");
}

10
lib/inventree/part.dart
View File

@ -27,9 +27,9 @@ class InvenTreePartCategory extends InvenTreeModel {
List<String> get rolesRequired => ["part_category"];
@override
Map<String, dynamic> formFields() {
Map<String, Map<String, dynamic>> formFields() {
Map<String, dynamic> fields = {
Map<String, Map<String, dynamic>> fields = {
"name": {},
"description": {},
"parent": {},
@ -140,9 +140,9 @@ class InvenTreePartParameter extends InvenTreeModel {
InvenTreeModel createFromJson(Map<String, dynamic> json) => InvenTreePartParameter.fromJson(json);
@override
Map<String, dynamic> formFields() {
Map<String, Map<String, dynamic>> formFields() {
Map<String, dynamic> fields = {
Map<String, Map<String, dynamic>> fields = {
"header": {
"type": "string",
"read_only": true,
@ -200,7 +200,7 @@ class InvenTreePart extends InvenTreeModel {
List<String> get rolesRequired => ["part"];
@override
Map<String, dynamic> formFields() {
Map<String, Map<String, dynamic>> formFields() {
return {
"name": {},
"description": {},

2
lib/inventree/project_code.dart
View File

@ -17,7 +17,7 @@ class InvenTreeProjectCode extends InvenTreeModel {
String get URL => "project-code/";
@override
Map<String, dynamic> formFields() {
Map<String, Map<String, dynamic>> formFields() {
return {
"code": {},
"description": {},

127
lib/inventree/purchase_order.dart
View File

@ -1,22 +1,22 @@
import "package:inventree/api.dart";
import "package:inventree/helpers.dart";
import "package:inventree/inventree/company.dart";
import "package:inventree/inventree/part.dart";
import "package:inventree/inventree/model.dart";
import "package:inventree/inventree/orders.dart";
const int PO_STATUS_PENDING = 10;
const int PO_STATUS_PLACED = 20;
const int PO_STATUS_COMPLETE = 30;
const int PO_STATUS_CANCELLED = 40;
const int PO_STATUS_LOST = 50;
const int PO_STATUS_RETURNED = 60;
class InvenTreePurchaseOrder extends InvenTreeModel {
/*
* Class representing an individual PurchaseOrder instance
*/
class InvenTreePurchaseOrder extends InvenTreeOrder {
InvenTreePurchaseOrder() : super();
InvenTreePurchaseOrder.fromJson(Map<String, dynamic> json) : super.fromJson(json);
@override
InvenTreeModel createFromJson(Map<String, dynamic> json) => InvenTreePurchaseOrder.fromJson(json);
@override
String get URL => "order/po/";
@ -26,8 +26,8 @@ class InvenTreePurchaseOrder extends InvenTreeModel {
String get receive_url => "${url}receive/";
@override
Map<String, dynamic> formFields() {
var fields = {
Map<String, Map<String, dynamic>> formFields() {
Map<String, Map<String, dynamic>> fields = {
"reference": {},
"supplier": {
"filters": {
@ -69,33 +69,8 @@ class InvenTreePurchaseOrder extends InvenTreeModel {
};
}
String get issueDate => getString("issue_date");
String get completeDate => getString("complete_date");
String get creationDate => getString("creation_date");
String get targetDate => getString("target_date");
int get lineItemCount => getInt("line_items", backup: 0);
bool get overdue => getBool("overdue");
String get reference => getString("reference");
int get responsibleId => getInt("responsible");
int get supplierId => getInt("supplier");
// Project code information
int get projectCodeId => getInt("project_code");
String get projectCode => getString("code", subKey: "project_code_detail");
String get projectCodeDescription => getString("description", subKey: "project_code_detail");
bool get hasProjectCode => projectCode.isNotEmpty;
InvenTreeCompany? get supplier {
dynamic supplier_detail = jsondata["supplier_detail"];
@ -109,39 +84,13 @@ class InvenTreePurchaseOrder extends InvenTreeModel {
String get supplierReference => getString("supplier_reference");
int get status => getInt("status");
bool get isOpen => api.PurchaseOrderStatus.isNameIn(status, ["PENDING", "PLACED"]);
String get statusText => getString("status_text");
bool get isPending => api.PurchaseOrderStatus.isNameIn(status, ["PENDING"]);
bool get isOpen => status == PO_STATUS_PENDING || status == PO_STATUS_PLACED;
bool get isPlaced => api.PurchaseOrderStatus.isNameIn(status, ["PLACED"]);
bool get isPending => status == PO_STATUS_PENDING;
bool get isPlaced => status == PO_STATUS_PLACED;
bool get isFailed => status == PO_STATUS_CANCELLED || status == PO_STATUS_LOST || status == PO_STATUS_RETURNED;
double? get totalPrice {
String price = getString("total_price");
if (price.isEmpty) {
return null;
} else {
return double.tryParse(price);
}
}
// Return the currency for this order
// Note that the nomenclature in the API changed at some point
String get totalPriceCurrency {
if (jsondata.containsKey("order_currency")) {
return getString("order_currency");
} else if (jsondata.containsKey("total_price_currency")) {
return getString("total_price_currency");
} else {
return "";
}
}
bool get isFailed => api.PurchaseOrderStatus.isNameIn(status, ["CANCELLED", "LOST", "RETURNED"]);
Future<List<InvenTreePOLineItem>> getLineItems() async {
@ -162,9 +111,6 @@ class InvenTreePurchaseOrder extends InvenTreeModel {
return items;
}
@override
InvenTreeModel createFromJson(Map<String, dynamic> json) => InvenTreePurchaseOrder.fromJson(json);
/// Mark this order as "placed" / "issued"
Future<void> issueOrder() async {
// Order can only be placed when the order is 'pending'
@ -185,12 +131,15 @@ class InvenTreePurchaseOrder extends InvenTreeModel {
}
}
class InvenTreePOLineItem extends InvenTreeModel {
class InvenTreePOLineItem extends InvenTreeOrderLine {
InvenTreePOLineItem() : super();
InvenTreePOLineItem.fromJson(Map<String, dynamic> json) : super.fromJson(json);
@override
InvenTreeModel createFromJson(Map<String, dynamic> json) => InvenTreePOLineItem.fromJson(json);
@override
String get URL => "order/po-line/";
@ -198,7 +147,7 @@ class InvenTreePOLineItem extends InvenTreeModel {
List<String> get rolesRequired => ["purchase_order"];
@override
Map<String, dynamic> formFields() {
Map<String, Map<String, dynamic>> formFields() {
return {
"part": {
// We cannot edit the supplier part field here
@ -232,38 +181,24 @@ class InvenTreePOLineItem extends InvenTreeModel {
};
}
double get received => getDouble("received");
bool get isComplete => received >= quantity;
double get quantity => getDouble("quantity");
double get progressRatio {
if (quantity <= 0 || received <= 0) {
return 0;
}
double get received => getDouble("received");
return received / quantity;
}
String get progressString => simpleNumberString(received) + " / " + simpleNumberString(quantity);
double get outstanding => quantity - received;
String get reference => getString("reference");
int get orderId => getInt("order");
int get supplierPartId => getInt("part");
InvenTreePart? get part {
dynamic part_detail = jsondata["part_detail"];
if (part_detail == null) {
return null;
} else {
return InvenTreePart.fromJson(part_detail as Map<String, dynamic>);
}
}
int get partId => getInt("pk", subKey: "part_detail");
String get partName => getString("name", subKey: "part_detail");
String get partImage => getString("thumbnail", subKey: "part_detail");
InvenTreeSupplierPart? get supplierPart {
dynamic detail = jsondata["supplier_part_detail"];
@ -281,19 +216,13 @@ class InvenTreePOLineItem extends InvenTreeModel {
String get purchasePriceCurrency => getString("purchase_price_currency");
String get purchasePriceString => getString("purchase_price_string");
int get destination => getInt("destination");
Map<String, dynamic> get destinationDetail => getMap("destination_detail");
@override
InvenTreeModel createFromJson(Map<String, dynamic> json) => InvenTreePOLineItem.fromJson(json);
}
/*
* Class representing an attachment file against a StockItem object
* Class representing an attachment file against a PurchaseOrder object
*/
class InvenTreePurchaseOrderAttachment extends InvenTreeAttachment {

190
lib/inventree/sales_order.dart Normal file
View File

@ -0,0 +1,190 @@
import "package:inventree/helpers.dart";
import "package:inventree/inventree/company.dart";
import "package:inventree/inventree/model.dart";
import "package:inventree/inventree/orders.dart";
import "package:inventree/api.dart";
/*
* Class representing an individual SalesOrder
*/
class InvenTreeSalesOrder extends InvenTreeOrder {
InvenTreeSalesOrder() : super();
InvenTreeSalesOrder.fromJson(Map<String, dynamic> json) : super.fromJson(json);
@override
InvenTreeModel createFromJson(Map<String, dynamic> json) => InvenTreeSalesOrder.fromJson(json);
@override
String get URL => "order/so/";
@override
List<String> get rolesRequired => ["sales_order"];
@override
Map<String, Map<String, dynamic>> formFields() {
Map<String, Map<String, dynamic>> fields = {
"reference": {},
"customer": {
"filters": {
"is_customer": true,
}
},
"customer_reference": {},
"description": {},
"project_code": {},
"target_date": {},
"link": {},
"responsible": {},
"contact": {
"filters": {
"company": customerId,
}
}
};
if (!InvenTreeAPI().supportsProjectCodes) {
fields.remove("project_code");
}
if (!InvenTreeAPI().supportsContactModel) {
fields.remove("contact");
}
return fields;
}
@override
Map<String, String> defaultGetFilters() {
return {
"customer_detail": "true",
};
}
@override
Map<String, String> defaultListFilters() {
return {
"customer_detail": "true",
};
}
int get customerId => getInt("customer");
InvenTreeCompany? get customer {
dynamic customer_detail = jsondata["customer_detail"];
if (customer_detail == null) {
return null;
} else {
return InvenTreeCompany.fromJson(customer_detail as Map<String, dynamic>);
}
}
String get customerReference => getString("customer_reference");
bool get isOpen => api.SalesOrderStatus.isNameIn(status, ["PENDING", "IN_PROGRESS"]);
bool get isComplete => api.SalesOrderStatus.isNameIn(status, ["SHIPPED"]);
}
/*
* Class representing an individual line item in a SalesOrder
*/
class InvenTreeSOLineItem extends InvenTreeOrderLine {
InvenTreeSOLineItem() : super();
InvenTreeSOLineItem.fromJson(Map<String, dynamic> json) : super.fromJson(json);
@override
InvenTreeModel createFromJson(Map<String, dynamic> json) => InvenTreeSOLineItem.fromJson(json);
@override
String get URL => "order/so-line/";
@override
List<String> get rolesRequired => ["sales_order"];
@override
Map<String, Map<String, dynamic>> formFields() {
return {
"order": {
"hidden": true,
},
"part": {},
"quantity": {},
"reference": {},
"notes": {},
"link": {},
};
}
@override
Map<String, String> defaultGetFilters() {
return {
"part_detail": "true",
};
}
@override
Map<String, String> defaultListFilters() {
return {
"part_detail": "true",
};
}
double get allocated => getDouble("allocated");
bool get isAllocated => allocated >= quantity;
double get shipped => getDouble("shipped");
double get outstanding => quantity - shipped;
double get progressRatio {
if (quantity <= 0 || shipped <= 0) {
return 0;
}
return shipped / quantity;
}
String get progressString => simpleNumberString(shipped) + " / " + simpleNumberString(quantity);
bool get isComplete => shipped >= quantity;
double get available => getDouble("available_stock") + getDouble("available_variant_stock");
double get salePrice => getDouble("sale_price");
String get salePriceCurrency => getString("sale_price_currency");
}
/*
* Class representing an attachment file against a SalesOrder object
*/
class InvenTreeSalesOrderAttachment extends InvenTreeAttachment {
InvenTreeSalesOrderAttachment() : super();
InvenTreeSalesOrderAttachment.fromJson(Map<String, dynamic> json) : super.fromJson(json);
@override
InvenTreeModel createFromJson(Map<String, dynamic> json) => InvenTreeSalesOrderAttachment.fromJson(json);
@override
String get REFERENCE_FIELD => "order";
@override
String get URL => "order/po/attachment/";
}

18
lib/inventree/status_codes.dart
View File

@ -105,6 +105,24 @@ class InvenTreeStatusCode {
}
}
// Return the 'name' (untranslated) associated with a given status code
String name(int status) {
Map<String, dynamic> _entry = entry(status);
String _name = (_entry["name"] ?? "") as String;
if (_name.isEmpty) {
debug("No match for status code ${status} at '${URL}'");
}
return _name;
}
// Test if the name associated with the given code is in the provided list
bool isNameIn(int code, List<String> names) {
return names.contains(name(code));
}
// Return the 'color' associated with a given status code
Color color(int status) {
Map<String, dynamic> _entry = entry(status);

12
lib/inventree/stock.dart
View File

@ -27,7 +27,7 @@ class InvenTreeStockItemTestResult extends InvenTreeModel {
List<String> get rolesRequired => ["stock"];
@override
Map<String, dynamic> formFields() {
Map<String, Map<String, dynamic>> formFields() {
return {
"stock_item": {"hidden": true},
"test": {},
@ -158,8 +158,8 @@ class InvenTreeStockItem extends InvenTreeModel {
String get WEB_URL => "stock/item/";
@override
Map<String, dynamic> formFields() {
return {
Map<String, Map<String, dynamic>> formFields() {
Map<String, Map<String, dynamic>> fields = {
"part": {},
"location": {},
"quantity": {},
@ -175,6 +175,8 @@ class InvenTreeStockItem extends InvenTreeModel {
"packaging": {},
"link": {},
};
return fields;
}
@override
@ -609,8 +611,8 @@ class InvenTreeStockLocation extends InvenTreeModel {
String get pathstring => getString("pathstring");
@override
Map<String, dynamic> formFields() {
Map<String, dynamic> fields = {
Map<String, Map<String, dynamic>> formFields() {
Map<String, Map<String, dynamic>> fields = {
"name": {},
"description": {},
"parent": {},