The Business object
Beta API Versions
API versions labelled as Beta are not subject to our standard versioning policy. As such, they may undergo small breaking changes until they are transitioned to the stable version. We encourage you to exercise caution when using Beta API versions and take the necessary steps to ensure a smooth integration into your applications
This section applies to 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.
| 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 business fiscal year end day. |
| fiscalYearEndMonth | number | The business fiscal year end month. |
| 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. |
| 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. |
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. |
How to - User Guide
Step-by-step guide on utilizing this endpoint.