`payouts.statement`

Download a payment statement (PDF) for one of your paid payouts by id: what it was for, fees, GST/HST, total and date. It isn't a pay stub.

GETPOST/api/v1/contractor/payouts.statement

Permissions

contractor:read

Who can call it

contractor

Retries

Safe to retry: it only reads

MCP

contractor_payouts_statement

Fields

idstring (ID)Required
The record's ID.

curl -G https://app.getoatmilk.com/api/v1/contractor/payouts.statement \
  -H "Authorization: Bearer $OATMILK_OAUTH_TOKEN" \
  -H "X-Accounting-Organization: $OATMILK_ORGANIZATION_ID" \
  --data-urlencode 'id=9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d'

const response = await fetch("https://app.getoatmilk.com/api/v1/contractor/payouts.statement?id=9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d", {
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_OAUTH_TOKEN}`,
    "X-Accounting-Organization": process.env.OATMILK_ORGANIZATION_ID,
  },
});
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/contractor/payouts.statement",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_OAUTH_TOKEN']}",
        "X-Accounting-Organization": os.environ["OATMILK_ORGANIZATION_ID"],
    },
    params={
        "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
    },
    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/contractor/payouts.statement

curl -G https://app.getoatmilk.com/api/v1/contractor/payouts.statement \
  -H "Authorization: Bearer $OATMILK_OAUTH_TOKEN" \
  -H "X-Accounting-Organization: $OATMILK_ORGANIZATION_ID" \
  --data-urlencode 'id=9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d'

const response = await fetch("https://app.getoatmilk.com/api/v1/contractor/payouts.statement?id=9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d", {
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_OAUTH_TOKEN}`,
    "X-Accounting-Organization": process.env.OATMILK_ORGANIZATION_ID,
  },
});
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/contractor/payouts.statement",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_OAUTH_TOKEN']}",
        "X-Accounting-Organization": os.environ["OATMILK_ORGANIZATION_ID"],
    },
    params={
        "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
    },
    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