| code | string | Unique code identifying this import job.
Use this code to confirm and start the import via PUT /{code},
or to check status via GET /{code}.
|
Unique code identifying this import job.
Use this code to confirm and start the import via PUT /{code},
or to check status via GET /{code}.
|
| hasHeaderRow | boolean | Whether the first row was treated as column headers.
If hasHeaderRow was explicitly provided in the request, this reflects that value.
If not provided, this shows the auto-detected result based on the first row content.
|
Whether the first row was treated as column headers.
If hasHeaderRow was explicitly provided in the request, this reflects that value.
If not provided, this shows the auto-detected result based on the first row content.
|
| headers | array of string | List of column headers detected from the CSV file.
If hasHeaderRow was true, these are from the first row.
If hasHeaderRow was false, these are auto-generated (Column1, Column2, etc.).
|
List of column headers detected from the CSV file.
If hasHeaderRow was true, these are from the first row.
If hasHeaderRow was false, these are auto-generated (Column1, Column2, etc.).
|
| totalRows | integer | Total number of data rows in the CSV file (excluding the header row if present).
This is the number of rows that will be processed during import.
|
Total number of data rows in the CSV file (excluding the header row if present).
This is the number of rows that will be processed during import.
|
| previewRows | array of object | Preview of the first few rows from the CSV file.
Each row is a dictionary mapping header names to cell values.
Use this to verify the data looks correct before confirming the import.
Typically includes up to 5 preview rows.
|
Preview of the first few rows from the CSV file.
Each row is a dictionary mapping header names to cell values.
Use this to verify the data looks correct before confirming the import.
Typically includes up to 5 preview rows.
|
| suggestedMappings | array of CsvColumnMappingDto | Auto-suggested column mappings based on header name matching.
The system attempts to match CSV headers to known target fields using fuzzy matching.
Review and adjust these mappings as needed when confirming the import.
Only includes mappings for headers that could be matched to target fields.
|
Auto-suggested column mappings based on header name matching.
The system attempts to match CSV headers to known target fields using fuzzy matching.
Review and adjust these mappings as needed when confirming the import.
Only includes mappings for headers that could be matched to target fields.
|
| allowedTargetFields | array of enum | Target fields that apply to this import's kind. Null means every target is available
(client imports); contact imports return the contact-relevant subset.
Name Code Type Status Email Telephone InternalReference CanContactPost CanContactTelephone CanContactEmail CanContactSms PclSent Manager Partner Associate CompanyNumber CompaniesHouseAuthenticationCode VatNumber VatRegistered VatRegDate VatScheme VatReportingPeriod Utr SelfAssessmentUtr CompanyUtr NiNumber PayeRef AccountsOfficeRef TradingAs NatureOfBusiness IncorporationDate RegisteredAddress PostalAddress InvoiceAddress RegisteredAddressLine1 RegisteredAddressLine2 RegisteredAddressLine3 RegisteredAddressCity RegisteredAddressPostCode RegisteredAddressCountry PostalAddressLine1 PostalAddressLine2 PostalAddressLine3 PostalAddressCity PostalAddressPostCode PostalAddressCountry InvoiceAddressLine1 InvoiceAddressLine2 InvoiceAddressLine3 InvoiceAddressCity InvoiceAddressPostCode InvoiceAddressCountry ContactName ContactTitle ContactFirstName ContactMiddleName ContactLastName ContactEmail ContactPhone ContactMobile ContactDateOfBirth PersonalCode ContactRelationships Team Website ContactNationality ContactMaritalStatus ContactAddress VatPeriodEnd Notes ImportantNotes SicCodes DateOfTrading TradingAsSoleTrader LinkedInUrl FacebookUrl TwitterUrl InstagramUrl AuthSelfAssessment AuthCorporationTax AuthPayeForEmployers AuthIndividualPayAsYouEarn AuthVat AuthConstructionIndustryScheme AuthTaxCredits AuthHighIncomeChildBenefitCharge AuthMakingTaxDigitalIncomeTax AuthMakingTaxDigitalVat AuthTrusts AmlClientId Notes2 Notes3 Notes4 Notes5 VatFlatRateScheme AmlContactId RelatedClientName ContactIsPrimary ContactJobTitle RegisteredAddressCounty PostalAddressCounty InvoiceAddressCounty ContactPreferredName CanContactWhatsApp
|
Target fields that apply to this import's kind. Null means every target is available
(client imports); contact imports return the contact-relevant subset.
Name Code Type Status Email Telephone InternalReference CanContactPost CanContactTelephone CanContactEmail CanContactSms PclSent Manager Partner Associate CompanyNumber CompaniesHouseAuthenticationCode VatNumber VatRegistered VatRegDate VatScheme VatReportingPeriod Utr SelfAssessmentUtr CompanyUtr NiNumber PayeRef AccountsOfficeRef TradingAs NatureOfBusiness IncorporationDate RegisteredAddress PostalAddress InvoiceAddress RegisteredAddressLine1 RegisteredAddressLine2 RegisteredAddressLine3 RegisteredAddressCity RegisteredAddressPostCode RegisteredAddressCountry PostalAddressLine1 PostalAddressLine2 PostalAddressLine3 PostalAddressCity PostalAddressPostCode PostalAddressCountry InvoiceAddressLine1 InvoiceAddressLine2 InvoiceAddressLine3 InvoiceAddressCity InvoiceAddressPostCode InvoiceAddressCountry ContactName ContactTitle ContactFirstName ContactMiddleName ContactLastName ContactEmail ContactPhone ContactMobile ContactDateOfBirth PersonalCode ContactRelationships Team Website ContactNationality ContactMaritalStatus ContactAddress VatPeriodEnd Notes ImportantNotes SicCodes DateOfTrading TradingAsSoleTrader LinkedInUrl FacebookUrl TwitterUrl InstagramUrl AuthSelfAssessment AuthCorporationTax AuthPayeForEmployers AuthIndividualPayAsYouEarn AuthVat AuthConstructionIndustryScheme AuthTaxCredits AuthHighIncomeChildBenefitCharge AuthMakingTaxDigitalIncomeTax AuthMakingTaxDigitalVat AuthTrusts AmlClientId Notes2 Notes3 Notes4 Notes5 VatFlatRateScheme AmlContactId RelatedClientName ContactIsPrimary ContactJobTitle RegisteredAddressCounty PostalAddressCounty InvoiceAddressCounty ContactPreferredName CanContactWhatsApp
|
