Skip to content

Business Affiliates

The Business Affiliates model represents the legal entities that participate in business transactions with a tenant. It provides the reference data for vendors, customers, carriers, and other commercial parties.

A BusinessAffiliate is an entity scoped to a tenant representing a legal entity that does business with the tenant. It is the primary entity in the affiliate model.

PropertyTypeMultiplicityDescription
nameString[1..1]The name of the business affiliate as known in the tenant. Required and unique within the tenant.
legalCompanyInfo[1..1]Legal information about the business affiliate
contactContact[1..1]Main contact for the business affiliate
addressAddress[1..1]Main address for the business affiliate
contactsMap of String to Contact[0..*]Additional contacts, each indexed by a string tag
addressesMap of String to Address[0..*]Additional addresses, each indexed by a string tag
  • name is required and unique within the tenant.
  • legal.name must equal name. If both are provided in an input and they differ, the operation fails.
  • contacts and addresses enforce uniqueness by tag — updates with the same tag replace the previous value.

A BusinessRole entity represents the role that a specific BusinessAffiliate plays in supply chain transactions. A single BusinessAffiliate may play multiple roles (e.g., the same company might be both a vendor and a carrier).

PropertyTypeDescription
parentEIdEntityIdThe BusinessAffiliate that holds this role
roleBusinessRoleTypeThe standard role type
  • parentEId is required and must reference an existing BusinessAffiliate.
  • role is required and must be a valid BusinessRoleType.

An enumeration of the roles companies play in supply chain transactions:

ValueDescription
VENDORA company that supplies goods or services to the tenant. Referenced from ItemSupply entities.
CUSTOMERA company that purchases goods or services from the tenant.
CARRIERA company that transports goods for the tenant.
OPERATORThe tenant company itself or companies the tenant controls and operates on its behalf.
OTHERAny other type of company participating in the tenant’s supply chain.

This list will expand as the system supports more commercial roles.

CompanyInfo is a value object containing legal and registration information about a company:

PropertyTypeDescription
nameStringThe company name as known in the tenant
legalNameStringThe legal name as registered in the jurisdiction
countryCountrySymbolThe country where the company is registered
taxIdStringTax identification number
registrationIdStringCompany registration number
naicsCodeNaicsCodeIndustry classification code

The Contact entity and Identity value type represent persons associated with business affiliates.

Real-world identification information for a person:

PropertyTypeDescription
salutationStringHonorific (Mr., Ms., Dr., etc.)
firstNameStringFirst name
middleNameStringMiddle name
lastNameStringLast name
suffixStringName suffix
jobStringJob title
emailEmailPrimary email
phoneStringPrimary phone
addressAddressPrimary address
emailsMap of String to EmailAdditional email addresses by tag
phonesMap of String to StringAdditional phone numbers by tag
addressesMap of String to AddressAdditional addresses by tag
sitesMap of String to (site)Additional site references by tag

An entity scoped to a tenant representing a real-world person needed in operations and business transactions.

PropertyTypeDescription
identityIdentityThe person’s identification information
notesStringOptional notes about the contact

BusinessAffiliate and BusinessRole entities are referenced by ItemSupply entities through the vendorEId property. When an item’s supply source is linked to a persistent vendor record, the ItemSupply.vendorEId holds the entity identity of the BusinessRole with type VENDOR for that vendor. See Items for details.

Purchase orders reference three BusinessRole entities: customer (buyer), supplier (vendor), and carrier. These roles are drawn from the BusinessAffiliate model. See Purchase Orders for details.

Excluded from this document: The Organization entity from the base affiliates model is a more general entity that may supersede BusinessAffiliate in future versions. It is documented in the source file but not yet in active use in the R1 implementation. The NacsCode value type and its validation rules will be documented when the NAICS code feature is fully implemented.