Business Info

Overview

From the Business Info endpoint, you can retrieve a business' details such as their address, phone number, and business registration. See Business Info endpoint for more details.

📘
The business information is information that is held in the accounting service provider about a business.

Data Model

Field	Type	Description
businessName	string	Name of the connected business.
legalName	string	Registered legal name of the connected business.
mailingAddress	Reference Types	The business mailing address.
legalAddress	Reference Types	The business legal address.
businessEmail	string	The primary email of the connected business.
businessType	string	The type of the connected business (e.g. LLC).
website	string	The business official website.
primaryPhoneNumber	string	The primary phone number of the connected business.
fiscalYearEndDay	number	The end date of the financial year for the business.
fiscalYearEndMonth	number	The end date of the financial year for the business.
industryType	string	The industry type of the connected business (e.g. Financial).
industryCode	string	The industry code of the connected business a.ka NAIC/SIC code (e.g. 523).
baseCurrency	string	A three letter string representing the ISO-4217 code for the base currency of the connected business. See Currency]
accountingMethod	string	The default accounting method for a connected business: `cash` or `accrual`.
firstRecordDate	string See Date	The first transaction date in the service provider. See Connections.
businessRegistrationNumber	string	Registration number given to the connected business by authority in the country of origin. In Canada this is Corporations Canada.
businessShortCode	string	A unique identifier for the business. Used in a number of potential use cases such as deep linking. Applicable to Xero only.
currencyRefs	array	An array of supported currencies by the business.
locationRefs	array	An array of operating locations or branches for the business.
subsidiaryRefs	array	An array of subsidiaries for the business.

Supported Currencies

Field	Type	Description
id	string	Identifier for the currency, unique to the business in the accounting service provider. Can be the same as symbol for certain service providers.
isActive	boolean	Indicates it the currency is being used by the business.
isBaseCurrency	boolean	Indicates if this is the base currency used by the business.
symbol	string	A three letter string representing the ISO-4217 code for the currency. See Currency.
name	string	Full name of the currency.

Locations

Field	Type	Description
id	string	Identifier for the location, unique to the business in the accounting service provider.
name	string	Full name of the business location.
address	Reference Types	The business location mailing address.
parentRef	object	Reference to the parent location id and name.

Subsidiaries

Field	Type	Description
id	string	Identifier for the subsidiary, unique to the business in the accounting service provider.
name	string	Full name of the business subsidiary.
parentRef	object	Reference to the parent subsidiary id and name.
currencies	array	An array of supported currency IDs.
locations	array	An array of supported location IDs.

Example Data

{
  "businessName": "Railz",
  "legalName": "Railz Financial Technologies Inc",
  "mailingAddress":
  {
    "line1": "180 John St",
    "line2": "Suite 12E",
    "city": "Seattle",
    "region": "Washington",
    "country": "United States",
    "postalCode": "19222"
  },
  "legalAddress":
  {
    "line1": "180 John St",
    "line2": "Suite 12E",
    "city": "Seattle",
    "region": "Washington",
    "country": "United States",
    "postalCode": "19222"
  },
  "businessEmail": "[email protected]",
  "businessType": "CCPC",
  "website": "www.railz.ai",
  "primaryPhoneNumber": "416-555-1212",
  "fiscalYearEndDay": 31,
  "fiscalYearEndMonth": 12,
  "industryType": "Financial",
  "industryCode": "123",
  "businessShortCode": "6Qfdg!",
  "baseCurrency": "USD",
  "accountingMethod": "accrual",
  "businessRegistrationNumber": "BN123456789",
  "currencyRefs":
  [
    {
      "id": "21",
      "isActive": false,
      "isBaseCurrency": true,
      "symbol": "USD",
      "name": "USA"
    }
  ],
  "locationRefs":
  [
    {
      "id": "52",
      "name": "United States",
      "address":
      {
        "line1": "180 John St",
        "line2": "Suite 12E",
        "city": "Seattle",
        "region": "Washington",
        "country": "United States",
        "postalCode": "19222"
      },
      "parentRef":
      {
        "id": "11",
        "name": "United States"
      }
    }
  ],
  "subsidiaryRefs":
  [
    {
      "id": "8",
      "name": "Honeywell",
      "parentRef":
      {
        "id": "2",
        "name": "Honeywell Holdings"
      },
      "currencies":
      [
        {
          "id": "3"
        }
      ],
      "locations":
      [
        {
          "id": "5"
        }
      ]
    }
  ]
}