• Deutsch
  • English
fiskaly Dashboard and Management API

fiskaly Dashboard and Management API.

With the fiskaly Dashboard you have insights into your products which you have booked with fiskaly. The Dashboard allows you to create and manage organisations and their users, see which transactions have already been started and which clients and technical security system (TSS) have been created. It visualises your data and you can see at a glance what is happening in the fiskaly system.

Register for free with the fiskaly Dashboard

Log-in-Dashboard_english_fiskaly-Dashboard-and-Management-API To use the fiskaly Dashboard, you need your own account. You can create one free of charge. All companies that you create in the test can also be switched to live mode after signing the contract.

Click here for the Dashboard

Info: When you log in for the first time, you must create a main organisation. After that you have the option to create your main and sub organisations via the dashboard or via the management API.

fiskaly Dashboard Manual

The detailed Dashboard manual is available on the fiskaly developer website.

Management API

Via the Management API you can also solve all functions of the Dashboard programmatically. Only the first main organisation has to be created via the Dashboard. The detailed documentation of the interface functions with their parameters can be found on the fiskaly developer website.  In the Management API, the terms Organisation are used for main organisation and Managed Organisation for sub-organisation.

Organisations and user rights

In the fiskaly system, a distinction is made between main organisations and sub-organisations. What the difference is and how this affects user rights is described below. All information about the organisations can be found on the fiskaly developer website or in the Dashboard user manual.

What is a main organisation?

A main organisation is an authoritative unit in the fiscal system. It usually represents a holding, business or branch office. Main organisations can be created free of charge via the dashboard. Sub-organisations (in the fiskaly system: managed organizations) can be attached to them. Sub-organisations can also be managed via the main organisation. In the organisation management, additional organisations can be created, information can be viewed, the organisation can be switched to live mode, an organisation logo can be stored, users can be organised, API keys can be created for the main organisation and API keys can be created for the sub-organisations.

Important: A main organisation cannot be a sub-organisation of another main organisation.

User rights in the main organisation

Users of the main organisation, as well as persons invited to the main organisation, have access to all information displayed in the dashboard of the main organisation as well as to the information of the attached sub-organisation(s) of this main organisation. I.e. overview dashboard, TSS number(s), client(s), transactions, exports, integrations etc. are displayed to the users. fiskaly user rights

What is a sub-organisation?

The sub-organisation is dependent on its superior main organisation and can never stand alone. It must always be subordinate to a main organisation. Sub-organisations are given the badge "managed". They can also be created via the dashboard. create organisation

User rights in the sub-organisation

Users who are activated for the sub-organisation only have access to the information of the respective sub-organisation. The users have no insight into the information of the super-ordinate main organisation. Within the sub-organisation, users have access to the dashboard and all the information stored there.

How to create a sub-organisation (managed organisation)

In the Dashboard, in the menu item Settings > Organisation Management, click on the button Create new organisation and select the box Create managed organisation. Then specify under which main organisation this sub-organisation should be created.

Under this link you will find how to create the managed organisation via the Management API. Make sure that the ManagedOrganisation button is selected. create managed organisation

Difference between a main organisation and a sub-organisation

In the fiscaly system, a distinction is made between main organisations and sub-organisations. Sub-organisations are dependent on the main organisation. They cannot themselves contain any other sub-organisations. Similarly, a main organisation cannot be a sub-organisation of another main organisation. It is important to know that the user rights of main organisations and sub-organisations differ.

Difference in user rights in main and sub-organisations

Users of main organisations or sub-organisations have access to the information displayed in the dashboard of the respective organisation. The user rights within the main organisation and the sub-organisation differ in that users of the main organisation also have access to the information of the respective linked sub-organisations. Users of the sub-organisations, however, do not have access to the information of the parent main organisation.

API Keys

At least one API key must be created at the organisation level.

Via the dashboard in the menu item Developer > API Key click on the button Create API Key and select a name for the new API Key. Then select Create. new API key Attention: the API Secret is only displayed immediately after the creation of a new API Key! new API key 2 API Keys can also be generated via the Management API.

The API key of the main organisation can be used to manage the sub-organisations. A separate API key must be created for each sub-organisation in order to create a TSS for it and to use the other functionalities of the fiskaly SIGN API. API Keys for main organisations must be created via the Dashboard or the Management API. For sub-organisations, API Keys can be generated automatically.

An API Key is bound to an organisation and to the selected mode (Test/Live). This means that each API key can only be used for its own organisation. Exception: API Keys of a main organisation can be used for the respective sub-organisations.

If the API key was created in test mode, it can only(!) be used to create entities for test purposes. With a key created in live mode, only(!) live entities can be produced. I.e. in a live organisation, further sub-organisations can be created with the live API key, so that each sub-organisation does not have to be switched individually to live mode.

On the fiskaly developer page you can find all information about the API Keys here. fiskaly API keys English

Billing options

There are two ways to control the billing:

Bill_to_Organisation

With the Bill_to_Organisation option, the bill is sent to the main organisation and can also be viewed via the dashboard.

Withhold Billing

With the Withhold Billing option, the bill is not made to this sub-organisation and can also not be viewed via the dashboard. For example, the fiskaly TSS can be sold as part of a checkout package without your customer seeing the price of the fiskaly TSS.

On the fiskaly developer page, all Information on Billing can be found here. fiskaly Info about Billing

Organisational structure

Cash register manufacturer offers fiskaly Cloud TSS in its portfolio

A cash register manufacturer uses fiskaly Cloud TSS for its cash register software. He offers three solutions to his customers. Typically, point 1. is best practice for large cash register providers. Point 2. and 3. are designed for more complex models.

Contact our sales team for this: sales@fiskaly.com. Organisational structure

1. Individual customers - best practice Under the main organization of the cash register manufacturer, individual customers are created and managed as sub-organizations. The main organization is used to create the respective API Key of the sub-organization. The billing option was set to Withhold Billing, as the price of the fiskaly Cloud TSS is included in the total bill of the POS manufacturer to the customer.

2. Enterprise customers The POS manufacturer creates the Enterprise customer's holding company as the main organization. The Enterprise customer's branches are created as sub-organizations. The main organization of the Enterprise customer is created with the API Key of the main organization of the POS manufacturer. It is up to the POS vendor whether the Enterprise customer manages its organizations itself or is managed by the POS vendor. The billing options are set to Withhold Billing for the Enterprise customer's organizations.

3. White label partner The POS provider creates the White Label Partner company as the main organization. The White Label Partner's customers are created as sub-organizations. The main organization of the White Label Partner is created with the API Key of the main organization of the POS manufacturer. The White Label Partner manages its customers (sub-organizations) itself. The billing options are set to Withhold Billing for the organizations of the White Label Partner's customers.

For other models or special cases contact our sales team: sales@fiskaly.com.

Download

Here you can download the article fiskaly Dashboard and Management API as a .pdf file. fiskaly-Dashboard-und-Management-API_2020.pdf

Bleiben Sie auf dem Laufenden, indem Sie sich für unseren Newsletter anmelden.

Wir halten Sie über alles Gute in der modernen Welt der Fiskalisierung auf dem Laufenden.

Abonniere jetzt