API Docs / Schemas / ConfirmCsvImportRequest

ConfirmCsvImportRequest

Request to confirm column mapping configuration and start a CSV import job.
Used after uploading a CSV with showPreview=true to finalize the mapping and begin import.

Properties

Name Type Description
mappingCodestring

Code of an existing saved mapping to use for this import.
Use GET /mappings to list available mappings (includes system defaults like 'limited-company-clients').
Mutually exclusive with ColumnMappings - provide one or the other, not both.
If neither is provided, the suggested mappings from the preview will be used.

Code of an existing saved mapping to use for this import.
Use GET /mappings to list available mappings (includes system defaults like 'limited-company-clients').
Mutually exclusive with ColumnMappings - provide one or the other, not both.
If neither is provided, the suggested mappings from the preview will be used.

columnMappingsarray of CsvColumnMappingDto

Inline column mappings to use for this import.
Each mapping specifies which CSV header maps to which target field.
Mutually exclusive with MappingCode - provide one or the other, not both.
If neither is provided, the suggested mappings from the preview will be used.

Inline column mappings to use for this import.
Each mapping specifies which CSV header maps to which target field.
Mutually exclusive with MappingCode - provide one or the other, not both.
If neither is provided, the suggested mappings from the preview will be used.

matchFieldenum

Code Name CompanyNumber InternalReference NiNumber

Code Name CompanyNumber InternalReference NiNumber

importModeenum

CreateOnly UpdateOnly CreateAndUpdate

CreateOnly UpdateOnly CreateAndUpdate

enrichFromCompaniesHouseboolean

Whether to enrich newly created clients with Companies House data after import.
Only applies to eligible company types (excludes Individual, SoleTrader, Trust).
Default: false

Whether to enrich newly created clients with Companies House data after import.
Only applies to eligible company types (excludes Individual, SoleTrader, Trust).
Default: false

defaultClientTypeenum

PrivateLimitedCompany PublicLimitedCompany LimitedLiabilityPartnership Partnership Individual Trust Charity SoleTrader

PrivateLimitedCompany PublicLimitedCompany LimitedLiabilityPartnership Partnership Individual Trust Charity SoleTrader

JSON Example

{
  "mappingCode": "string",
  "columnMappings": [
    {
      "csvHeader": "...",
      "targetField": "..."
    }
  ],
  "matchField": "Code",
  "importMode": "CreateOnly",
  "enrichFromCompaniesHouse": false
}

Used By Operations