Site structure

The Hyfin platform has support for multiple levels of access. Below are definitions of the available business structures within the API along with how they relate to each other.

Name
Definition
Site Enterprise
An optional Site Enterprise can be created to allow multiple Site groups and Sites to be organized and managed under a single Site Enterprise.
Site Group
An optional Site Group can be created to allow multiple Sites to be organized and managed under a single Site Group.
Site
Create a Site for each business location, or for each merchant id a business has. A Site can belong to a Site Group or a Site Enterprise, but does not have to. Every Site must belong to an Agency.

An example

A pizza franchise has 12 restaurants, owned by two franchisees with 6 restaurants each. The franchise brand is the Site Enterprise, each franchisee is a Site Group, and each restaurant is a Site. Each franchisee manages their 6 restaurants together, the brand manages all 12, and each restaurant's customers, invoices and payments stay on its own Site.

A business with one location needs only a Site. Most calls you make act on one Site, so they take its site_id in the URL.

Tier Structure

The table below shows a few ways to set up the structure for your Sites.

Enterprises
Site Enterprise
Site Group(s)
Site(s)
Multi-site Companies
Site Group
Site(s)
Single-site Companies
Site

Related