Clients - CSV Import
CSV-based client import with flexible column mapping. Upload a CSV file to get a preview with auto-suggested column mappings. Configure mappings using system defaults (Limited Company, Individual) or create custom mappings. Start the import with sync-when-fast pattern (waits up to 10 seconds, returns 201 if completed, 202 if still processing). Supports create-only, update-only, or create-and-update modes with configurable match fields (CompanyNumber, Code, Name, etc.).
-
POST Upload Client CSVUploads a CSV file for importing clients. With showPreview=true (default), returns 201 with preview data. With showPreview=false and a mapping provide.../tenants/{tenant}/clients/import/csv
-
GET Get Import StatusReturns the current status and progress of a CSV import job. Poll this endpoint after receiving a 202 Accepted response./tenants/{tenant}/clients/import/csv/{code}
-
PUT Start CSV ImportConfirms the column mapping and starts the CSV import. Call after uploading with showPreview=true./tenants/{tenant}/clients/import/csv/{code}