`imports.preview`

Validate a CSV import using accountId, csv text and mapping with date, description, amount or debit/credit, and dateFormat. Returns errors without booking transactions.

POST/api/v1/accounting/imports.preview

Permissions

accounting:read

Who can call it

admin, finance

Retries

Safe to retry: it only reads

MCP

accounting_preview_bank_import

Fields

accountIdstring (ID)Required
The ID of a bank, card or payment account, from accounts.list.
csvstringRequired
at most 5000000 characters
filenamestring
The file's name, including its extension.
1–255 characters · Default "statement.csv"
currencystringRequired
Three-letter currency code, such as CAD or USD.
mappingobjectRequired
No other fields

curl https://app.getoatmilk.com/api/v1/accounting/imports.preview \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "accountId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
  "csv": "example",
  "currency": "CAD",
  "mapping": {
    "date": "2026-09-30",
    "description": "Synthetic example from the docs",
    "dateFormat": "YYYY-MM-DD"
  }
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/imports.preview", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "accountId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
    "csv": "example",
    "currency": "CAD",
    "mapping": {
      "date": "2026-09-30",
      "description": "Synthetic example from the docs",
      "dateFormat": "YYYY-MM-DD"
    }
  }),
});
const { data, error } = await response.json();
if (!response.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);

import os

import requests

response = requests.post(
    "https://app.getoatmilk.com/api/v1/accounting/imports.preview",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    json={
        "accountId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
        "csv": "example",
        "currency": "CAD",
        "mapping": {
            "date": "2026-09-30",
            "description": "Synthetic example from the docs",
            "dateFormat": "YYYY-MM-DD",
        },
    },
    timeout=30,
)
payload = response.json()
if not response.ok:
    raise RuntimeError(f"{payload['error']['code']}: {payload['error']['message']}")
print(payload["data"])

Response

{
  "data": { … }
}

Try it

Checks your input with this action’s real schema and answers like the API, with synthetic data. No key needed, and nothing changes.

Input

POST/api/v1/accounting/imports.preview

curl https://app.getoatmilk.com/api/v1/accounting/imports.preview \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "accountId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
  "csv": "example",
  "currency": "CAD",
  "mapping": {
    "date": "2026-09-30",
    "description": "Synthetic example from the docs",
    "dateFormat": "YYYY-MM-DD"
  }
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/imports.preview", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "accountId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
    "csv": "example",
    "currency": "CAD",
    "mapping": {
      "date": "2026-09-30",
      "description": "Synthetic example from the docs",
      "dateFormat": "YYYY-MM-DD"
    }
  }),
});
const { data, error } = await response.json();
if (!response.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);

import os

import requests

response = requests.post(
    "https://app.getoatmilk.com/api/v1/accounting/imports.preview",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    json={
        "accountId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
        "csv": "example",
        "currency": "CAD",
        "mapping": {
            "date": "2026-09-30",
            "description": "Synthetic example from the docs",
            "dateFormat": "YYYY-MM-DD",
        },
    },
    timeout=30,
)
payload = response.json()
if not response.ok:
    raise RuntimeError(f"{payload['error']['code']}: {payload['error']['message']}")
print(payload["data"])

Fields

Fields inside mapping

Example

Try it