v1

latestOpenAPI 3.0.12026-07-144840447.2 KB

Fiscal years

List Company's Fiscal Years

This endpoint returns a list of fiscal years of the company.

ℹ️ This endpoint requires one of the following scopes: fiscal_years:all, fiscal_years:readonly

get/api/external/firm/v1/companies/{company_id}/fiscal_years

Path parameters

company_idinteger required

Existing company identifier (id)

Query parameters

pageinteger

Example:1

Items are paginated, this is the current page which will be returned. The page index is starting at 1.

per_pageinteger

Example:20

Items are paginated. By default, you get 20 items per page. You can specify another number of items per page.

Response

Returns the list of fiscal years of the company.

total_pagesinteger required

The total number of pages available

current_pageinteger required

The current page returned

total_itemsinteger required

The total number of items available

per_pageinteger required

The number of items per page

Example response

{
  "items": [
    {
      "start": "2023-08-30",
      "finish": "2022-12-31",
      "status": "open"
    }
  ],
  "total_pages": 5,
  "current_page": 1,
  "total_items": 12,
  "per_page": 40
}