Sales Module

Back

Overview

The Sales module is responsible for managing all sales-related data, including orders, order lines, and order types.
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
• 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 - categorization of orders (e.g., credit or standard)

Models

This module exposes and consumes the following models:

• Sales Order Model
• Sales Order Line Model
• Sales Order Type 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

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