API Docs / Schemas / CreateCsvMappingRequest

CreateCsvMappingRequest

Request to create a new reusable CSV mapping.
Saved mappings can be referenced by code in future imports/exports,
eliminating the need to specify column mappings each time.

Properties

Name Type Description
name*string

Human-readable display name for this mapping.
Choose a descriptive name that identifies the CSV format (e.g., 'IRIS Export', 'Xero Contacts').
Required.

Human-readable display name for this mapping.
Choose a descriptive name that identifies the CSV format (e.g., 'IRIS Export', 'Xero Contacts').
Required.

columnMappings*array of CsvColumnMappingDto

The column mappings that define how CSV headers map to client fields.
Each mapping specifies a CSV header and the corresponding target field.
Required - must include at least one mapping.

The column mappings that define how CSV headers map to client fields.
Each mapping specifies a CSV header and the corresponding target field.
Required - must include at least one mapping.

matchFieldenum

Code Name CompanyNumber InternalReference NiNumber

Code Name CompanyNumber InternalReference NiNumber

mappingType*enum

Client

Client

JSON Example

{
  "name": "string",
  "columnMappings": [
    {
      "csvHeader": "...",
      "targetField": "..."
    }
  ],
  "matchField": "Code",
  "mappingType": "Client"
}

Used By Operations