finsit API - CompanyKeyFigurePreset

A collection of help pages for using the API.

CompanyKeyFigurePreset

URL /Api/v2/Company/{companyId}/KeyFigurePreset/{keyFigurePresetId}
Accepted verbs GET, DELETE, PUT, POST
Description

Provides methods to get or manage settings for which key figures that are supposed to be displayed in the presentation view for the company.

GET /Api/v2/Company/{companyId}/KeyFigurePreset

Get all configured key figure presets for a company.

Parameters
NameDescriptionAdditional information
companyId Company id.

URI parameter

Returns

The requested list of KeyFigurePreset.

GET /Api/v2/Company/{companyId}/KeyFigurePreset/{keyFigurePresetId}

Get a particular key figure preset by its id.

Parameters
NameDescriptionAdditional information
companyId Company id.

URI parameter

keyFigurePresetId Id of the key figure preset to fetch.

URI parameter

Returns

The requested KeyFigurePreset.

DELETE /Api/v2/Company/{companyId}/KeyFigurePreset/{keyFigurePresetId}

Delete a key figure preset.

Parameters
NameDescriptionAdditional information
companyId Company id.

URI parameter

keyFigurePresetId Id of the key figure preset to delete.

URI parameter

PUT /Api/v2/Company/{companyId}/KeyFigurePreset

Update an existing key figure preset.

Parameters
NameDescriptionAdditional information
companyId Company id.

URI parameter

apiKeyFigurePreset Updated KeyFigurePreset information.

Body data

Returns

The KeyFigurePreset with updated information.

POST /Api/v2/Company/{companyId}/KeyFigurePreset

Create a new key figure preset.

Parameters
NameDescriptionAdditional information
companyId Company id.

URI parameter

apiKeyFigurePreset The new KeyFigurePreset to create.

Body data

Returns

The newly created KeyFigurePreset.