CsvColumnMappingDto
Represents a single column mapping from a CSV header to a client field.
Used in column mapping configurations to specify how CSV data maps to client records.
Properties
| Name | Type | Description |
|---|---|---|
| csvHeader | string | The CSV column header name exactly as it appears in the file. |
The CSV column header name exactly as it appears in the file. | ||
| targetField | enum | 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 |
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 | ||
JSON Example
{
"csvHeader": "string",
"targetField": "Name"
}
Contained in Schemas
- ConfirmCsvImportRequest Request to confirm column mapping configuration and start a CSV import job. Used after uploading a C...
- CreateCsvMappingRequest Request to create a new reusable CSV mapping. Saved mappings can be referenced by code in future imp...
- CsvExportRequestDto Request to start a CSV export of clients. Specify column mappings and optional filter criteria to co...
- CsvMappingDto Represents a saved CSV mapping configuration. Mappings define how CSV columns map to client fields a...
- CsvUploadResponseDto Response from uploading a CSV file with showPreview=true. Contains a preview of the CSV data and aut...
- UpdateCsvMappingRequest Request to update an existing CSV mapping.