ReferenceDevelopers

SimpleBooks API

Bramble SimpleBooks: bookkeeping for sole traders. Companies, receipts read automatically from photos and PDFs, categories, income, customers and invoices, the Self Assessment summary, and exports. Companies and who can use them are set up in the Admin Centre API.

Address: https://<your-org>.brambleit.cloud/simplebooks
Sign-in: Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Address: https://<your-org>.brambleit.cloud/api
Sign-in: Signed-in session, X-API-Key, or a Bramble app access token (Authorization: Bearer).
Endpoints: 55
OpenAPI: simplebooks.json
Guides: How SimpleBooks works

Everything is per company. Paths start /api/companies/:companyId/. Each person has a role in each company — owner, bookkeeper, submitter (can add receipts) or viewer — and some companies switch modules (invoicing, income) on or off.

Tax years follow the company's year end (31 March unless set otherwise) and are written like 2025-26.

Resources

Companies

A company's details, categories summary, tax years, summary figures and activity.

Method	Path	Summary
GET	`/api/me`	Who you are: the signed-in person and what they can do here
GET	`/api/companies/:companyId`	Get a company
PUT	`/api/companies/:companyId`	Update a company
GET	`/api/companies/:companyId/tax-years`	Tax years with data
GET	`/api/companies/:companyId/summary`	A tax year's figures
GET	`/api/companies/:companyId/activity`	Recent activity

Receipts

Receipts and their files, read automatically (merchant, date, total, VAT), categories, the bin, and reprocessing.

Method	Path	Summary
POST	`/api/companies/:companyId/categories`	Add a category
PATCH	`/api/companies/:companyId/categories/:id`	Update a category
GET	`/api/companies/:companyId/receipts`	List receipts
POST	`/api/companies/:companyId/receipts`	Add a receipt
GET	`/api/companies/:companyId/receipts/:id`	Get a receipt
PATCH	`/api/companies/:companyId/receipts/:id`	Update a receipt
DELETE	`/api/companies/:companyId/receipts/:id`	Move a receipt to the bin
POST	`/api/companies/:companyId/receipts/:id/restore`	Restore a receipt from the bin
POST	`/api/companies/:companyId/receipts/:id/reprocess`	Read a receipt again
GET	`/api/companies/:companyId/receipts/:id/file/:kind`	Decrypted file. Only ever served from here — authenticated and checked against the user's access to this receipt

Invoices & customers

Customers, invoice settings, invoices, sending them, PDFs, and payments.

Method	Path	Summary
GET	`/api/companies/:companyId/customers`	List customers
POST	`/api/companies/:companyId/customers`	Add a customer
PUT	`/api/companies/:companyId/customers/:id`	Update a customer
GET	`/api/companies/:companyId/invoice-settings`	Invoice settings
PUT	`/api/companies/:companyId/invoice-settings`	Update invoice settings
GET	`/api/companies/:companyId/invoices`	List invoices
GET	`/api/companies/:companyId/invoices/summary`	Money owed right now, plus this tax year's invoicing — for Home and Tax year
POST	`/api/companies/:companyId/invoices`	Create an invoice
GET	`/api/companies/:companyId/invoices/:id`	Get an invoice
PUT	`/api/companies/:companyId/invoices/:id`	Update an invoice
POST	`/api/companies/:companyId/invoices/:id/duplicate`	Copy an invoice
DELETE	`/api/companies/:companyId/invoices/:id`	Delete a draft invoice
POST	`/api/companies/:companyId/invoices/:id/void`	Void an invoice
POST	`/api/companies/:companyId/invoices/:id/send`	Send an invoice
GET	`/api/companies/:companyId/invoices/:id/pdf`	An invoice as PDF
POST	`/api/companies/:companyId/invoices/:id/payments`	Record a payment
DELETE	`/api/companies/:companyId/invoices/:id/payments/:paymentId`	Remove a payment

Income

Money received (cash basis), including invoice payments.

Method	Path	Summary
GET	`/api/companies/:companyId/income`	List income
GET	`/api/companies/:companyId/income/summary`	Income received in a tax year (cash basis): invoice payments + the log
POST	`/api/companies/:companyId/income`	Record income
PUT	`/api/companies/:companyId/income/:id`	Update income
DELETE	`/api/companies/:companyId/income/:id`	Delete income

Self Assessment

The year's figures for Self Assessment, marking it filed, and the PDF.

Method	Path	Summary
GET	`/api/companies/:companyId/tax-return`	A year's Self Assessment figures
PUT	`/api/companies/:companyId/tax-return`	Save Self Assessment choices
POST	`/api/companies/:companyId/tax-return/file`	Mark a year filed
POST	`/api/companies/:companyId/tax-return/reopen`	Reopen a filed year
GET	`/api/companies/:companyId/tax-return/pdf`	Self Assessment summary as PDF

Exports

A tax year as CSV, or a zip of receipts and files for one or more years.

Method	Path	Summary
POST	`/api/companies/:companyId/exports`	Start a zip export
GET	`/api/companies/:companyId/exports/:exportId`	An export's progress
GET	`/api/companies/:companyId/exports/:exportId/download`	Download an export

Where "Share to SimpleBooks" from a phone lands.

Method	Path	Summary
POST	`/share-target`	"Share → SimpleBooks" is normally caught by the service worker; if it isn't running yet, just open the app

Legacy (SimpleBooks v1)

Endpoints of the original SimpleBooks, kept for reference.

Method	Path	Summary
GET	`/app/simplebooks/version`	Version (legacy)
GET	`/app/simplebooks/companies`	List companies (legacy)
GET	`/app/simplebooks/companies/has-membership`	Does the person have a company? (legacy)
POST	`/app/simplebooks/companies/create`	Create a company (legacy)
POST	`/app/simplebooks/company/receipts`	Receipts for a month (legacy)
POST	`/app/simplebooks/company/receipts/total/year`	Year total (legacy)
POST	`/app/simplebooks/company/receipts/total/month`	Month total (legacy)

Export

Method	Path	Summary
GET	`/api/companies/:companyId/export.csv`	One tax year as a spreadsheet — same columns as the CSV inside the ZIP

Web pages

These return pages for the browser rather than data.

GET /
GET /sw.js