# 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:read`, `contractor:write` · Roles: contractor · Idempotency key required

MCP tool: `contractor_invoice_prepare`

## Fields

| Field | Type | Required | Notes |
| --- | --- | --- | --- |
| `periodId` | string (ID) | Yes | The ID of a contractor pay period. |
| `filename` | string | Yes | The file's name, including its extension. 1–255 characters. |
| `mimeType` | enum | Yes | The file's type, such as image/jpeg or application/pdf. One of: `application/pdf`, `image/png`, `image/jpeg`. |
| `sizeBytes` | integer | Yes | The file's size in bytes. at most 20000000; greater than 0. |
| `sha256` | string | Yes | The SHA-256 hash of the file's exact bytes, as 64 lowercase hex characters. SHA-256 hash as 64 lowercase hex characters. |
| `idempotencyKey` | string | Yes | 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. |

## Example request

```bash
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"
}'
```

Reference page: https://app.getoatmilk.com/docs/api/contractor/invoice.prepare