Connections

At Railz, a Connection refers to a connection to an accounting service provider. Connections often correspond to your customers' account credentials at their accounting service provider.

Connections are uniquely identified by their Connection ID, denoted by connectionId, which is generated by Railz when a Business connects its accounting service provider(s) through Railz Connect™.

Connection Statuses

Railz creates a connectionId for every connection to an accounting service provider. Each connection has a status that can be one of the following values:

  • pending: New connections are created in this state; this corresponds to Businesses that have not yet connected to an accounting service provider and, therefore, you won't be able to sync any data yet.
  • active: The business has connected to an accounting service provider and you should be able to retrieve its accounting data.
  • expired: The business was connected to an accounting service provider, but Railz has been told that the connection is no longer authorized. You will still be able to access any data that was already synchronized, but you won't be able to retrieve any new data until the business completes the authorization process again.
  • inactive: Unlinked; similar to expired in that you can access data already synchronized but not retrieve new data.
  • invalid: The connection was quickly marked as invalid after connecting due to one of the following reasons: invalid integrations settings in the Dashboard, business attempting connecting through a non-admin login, or business has an expired license with the accounting service provider.

Did this page help you?