CPaaS Fiscal API

Overview

Use the Fiscal API to allow your POS to handle fiscal integration in fiscal countries. The endpoints allows your POS to communicate directly with the fiscal devices.

Features

The CPaaS Fiscal API allows POS systems to handle fiscal integration in fiscal countries and communicate directly with the fiscal devices. Fiscal API enables the POS system to run the following operations:

  • Start (POST /sessions/start) and close (POST /sessions/finish) a daily session.
  • Retrieve the current session ID (GET /sessions).
  • Get client details required to start a session (GET /clients).
  • Reprint a fiscal ticket (POST /printouts/reprint).
  • Print non-fiscal printouts for fiscal countries that use physical fiscal printers (POST /printouts/non-fiscal).
  • Print fiscal reports for fiscal countries that use physical fiscal printers (POST /printouts/report).
  • Recalculate tax for Proforma invoice on Local Account for rebate handling (POST /taxes/proforma/calculate).
  • Validate customer data on-demand (POST /customers/validate).
  • Get current status of the fiscal report, which has been sent to printer (POST /printouts/report/status/{reportId}).
  • Get current fiscal integration configuration for a given session ID (GET /sessions/configuration/{fiscalSessionId}).
    Note: This endpoint is deprecated as of Release 2024.2. It will be decommissioned at the end of Q1 2025.
  • Do maintenance operations such as resetting the printer (POST /maintenance/operation).
  • Check the status of the dependent backend services (GET /healthCheck).
  • Register standalone events occuring without transactions (for example, opening cash drawer, printing error, sales transaction canceled, shop product modified, customer modified) (POST /clients/events).
  • Get fiscal report, which has been initiated to be printed (GET /printouts/report/{reportId})

NOTE: The CPaaS API only supports certain regions. For configuration details please refer to the CPaaS Documentation Suite.

Security

The CPaaS Fiscal API supports OAuth 2.0 for authentication purposes.
The supported protocol for the CPaaS Fiscal API is HTTPS.