---
title: "GET /financialYear"
method: GET
path: "/financialYear"
tags: ["financialYear"]
---

# GET /financialYear

`GET /financialYear`

## Request

- Base URL: `https://www.weclapp.com/api/nullapi/v2`
- URL: `https://www.weclapp.com/api/nullapi/v2/financialYear`
- Auth: API key in header `AuthenticationToken`
- TypeScript: <https://skmtc.dev/weclapp/apis/weclapp-api/docs/financialYear/get.ts> (a function with typed inputs; its response is checked against the schema)

query financialYear

## Query parameters

- `page` integer
- `pageSize` integer
- `sort` string

## Response `200`

financialYear response

- object
  - `result` FinancialYear[]
    - `id` string
    - `version` string
    - `createdDate` integer
    - `lastModifiedDate` integer
    - `name` string, required
    - `periods` Period[]
      - `id` string
      - `version` string
      - `createdDate` integer
      - `financialYearId` string, required
      - `lastModifiedDate` integer
      - `name` string, required
      - `open` boolean
      - `periodNumber` integer, required
      - `validFrom` integer
      - `validTo` integer
    - `status` 'CLOSED' | 'CURRENT' | 'PLANNED' | 'PRELIMINARY_CLOSED', required
    - `validFrom` integer
    - `validTo` integer

## Other responses

- `default`: error response

## Changes

- **2022-12-03** `cc274ef79dfd`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/weclapp/apis/weclapp-api/changes/financialYear/get.md)

---

[API](https://skmtc.dev/weclapp/apis/weclapp-api.md) - [All operations](https://skmtc.dev/weclapp/apis/weclapp-api/llms.txt) - [OpenAPI document](https://skmtc.dev/weclapp/apis/weclapp-api/revisions/0e021229755d?raw)