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 assigned to entities

Models

This module exposes and consumes the following models.

• Entity Model
• Supplier Model
• Address 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
• IsBilling (type: bool?) - billing address flag
• IsShipping (type: bool?) - shipping address flag

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
• Billing and shipping flags may coexist
• Address data is tenant-scoped