API reference
API reference
Every Oatmilk action, with its permissions, fields, examples and a place to try it.
The basics
Every action is a POST to its own address with a JSON object, and read actions also accept GET. Send your API key as a bearer token. Results come back in data; problems come back in error with a stable code. See Making requests.
POST https://app.getoatmilk.com/api/v1/accounting/<action>
Authorization: Bearer $OATMILK_API_KEY
Content-Type: application/json
Idempotency-Key: <one per change>775 company actions and 43 contractor actions, generated from the definitions the API checks requests against. The same reference is available as OpenAPI 3.1 and as plain text for AI tools. Press ⌘K to jump to any action by name.
Actions by area
Each area is also an MCP toolset, so an AI assistant can connect with only what it needs.
- TransactionsEntries, bank and card lines, categories, tags, accounts, reconciliation and statements.115 actions
- Inbox and uploadsReceipts, file uploads, company mail, connected inboxes and processing jobs.56 actions
- MatchingMatch receipts to bank transactions and review the decisions.11 actions
- AutopilotWhat needs a person, Autopilot runs, receipt reminders and the investigator.30 actions
- InvoicingInvoices, customers and vendors, and how they pay.50 actions
- Documents and signingAgreements, e-signatures and kept records such as tax returns.60 actions
- ContractorsThe finance side of contractors: directory, timesheets, payouts and recruiting.144 actions
- Contractor portalA contractor's own hours, pay, agreements and profile, with a contractor sign-in.43 actions
- Reports and taxReports, exports, insights, subscriptions and tax preparation.71 actions
- ComplianceThe compliance checklist, deadlines and reminders.10 actions
- StripeStripe activity, payouts, exceptions and tax confirmation.14 actions
- Connectors and webhooksWebhooks, Wise, Notion, Google Drive and other data sources.59 actions
- AI and memoryAI settings, classifier guidance, memory, the sandbox and compliance research.45 actions
- AdministrationCompany settings, people, API keys, email, runs and suggestions.95 actions
- History and rollbackEvery change anyone made to the company, who made it and how, and previewed rollbacks.7 actions
- Budgets and reservesSpending plans, tax and accountant costs, reserve accounts and funding gaps before filing.8 actions