| Field | Type | Required | Description | Example |
|---|---|---|---|---|
name |
Optional<String> | ✔️ | Name of the company | SpaceX |
ownerId |
JsonNullable<String> | ➖ | Owner ID | 12345 |
image |
JsonNullable<String> | ➖ | The Image URL of the company | https://www.spacex.com/static/images/share.jpg |
description |
JsonNullable<String> | ➖ | A description of the company | Space Exploration Technologies Corp. is an American aerospace manufacturer, space transportation services and communications company headquartered in Hawthorne, California. |
vatNumber |
JsonNullable<String> | ➖ | The VAT number of the company | BE0689615164 |
currency |
JsonNullable<Currency> | ➖ | Indicates the associated currency for an amount of money. Values correspond to ISO 4217. | USD |
status |
JsonNullable<String> | ➖ | The status of the company | Open |
fax |
JsonNullable<String> | ➖ | The fax number of the company | +12129876543 |
annualRevenue |
JsonNullable<String> | ➖ | The annual revenue of the company | +$35m |
numberOfEmployees |
JsonNullable<String> | ➖ | Number of employees | 500-1000 |
industry |
JsonNullable<String> | ➖ | The industry represents the type of business the company is in. | Apparel |
ownership |
JsonNullable<String> | ➖ | The ownership indicates the type of ownership of the company. | Public |
salesTaxNumber |
JsonNullable<String> | ➖ | A sales tax number is a unique number that identifies a company for tax purposes. | 12456EN |
payeeNumber |
JsonNullable<String> | ➖ | A payee number is a unique number that identifies a payee for tax purposes. | 78932EN |
abnOrTfn |
JsonNullable<String> | ➖ | An ABN is necessary for operating a business, while a TFN (Tax File Number) is required for any person working in Australia. | 46 115 614 695 |
abnBranch |
JsonNullable<String> | ➖ | An ABN Branch (also known as a GST Branch) is used if part of your business needs to account for GST separately from its parent entity. | 123 |
acn |
JsonNullable<String> | ➖ | The Australian Company Number (ACN) is a nine digit number with the last digit being a check digit calculated using a modified modulus 10 calculation. ASIC has adopted a convention of always printing and displaying the ACN in the format XXX XXX XXX; three blocks of three characters, each block separated by a blank. | XXX XXX XXX |
firstName |
JsonNullable<String> | ➖ | The first name of the person. | Elon |
lastName |
JsonNullable<String> | ➖ | The last name of the person. | Musk |
bankAccounts |
List<BankAccount> | ➖ | N/A | |
websites |
List<Website> | ➖ | N/A | |
addresses |
List<Address> | ➖ | N/A | |
socialLinks |
List<SocialLink> | ➖ | N/A | |
phoneNumbers |
List<PhoneNumber> | ➖ | N/A | |
emails |
List<Email> | ➖ | N/A | |
rowType |
Optional<CompanyRowType> | ➖ | N/A | |
customFields |
List<CustomField> | ➖ | N/A | |
tags |
List<String> | ➖ | N/A | [ "New" ] |
readOnly |
JsonNullable<Boolean> | ➖ | Whether the company is read-only or not | false |
salutation |
JsonNullable<String> | ➖ | A formal salutation for the person. For example, 'Mr', 'Mrs' | Mr |
birthday |
LocalDate | ➖ | The date of birth of the person. | 2000-08-12 |
passThrough |
List<PassThroughBody> | ➖ | The pass_through property allows passing service-specific, custom data or structured modifications in request body when creating or updating resources. |
