Sales Module

Back

Overview

The Sales module is responsible for managing all sales-related data, including orders, order lines, time tracking, categorisation and status workflows. It defines how sales are created, processed, and tracked within the system.

Sales is a foundational module and is required for:

• recording customer orders
• processing individual order lines
• managing order statuses and types
• time tracking against orders
• tracking payments, dispatch, and fulfillment
• auditing all sales activity

All operations are tenant-aware and scoped to the current tenant.

Services

The Sales module consists of the following services:

• Sales Orders - customer orders with full details
• Sales Order Lines - individual items within an order
• Sales Order Types - categorisation of orders (e.g., credit or standard)
• Sales Order Categories - grouping/classification for orders
• Sales Order Action Statuses - configurable action status definitions
• Sales Order Action Status Map - status history log per order
• Sales Order Time Task Types - types of billable/trackable work
• Sales Order Time Entries - time logged against an order

Models

This module exposes and consumes the following models:

• Sales Order Model
• Sales Order Line Model
• Sales Order Type Model
• Sales Order Category Model
• Sales Order Action Status Model
• Sales Order Action Status Map Model
• Sales Order Time Task Type Model
• Sales Order Time Entry Model

Sales Order Model

Represents a customer sales order.

Fields:

• Id (type: long) - internal identifier
• OrderNumber (type: string?) - order reference number
• EntityId (type: long?) - customer entity identifier
• StatusId (type: int?) - order status
• OrderDate (type: DateTime?) - order creation date
• Currency (type: string?) - order currency
• BillingAddressId (type: long?) - billing address reference
• ShippingAddressId (type: long?) - shipping address reference
• PriceListId (type: long?) - price list applied
• Subtotal (type: decimal?) - subtotal amount
• TaxTotal (type: decimal?) - tax total
• ShippingTotal (type: decimal?) - shipping total
• GrandTotal (type: decimal?) - final order total
• Notes (type: string?) - additional notes
• CreatedAt (type: DateTime?) - creation timestamp
• PromotionId (type: int?) - applied promotion
• PaidDate (type: DateTime?) - payment date
• CompletedDate (type: DateTime?) - order completion date
• DispatchDate (type: DateTime?) - dispatch/shipping date
• Courier (type: string?) - courier name
• CourierRef (type: string?) - courier reference number
• SalesOrderTypeId (type: int?) - order type
• SalesOrderCategoryId (type: int?) - order category
• UserId (type: long?) - user who created the order
• InProgressDate (type: DateTime?) - date order moved to in-progress
• PurchaseOrderRef (type: string?) - customer PO reference
• AdditionalRef (type: string?) - secondary reference
• Tags (type: string?) - comma-separated tags
• Description (type: string?) - order description (unlimited length)
• ActionNotes (type: string?) - internal action notes (unlimited length)
• Other1 (type: string?) - configurable field 1
• Other2 (type: string?) - configurable field 2
• Other3 (type: string?) - configurable field 3
• OtherNotes (type: string?) - additional notes (unlimited length)
• BillingSnapshot (type: SalesOrderAddressSnapshotModel?) - stamped billing address at time of order
• ShippingSnapshot (type: SalesOrderAddressSnapshotModel?) - stamped shipping address at time of order

Validation:

• IsReadyToAdd()
  • requires EntityId, OrderNumber, OrderDate, Currency, SalesOrderTypeId, GrandTotal >= 0
• IsReadyToUpdate()
  • requires Id > 0, EntityId > 0, SalesOrderTypeId > 0

Sales Order Line Model

Represents an individual line item within a sales order.

Fields:

• Id (type: long) - internal identifier
• SalesOrderId (type: long?) - parent sales order
• LineNumber (type: int?) - line sequence number
• ProductId (type: long?) - ordered product identifier
• Description (type: string?) - line description
• Quantity (type: decimal?) - quantity ordered
• UnitPrice (type: decimal?) - price per unit
• DiscountAmount (type: decimal?) - discount applied
• TaxAmount (type: decimal?) - tax applied
• LineTotal (type: decimal?) - line total after discounts and tax
• WarehouseId (type: long?) - warehouse reference
• EntityUserId (type: long?) - user who created the line
• Notes (type: string?) - additional notes
• QuantityFulfilled (type: decimal?) - fulfilled quantity
• QuantityReturned (type: decimal?) - returned quantity
• ReturnedDate (type: DateTime?) - date of return

Validation:

• IsReadyToAdd()
  • requires SalesOrderId, LineNumber, ProductId, Quantity > 0, UnitPrice >= 0, LineTotal >= 0
• IsReadyToUpdate()
  • requires Id > 0, SalesOrderId > 0, ProductId > 0, Quantity >= 0, UnitPrice >= 0

Sales Order Type Model

Represents a category/type of sales order.

Fields:

• Id (type: int) - internal identifier
• Title (type: string?) - order type name
• IsCredit (type: bool?) - indicates if order is credit type

Validation:

• IsReadyToAdd() - requires Title
• IsReadyToUpdate() - requires Id > 0, Title

Notes:

• Only one Sales Order Type can exist per title

Sales Order Category Model

Represents a grouping or classification label for sales orders.

Fields:

• Id (type: int) - internal identifier
• Name (type: string?) - category name
• Description (type: string?) - optional description
• SortOrder (type: int) - display order
• IsActive (type: bool) - active flag
• CreatedAt (type: DateTime?) - creation timestamp

Validation:

• IsReadyToAdd() - requires Name
• IsReadyToUpdate() - requires Id > 0, Name

Notes:

• Only one category can exist per name

Sales Order Action Status Model

Represents a configurable action status that can be applied to a sales order (e.g., Pending Review, Approved, On Hold).

Fields:

• Id (type: int) - internal identifier
• Name (type: string?) - status name
• Description (type: string?) - optional description
• SortOrder (type: int) - display order
• IsActive (type: bool) - active flag
• CreatedAt (type: DateTime?) - creation timestamp

Validation:

• IsReadyToAdd() - requires Name
• IsReadyToUpdate() - requires Id > 0, Name

Sales Order Action Status Map Model

Represents a status assignment on a specific sales order — acts as a status history log.

Fields:

• Id (type: int) - internal identifier
• SalesOrderId (type: int) - parent sales order
• ActionStatusId (type: int) - applied action status
• Notes (type: string?) - optional notes
• CreatedByUserId (type: int?) - user who applied the status
• CreatedAt (type: DateTime?) - timestamp when applied

Validation:

• IsReadyToAdd() - requires SalesOrderId > 0, ActionStatusId > 0
• IsReadyToUpdate() - requires Id > 0, SalesOrderId > 0, ActionStatusId > 0

Notes:

• Multiple status entries per order are allowed — full history is preserved

Sales Order Time Task Type Model

Represents a category of work that can be time-tracked against a sales order (e.g., Design, Development, Support).

Fields:

• Id (type: int) - internal identifier
• Name (type: string?) - task type name
• Description (type: string?) - optional description
• SortOrder (type: int) - display order
• IsActive (type: bool) - active flag
• CreatedAt (type: DateTime?) - creation timestamp

Validation:

• IsReadyToAdd() - requires Name
• IsReadyToUpdate() - requires Id > 0, Name

Sales Order Time Entry Model

Represents a block of time logged by a user against a sales order.

Fields:

• Id (type: int) - internal identifier
• SalesOrderId (type: int) - parent sales order
• UserId (type: int) - user who performed the work
• TaskTypeId (type: int) - type of work performed
• WorkDate (type: DateOnly?) - date the work was performed
• TotalMinutes (type: int) - duration in minutes
• Notes (type: string?) - optional notes
• CreatedByUserId (type: int?) - user who created the entry
• CreatedAt (type: DateTime?) - creation timestamp

Validation:

• IsReadyToAdd() - requires SalesOrderId > 0, UserId > 0, TaskTypeId > 0, TotalMinutes > 0, WorkDate
• IsReadyToUpdate() - requires Id > 0, SalesOrderId > 0, UserId > 0, TaskTypeId > 0