Skip to main content

Understanding Entities in the eyos System

Harrison Fletcher
Updated

When working with eyos, every event or interaction originates from a specific location within your business. To accurately track and attribute this data, we organise your structure into four key entities:

The Four Core Entities

Your organisation is represented in the eyos system using the following entities:

  1. Account
    The top-level entity that typically represents your entire organisation or corporate group. Most businesses will have just one account.

  2. Company
    A subdivision of the account, such as a brand, country, or business unit. This is a flexible layer used to represent how your organisation is structured internally.

  3.  

    Store
    Represents a physical or online store where sales or transactions occur.

  4. Device
    The actual point-of-sale device or terminal used in-store.

This entity structure enables seamless integration with PoS partners and supports accurate reporting for retailers

How These Entities Work Together

To uniquely identify where an event or transaction occurred, these entities are combined into a single string that follows this format:

AccountID_CompanyID_StoreID_DeviceID
 

This is used internally to map data correctly across your organization.

Example:

eyos_eyos-uk_eyos-bristol-cc_till-o1
 

This represents:

  • Account ID: eyos

  • Company ID: eyos-uk

  • Store ID: eyos-bristol-cc

  • Device ID: till-o1

These identifiers are provided by you, based on your existing internal systems and naming conventions. We will work with you to configure them to reflect your current structure, so there’s no need to create new IDs or adapt your internal logic.

 

Summary & Best Practices

  • Use your existing identifiers—no need to reinvent naming schemes.

  • Think of Accounts as global, Companies as brands or regions, Stores as sales locations, and Devices as terminals.

  • Maintain consistent formatting for easy management and traceability.

  • We’ll help configure everything to align with your business.

Related articles