`invoices.filesExtract`

Read an uploaded invoice file and return extracted invoice candidates with suggested customers. For CSV files, first call without csvMapping to get headers, then call again with the confirmed column mapping.

GETPOST/api/v1/accounting/invoices.filesExtract

Permissions

accounting:read

Who can call it

admin, finance

Retries

Safe to retry: it only reads

MCP

accounting_invoices_files_extract

Fields

sha256stringRequired
The SHA-256 hash of the file's exact bytes, as 64 lowercase hex characters.
SHA-256 hash as 64 lowercase hex characters
filenamestringRequired
The file's name, including its extension.
1–200 characters
mimeTypestringRequired
The file's type, such as image/jpeg or application/pdf.
at most 150 characters
csvMappingobject or null

curl -G https://app.getoatmilk.com/api/v1/accounting/invoices.filesExtract \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  --data-urlencode 'sha256=9f2b5c1d7e3a4b6c8d0e2f4a6b8c0d2e4f6a8b0c2d4e6f8a0b2c4d6e8f0a2b4c' \
  --data-urlencode 'filename=receipt.pdf' \
  --data-urlencode 'mimeType=example'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/invoices.filesExtract?sha256=9f2b5c1d7e3a4b6c8d0e2f4a6b8c0d2e4f6a8b0c2d4e6f8a0b2c4d6e8f0a2b4c&filename=receipt.pdf&mimeType=example", {
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
  },
});
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.get(
    "https://app.getoatmilk.com/api/v1/accounting/invoices.filesExtract",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    params={
        "sha256": "9f2b5c1d7e3a4b6c8d0e2f4a6b8c0d2e4f6a8b0c2d4e6f8a0b2c4d6e8f0a2b4c",
        "filename": "receipt.pdf",
        "mimeType": "example",
    },
    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

GET/api/v1/accounting/invoices.filesExtract

curl -G https://app.getoatmilk.com/api/v1/accounting/invoices.filesExtract \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  --data-urlencode 'sha256=9f2b5c1d7e3a4b6c8d0e2f4a6b8c0d2e4f6a8b0c2d4e6f8a0b2c4d6e8f0a2b4c' \
  --data-urlencode 'filename=receipt.pdf' \
  --data-urlencode 'mimeType=example'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/invoices.filesExtract?sha256=9f2b5c1d7e3a4b6c8d0e2f4a6b8c0d2e4f6a8b0c2d4e6f8a0b2c4d6e8f0a2b4c&filename=receipt.pdf&mimeType=example", {
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
  },
});
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.get(
    "https://app.getoatmilk.com/api/v1/accounting/invoices.filesExtract",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    params={
        "sha256": "9f2b5c1d7e3a4b6c8d0e2f4a6b8c0d2e4f6a8b0c2d4e6f8a0b2c4d6e8f0a2b4c",
        "filename": "receipt.pdf",
        "mimeType": "example",
    },
    timeout=30,
)
payload = response.json()
if not response.ok:
    raise RuntimeError(f"{payload['error']['code']}: {payload['error']['message']}")
print(payload["data"])

Fields

Fields inside csvMapping

Example

Try it