Electronic Journal
Welcome to the electronic journal
The electronic journal is part of the economic logging registry of sales required by law, The Cash Register Systems Regulations, i.e. in norwegian "kassasystemforskriften". (https://lovdata.no/dokument/SFE/forskrift/2015-12-18-1616)
The electronic journal receives, stores and serves data for economic transactions and daily sales settlements.
For further functional description of the purpose of the electronic journal, please take a look at the "Guides" section.
The following are the most common user scenarios of the electronic journal. For a complete documentation of the functionality of the electronic journal, please take a look at the swagger documentation (https://petstore.swagger.io/?url=https://api.entur.io/electronic-journal/v1/api-docs)
The API reference(s) can be found here: electronic-journal
Simple functional scenarios
The endpoints provides functionality as described in the section below. For a complete description, please take a look at the Swagger Documentation.
You will need to be authorized either with an internal Entur authorization token or a Partner authorization token in order to make use of any of the end points.
Complex functional scenarios
Using electronic journal - Two-step scenarios:
In order to use the electronic journal at all you will need to create a point of sale first. All use of endpoints for transactions, settlements etc. requiere that there be first a point of sale with a given identifyer. Please refer to the user guide for the POS Register in order to do so.
When using the electronic journal, as mentioned above, all transactions need to be related to a point of sale. Furthermore, every settlement has to be closed at the end of the day. The settlement is meant to be in a time frame of within 24 hours. That is to say, a settlement should be opened in the morning when sales start and closed at the end of the day. Sales the day after are not allowed to be added to the settlement of the previous day.
Hence use the following scenario:
POST
Open new settlement
Open a new settlement: POST to /settlements
PUT
Close settlement
Close a settlement with a given id: PUT to /settlements/{id}/close
Please refer to the section below for more details on using these two end points.