Periods and years
The months and the fiscal years this company can be read for. A figure is always asked for by one of these labels, so a caller reads them first.
The endpoints
| Method | Path | Answers |
|---|---|---|
| GET | /api/v1/organisations/{organisation}/periods | The months |
| GET | /api/v1/organisations/{organisation}/years | The fiscal years |
Both need a bearer token, a credential issued for that company, and the reference.read scope.
What they answer
GET /api/v1/organisations/149/periods
{ "data": [ { "period": "Sep-2024" }, { "period": "Oct-2024" }, { "period": "Nov-2024" } ],
"page": 1, "per_page": 50, "total": 40, "has_more": false }
GET /api/v1/organisations/149/years
{ "data": [ { "year": "2027" }, { "year": "2026" }, { "year": "2025" }, { "year": "2024" } ],
"page": 1, "per_page": 50, "total": 4, "has_more": false }| Field | What it says |
|---|---|
period | A month as Mon-YYYY, which is what period
takes everywhere else. The list runs oldest first. |
year | A fiscal year as YYYY when the fiscal year starts in January,
and YYYY/YY when it does not. The list runs from the year after the reporting one
backwards. |
The months start where the company's loaded data starts and run to the end of the fiscal year after the
reporting one, so a plan or a forecast month is in the list too. A month outside it is refused by a figure
read with period_outside_window, as the write side refuses it.
A company the credential does not name answers 404, not 403: a read never confirms
that another company exists.