Get list of fiscal years

GET /cs-close-api/fiscal-years

The purpose of the "Get Fiscal Years" call is to return alist of ALL fiscal years, as seen in the database. This means the call will return all fiscal years regardless of whether the period is currently open, completed, not started, etc.

Query parameters

  • If includePeriods is set to true, the periods in the year will also be loaded.

  • page integer(int32)

    The page define the current page number. It should be positive integer number and should start with minimum value 1.

    Minimum value is 1.

  • size integer(int32)

    The size define number of records on each page. It should be positive integer number between 1 to 10000.

    Minimum value is 1, maximum value is 10000.

  • sort array[string]

    The sort parameter accepts an array of strings, allowing for multiple sorting criteria. By default, sorting order is ascending.

  • name string

    The name parameter is an optional filter that allows you to narrow down the results based on specific name content.

  • It should have positive integer value.

Responses

GET /cs-close-api/fiscal-years
curl \
 --request GET 'http://close-service:8082/cs-close-api/fiscal-years'
Response examples (200)
{
  "result": [
    {
      "id": 42,
      "name": "string",
      "startDate": "2025-05-04T09:42:00Z",
      "endDate": "2025-05-04T09:42:00Z",
      "periods": [
        "{\n    \"id\": 37,\n    \"name\": \"Sep\",\n    \"year\": \"2018\",\n    \"status\": \"IN_PROGRESS\",\n    \"startDate\": \"2017-09-01\",\n    \"endDate\": \"2017-09-30\",\n    \"closeDayStartDate\": \"2017-09-01\",\n    \"closeDayEndDate\": \"2017-09-30,\n    \"completionDate\": null\n}\n"
      ]
    }
  ],
  "metadata": {
    "totalElements": 42,
    "totalPages": 42,
    "first": true,
    "last": true,
    "empty": true,
    "numberOfElements": 42,
    "size": 42,
    "sorted": true
  }
}