Entities Module

Back

Overview

The Entities module is responsible for managing all business entities within the system.
An entity represents either a Customer or a Supplier, including their addresses and users.

This module defines how entities are created, validated, updated and deleted before they are used
by sales, pricing, ordering and access-control modules.

All operations are tenant-aware and fully audited.

Services

The Entities module consists of the following services:

• Customer - manage customers and their details
• Supplier - manage suppliers and their details
• Entity Address - manage billing and shipping addresses
• Entity User - manage users, roles, passwords and self-service profile
• Files - manage filemanage file attachments linked to entities
• File Types - manage file type definitions

Models

This module exposes and consumes the following models.

• Entity Model
• Supplier Model
• Address Model
• Files Model
• File Types Model

Entity Model

Represents a business entity (customer).

Fields:

• Id (type: long) - internal identifier
• Code (type: string?) - unique customer code
• Name (type: string?) - customer display name
• Email (type: string?) - primary email address
• Phone (type: string?) - contact phone number
• HasAccessToAllProducts (type: bool?) - access to all products flag
• DefaultBillingAddressId (type: long) - default billing address
• DefaultShippingAddressId (type: long) - default shipping address
• IsActive (type: bool?) - active flag

Validation:

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

Notes:

• Used for customers
• Email must be unique across all entities
• Entity type is determined internally (IsSupplier flag)
• All data is tenant-scoped

Supplier Model

Represents a supplier entity.

Extends Entity Model with supplier-specific fields.

Additional Fields:

• RelatedEntityId (type: long?) - related customer or entity identifier
• RelatedEntityRelationship (type: string?) - relationship description
• PaymentTermsDays (type: int?) - payment terms in days
• IsPayOnAccount (type: bool?) - pay on account flag
• CreditLimit (type: decimal?) - credit limit amount

Validation:

• Inherits validation from Entity Model

Notes:

• SupplierModel inherits from EntityModel
• Supplier-specific fields are applied only when IsSupplier = true
• Stored in the same entity data store as customers
• Tenant-scoped and audited

Address Model

Represents an address assigned to an entity.

Fields:

• Id (type: long) - internal identifier
• EntityID (type: long?) - associated entity identifier
• Name (type: string?) - address name or label
• Line1 (type: string?) - first address line
• Line2 (type: string?) - second address line
• City (type: string?) - city
• StateRegion (type: string?) - state or region
• PostalCode (type: string?) - postal code
• CountryCode (type: string?) - ISO country code
• Phone (type: string?) - contact phone
• Email (type: string?) - contact email
• AddressType (type: int?) - address type (FK to EntityAddressType; default: 0)

Validation:

• IsReadyToAdd()
  • requires EntityID > 0
  • requires Name
  • requires Line1
  • requires City
  • requires PostalCode
  • requires CountryCode
• IsReadyToUpdate()
  • requires Id > 0
  • requires Name

Notes:

• An entity may have multiple addresses
• Address purpose is determined by AddressType — see EntityAddressType Model
• Address data is tenant-scoped

EntityAddressType Model

Defines the purpose of an address. Values are fixed system constants — the same for all tenants.

Fields:

• Id (type: int) - identifier (also used as the FK value in Address.AddressType)
• Title (type: string) - display name

Fixed values:

Notes:

• These values are seeded at database level and must not be changed
• Address.AddressType is constrained by FK to this table
• Replaces the previous IsBilling / IsShipping boolean flags

Files Model

Represents a file attachment linked to an entity.

Fields:

• Id (type: long) - internal identifier
• EntityId (type: long) - associated entity identifier
• FileName (type: string) - file name
• Description (type: string?) - file description
• CreatedAt (type: DateTime) - creation timestamp
• UpdatedAt (type: DateTime?) - last update timestamp
• FileURL (type: string?) - URL or path to the file
• FileType (type: long?) - file type identifier

Validation:

• IsReadyToAdd()
  • requires EntityId > 0
  • requires FileName
• IsReadyToUpdate()
  • requires Id > 0
  • requires EntityId > 0
  • requires FileName

Notes:

• Files are linked to entities via EntityId
• File storage location is managed externally
• All data is tenant-scoped

File Type Model

Represents a category or type of file.

Fields:

• Id (type: long) - internal identifier
• Title (type: string) - file type display title
• Icon (type: string?) - optional icon identifier
• CreatedAt (type: DateTime) - creation timestamp

Validation:

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

Notes:

• File types provide categorization for files
• Used for filtering and organizing attachments
• All data is tenant-scoped