CsvMappingDto

Represents a saved CSV mapping configuration.
Mappings define how CSV columns map to client fields and can be reused across imports and exports.
Preset mappings are available to all tenants; tenant mappings are private.

Properties

Name	Type	Description
code	string	Unique code identifying this mapping. Use this code in the mappingCode parameter when uploading or confirming an import/export. Preset codes: 'limited-company-clients', 'individual-clients'.
Unique code identifying this mapping. Use this code in the mappingCode parameter when uploading or confirming an import/export. Preset codes: 'limited-company-clients', 'individual-clients'.
name	string	Human-readable display name for this mapping.
Human-readable display name for this mapping.
columnMappings	array of CsvColumnMappingDto	The column mappings that define how CSV headers map to target fields. Each entry specifies a CSV header name and the corresponding client field.
The column mappings that define how CSV headers map to target fields. Each entry specifies a CSV header name and the corresponding client field.
matchField	enum	Code Name CompanyNumber InternalReference NiNumber
Code Name CompanyNumber InternalReference NiNumber
isPreset	boolean	True if this is a preset mapping available to all tenants. Preset mappings cannot be modified or deleted. False for tenant-specific custom mappings.
True if this is a preset mapping available to all tenants. Preset mappings cannot be modified or deleted. False for tenant-specific custom mappings.
mappingType	enum	Client
Client
createdDate	string	When this mapping was created (UTC).
When this mapping was created (UTC).
updatedDate	string	When this mapping was last updated (UTC). Null if never updated.
When this mapping was last updated (UTC). Null if never updated.

JSON Example

{
  "code": "string",
  "name": "string",
  "columnMappings": [
    {
      "csvHeader": "...",
      "targetField": "..."
    }
  ],
  "matchField": "Code",
  "isPreset": false
}

Used By Operations

Contained in Schemas

CsvMappingDtoPagedResult