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 (http://petstore.swagger.io/?url=https://api.dev.entur.io/electronic-jour...)

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:

 Open a new settlement: POST to /settlements

 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.

Operations handling economic transactions for a settlement

 Get all transactions for a pos with a given id in a given time period: GET to /transactions

 
 Example response
 
 
 
 
 
 
 

 

 Get all transactions for a settlement with a given id: GET to /settlements/{id}/transactions

 
 Example response
 
 
 
 

 

Add a transaction for a settlement with a given id: POST to /settlements/{id}/transactions

 
 Example request
 
 Example response

Other settlement-related operations

 Get aborted sales for a settlement with a given id: GET to /settlements/{id}/aborted-sales

 
 Example response
 
 
 
 

 

 Open a new settlement: POST to /settlements

 
 Example request
 
 Example response

 

 Close a settlement with a given id: PUT to /settlements/{id}/close

 
 Example request
 
 Example response

Deposit-related operations

Create a new deposit for a settlement with a given id: POST to /settlements/{id}/deposits

 
 Example request
 
 Example response

 

Close a deposit with a given id: PUT to /deposits/{id}/close

 
 Example response

Operations handling diffs in the cash registry

Get a list of diffs for a given time period: GET to /diffs/in-period

 
 Example response

 

Create a new diff for a settlement with a given id: POST to /settlements/{id}/diffs

 
 Example request
 
 Example response

Report-producing operations

Get the Z report for a settlement with a given id: GET to /settlements/{id}/z-report

 
 Example response

 

Get the summary for a settlement with a given id: GET to /settlements/{id}/summary

 
 Example response

 

 Get all terminal reports for a pos with a given id: GET to /terminal-report/{pointOfSale}

 
 Example response

 

As mentioned in the previous section, the electronic journal is part of the economic logging registry of sales required by law, The Cash Register Systems Regulations, i.e. in norwgian "kassasystemforskriften".  (https://lovdata.no/dokument/SFE/forskrift/2015-12-18-1616)

Whenever cash switches owner a transaction in the economic journal is required to be registered. All cash handling entities, either humans or machines are required by law to register the operation of handling of cash as a transaction in the economic journal. The same applies to making deposits from a cash storing device e.g. transfer of cash from a cashguard to a deposit location e.g. an IVA-machine.

Sale not involving transfer of cash (e.g the sale of tickets through a web page or a mobile app) are not subjected to the Cash Register Systems Regulations and their economic report are handled by ordinary accounting systems.

Important concepts:

Deposit: Moving money into or out of a settlement without transferring the money out of Entur. Examples are empyting CashGuard, refilling TVM, depositing money on an IVA machine etc.
Diff: A representation of a mismatch between the amount of money the settlement should contain and the amount it actually has
Economy report: The z-report for a settlement. The Z-report is the registry of transactions of cash in a cash handling device for one day. 
Event: Used for logging events happening in the electronic journal
Receipt: A representation of a receipt for different kinds of transactions. All receipts have to be counted by the electronic journal
Payment: The full or partial payment of a transaction.
Point of sale: The place where a transaction is completed. For mobile terminals (MT) this is the employee using the terminal rather than a physical location
Settlement: An overview of the sales performed in a given period of time
Summary: A summary of transactions, deposits and diffs
Terminal report: A representation of the z-report produced by the terminal for a pos
Transaction: A transfer of money
Transaction line: A part of a transaction.

ER diagram

The API reference(s) can be found here: