@smokeballdev/smokeball-client-sdk

​
Interface: Company

Company details.

​
Properties

​
abn?

optional abn: string
For AU: Australian Company Number (ABN) of the company. For UK: Company Registration Number (CRN) of the company. Only supported in AU and UK.

​
businessAddress?

optional businessAddress: AddressWithDxAddress
Company business address.

​
companyNumber?

optional companyNumber: string
Australian Company Number. Only supported in AU.

​
companyNumberType?

optional companyNumberType: string
Australian company number type. Possible values: ACN, ARBN Only supported in AU.

​
directorIds?

optional directorIds: string[]
Company list of Director Ids

​
email?

optional email: string
Company email address.

​
fax?

optional fax: Phone
Company fax number.

​
mailingAddress?

optional mailingAddress: Address
Company mailing address.

​
name?

optional name: string
Company name.

​
notes?

optional notes: string
Additional notes for company (if applicable).

​
phone?

optional phone: Phone
Company primary phone number.

​
staffIds?

optional staffIds: string[]
Company list of Staff Ids

​
type?

optional type: string
Company type. Possible values for US: Corporation, Government Agency, Limited Liability Company, Sole Proprietor, Partnership, Not-for-Profit Possible values for AU: Company, Sole Proprietor, Partnership, Government Department Possible values for UK: Company, Sole Trader, Partnership, Limited Liability Partnership, Government Department