Models
Company
Properties
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | The ID of the company. Use it wherever an endpoint takes a companyId. Example: "c_01JQZ8X0M4T7RB6K9V2NDHW3PA" |
teamId | string | Yes | The ID of the team the company belongs to. Example: "team_01JQZ8X0M4T7RB6K9V2NDHW3PA" |
name | string | Yes | The legal name of the company, as it is written on the documents it sends. Example: "Recommand BV" |
address | string | Yes | Street name and number of the company's registered address. Example: "Kortrijksesteenweg 1092" |
postalCode | string | Yes | Postal code of the company's registered address. Example: "9051" |
city | string | Yes | City of the company's registered address. Example: "Gent" |
country | string | Yes | The country the company is registered in, in ISO 3166-1 alpha-2 format. Example: "BE" |
enterpriseNumberScheme | string | null | Yes | The Peppol scheme the enterprise number belongs to, for example 0208 for the Belgian enterprise number register. Null when no scheme was recorded. Example: "0208" |
enterpriseNumber | string | Yes | The company's registration number in its national business register, without the scheme prefix. Example: "1012081766" |
vatNumber | string | Yes | The company's VAT number, including its country prefix. Example: "BE1012081766" |
email | string | null | Yes | Contact email address recorded for the company. This is not where document notifications go; those are configured per address through the notification email address endpoints. Example: "billing@example.com" |
phone | string | null | Yes | Contact phone number recorded for the company. Example: "+32 9 396 20 39" |
isSmpRecipient | boolean | Yes | Whether the company is registered in the SMP to receive documents. Set it to false for a company that only sends. Registration also requires the company to be verified when your team's verification requirements are strict, and never happens for playground teams. Example: true |
isVerified | boolean | Yes | Whether an authorised representative completed the identity check, which is needed before exchanging documents. Start the check with the verify company endpoint. Example: true |
createdAt | string (date-time) | Yes | When the company was created. Format: date-time |
updatedAt | string (date-time) | Yes | When the company was last changed. Format: date-time |