BrambleHelp
ReferenceSimpleBooks API

Export

MethodPathSummary
GET/api/companies/:companyId/export.csvOne tax year as a spreadsheet — same columns as the CSV inside the ZIP

#One tax year as a spreadsheet — same columns as the CSV inside the ZIP

GET/api/companies/:companyId/export.csv
Address
https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/export.csv
Requires
Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: SimpleBooks.

Path parameters

NameTypeDescription
companyIdrequiredinteger

Query parameters

NameTypeDescription
tax_yearany

Response

A download, a body.

Errors

StatusMessage
403Your role in this company doesn't allow exports

Example request

JavaScript
// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/simplebooks/api/companies/1/export.csv', {
  method: 'GET',
  credentials: 'include',
});
const data = await res.json();