API Docs / Schemas / CsvExportRequestDto

CsvExportRequestDto

Request to start a CSV export of clients.
Specify column mappings and optional filter criteria to control the export output.

Properties

Name Type Description
mappingCodestring

Code of an existing saved mapping to use for column headers.
Use GET /clients/import/csv/mappings to list available mappings.
Mutually exclusive with ColumnMappings - provide one or the other.
If neither is provided, all fields are exported with enum names as headers.

Code of an existing saved mapping to use for column headers.
Use GET /clients/import/csv/mappings to list available mappings.
Mutually exclusive with ColumnMappings - provide one or the other.
If neither is provided, all fields are exported with enum names as headers.

columnMappingsarray of CsvColumnMappingDto

Inline column mappings for the export.
Each mapping specifies which client field maps to which CSV header.
Mutually exclusive with MappingCode - provide one or the other.
If neither is provided, all fields are exported with enum names as headers.

Inline column mappings for the export.
Each mapping specifies which client field maps to which CSV header.
Mutually exclusive with MappingCode - provide one or the other.
If neither is provided, all fields are exported with enum names as headers.

includeHeadersboolean

Whether to include a header row in the CSV output.
Default: true

Whether to include a header row in the CSV output.
Default: true

filterCsvExportFilterDto

JSON Example

{
  "mappingCode": "string",
  "columnMappings": [
    {
      "csvHeader": "...",
      "targetField": "..."
    }
  ],
  "includeHeaders": false,
  "filter": {
    "managerCodes": [
      "..."
    ],
    "partnerCodes": [
      "..."
    ],
    "associateCodes": [
      "..."
    ],
    "statuses": [
      "..."
    ],
    "types": [
      "..."
    ]
  }
}

Used By Operations