Spey
Books
API
API Reference
Search
⌘K
Introduction
Getting Started
Quick Start
Authentication Setup
Developer Shell
Your First Invoice
Concepts
Double-Entry Bookkeeping
Chart of Accounts
VAT Handling
Guides
VAT Returns
Bank Reconciliation
CSV Import
Dividends
Webhooks Guide
Error Handling
Director Loans & S455
Categorisation Rules
Reports
Migration
Invoices & Quotes
Contacts & Directors
Transactions & Journals
Opening Balances
API Reference
Overview
Authentication
Errors
Pagination
Conventions
Rate Limiting
Core
Auth
Overview
Login with username and password
Logout
Get current user
Change password
Refresh access token
Disable TOTP
Verify and enable TOTP
Generate TOTP secret for setup
Verify TOTP code
Verify email with token
Send verification email to current user
Check email verification status
Request password reset email
Reset password with token
Validate a password reset token
Register a new user and organisation
Organisation
Overview
The Organisation object
Get organisation details and settings
Update organisation profile
Update organisation settings
Accounting
Accounts
Overview
The Accounts object
List chart of accounts
Create an account
Get account types with counts
Get account details
Update an account
Delete an account
Get account balance
Transactions
Overview
The Transactions object
List transactions
Create a transaction
Get account ledger
Get transaction details
Delete a draft transaction
Categorise a transaction
Reconcile a transaction
Update transaction status
Suggest transaction category
Invoices
Overview
The Invoices object
Send invoice via email
Download invoice as PDF
List invoices
Create an invoice
Preview invoice calculations
Retrieve an invoice
Update a draft invoice
Delete a draft invoice
Record a payment
Update invoice status
Quotes
Overview
The Quotes object
List quotes
Create a new quote
Preview quote calculations
Get quote details
Update a quote
Delete a draft quote
Convert quote to invoice
Update quote status
Contacts
Overview
The Contacts object
List contacts
Create a contact
Get contact details
Update a contact
Deactivate a contact
Get contact financial summary
Reports
Overview
Aged Creditors Report
Aged Debtors Report
Balance Sheet
Dashboard summary
List financial periods
Get financial period details
Profit & Loss
Trial Balance
VAT Return Summary
Banking
Bank Accounts
Overview
The Bank Accounts object
List bank accounts
Bank Imports
Overview
List bank imports
Upload bank statement
Get bank import details
Delete a bank import
Confirm bank import
Remap bank import columns
Categorisation Rules
Overview
The Categorisation Rules object
List categorisation rules
Create categorisation rule
Create rule from import categorisation
List global consensus rules with tenant account resolution
Reorder rules by updating priorities
Test a value against categorisation rules
Update categorisation rule
Delete categorisation rule
Company
Directors
Overview
The Directors object
List directors and shareholders
Add a director or shareholder
Get director details
Update director details
Resign a director
Director Loans
Overview
List Director Loan Account transactions
Record a Director Loan Account transaction
Get DLA running balance per director
Get DLA balance for a single director
S455 Corporation Tax exposure summary
Create year-end DLA snapshot with S455 and BiK calculations
List year-end DLA snapshots
Dividends
Overview
List dividends
Declare a dividend for a director
List board minutes
Record board minutes approving a dividend declaration
Get board minutes with associated dividends
Check available retained profits for dividend declaration
Dividend summary by financial year
Calculate UK dividend tax liability
Get dividend details
Mark a dividend as paid
Void a dividend and reverse its journal entries
Download dividend voucher as PDF
Board Minutes
Overview
Download board minutes as PDF
Import & Migration
Contact Imports
Overview
The Contact Imports object
List contact imports
Upload contacts file
Get contact import details
Delete a contact import
Confirm contact import
Resolve identity conflicts
Opening Balances
Overview
The Opening Balances object
Get opening balance status
Upload opening balances
Get opening balance details
Delete an opening balance import
Confirm opening balances
Map opening balance accounts
Void opening balances
Invoice Imports
Overview
The Invoice Imports object
Upload invoices file
Get invoice import details
Delete an invoice import
Confirm invoice import
Void invoice import
Bill Imports
Overview
The Bill Imports object
Upload bills file
Get bill import details
Delete a bill import
Confirm bill import
Void bill import
Migration
Overview
Create a new migration
Get active migration
List migration history
Get migration details
Abandon a migration
Execute migration
Upload migration data
Upload deferred migration data
Upload provider export
Validate migration data
Integration
API Keys
Overview
The API Keys object
List API keys
Create API key
List available API key scopes
Update API key name
Revoke API key
Rotate API key
Webhooks
Overview
The Webhooks object
List webhook endpoints
Create webhook endpoint
Update webhook endpoint
Delete webhook endpoint
Webhook delivery log
Rotate webhook signing secret
API Request Log
Overview
The API Request Log object
List API request log entries
Get API request log entry detail
Platform
Billing
Overview
The Billing object
Create checkout session
List subscription plans
Create billing portal session
Get billing status
Bug Reports
Overview
The Bug Reports object
List bug reports
Submit a bug report
Get bug report details
Stripe Webhooks
Overview
Handle Stripe webhook events
Health
Overview
Health check
Transparency
Overview
Recent transparency entries
Transparency statistics
Public
Overview
Get early access availability
Admin
Admin
Overview
View audit log
Bulk delete bug reports
Delete a bug report
List organisations
Get organisation details
Update organisation
Delete organisation
Cancel subscription
Refund payment
Retry payment
Search platform
Get platform settings
Update platform setting
Platform statistics
Clear system cache
System health check
Replay failed webhooks
List failed webhooks
List users
Get user details
Delete user
Disable user MFA
Impersonate user
Update user role
Send password reset
Suspend user
Unlock user
Unsuspend user
Admin Bug Reports
Overview
List bug reports (admin)
Get bug report (admin)
Update bug report status
Stripe Webhooks
Endpoints
POST
https://app.speybooks.com/api/v1/stripe-webhook/stripe
Handle Stripe webhook events