Receipts

#Add a category

Address

https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/categories

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: SimpleBooks.

Path parameters

Request body JSON

Response 201

{
  "id": 42
}

Errors

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/simplebooks/api/companies/1/categories', {
  method: 'POST',
  credentials: 'include',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"name":"Example name","tax_key":"…","icon":"…"}),
});
const data = await res.json();

#Update a category

Address

https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/categories/:id

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: SimpleBooks.

Path parameters

Request body JSON

Response 200

{
  "ok": true
}

Errors

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/simplebooks/api/companies/1/categories/12.5', {
  method: 'PATCH',
  credentials: 'include',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"name":"Example name","tax_key":"…","archived":"…"}),
});
const data = await res.json();

#List receipts

Address

https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/receipts

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: SimpleBooks.

Path parameters

Query parameters

Response 200

{
  "receipts": [],
  "more": false
}

Example request

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

#Add a receipt

Address

https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/receipts

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: SimpleBooks.

Path parameters

Request body

multipart/form-data with the file, plus these fields:

Response duplicateUpload ? 200 : 201

{
  "id": 42,
  "duplicate_upload": null
}

Errors

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/simplebooks/api/companies/1/receipts', {
  method: 'POST',
  credentials: 'include',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"client_ref":"…","source":"…"}),
});
const data = await res.json();

#Get a receipt

Address

https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/receipts/:id

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: SimpleBooks.

Path parameters

Response 200

{
  "receipt": null,
  "suggestions": [],
  "ocr_text": "string",
  "original": {
    "mime": "string",
    "bytes": 1,
    "sha256": "string",
    "width": 1,
    "height": 1
  },
  "possible_duplicates": [
    {
      "id": 42,
      "merchant": "string",
      "total": 12.5,
      "receipt_date": "2026-11-12"
    }
  ],
  "can_edit": true
}

Example request

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

#Update a receipt

Address

https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/receipts/:id

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: SimpleBooks.

Path parameters

Request body JSON

Response 200

{
  "ok": true
}

Errors

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/simplebooks/api/companies/1/receipts/42', {
  method: 'PATCH',
  credentials: 'include',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"merchant":"string","description":"string","notes":"string","payment_method":"…","receipt_date":"2026-11-12","business_pct":12.5,"category_id":"string","confirm":"…"}),
});
const data = await res.json();

#Move a receipt to the bin

Address

https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/receipts/:id

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: SimpleBooks.

Path parameters

Response 200

{
  "ok": true
}

Errors

Example request

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

#Restore a receipt from the bin

Address

https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/receipts/:id/restore

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: SimpleBooks.

Path parameters

Response 200

{
  "ok": true
}

Errors

Example request

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

#Read a receipt again

Address

https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/receipts/:id/reprocess

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: SimpleBooks.

Path parameters

Response 200

{
  "ok": true
}

Errors

Example request

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

#Decrypted file. Only ever served from here — authenticated and checked against the user's access to this receipt

Address

https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/receipts/:id/file/:kind

Requires

Signed-in browser session (the sso_session / session_id cookies from Bramble sign-in).
Licence: SimpleBooks.

Path parameters

Query parameters

Response

An empty body, a download, a body.

Errors

Example request

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