ClientImportData
Comprehensive model containing all data for importing a client.
This model is used both by third-party import services and direct import endpoints.
Properties
| Name | Type | Description |
|---|---|---|
| externalId | string | The external ID from the third-party platform (optional for direct imports) |
The external ID from the third-party platform (optional for direct imports) | ||
| client | CreateClientRequest | |
| businessDetails | BusinessDetailsDto | |
| contacts | array of CreateClientContactRequest | List of contacts with their roles - creates Contact entities and links them to the Client via ClientContact |
List of contacts with their roles - creates Contact entities and links them to the Client via ClientContact | ||
| links | array of CreateClientLinkRequest | Links (website, social media, etc.) - creates ClientLink entities |
Links (website, social media, etc.) - creates ClientLink entities | ||
| notes | array of CreateClientNoteRequest | Additional notes - creates ClientNote entities attached to the client |
Additional notes - creates ClientNote entities attached to the client | ||
| address | AddressData | |
JSON Example
{
"externalId": "string",
"client": {
"name": "string",
"type": "...",
"internalReference": "string",
"managerCode": "string",
"partnerCode": "string"
},
"businessDetails": {
"company": "...",
"tradingAs": "string",
"postalAddress": "string",
"invoiceAddress": "string",
"dateOfTrading": "2024-01-01T00:00:00Z"
},
"contacts": [
{
"role": "...",
"types": "...",
"contact": "..."
}
],
"links": [
{
"url": "...",
"linkType": "..."
}
]
}