finsit API - CompanyFiscalYearKeyFigureData

A collection of help pages for using the API.

CompanyFiscalYearKeyFigureData

URL /Api/v2/Company/{companyId}/FiscalYear/{fiscalYearId}/KeyFigureData
Accepted verbs GET, DELETE, PUT
Description

Provides methods to get or manage key figure data for a specified company.

GET /Api/v2/Company/{companyId}/FiscalYear/{fiscalYearId}/KeyFigureData?dimensionId={dimensionId}

Get all key figure data for a company in the specific fiscal year. Key figure data can be filtered by dimension by providing the optional dimensionId URI argument.

Parameters
NameDescriptionAdditional information
companyId Company id.

URI parameter
fiscalYearId Id of the fiscal year.

URI parameter
dimensionId Optional dimension id for filtering the result.

URI parameter
Returns

A list of KeyFigureData objects.

DELETE /Api/v2/Company/{companyId}/FiscalYear/{fiscalYearId}/KeyFigureData

Remove key figure data for a fiscal year.

Parameters
NameDescriptionAdditional information
companyId Company id.

URI parameter
fiscalYearId Id of the fiscal year.

URI parameter

PUT /Api/v2/Company/{companyId}/FiscalYear/{fiscalYearId}/KeyFigureData

Update key figure data for a fiscal year. To set an optional dimension for a key figure data, specify a "dimensionId".

Parameters
NameDescriptionAdditional information
companyId Company id.

URI parameter
fiscalYearId Id of the fiscal year.

URI parameter
listOfApiKeyFigureData A list of updated KeyFigureData information.

Body data
Returns

The list of KeyFigureData with updated information.