`dataImports.preview`

Read every row of the database with a column mapping and group the rows: ready, needs a decision (a new or ambiguous customer or contractor, an invoice number already in Oatmilk, or a possible duplicate payment), already imported, can't import (with the reason), or left out. Nothing is saved. Payment and tax columns are never read, and what they hold is hidden anywhere else in the preview.

GETPOST/api/v1/accounting/dataImports.preview

Permissions

accounting:read

Who can call it

admin, finance

Retries

Safe to retry: it only reads

MCP

accounting_data_imports_preview

Fields

targetenumRequired
invoicescontractor_payments
sourceenum
Where the record came from.
notion
Default "notion"
databaseIdstringRequired
1–200 characters
mappingobjectRequired
No other fields

curl https://app.getoatmilk.com/api/v1/accounting/dataImports.preview \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "target": "invoices",
  "databaseId": "example",
  "mapping": {
    "columns": {}
  }
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/dataImports.preview", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "target": "invoices",
    "databaseId": "example",
    "mapping": {
      "columns": {}
    }
  }),
});
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/dataImports.preview",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    json={
        "target": "invoices",
        "databaseId": "example",
        "mapping": {
            "columns": {},
        },
    },
    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/dataImports.preview

curl https://app.getoatmilk.com/api/v1/accounting/dataImports.preview \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "target": "invoices",
  "databaseId": "example",
  "mapping": {
    "columns": {}
  }
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/dataImports.preview", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "target": "invoices",
    "databaseId": "example",
    "mapping": {
      "columns": {}
    }
  }),
});
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/dataImports.preview",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    json={
        "target": "invoices",
        "databaseId": "example",
        "mapping": {
            "columns": {},
        },
    },
    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