Skip to main content
​
tenant_id
string<ten_string>
required

The id of the Tenant

Example:

"ten_Vl1a3f7JlZ9pZ5hL2wNfLn"

​
name
string
required

The name of the Business

Maximum string length: 255
Example:

"Roofing Pros"

​
industry
string | null
required

The industry of the Business

Example:

"Roofing Contractors"

​
entries_start
string<date-time>
required

The datetime in UTC ISO 8601 format from which the system will sync a Business' accounting data

​
entity_type
required

The Business structure, which determines the default Chart of Accounts

Available options:
c-corp,
llc,
partnership,
s-corp,
sole-prop,
household,
non-profit
​
fiscal_year
string
required

The Business' fiscal year start period in format MM/DD

Maximum string length: 5
Example:

"01/01"

​
external_id
string
required

The external ID of the Business

Maximum string length: 255
Example:

"1234567890"

​
id
string<biz_string>
required

The id of the Business

Example:

"biz_GA6EG2qFxA97NZHtxeLPUy"

​
status
enum<string>
default:active

Whether the business is active or inactive

Available options:
active,
inactive
​
onboarding_date
string<date> | null

The date the business was onboarded

​
plan
enum<string>
default:managed

The Business plan

Available options:
diy,
managed
​
assigned_bookkeeper
string<usr_string> | null

The id of the bookkeeper assigned to this business, if any

​
phone_number
string | null

Phone number for MMS receipt ingestion (E.164 format)

​
country
enum<string>
default:united_states

The country of the Business

Available options:
canada,
united_states
Example:

"united_states"

​
region

The region of the Business, such as a state or province

Available options:
alberta,
british_columbia,
manitoba,
new_brunswick,
newfoundland_and_labrador,
northwest_territories,
nova_scotia,
nunavut,
ontario,
prince_edward_island,
quebec,
saskatchewan,
yukon
Example:

"california"

​
canada_gst_registered
boolean | null

Whether the Business is registered for GST/HST

​
canada_tax_status
enum<string> | null

The Canadian tax status of the Business

Available options:
itc_eligible,
exempt
Example:

"itc_eligible"