Import Client

POST /api/tenants/{tenant}/clients/import

Import a client with comprehensive data. This saves you creating a Client and then creating additional info such as contacts, etc - you can create them all in a single request. Creates Client, BusinessDetails, Contacts (via ClientContact), ClientLinks, and ClientNotes. If enrichFromCompaniesHouse is true, enriches UK private limited companies with Companies House data (company details, key dates, officers).

Parameters

Name	Type	Description
tenant*	path string	The Tenant.Code
The Tenant.Code
enrichFromCompaniesHouse	query boolean

Request Body*

ClientImportData

{
  "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": "..."
    }
  ]
}

Responses

201 Created

ClientDto

400 Bad Request

ValidationProblemDetails

401 Unauthorized - Invalid or missing API key