Businesses

At Railz, a business refers to an entity that shares access to their data. Each business can have multiple data connections to different service providers such as one connection to accounting data and one or more connections for bank accounts. Businesses are often represented by your customers.

Businesses are uniquely identified by their business name, denoted by businessName.

Creating a Business

Businesses can be created in one of three ways:

  1. Using the POST /businesses endpoint in the Railz API.
  2. Using Railz Connect™ by providing the businessName parameter.
  3. Using Railz Sites™

Restrictions on Business Names

If you don't provide a business name when loading Railz Connect™ in your client-side app, Railz Connect™ will auto-generate a unique identifier as the business name.

Business Names must be:

  • Unique
  • At least 2 characters long
  • A maximum of 40 characters long

Business Statuses

Each Railz business has a status that can be one of the following values:

  • inactive: Businesses with no active connections. You will still be able to retrieve existing data but no future synchronization will take place.
  • active: The business has connected to an accounting service provider and you should be able to retrieve its accounting data.

📘

A business can only have one unique active accounting connection.


Read Next

Learn more about the integrations and types of data Railz supports.

Did this page help you?