Core Entities

epilot ships with a set of built-in entity schemas that model common business objects. This page lists all core schemas with their descriptions, relationship diagram, and links to API docs.

See the API Changelog for recent changes to entities and APIs.

Relationship Diagram

graph TB %% Customer Relations Account[Account] Contact[Contact] %% Sales Opportunity[Opportunity] Order[Order] %% Products Product[Product] Price[Price] Tax[Tax] %% Contracts & Billing Contract[Contract] BillingAccount[Billing Account] BillingEvent[Billing Event] %% Metering Meter[Meter] MeterCounter[Meter Counter] %% Sales Flow Opportunity -->|has many| Order %% Customer Relations Contact -->|has many| Opportunity Contact -->|has many| Order Contact -->|has one| Account Contact -->|has many| Contract Contact -->|has many| Ticket Contact -->|has many| BillingAccount Order -->|has many| Product %% Products Product -->|has many| Price Price -->|has one| Tax %% Contracts & Billing Contract -->|has one| BillingAccount Contract -->|has one| Order Contract -->|has many| Meter BillingAccount -->|has many| BillingEvent %% Metering Meter -->|has many| MeterCounter style Account fill:#e1f5ff style Contact fill:#e1f5ff style Opportunity fill:#fff4e1 style Order fill:#fff4e1 style Product fill:#f0e1ff style Price fill:#f0e1ff style Tax fill:#f0e1ff style Contract fill:#e1ffe1 style BillingAccount fill:#e1ffe1 style BillingEvent fill:#e1ffe1

Built-in Entity Schemas

Customer Relations

Contact

#

Contacts store details about customers or individuals managed by the epilot organization.

API Reference

Account

#

Accounts store details about companies. Contacts can be linked to an account to represent a business customer.

API Reference

Partner

#

Partners store details about collaborating third parties, such as installation partners, OEMs and other business partners.

API Reference

Ticket

#

Tickets store customer support requests and help desk inquiries.

Sales

Opportunity

#

Opportunities store details about sales leads or product inquiries usually made through journeys.

API Reference

Order

#

Orders store details about requested products, pricing and past orders placed by customers.

API Reference

Product Hub

Product

#

Products represent services or products sold by the epilot organization.

API Reference

Price

#

Prices configure the pricing models for products.

API Reference

Tax

#

Taxes represent the tax rates applied to prices.

API Reference

Coupon

#

Coupons represent discounts or promotions that can be applied to products.

API Reference

Contracts & Billing

Contract

#

Contracts store details about service agreements, tariffs and other agreements between customers and the epilot organization.

API Reference

Billing Account

#

Billing accounts store billing information and payment details for customers.

API Reference

Billing Event

#

Billing events store records of financial transactions, including payments, invoices, and credit notes.

API Reference

Metering

Meter

#

Meters store details about power, gas, water, or other devices used to meter consumption.

API Reference

Meter Counter

#

Meter counters represent the counters used in meter devices, allowing separate tracking for different consumption types or purposes, such as peak and off-peak energy usage.

API Reference

Journeys

Journey

#

Journeys contain the configuration of a customer journey, which is used to collect data from customers.

API Reference

Submission

#

Submissions store raw data collected from Journeys or other outside data sources into epilot.

API Reference

Messaging

Message

#

Messages are email communications sent and received through the epilot platform.

API Reference

Email Template

#

Email templates are used as templates containing variables for emails sent from epilot.

API Reference

Marketing & Analytics

Campaign

#

Campaigns store marketing campaign information and configurations.

Target

#

Targets represent goals or milestones for sales and marketing activities.

Product Recommendation

#

Product recommendations suggest products to customers based on their preferences and behavior.

System

File

#

Files store details about documents, images, templates and other files uploaded to the epilot platform.

API Reference

Comment

#

Comments allow users to add notes and have discussions across the platform.

API Reference

Portal User

#

Portal users are users registered to use end customer portals or installer portals.

API Reference