obono

obono RKSV API

Provides a RESTful API for interacting with virtual cash registers and creating receipts that are conform with the Registrierkassensicherheitsverordnung…

E-commerce#openapi#ecommerce

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Provides a RESTful API for interacting with virtual cash registers and creating receipts that are conform with the Registrierkassensicherheitsverordnung (RKSV).

You may find our automatically generated clients for various programming languages and environments helpful...

Endpoints 18

registrierkasse

  • GETgetRegistrierkasse/registrierkassen/:registrierkasseUuidReturns information about a particular Registrierkasse.
  • GETgetDEP/registrierkassen/:registrierkasseUuid/depGenerates a DEP file.

beleg

  • GETGET /belege/{belegUuid}/belege/:belegUuidRetrieves a particular Beleg from the "Datenerfassungsprotokoll".
  • POSTcreateAbschluss/registrierkassen/:registrierkasseUuid/abschlussGenerates an Abschlussbeleg.
  • GETgetBelege/registrierkassen/:registrierkasseUuid/belege?format=export&order=asc&limit=0&offset=0&before=string&after=string&gte=0&lte=0Retrieves the Beleg collection from the "Datenerfassungsprotokoll".
  • GETgetBeleg/registrierkassen/:registrierkasseUuid/belege/:belegUuidRetrieves a particular Beleg from the "Datenerfassungsprotokoll".
  • PUTaddBeleg/registrierkassen/:registrierkasseUuid/belege/:belegUuidSigns a receipt and stores it in the "Datenerfassungsprotokoll".

auth

  • GETGET /auth/authRequest a JWT access token using your obono username and password.

export

  • GETGET /export/csv/registrierkassen/{registrierkasseUuid}/belege/export/csv/registrierkassen/:registrierkasseUuid/belege?before=string&after=string&posten=true
  • GETGET /export/dep131/registrierkassen/{registrierkasseUuid}/belege/export/dep131/registrierkassen/:registrierkasseUuid/belege?before=string&after=string
  • GETGET /export/dep7/registrierkassen/{registrierkasseUuid}/belege/export/dep7/registrierkassen/:registrierkasseUuid/belege?before=string&after=string
  • GETGET /export/gobd/registrierkassen/{registrierkasseUuid}/export/gobd/registrierkassen/:registrierkasseUuid?before=string&after=string
  • GETGET /export/html/belege/{belegUuid}/export/html/belege/:belegUuid
  • GETGET /export/pdf/belege/{belegUuid}/export/pdf/belege/:belegUuid
  • GETGET /export/qr/belege/{belegUuid}/export/qr/belege/:belegUuid
  • GETGET /export/thermal-print/belege/{belegUuid}/export/thermal-print/belege/:belegUuid?qr=true&width=42&dialect=escpos&encoding=raw
  • GETGET /export/xls/registrierkassen/{registrierkasseUuid}/belege/export/xls/registrierkassen/:registrierkasseUuid/belege?before=string&after=string

monatsbelege

  • GETgetMonatsbelege/registrierkassen/:registrierkasseUuid/monatsbelege?year=0&month=0Returns a list of Monatsbelege.

API details

Authentication
HTTP Basic authentication (username and password)
An API key in the Authorization header
Operations
18 operations on 17 pathsGET 16PUT 1POST 1
Main resources
export 9beleg 5registrierkasse 2auth 1monatsbelege 1
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 1.4.0.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the obono RKSV API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the obono RKSV API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “getRegistrierkasse” (GET /registrierkassen/:registrierkasseUuid), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the obono RKSV API?

Provides a RESTful API for interacting with virtual cash registers and creating receipts that are conform with the Registrierkassensicherheitsverordnung… It is listed under E-commerce and has 18 endpoints.

Who publishes the obono RKSV API?

It is listed from obono's public API description (an OpenAPI document), not published by obono on Swastik Codes. Anyone who controls obono.at can claim the profile by adding a DNS TXT record.

How do I authenticate with the obono RKSV API?

It accepts 2 methods: HTTP Basic authentication (username and password); an API key in the Authorization header.

How many endpoints does the obono RKSV API have?

18 operations on 17 paths (16 GET, 1 PUT, 1 POST). The largest groups are export, beleg, registrierkasse, auth.

Is forking the obono RKSV API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.