API Reference
The SpeyBooks API exposes 31 resources across 197 endpoints, organised into eight categories.
All endpoints share a consistent design: prefixed IDs, monetary values in minor units (pence), ISO 8601 dates, and a { success, data } response envelope. See Conventions for the full contract.
Core
Foundation resources for authentication and tenant configuration.
| Resource | Endpoints | Description |
|---|---|---|
| Auth | 16 | Authentication, sessions, TOTP, password reset, registration |
| Organisation | 5 | Company identity, VAT scheme, fiscal year, settings |
Accounting
Double-entry bookkeeping, invoicing, and financial reporting.
| Resource | Endpoints | Description |
|---|---|---|
| Accounts | 7 | Chart of accounts — assets, liabilities, equity, revenue, expenses |
| Transactions | 9 | Journal entries with double-entry validation |
| Invoices | 11 | Sales invoices with line items and VAT |
| Quotes | 8 | Quotes and estimates, convertible to invoices |
| Credit Notes | 7 | |
| Contacts | 6 | Customers, suppliers, and contact management |
| Reports | 10 | Trial balance, P&L, balance sheet, VAT returns |
Banking
Bank account connections, statement imports, and transaction matching.
| Resource | Endpoints | Description |
|---|---|---|
| Bank Accounts | 2 | Linked bank accounts |
| Bank Imports | 6 | CSV statement upload, preview, and confirm |
| Categorisation Rules | 8 | Automatic transaction categorisation |
Company
UK limited company administration — directors, dividends, and loans.
| Resource | Endpoints | Description |
|---|---|---|
| Directors | 5 | Director records and appointments |
| Director Loans | 7 | DLA tracking and repayments |
| Dividends | 12 | Dividend declarations and vouchers |
| Board Minutes | 1 | Board minute records |
Import & Migration
Bulk data import and provider migration tools.
| Resource | Endpoints | Description |
|---|---|---|
| Contact Imports | 6 | CSV contact import pipeline |
| Opening Balances | 7 | Opening balance import and verification |
| Invoice Imports | 5 | Bulk invoice import |
| Bill Imports | 5 | Bulk bill/purchase import |
| Migration | 10 | Provider migration wizard |
Integration
API keys, webhooks, and request auditing.
| Resource | Endpoints | Description |
|---|---|---|
| API Keys | 6 | Key management, scoped permissions |
| Webhooks | 6 | Event subscriptions and delivery |
| API Request Log | 2 | Request audit trail |
Platform
Billing, bug reports, and system health.
| Resource | Endpoints | Description |
|---|---|---|
| Billing | 5 | Subscription and payment management |
| Bug Reports | 3 | In-app bug reporting |
| Stripe Webhooks | 1 | Stripe event handler |
| Health | 1 | System health check |
| Transparency | 2 | Public bug tracker feed |
| Public | 3 | Public endpoints (no auth) |
Admin
Platform administration and user management. Requires admin role.
| Resource | Endpoints | Description |
|---|---|---|
| Admin | 31 | System settings, stats, moderation |
| Admin Bug Reports | 3 | Bug report triage and resolution |