Skip to content

Items Information Model R1

Reference Data for materials, finished products, etc. and inventory pieces that need to be uniquely identified

This document applies to the R1 Version of the product that covers MVP1 through MVP4.

BusinessAffiliates Class Diagram

uml diagram

Classes

BusinessAffiliate Entity

Legal Entities that do business with the tenant.

Property Type multi Description
name String [1] The name of the Business Affiliate in the Tenant
legal CompanyInformation [1] Legal Information for the Business Affiliate
contact Contact [1] Main Contact for the Business Affiliate
address Address [1] Main Address for the Business Affiliate
contacts Map<String, Contact> [*] Other Contacts for the Business Affiliate indexed by a String Tag
addresses Map<String, Address> [*] Other Addresses for the Business Affiliate indexed by a String Tag

Invariants

  • name is required and unique in the tenant.
  • legal.name must always be equal to name. If both name and legal.name are provided in the input and they are not the same, the operation should fail.

Interpretation

  • The property legal.name will be removed in the future and should not be relied upon.

BusinessRole Entity

Information associated with a Role a Legal Entity plays in Supply Chain Business Transactions.

Property Type multi Description
parentEid EntityId [1] The Business Affiliate that holds this role. (Handled through Metadata)
role BusinessRoleType [1] The standard role type the referred affiliate plays according to this BusinessRole

Invariants

  • name is required.
    • businessAffiliateEId is required and must be a reference to an existing BusinessAffiliate entity at the time of creation or update.
    • role is required.

BusinessRoleType

An enumeration of the types of Roles Companies play in Supply Chain transactions (This list will expand as the system supports workflows
related to more roles).

Value Description
VENDOR A company that supplies goods or services to the tenant.
CUSTOMER A company that purchases goods or services from the tenant.
CARRIER A company that transports goods or services for the tenant.
OPERATOR The tenant company itself or other companies that the tenant controls and operate on its behalf.
OTHER Any other type of company that plays a role in the tenant’s supply chain.

Other Reference Information

(This will be moved to their own domain/subdomain)

Company Information

Information about the legal entity and activities of a Company.

Property Type multi Description
name String [1] The name of the Company as it is known in the Tenant
legalName String [?] The legal name of the Company in the Jurisdiction where it is registered
country CountrySymbol [?] The country where the Company is registered
taxId String [?] The tax id of the Company
registrationId String [?] The registration id of the Company
naicsCode NaicsCode [?] The NAICS code of the Company

Mutation Behaviors

BusinessAffiliate

Invariants

  • name is required and unique in the tenant.
  • legal.name is always equal to name. If both name and legal.name are provided in the input and they are not the same, the operation should fail.
  • contacts and addresses have a single entry for each value of the tag that identifies each of them. Updates with the same tag will override the previous value.

BusinessRole

Invariants

  • parentEid is required and must refer to a valid BusinessAffiliate entity.
  • role is required and must be a valid BusinessRoleType Value.

Copyright: © Arda Systems 2025-2026, All rights reserved

Comments