API documentation
Integrate FiscalFlow with your existing systems. Base URL: https://api.fiscalflow.co.zw
FDMS sandbox reference base URL: https://fdmsapitest.zimra.co.zw
Quickstart
- Create a sandbox API key in the developer portal.
- Register a virtual device for your merchant.
- Open a fiscal day, submit an invoice, close the day.
- Verify the QR code on the FDMS public portal.
curl https://api.fiscalflow.co.zw/v1/invoices \
-H "Authorization: Bearer sk_test_…" \
-H "Content-Type: application/json" \
-d '{
"device_id": "vfd_sbx_001",
"type": "FISCAL_INVOICE",
"currency": "USD",
"lines": [{ "name": "Item", "qty": 1, "price": 100, "tax": "VAT_15" }]
}'API reference
Public-v1 (no mTLS bootstrap)
- POST /Public/v1/{deviceID}/RegisterDevice
- GET /Public/v1/GetServerCertificate
- POST /Public/v1/{deviceID}/VerifyTaxpayerInformation
Device-v1 (core fiscal lifecycle)
- GET /Device/v1/{deviceID}/GetConfig
- GET /Device/v1/{deviceID}/GetStatus
- POST /Device/v1/{deviceID}/OpenDay
- POST /Device/v1/{deviceID}/SubmitReceipt
- POST /Device/v1/{deviceID}/CloseDay
- POST /Device/v1/{deviceID}/IssueCertificate
- POST /Device/v1/{deviceID}/Ping
- POST /Device/v1/{deviceID}/SubmitFile
- GET /Device/v1/{deviceID}/SubmittedFileList
ProductsStock-v1 (goods/stock lookup)
- GET /ProductsStock/v1/{deviceID}/Search
User-v1 (POS user management)
- GET /User/v1/{deviceID}/GetUsersList
- POST /User/v1/{deviceID}/CreateUser
- POST /User/v1/{deviceID}/Login
- POST /User/v1/{deviceID}/ChangePassword
- POST /User/v1/{deviceID}/ResetPassword
- POST /User/v1/{deviceID}/ConfirmPasswordReset
- POST /User/v1/{deviceID}/Block/{userName}
- POST /User/v1/{deviceID}/Unblock/{userName}
- POST /User/v1/{deviceID}/Update
- POST /User/v1/{deviceID}/SendSecurityCodeToTaxpayer
- POST /User/v1/{deviceID}/SendSecurityCodeToUserEmail
- POST /User/v1/{deviceID}/SendSecurityCodeToUserPhone
- POST /User/v1/{deviceID}/ConfirmUser
- POST /User/v1/{deviceID}/ConfirmContact
Webhooks
Subscribe to invoice.approved, fiscal_day.closed, and certificate.expiring. Configure endpoints in the merchant dashboard.
Glossary
- FDMS
- ZIMRA Fiscalisation Data Management System
- VFD
- Virtual Fiscal Device
- CSR
- Certificate Signing Request
- Z Report
- End-of-day fiscal summary