Fiscal Harmony API
    Fiscal Harmony API
    • Introduction
    • Authentication
    • Data
    • Webhooks
    • Support
    • Account
      • 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

    Introduction

    Fiscal Harmony API#

    The Fiscal Harmony API interface allows you to send invoices and credit notes through to the revenue authority for fiscal processing using your own custom Web application or user interface(s).
    Document Version:    0.2.7
API:    Fiscal Harmony
Created By:    -
Document Date:   3 March 2026

    Version Notes#

    10 January 2024
    Initial document version.
    22 March 2024
    TaxMapping section updated.
    02 April 2024
    New Customisations Section Added
    05 April 2024
    Addition endpoint to retrieve the list of all supported currencies on the platform.
    07 May 2024
    QR Code data (as QRData) now available in API response for StatusRequest.
    15 May 2024
    Additional data to associate with QR code.
    27 August 2024
    Added HSCode (as ProductCode) to LineItem definition
    04 November 2024
    Added BillingStatus to Device.
    01 April 2025
    HSCode is now mandatory in all transactions (Invoice and CreditNote).

    Table of Contents:#

    Authentication
    Data
    Webhooks
    Support
    Account
    Get Profile
    Get Fiscal Device
    Subscription
    Transactions
    Submit Invoice
    Submit Credit Note
    Check Status
    Download Pdf
    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

    API Endpoints#

    When it comes to handling API requests to Fiscal Harmony, we use the following endpoints for API requests:
    Production:
    https://api.fiscalharmony.co.zw/api
    Development:
    https://apitest.fiscalharmony.co.zw/api
    For the sake of this documentation, you may make use of the mock server or the development end point. Only make use of the production endpoint any real-time operations you wish to perform on your app.
    When making use of the endpoints, you would need to make use of your API key and API Secret from your Fiscal Harmony account, which you can read on the Authentication page on how to find them.

    Resources and URIs#

    The Fiscal Harmony system may be accessed via a RESTful API (this document). A RESTful API utilises HTTP commands in order to perform an operation on a resource at the server:
    PUT     : To create resource
    POST    : Update resource
    GET     : Get a resource or list of resources
    DELETE  : To delete resource
    This resource is addressed by a URI; and what is returned by the server is a representation of that resource depending on its current state.

    Error Codes#

    When making requests to the API, the following are the typical response codes one may get:
    CodeTypical Reason
    200Success
    400For POST requests, this means the data you sent is not in the correct format, or some critical data is missing or incorrect. The body of the message will tell you what you need to correct in order to make a successful submission
    401Check that API Key is correct and the document body has been correctly signed.
    404For GET requests, this means the resource that you are trying to access is not available to your account.
    50XThe revenue authority is currently inaccessible. You may try again in a couple of minutes

    Recommended Operation Hours#

    Although some businesses operate 24 hours a day, for any other business it is strongly recommended to post transactions during normal working hours. Service outage may occur during routine evening maintenance which typically occurs outside of normal working hours i.e. 08:00 - 17:00 GMT+02:00 Harare.
    Modified at 2026-03-04 06:43:42
    Next
    Authentication
    Built with