Invoices & customers

#List customers

Address

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

Requires

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

Path parameters

Query parameters

Response 200

{
  "customers": [
    {
      "id": 42,
      "company_id": 7,
      "name": "Example name",
      "email": "alex@example.com",
      "phone": "string",
      "address": "string",
      "cis_rate": 12.5,
      "terms_days": 1,
      "notes": "string",
      "created_at": "2026-11-12T09:30:00.000Z",
      "updated_at": "2026-11-12T09:30:00.000Z",
      "archived_at": "2026-11-12T09:30:00.000Z",
      "invoices": false,
      "owed": null,
      "last_invoice": false,
      "contacts": []
    }
  ]
}

Example request

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

#Add a customer

Address

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

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
}

Example request

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

#Update a customer

Address

https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/customers/: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/customers/12.5', {
  method: 'PUT',
  credentials: 'include',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"name":"Example name","email":"alex@example.com","phone":"string","address":"string","notes":"string","cis_rate":"…","terms_days":"string","archived":"…","contacts":[]}),
});
const data = await res.json();

#Invoice settings

Address

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

Requires

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

Path parameters

Response 200

{
  "settings": [],
  "email_enabled": true,
  "email_from": "alex@example.com"
}

Example request

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

#Update invoice settings

Address

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

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/invoice-settings', {
  method: 'PUT',
  credentials: 'include',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"invoice_prefix":"…","next_invoice_no":12.5,"default_terms_days":12.5,"bank_account_name":"Example bank account name","bank_sort_code":"…","bank_account_no":"…","invoice_footer":"string"}),
});
const data = await res.json();

#List invoices

Address

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

Requires

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

Path parameters

Query parameters

Response 200

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

Example request

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

#Money owed right now, plus this tax year's invoicing — for Home and Tax year

Address

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

Requires

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

Path parameters

Query parameters

Response 200

{
  "owed": {
    "invoices": 1,
    "amount": null,
    "overdue_invoices": 12.5,
    "overdue": null
  },
  "drafts": 1,
  "tax_year": null,
  "year": {
    "invoices": 1,
    "invoiced": null,
    "invoiced_net": null,
    "vat": null,
    "cis": null,
    "received": null
  }
}

Example request

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

#Create an invoice

Address

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

Requires

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

Path parameters

Response 201

{
  "id": 42
}

Example request

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

#Get an invoice

Address

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

Requires

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

Path parameters

Response 200

{
  "invoice": null,
  "editable": false
}

Example request

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

#Update an invoice

Address

https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/invoices/: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/invoices/42', {
  method: 'PUT',
  credentials: 'include',
});
const data = await res.json();

#Copy an invoice

Address

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

Requires

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

Path parameters

Response 201

{
  "id": 42
}

Example request

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

#Delete a draft invoice

Address

https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/invoices/: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/invoices/42', {
  method: 'DELETE',
  credentials: 'include',
});
const data = await res.json();

#Void an invoice

Address

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

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/invoices/42/void', {
  method: 'POST',
  credentials: 'include',
});
const data = await res.json();

#Send an invoice

Address

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

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,
  "number": null
}

Errors

Example request

// From a page served by Bramble (uses the signed-in session)
const res = await fetch('/simplebooks/api/companies/1/invoices/42/send', {
  method: 'POST',
  credentials: 'include',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"channel":"string","to":"…","cc":"…","message":"Saved"}),
});
const data = await res.json();

#An invoice as PDF

Address

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

Requires

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

Path parameters

Query parameters

Response

A body.

Example request

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

#Record a payment

Address

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

Requires

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

Path parameters

Request body JSON

Response 201

{
  "ok": true
}

Errors

Example request

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

#Remove a payment

Address

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

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/invoices/42/payments/12.5', {
  method: 'DELETE',
  credentials: 'include',
});
const data = await res.json();