Fiscal Harmony API
    Fiscal Harmony API
    • Introduction
    • Authentication
    • Data
    • Support
    • Webhooks
    • Account
      • Test
        POST
      • Get Profile
        GET
      • Get Fiscal Device
        GET
      • Subscription
        GET
    • Transactions
      • Submit Invoice
        POST
      • Submit Credit Note
        POST
      • Check Status
        POST
      • Download Pdf
        GET
    • Mappings
      • Tax Mappings
        • Get All TaxMappings
        • Add Tax Mapping
        • Get Specific Tax Mapping
        • Update Tax Mapping
        • Delete Tax Mapping
      • Currency Mappings
        • Supported Currencies
        • Get All CurrencyMappings
        • Add Currency Mapping
        • Get Specific Currency Mapping
        • Update Currency Mapping
        • Delete Currency Mapping
    • Schemas
      • Account
        • Profile
        • FiscalDevice
        • DeviceConfig
        • ApplicableTax
        • BillingPlan
        • BillingStatus
        • Subscription
      • Mappings
        • CurrencyMapping
        • TaxMapping
      • Transactions
        • Invoice
        • CreditNote
        • BuyerContact
        • PaymentMethodType
        • LineItem
        • StatusRequest
      • Date

    Authentication

    Authentication#

    Authentication and Authorisation for the active user on the API is done through the use of HTTP Headers containing the API Key to identify the user and a request signature, signed using the API Secret. To send requests, one must perform a login request first to acquire a valid cookie to use with subsequent requests.

    Obtaining API Keys#

    With an active account, log in to your account and navigate to the API Keys tab on the side navigation. Once on the API Keys menu, click Create an API Key if one is not already created.
    Once you have the API Key and Secret, you can now use them to access the API. The API Secret will be shown only once and then never again, if you lose the API Secret, you will need to log in again and rotate the API Secret. Therefore, it is recommended to make sure you copy your API Secret and keep it in a safe place.

    Constructing Headers#

    To access the API, a few HTTP headers need to be present in order to be properly authenticated. Those headers are:
    HeaderDescription
    X-Api-KeyThis is the API Key obtained in the previous step.
    X-Api-SignatureThis is the Base64 encoded HMACSHA256 signature, signed using the API Secret, of the JSON request body for all requests with a body.
    Not required for GET requests.
    X-ApplicationThe name of the application that uniquely identifies it (provided by Fiscal Harmony).
    X-App-StationThe unique identifier for the workstation/till/operator/station/user using the third party application. The third party using this API must be able to uniquely identify each operator for audit purposes. This value should not change once set.
    X-App-VersionThe version of the application.
    The X-Api-Signature is constructed by hashing the body and the secret key together and then encrypting it. You may use the following code to perform that function:
    C#
    NodeJS
    The X-App-Station header is mandatory, therefore provide it to ensure that your API connections keep working without needing to re-develop your integration. The value in this header must be unique for each user or physical device operating your application.

    Prescript for Postman and Apidog#

    If you are using Postman for testing the API, you may use the prescript below to handle requests. This prescript works on Apidog as well, however will only work when you Run in Apidog .
    Modified at 2026-03-09 09:13:34
    Previous
    Introduction
    Next
    Data
    Built with