Read fiscal periods

GET /fiscalperiods

Read a list of fiscal periods.

Headers

  • Authorization string Required

    Authorization header

Query parameters

  • type string

    Filter the results by type of accounting period. Use "Period" to retrieve only sub-periods within financial years, "Year" to retrieve only full financial years, or "All" to retrieve both financial years and their associated periods.

    Values are Year, Period, or All. Default value is Year.

Responses

  • 200 application/json

    List of fiscal periods.

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string
    • Access-Control-Allow-Credentials string
    • X-Trace-Id string
    Hide response attributes Show response attributes object
    • id string

      A unique identifier for the accounting period within 24SevenOffice.

    • type string

      The type of accounting period, either "Year" for a full financial year or "Period" for a sub-period within a financial year.

      Values are Year or Period.

    • startingDate string

      The first day of the financial year or accounting period.

    • endingDate string

      The last day of the financial year or accounting period.

GET /fiscalperiods
curl \
 --request GET 'https://rest.api.24sevenoffice.com/v1/fiscalperiods' \
 --header "Authorization: string"
Response examples (200)
# Headers
Access-Control-Allow-Origin: string
Access-Control-Allow-Credentials: string
X-Trace-Id: string

# Payload
[
  {
    "id": "3acda329-3074-4036-a1a2-499397dd6dc3",
    "type": "Year",
    "startingDate": "2023-01-01",
    "endingDate": "2023-12-31"
  }
]