Home / EFRIS Integration API: Developer Guide

EFRIS Integration API: Developer Guide

EFRIS Gateway is middleware for developers connecting accounting, ERP, billing and POS applications to URA EFRIS in Uganda. It exposes JSON endpoints for products, stock, invoices, receipts and credit notes, with a separate API key for each taxpayer account.

Authentication and base URL

Use your deployment's base URL with the /api/efris prefix. For hosted access the base URL is https://efrisgateway.com/api/efris. Keep the URL and key in server-side configuration.

GET /api/efris/diagnostics
X-API-Key: YOUR_API_KEY
Content-Type: application/json

Call this authenticated endpoint from your backend after onboarding. Never expose the API key in browser JavaScript, public repositories or logs. Ask your provider to rotate a leaked key.

Integration sequence

Operation	Endpoint relative to /api/efris
Check setup	GET /diagnostics
Load units	GET /units-of-measure
Load payment methods	GET /payment-methods
Register a product	POST /register-product
Record incoming goods	POST /stock-increase
Submit a sale	POST /submit-invoice or POST /submit-receipt
Reverse a sale	POST /submit-credit-note

Request fields accept snake_case or camelCase; responses use camelCase. Download the ERP integration guide and its Postman collection for required fields, payload examples and replies. This overview does not replace them.

Store fiscal results before printing

When a submission succeeds, persist the fiscal document number, verification code and QR code with the source transaction. The gateway's integration guide describes the returned fields and fiscal document layout. Keep local transaction status separate from URA acceptance so a failed submission is visible to staff.

Error handling and safe retries

Validation failures require a correction. Check HTTP status and the response's success flag, then surface detail to the operator. URA failures can include a ura object with code, message, field and hint.

A timeout does not prove URA rejected a sale. Reconcile the transaction before resubmitting and follow the full guide's reliability rules. Preserve your source invoice number and avoid blindly retrying fiscal submissions.

Before production

Confirm with us that your account is on the test or live environment you expect.
Validate product registration, units, taxes, rounding and stock for goods.
Test accepted documents, rejection handling, credit notes and printing.
Test interrupted requests and duplicate submissions with the documented recovery flow.
Agree monitoring, key rotation, reconciliation and support ownership.

Working with a business client?

Share the business guide to EFRIS system-to-system integration to explain onboarding and deployment choices. Tell us your programming language, software version, taxpayer count and expected transaction volume when requesting access.

Who you are buying from

Enterprise software, Acounting software, EFRIS integration and tax compliance � Kampala, Uganda.

Registered name: Midway Systems Ltd
Company registration: 80040689807095 (URSB, Uganda)
Address: Nabisunsa Close, Kyambogo
Company website: midwayug.com
Email: [email protected]
Phone: +256706090021

Talk to us

Send a message and we will come back to you.

Email

[email protected]

Best for detailed questions and quotes.

Start a conversation

Usually the quickest way to reach us.

Phone

+256706090021

Business hours, East Africa Time.

Kyambogo-k4-Nakawa