Organisations

The companies a credential may read. Every path that answers a figure names one of them, so this is the first call a caller makes.

The endpoint

MethodPathAnswers
GET/api/v1/organisationsThe companies this credential may read

Needs a bearer token and the reference.read scope. Not under a company, because it is the list of companies itself.

What it answers

{
  "data": [
    { "id": 141, "name": "Acme Holdings", "currency": "USD", "fiscal_month_start": 1,
      "is_consolidate": 1, "reporting_month": "Sep-2026" },
    { "id": 142, "name": "Acme Singapore", "currency": "SGD", "fiscal_month_start": 1,
      "is_consolidate": 0, "reporting_month": "Sep-2026" }
  ],
  "page": 1, "per_page": 50, "total": 2, "has_more": false
}
FieldWhat it says
idThe company id every other path takes.
nameThe company's name.
currencyThe reporting currency, three letters. It is the currency a figure is answered in unless another is asked for.
fiscal_month_startThe month its fiscal year begins, 1 to 12.
is_consolidate1 for the group, which consolidates; 0 for a company that keeps its own ledger.
reporting_monthThe month the screens default to, as Mon-YYYY.

Only the companies ticked on the credential are answered. One that is not answers 404 on its own paths, not 403: the API does not confirm that another group's company exists.