PEpennylane
Fiscal years

List Company's Fiscal Years

Changed on

⚠️ This endpoint is deprecated. Use List Company's Fiscal Years from the Company API v2 instead. Your firm token can call it for any company of your firm through the X-Company-Id header. Learn how to use your firm token with the Company API v2.

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

Request

  • Base URL
    https://app.pennylane.com
  • URL
    https://app.pennylane.com/api/external/firm/v1/companies/{company_id}/fiscal_years
  • Auth
    OAuth 2
    Authorization code: https://app.pennylane.com/oauth/authorize
    Token URL: https://app.pennylane.com/oauth/oauth/token scopes: fiscal_years:all, fiscal_years:readonly

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
}

Changes