Reference Module

Back

Overview

The Reference module manages tenant-scoped reference data that is foundational
for sales, promotions, pricing, and inventory modules.

It handles:

• Countries
• Currencies
• Entity Statuses
• Activity log
• Order Statuses
• Promotions
• System Options
• Tax Codes
• Units of Measure

All operations are tenant-aware.

Services

The Reference module consists of the following services:

• Country - country data
• Currency - currency definitions
• Entity Status - entity status definitions
• Activity - immutable activity/audit log
• Order Status - order status definitions
• Promotions - promotions and discounts
• System Options - system-wide options
• Tax Codes - tax classifications
• Unit of Measure - measurement units

Models

This module exposes and consumes the following models:

• Country Model
• Currency Model
• Entity Status Model
• Activity Model
• Order Status Model
• Promotions Model
• System Options Model
• Tax Code Model
• Unit of Measure Model

Currency Model

Represents a currency available in the system.

Fields:

• Id (type: int) - internal identifier
• CurrencyCode (type: string?) - ISO currency code (e.g. GBP, USD)
• CurrencySymbol (type: string?) - display symbol (e.g. £, $)
• CurrencyLabel (type: string?) - full display name (e.g. British Pound)
• CreatedAt (type: DateTime) - creation timestamp

Validation:

• IsReadyToAdd() — requires CurrencyCode, CurrencySymbol, CurrencyLabel
• IsReadyToUpdate() — requires Id > 0

Entity Status Model

Represents a status that can be assigned to a customer or supplier entity.

Fields:

• Id (type: int) - internal identifier
• Title (type: string?) - status display label
• Weighting (type: int) - ordering weight
• CreatedAt (type: DateTime) - creation timestamp

Seeded defaults: Prospect (weighting 0), Active (weighting 1), Inactive (weighting 2)

Validation:

• IsReadyToAdd() — requires Title
• IsReadyToUpdate() — requires Id > 0

Activity Model

Represents an immutable activity/audit record.

Fields:

• Id (type: long) - internal identifier
• CreatedAt (type: DateTime) - timestamp the record was created
• ActivityCode (type: int) - numeric activity type code
• UserId (type: long?) - user who performed the action
• Comment (type: string?) - description of the activity
• EntityId (type: long?) - related entity identifier
• Screen (type: string?) - originating screen or feature
• IPAddress (type: string?) - IP address

Notes:

• Activity records are append-only — no update or delete is permitted

Country Model

Represents a country.

Fields:

• CountryCode (type: string) - unique country code
• CountryName (type: string) - country display name

Validation:

• IsReadyToAdd()
  • requires CountryCode and CountryName
• IsReadyToUpdate()
  • not explicitly defined

Order Status Model

Represents an order status.

Fields:

• Id (type: int?) - internal identifier
• Name (type: string?) - status name
• Weighting (type: int?) - optional sorting weight

Validation:

• No explicit validation method

Promotions Model

Represents a promotion or discount.

Fields:

• Id (type: int) - internal identifier
• CreatedAt (type: DateTime) - creation timestamp
• StartDate (type: DateTime?) - promotion start date
• EndDate (type: DateTime?) - promotion end date
• IsOneUse (type: bool?) - one-time use flag
• MoneyOff (type: decimal?) - flat discount amount
• PercentageDiscount (type: decimal?) - percentage discount
• IsActive (type: bool?) - active flag
• PromoCode (type: string?) - unique promo code
• MinOrderLevel (type: decimal?) - minimum order value for applicability

Validation:

• IsReadyToAdd()
  • requires StartDate, EndDate
  • requires MoneyOff > 0 or PercentageDiscount > 0
  • requires PromoCode
  • requires MinOrderLevel > 0
• IsReadyToUpdate()
  • requires Id > 0

System Options Model

Represents a system-wide option.

Fields:

• Id (type: int) - internal identifier
• CreatedAt (type: DateTime?) - creation timestamp
• SystemOptionTypeId (type: int) - option type
• IsActive (type: bool?) - active flag
• Value (type: string?) - option value

Validation:

• IsReadyToAdd()
  • requires SystemOptionTypeId > 0 and Value not empty
• IsReadyToUpdate()
  • requires Id > 0, SystemOptionTypeId > 0, and Value not empty

Tax Code Model

Represents a tax classification.

Fields:

• Id (type: long) - internal identifier
• Code (type: string) - unique tax code
• Description (type: string?) - description
• RatePercent (type: decimal?) - tax rate
• IsActive (type: bool?) - active flag

Validation:

• IsReadyToAdd()
  • requires Code, Description, RatePercent
• IsReadyToUpdate()
  • requires Id > 0, Code, Description, RatePercent

Unit of Measure Model

Represents a unit of measure.

Fields:

• Id (type: long) - internal identifier
• Code (type: string) - unique unit code
• Name (type: string) - display name

Validation:

• IsReadyToAdd()
  • requires Code and Name
• IsReadyToUpdate()
  • requires Id > 0, Code, Name