Get list of fiscal years

GET /fiscal-years
Oauth2

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

  • includePeriods string

    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.

  • fetchDepth

    It should have positive integer value.

Responses

  • 200 application/json

    The requested page of entities.

    Hide response attributes Show response attributes object
    • result array[object]
      Hide result attributes Show result attributes object
      • id integer
      • name string
      • startDate string(date-time)
      • endDate string(date-time)
      • periods array[object]
        Hide periods attributes Show periods attributes object
        • id integer
        • name string
        • year string
        • status string

          Values are NOT_STARTED, IN_PROGRESS, COMPLETE, DELETED, or DISABLED.

        • startDate string(date)
        • endDate string(date)
        • closeDayStartDate string(date)
        • closeDayEndDate string(date)
        • completionDate string(date-time)
    • metadata object

      Paging metadata dto.

      Hide metadata attributes Show metadata attributes object
      • totalElements integer(int64)

        The total number of rows in the result set.

      • totalPages integer(int32)

        The total number of pages in the result set, should = totalElements / size

      • first boolean

        True if this is the first page.

      • last boolean

        True if this is the last page.

      • empty boolean

        True if the result is empty.

      • numberOfElements integer(int32)

        The number of results in this page. Will be <= size.

      • size integer(int32)

        The page size.

      • sorted boolean

        True if the results are sorted.
GET /fiscal-years 
curl \
 --request GET 'https://usaapi02.cadencyservices.trintech.com/test/api/fiscal-years' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
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
  }
}