Company Change
The Company Change webhook triggers:
- Company created
- Company updated.
Summary
The following gives and overview of the fields in the json.
| Field | Description |
|---|---|
| id | Unique identifier for the company record. |
| companyName | The name of the company. |
| companyNumber | The registration number or unique identifier for the company. |
| emailAddress | The primary email address associated with the company (nullable if not specified). |
| accountCode | Unique code identifying the account associated with the company (nullable if not specified). |
| telephoneNumber | The company's primary telephone number (nullable if not specified). |
| status | The current status of the company (e.g., "ACTIVE"). |
| category | The category assigned to the company (nullable if not specified). |
Primary Address Details
| Field | Description |
|---|---|
| primaryAddress.addressLine1 | The first line of the company's primary address (nullable if not specified). |
| primaryAddress.addressLine2 | The second line of the company's primary address (nullable if not specified). |
| primaryAddress.addressLine3 | The third line of the company's primary address (nullable if not specified). |
| primaryAddress.city | The city of the company's primary address (nullable if not specified). |
| primaryAddress.postcode | The postcode of the company's primary address (nullable if not specified). |
| primaryAddress.country | The country of the company's primary address (nullable if not specified). |
| primaryAddress.isoCountry2 | ISO 3166-1 alpha-2 code of the primary address country (nullable if not specified). |
Billing Address Details
| Field | Description |
|---|---|
| billingAddress.addressLine1 | The first line of the company's billing address (nullable if not specified). |
| billingAddress.addressLine2 | The second line of the company's billing address (nullable if not specified). |
| billingAddress.addressLine3 | The third line of the company's billing address (nullable if not specified). |
| billingAddress.city | The city of the company's billing address (nullable if not specified). |
| billingAddress.postcode | The postcode of the company's billing address (nullable if not specified). |
| billingAddress.country | The country of the company's billing address (nullable if not specified). |
| billingAddress.isoCountry2 | ISO 3166-1 alpha-2 code of the billing address country (nullable if not specified). |
Custom Data
| Field | Description |
|---|---|
| customData | An array of additional custom data fields or metadata related to the company. |
Example
{
"id":202,
"companyName":"aa",
"companyNumber":"bb",
"emailAddress":null,
"accountCode":null,
"telephoneNumber":null,
"status":"ACTIVE",
"category":null,
"primaryAddress":{
"addressLine1":null,
"addressLine2":null,
"addressLine3":null,
"city":null,
"postcode":null,
"country":null,
"isoCountry2":null
},
"billingAddress":{
"addressLine1":null,
"addressLine2":null,
"addressLine3":null,
"city":null,
"postcode":null,
"country":null,
"isoCountry2":null
},
"customData":[]
}