Pre Import CSV data

The preimport endpoint is the first step when importing CSV data into Invoice Ninja. It validates your file(s) and returns the column headers found in each CSV, allowing you to map them to system fields before performing the actual import.

How it works

1. Set import_type to indicate the entity type (e.g. invoice, quote, client, product, payment, vendor, expense).
2. Attach one or more CSV files using the files[] parameter, keyed by entity type:
   • files[invoice] — invoice records
   • files[client] — client records
   • files[product] — product records
   • files[payment] — payment records
   • files[vendor] — vendor records
   • files[expense] — expense records
3. The response returns the detected column headers for each uploaded file so you can build a field mapping for the subsequent /api/v1/import call.

You may upload multiple entity files in a single request. Only include the entity types relevant to your import.

Example

curl -X POST 'https://invoiceninja.com/api/v1/preimport' \
  -H 'X-API-TOKEN: YOUR_API_TOKEN_HERE' \
  -H 'Accept: application/json' \
  -F 'import_type=invoice' \
  -F 'files[invoice]=@invoices.csv' \
  -F 'files[client]=@clients.csv'