`documents.records.get`

Read one record's details as labelled values to put into a document, such as a contractor's or customer's legal name, email, phone and address, a merchant's website, a teammate's name and role, or the company's legal name, address and business number. Pass type and id from documents.records.search (id is "company" for the company).

GETPOST/api/v1/accounting/documents.records.get

Permissions

accounting:read

Who can call it

admin, finance

Retries

Safe to retry: it only reads

MCP

accounting_documents_records_get

Fields

typeenumRequired
contractorpartymerchantmembercompany
idstringRequired
The record's ID.
1–200 characters

curl -G https://app.getoatmilk.com/api/v1/accounting/documents.records.get \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  --data-urlencode 'type=contractor' \
  --data-urlencode 'id=example'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/documents.records.get?type=contractor&id=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/documents.records.get",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    params={
        "type": "contractor",
        "id": "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/documents.records.get

curl -G https://app.getoatmilk.com/api/v1/accounting/documents.records.get \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  --data-urlencode 'type=contractor' \
  --data-urlencode 'id=example'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/documents.records.get?type=contractor&id=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/documents.records.get",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    params={
        "type": "contractor",
        "id": "example",
    },
    timeout=30,
)
payload = response.json()
if not response.ok:
    raise RuntimeError(f"{payload['error']['code']}: {payload['error']['message']}")
print(payload["data"])

Fields

Example

Try it