`invoice.prepare`

Get a private upload link for an invoice (a PDF, PNG or JPEG up to 20 MB, with its size and SHA-256) for one of your pay periods.

POST/api/v1/contractor/invoice.prepare

Permissions

contractor:readcontractor:write

Who can call it

contractor

Retries

Idempotency key required

MCP

contractor_invoice_prepare

Fields

periodIdstring (ID)Required
The ID of a contractor pay period.
filenamestringRequired
The file's name, including its extension.
1–255 characters
mimeTypeenumRequired
The file's type, such as image/jpeg or application/pdf.
application/pdfimage/pngimage/jpeg
sizeBytesintegerRequired
The file's size in bytes.
at most 20000000 · greater than 0
sha256stringRequired
The SHA-256 hash of the file's exact bytes, as 64 lowercase hex characters.
SHA-256 hash as 64 lowercase hex characters
idempotencyKeystringRequired
Any unique text you generate once per intended change, so a retried request only happens once. Send it as the Idempotency-Key header instead if you prefer; if you send both they must match.
8–200 characters

curl https://app.getoatmilk.com/api/v1/contractor/invoice.prepare \
  -H "Authorization: Bearer $OATMILK_OAUTH_TOKEN" \
  -H "X-Accounting-Organization: $OATMILK_ORGANIZATION_ID" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "periodId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
  "filename": "receipt.pdf",
  "mimeType": "application/pdf",
  "sizeBytes": 1,
  "sha256": "9f2b5c1d7e3a4b6c8d0e2f4a6b8c0d2e4f6a8b0c2d4e6f8a0b2c4d6e8f0a2b4c"
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/contractor/invoice.prepare", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_OAUTH_TOKEN}`,
    "X-Accounting-Organization": process.env.OATMILK_ORGANIZATION_ID,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "periodId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
    "filename": "receipt.pdf",
    "mimeType": "application/pdf",
    "sizeBytes": 1,
    "sha256": "9f2b5c1d7e3a4b6c8d0e2f4a6b8c0d2e4f6a8b0c2d4e6f8a0b2c4d6e8f0a2b4c"
  }),
});
const { data, error } = await response.json();
if (!response.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);

import os
import uuid

import requests

response = requests.post(
    "https://app.getoatmilk.com/api/v1/contractor/invoice.prepare",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_OAUTH_TOKEN']}",
        "X-Accounting-Organization": os.environ["OATMILK_ORGANIZATION_ID"],
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "periodId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
        "filename": "receipt.pdf",
        "mimeType": "application/pdf",
        "sizeBytes": 1,
        "sha256": "9f2b5c1d7e3a4b6c8d0e2f4a6b8c0d2e4f6a8b0c2d4e6f8a0b2c4d6e8f0a2b4c",
    },
    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/contractor/invoice.prepare

curl https://app.getoatmilk.com/api/v1/contractor/invoice.prepare \
  -H "Authorization: Bearer $OATMILK_OAUTH_TOKEN" \
  -H "X-Accounting-Organization: $OATMILK_ORGANIZATION_ID" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "periodId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
  "filename": "receipt.pdf",
  "mimeType": "application/pdf",
  "sizeBytes": 1,
  "sha256": "9f2b5c1d7e3a4b6c8d0e2f4a6b8c0d2e4f6a8b0c2d4e6f8a0b2c4d6e8f0a2b4c"
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/contractor/invoice.prepare", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_OAUTH_TOKEN}`,
    "X-Accounting-Organization": process.env.OATMILK_ORGANIZATION_ID,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "periodId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
    "filename": "receipt.pdf",
    "mimeType": "application/pdf",
    "sizeBytes": 1,
    "sha256": "9f2b5c1d7e3a4b6c8d0e2f4a6b8c0d2e4f6a8b0c2d4e6f8a0b2c4d6e8f0a2b4c"
  }),
});
const { data, error } = await response.json();
if (!response.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);

import os
import uuid

import requests

response = requests.post(
    "https://app.getoatmilk.com/api/v1/contractor/invoice.prepare",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_OAUTH_TOKEN']}",
        "X-Accounting-Organization": os.environ["OATMILK_ORGANIZATION_ID"],
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "periodId": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
        "filename": "receipt.pdf",
        "mimeType": "application/pdf",
        "sizeBytes": 1,
        "sha256": "9f2b5c1d7e3a4b6c8d0e2f4a6b8c0d2e4f6a8b0c2d4e6f8a0b2c4d6e8f0a2b4c",
    },
    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