URA EFRIS API Reference

This section documents the available EFRIS API functions, their request/response objects, and preconditions. Each function belongs to a module such as Initialization, Invoice Management, Stock, Items, Taxpayer Information, and System Dictionary. The system interface uses JSON format to transfer data, with payload divided into data, globalInfo, and returnStateInfo.

---

List of EFRIS Functions

Authentication & Initialization

Interface Name	Code	Description	Precondition	Request Object	Response Object
Get Server Time	T101	Returns server current time and date	-	GetServerTimeReq	GetServerTimeRes
Client Initialization	T102	Returns the server's public key	-	ClientInitReq	ClientInitRes
Log In	T103	Client login	-	LoginReq	LoginRes
Get Symmetric Key	T104	Obtain symmetric key and signature info	Online Mode	SymmetricKeyReq	SymmetricKeyRes
Forget Password	T105	Reset password	-	ForgetPasswordReq	ForgetPasswordRes
TCS Upgrade Download	T133	Query files needed to upgrade system	-	TCSUpgradeReq	TCSUpgradeRes
Get TCS Latest Version	T135	Get TCS latest version	-	TCSVersionReq	TCSVersionRes
Certificate Public Key Upload	T136	Upload certificate public key	-	CertUploadReq	CertUploadRes
Upload Device Issuing Status	T176	Upload device issuing status	-	DeviceStatusReq	DeviceStatusRes

Invoice Management

Interface Name	Code	Description	Precondition	Request Object	Response Object
Invoice Upload	T109	Upload Invoice/Receipt or Debit Note	Authentication	InvoiceUploadReq	InvoiceUploadRes
Invoice Query	T106	Obtain already issued invoices/receipts	Authentication	InvoiceQueryReq	InvoiceQueryRes
Query Normal Invoice	T107	Query invoices eligible for Credit/Debit Note	Authentication	NormalInvoiceReq	NormalInvoiceRes
Invoice Details	T108	Retrieve invoice details by number	Authentication	InvoiceDetailsReq	InvoiceDetailsRes
Invoice Remain Details	T186	Query invoice remaining details	Authentication	InvoiceRemainReq	InvoiceRemainRes
Invoice Reconciliation	T117	Contrast client invoice with server	Authentication	InvoiceReconcileReq	InvoiceReconcileRes
Batch Invoice Upload	T129	Batch upload invoices	Authentication	BatchInvoiceReq	BatchInvoiceRes
Update Buyer Details	T166	Update buyer's info on EDC invoice	Authentication	UpdateBuyerReq	UpdateBuyerRes
EDC Invoice Inquiry	T167	EDC Invoice/Receipt inquiry	Authentication	EDCInvoiceReq	EDCInvoiceRes
Query FDN Status	T187	Query Export FDN status	Authentication	FDNStatusReq	FDNStatusRes
Z-Report Daily Upload	T116	Z-report Daily Upload	Authentication	ZReportReq	ZReportRes

Credit & Debit Notes

Interface Name	Code	Description	Precondition	Request Object	Response Object
Credit Application	T110	Upload credit note against invoice	Authentication	CreditAppReq	CreditAppRes
Credit/Debit List Query	T111	Check credit note approval status	Authentication	CreditListReq	CreditListRes
Credit Application Detail	T112	Credit note application details retrieval	Authentication	CreditDetailReq	CreditDetailRes
Credit Note Approval	T113	Credit Note issue approval	Authentication	CreditApprovalReq	CreditApprovalRes
Cancel Credit/Debit App	T114	Cancel approved credit/debit note	Authentication	CancelCreditReq	CancelCreditRes
Query Cancel Detail	T118	Query Credit/Debit Note apply details	Authentication	CancelDetailReq	CancelDetailRes
Void Credit/Debit App	T120	Cancel credit note not yet approved	Authentication	VoidCreditReq	VoidCreditRes
Query Cancel Credit Detail	T122	Query cancel credit note details	Authentication	QueryCancelCreditReq	QueryCancelCreditRes

Goods & Stock Management

Interface Name	Code	Description	Precondition	Request Object	Response Object
Goods/Services Inquiry	T127	Goods/Services Inquiry	Authentication	GoodsInquiryReq	GoodsInquiryRes
Goods Inquiry by Code	T144	Goods/Services Inquiry by goods Code	Authentication	GoodsCodeReq	GoodsCodeRes
Goods/Services Upload	T130	Goods/Services Upload	Authentication	GoodsUploadReq	GoodsUploadRes
Query Stock Quantity	T128	Query stock quantity by goods id	Authentication	StockQtyReq	StockQtyRes
Goods Stock Maintain	T131	Goods stock management	Authentication	StockMaintainReq	StockMaintainRes
Goods Stock Transfer	T139	Transfer stock between branches	Authentication	StockTransferReq	StockTransferRes
Stock Records Query	T145	Goods Stock records query	Authentication	StockRecordsReq	StockRecordsRes
Stock Records Query (Diff)	T147	Stock records query (Current Branch)	Authentication	StockRecordsDiffReq	StockRecordsDiffRes
Stock Records Detail	T148	Goods Stock records detail query	Authentication	StockDetailReq	StockDetailRes
Stock Adjust Records	T149	Goods Stock Adjust records query	Authentication	StockAdjustReq	StockAdjustRes
Stock Adjust Detail	T160	Goods Stock Adjust detail query	Authentication	StockAdjustDetailReq	StockAdjustDetailRes
Stock Transfer Records	T183	Goods Stock Transfer records query	Authentication	StockTransRecReq	StockTransRecRes
Stock Transfer Detail	T184	Goods Stock Transfer detail query	Authentication	StockTransDetailReq	StockTransDetailRes

System & Dictionary

Interface Name	Code	Description	Precondition	Request Object	Response Object
System Dictionary Update	T115	System dictionary update	-	DictionaryReq	DictionaryRes
Query Commodity Category	T123	Query Commodity Category	-	CommodityCatReq	CommodityCatRes
Commodity Category Pagination	T124	Query Commodity Category pagination	-	CommodityPagReq	CommodityPagRes
Commodity Category Incremental	T134	Commodity category incremental update	Authentication	CatIncrementalReq	CatIncrementalRes
Query Excise Duty	T125	Obtain excise duty codes	-	ExciseDutyReq	ExciseDutyRes
Acquiring Exchange Rate	T121	Acquiring exchange rate	Authentication	ExchangeRateReq	ExchangeRateRes
Get All Exchange Rates	T126	Get All Exchange Rates	Authentication	AllExchangeRateReq	AllExchangeRateRes
Query Category/Excise by Date	T146	Query Commodity Category/Excise Duty	Authentication	CatExciseDateReq	CatExciseDateRes
Query HS Code List	T185	Query HS Code List	-	HSCodeReq	HSCodeRes

Taxpayer & Branch Management

Interface Name	Code	Description	Precondition	Request Object	Response Object
Query Taxpayer by TIN	T119	TIN validation	Authentication	TaxpayerTINReq	TaxpayerTINRes
Check Exempt/Deemed Taxpayer	T137	Check exempt/Deemed taxpayer	Authentication	CheckTaxpayerReq	CheckTaxpayerRes
Get All Branches	T138	Obtain all branches with IDs	-	BranchesReq	BranchesRes

EDC & Fuel Operations

Interface Name	Code	Description	Precondition	Request Object	Response Object
Query Fuel Type	T162	Query fuel type	-	FuelTypeReq	FuelTypeRes
Upload Shift Info	T163	Upload shift information	Authentication	ShiftInfoReq	ShiftInfoRes
Upload EDC Disconnection	T164	Upload EDC disconnection data	Authentication	EDCDisconnectReq	EDCDisconnectRes
Query Fuel Pump Version	T168	Query fuel pump version	-	PumpVersionReq	PumpVersionRes
Query Pump/Nozzle/Tank	T169	Query fuel pump, nozzle, tank by pump no	Authentication	PumpNozzleTankReq	PumpNozzleTankRes
Query EFD Location	T170	Query EFD location	Authentication	EFDLocationReq	EFDLocationRes
Query EDC UoM Rate	T171	Query EDC UoM exchange rate	-	EDCUoMReq	EDCUoMRes
Fuel Nozzle Status Upload	T172	Fuel nozzle status upload	Authentication	NozzleStatusReq	NozzleStatusRes
Query EDC Device Version	T173	Query Edc device Version	-	EDCVersionReq	EDCVersionRes

Agent & USSD Operations

Interface Name	Code	Description	Precondition	Request Object	Response Object
Account Creation USSD	T175	Account Creation for USSD taxpayer	Authentication	USSDAccountReq	USSDAccountRes
Negative Stock Config Inquiry	T177	Negative stock configuration inquiry	-	NegStockReq	NegStockRes
EFD Transfer	T178	EFD Transfer	Authentication	EFDTransferReq	EFDTransferRes
Query Agent Relation	T179	Query agent relation information	Authentication	AgentRelationReq	AgentRelationRes
Query Principal Agent TIN	T180	Query Principal agent TIN information	Authentication	PrincipalAgentReq	PrincipalAgentRes
Upload Frequent Contacts	T181	Upload Frequent Contacts	Authentication	FrequentContactReq	FrequentContactRes
Get Frequent Contacts	T182	Get Frequent Contacts	Authentication	GetFrequentContactReq	GetFrequentContactRes

Utilities

Interface Name	Code	Description	Precondition	Request Object	Response Object
Upload Exception Log	T132	Upload exception log	Authentication	ExceptionLogReq	ExceptionLogRes