Income

#List income

Address

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

Requires

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

Path parameters

Query parameters

Response 200

{
  "income": [
    {
      "id": 42,
      "company_id": 7,
      "customer_id": 7,
      "payer": "string",
      "received_on": "2026-11-12",
      "tax_year": "string",
      "description": "string",
      "gross": 12.5,
      "cis_deducted": 12.5,
      "vat": 12.5,
      "net": 12.5,
      "reference": "string",
      "notes": "string",
      "created_by": 1,
      "created_at": "2026-11-12T09:30:00.000Z",
      "updated_at": "2026-11-12T09:30:00.000Z",
      "deleted_at": "2026-11-12T09:30:00.000Z",
      "customer_name": "Example customer name"
    }
  ],
  "payers": []
}

Example request

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

#Income received in a tax year (cash basis): invoice payments + the log

Address

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

Requires

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

Path parameters

Query parameters

Response 200

{
  "tax_year": null,
  "…await taxreturn.incomeTo": "…"
}

Example request

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

#Record income

Address

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

Requires

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

Path parameters

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

#Update income

Address

https://<your-org>.brambleit.cloud/simplebooks/api/companies/:companyId/income/: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/income/12.5', {
  method: 'PUT',
  credentials: 'include',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"received_on":"2026-11-12","customer_id":12.5,"payer":"string","description":"string","reference":"string","notes":"string","gross":[],"cis_deducted":"…","vat":"…"}),
});
const data = await res.json();

#Delete income

Address

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