API DOCUMENTATION

(FOR SYSTEM TO SYSTEM USERS)

Version 1.1

EFRIS
kakasa@ura.go.ug
 Document History
2019-04-03 V1.0 Create by URA

2020-7-13 V13.1 T109 goodsDetails:deemedFlag supported deemed

Add Error Code 2075 : Invoice amount exceeds the

2020-7-16 V13.2
maximum limit!

T115 currencyType Add field ‘description’

T131 Support stock-in and stock adjustment

2020-7-22 V13.3
Add Error Code：2076-2092

Add Interface T135：Get TCS Plus Latest Version

TABLE OF CONTENTS
Document History ................................................................................................................................................... 2

Interface specification ............................................................................................................................................. 4

Introduction ................................................................................................................................................... 4

Field description............................................................................................................................................. 5

ReturnCode description ................................................................................................................................. 7

Interface code table ..................................................................................................................................... 26

EFD interface code table ..................................................................................................................... 26

Customs interface code table ........................................................................................................... 114

Request/Response code table ................................................................................................................... 124

 Interface specification

Introduction

The system interface uses json format to transfer data. The protocol is divided into three
parts: data, globalInfo, and returnStateInfo.
 The data part contains the inner layer message and the encryption method of the message.

 The globalInfo part is a global variable containing interface information and other necessary

attributes.

 returnStateInfo part is the result status information.

Request message date format: yyyy-MM-dd HH24:mi:ss yyyy-MM-dd

Return message date format: Follow system time format
T101 return date format : dd/MM/yyyy HH:mm:ss
The outer layer protocol format is as follows:
{
"data": {
"content": "encrypted content",
"signature": "JKQWJK34K32JJEK2JQWJ5678",
"dataDescription": {
"codeType": "0",
"encryptCode": "1",
"zipCode": "0"
}
},
"globalInfo": {
"appId": "AP01",
"version": "1.1.20191201",
"dataExchangeId": "9230489223014123",
"interfaceCode": "T101",
"requestCode": "TP",
"requestTime": "2019-06-11 17:07:07",
"responseCode": "TA",
"userName": "admin",
 "deviceMAC": "FFFFFFFFFFFF",
"deviceNo": "00022000634",
"tin": "1009830865",
"brn": "",
"taxpayerID": "1",
"longitude": "116.397128",
"latitude": "39.916527",
"extendField": {
"responseDateFormat": "dd/MM/yyyy",
"responseTimeFormat": "dd/MM/yyyy HH:mm:ss"
}
},
"returnStateInfo": {
"returnCode": "",
"returnMessage": ""
}
}

Field description

Field Field Name Required Length Description

content Inner message Unlimite This field can be empty if the
d request message is empty.
N If the request message is not
empty, the field must be BASE64
encoded regardless of encryption.
signature Signature value Y
codeType YN encryption Y 1 0-plain text 1- ciphertext
1 If codeType is 1, encryptCode
takes effect
encryptCode Encryption Y
1-RSA
2-AES
zipCode YN compression Y 1 0-uncompressed 1-compressed
appId Y 5 AP01-for EFD
AP02-for CS
AP03-for APP(validation)
AP04-for system2system
version version number Y 15 Client software version number
1.1.20191201

dataExchangeI Data interaction ID Y 32 UUID

d
interfaceCode Interface coding Y 5 See the interface code table for
details.
requestCode Requester code Y 5 See Requester/Responder Code
Table for details.
requestTime Request time Y 20 YYYY-MM-DD HH24:mi:ss
responseCode Return square Y 5 See Requester/Responder Code
code Table for details.
userName username Y 20
deviceMAC Device MAC Y 25 FFFFFFFFFFFF
address
deviceNo device ID Y 20 DSN
tin tin Y 20 TIN

brn brn N 100 BRN

taxpayerID taxpayerID Y 20 taxpayerID

longitude longitude number The number of integer digits does

not exceed 20 digits and the
Y
number of decimal places does
not exceed 8 digits
latitude latitude number The number of integer digits does
not exceed 20 digits and the
Y
number of decimal places does
not exceed 8 digits
extendField Extend Field N Unlimite Reserved as an extension field
d
returnCode Return Code Y 2 ReturnCode description
returnMessage Return Message N Unlimite When the "returnCode" value is
d 99, the exception information will
be assigned to the field.
responseDate responseDateFor Y System date format
 Format mat
responseTime responseTimeFor System time format
Y
Format mat

ReturnCode description

ReturnCode Description
99 Unknow error
00 SUCCESS
01 Interface coding error
02 White box encryption failed
03 White box decryption failed
04 Read white box error
05 AppID error
06 The outer message is empty
07 GlobalInfo content cannot be empty
08 Data content cannot be empty
09 ReturnStateInfo content cannot be empty
10 DataDescription content cannot be empty
11 InterfaceCode cannot be empty
12 UserName cannot be empty
13 TaxpayerID cannot be empty
14 DeviceMAC cannot be empty
15 Unpacking data error
16 AppID cannot be empty
17 Version cannot be empty
18 DataExchangeId cannot be empty
19 RequestCode cannot be empty
20 RequestTime cannot be empty
21 ResponseCode cannot be empty
22 Currency cannot be empty
23 Tax rate acquisition error
24 The version cannot be longer than 15 characters
25 DataExchangeId cannot be greater than 32
characters!
26 RequestCode error
27 ResponseCode error
28 The difference between RequestTime and the current
time is greater than ten minutes!
29 DeviceMAC cannot be greater than 25 characters
30 AppID error
31 RequestTime time format error
32 Version is too low, please upgrade version
33 Version error
34 Longitude cannot be empty
35 Longitude cannot be greater than 60 characters
36 Latitude cannot be empty
37 Longitude cannot be greater than 60 characters
38 Signature value is invalid!
39 Signature value can not be empty!
40 Insufficient permissions!
41 Item does not exist！
42 Illegal request registration type error！
43 Outer packet json format is invalid!
100 Taxpayer does not exist
101 Taxpayer status is abnormal
102 Taxpayer branch status abnormal
300 The original invoice number does not exist
301 The original invoice number has not been completed
303 Update failed
304 According to the original invoice number, the
result is null
305 Invoice approval failed
306 Creditnote has been issued, duplicate submission
is not allowed
307 Get process template is empty
308 Approval failed
309 Items cannot be empty
310 The date cannot be voided
311 BusinessKey does not exist
312 Cannot apply for credit note/ debit note, the
fiscal document has exceeded the allowable
application days.
313 The application has been voided!
314 The application cannot be voided for initiated sub
process, please contact URA.
315 Successfully Operated
316 Seller does not have taxpayer account
317 Debitnote has been issued, duplicate submission
 is not allowed
318 The debit note has a cancellation request in
process, please don't apply repeatedly.
319 The credit note has been cancelled, please don't
apply repeatedly.
400 Device does not exist
401 Device key does not exist
402 Device key expired
403 Device status is abnormal
501 get captcha error！
502 Verification code is not correct！
503 Check ORCode error！
504 The invoice does not exist.
505 Report code does not exist！
1001 Device number cannot be empty
1002 Billing date cannot be empty ISSUEDDATE can't
NULL
1003 Operator cannot be empty OPERATOR can't NULL
1004 Currency cannot be empty
1005 Invoice type cannot be empty
1006 invoiceKind cannot be empty
1007 Data source cannot be empty
1008 TIN cannot be empty
1009 LEAGNAME cannot be empty
1010 BUYERBRN cannot be empty
1011 BUYERLEGALNAME cannot be empty
1012 BUYERTYPE cannot be empty
1013 product name cannot be empty
1014 QTY product name
1015 UNITOFMEASURE cannot be empty
1016 unitPrice cannot be empty
1017 TOTAL cannot be empty
1018 TAXRATE cannot be empty
1019 ORDERNUMBER cannot be empty
1020 DISCOUNTFLAG cannot be empty
1021 DEEMEDFLAG cannot be empty
1022 EXCISEFLAG cannot be empty
1023 TAXCATEGORY cannot be empty
1024 NETAMOUNT cannot be empty

1025 TAXRATE cannot be empty

1026 TAXAMOUNT cannot be empty
1027 GROSSAMOUNT cannot be empty
1028 NETAMOUNT cannot be empty
1029 TAXAMOUNT cannot be empty
1030 GROSSAMOUNT cannot be empty
1031 ITEMCOUNT cannot be empty

1032 MODECODE cannot be empty

1033 QRCODE cannot be empty

1040 Invoice number already exists

1100 sellerDetails-->tin:cannot be empty!

1101 sellerDetails-->tin:The byte length cannot be less
than 10 and cannot be greater than20!
1102 sellerDetails-->tin:The inner packet tin must be
the same as the tin packet in the outer packet.!
1103 sellerDetails-->ninBrn:cannot be empty!
1104 sellerDetails-->ninBrn:Byte length cannot be
greater than 20!
1105 sellerDetails-->legalName:cannot be empty!
1106 sellerDetails-->legalName:Byte length cannot be
greater than 256!
1107 sellerDetails-->businessName:cannot be empty!
1108 sellerDetails-->businessName:Byte length cannot
be greater than 256!
1109 sellerDetails-->address:cannot be empty!
1110 sellerDetails-->address:Byte length cannot be
greater than 500!
1111 sellerDetails-->mobilePhone:cannot be empty!
1112 sellerDetails-->mobilePhone:Byte length cannot be
greater than 30!
1113 sellerDetails-->linePhone:cannot be empty!
1114 sellerDetails-->linePhone:Byte length cannot be
greater than 30!
1115 sellerDetails-->emailAddress:cannot be empty!
1116 sellerDetails-->emailAddress:The byte length
cannot be less than 6 and cannot be greater than50!
1117 sellerDetails-->emailAddress:Must be an email
address
1118 sellerDetails-->placeOfBusiness:cannot be empty!
1119 sellerDetails-->placeOfBusiness:Byte length
cannot be greater than 500!
1120 sellerDetails-->referenceNo:cannot be empty!
1121 sellerDetails-->referenceNo:Byte length cannot be
greater than 50!
1122 basicInformation-->invoiceNo:cannot be empty!
1123 basicInformation-->invoiceNo:Byte length cannot
be greater than 20!
1124 basicInformation-->antifakeCode:cannot be empty!
1125 basicInformation-->antifakeCode:The byte length
cannot be less than 0 and cannot be greater than20!
1126 basicInformation-->antifakeCode:Cannot be greater
than -1!
1127 basicInformation-->deviceNo:The inner packet
deviceNo must be the same as the deviceNo packet
in the outer packet!
1129 basicInformation-->issuedDate:cannot be empty!
1130 basicInformation-->issuedDate:The time format
must beyyyy-MM-dd HH:mm:ss!
1131 basicInformation-->operator:cannot be empty!
1132 basicInformation-->operator:Byte length cannot be
greater than 100!
1133 basicInformation-->currency:cannot be empty!
1134 basicInformation-->currency:Byte length cannot be
greater than 10!
1135 basicInformation-->invoiceType:Invalid field
value!
1136 basicInformation-->oriInvoiceId:If 'invoiceType :
4', this field cannot be empty!
1137 basicInformation-->oriInvoiceId:cannot be empty!
1138 basicInformation-->oriInvoiceId:Byte length
cannot be greater than 20!
1139 basicInformation-->invoiceKind:Invalid field
value!
1140 basicInformation-->dataSource:Invalid field
value!
1141 basicInformation-->payWay:Invalid field value!
1142 buyerDetails-->buyerTin:cannot be empty!
1143 buyerDetails-->buyerTin:The byte length cannot be
less than 10 and cannot be greater than20!
1144 buyerDetails-->buyerNinBRn:cannot be empty!
1145 buyerDetails-->buyerNinBRn:Byte length cannot be
greater than 20!
1146 buyerDetails-->buyerPassportNum:cannot be empty!
1147 buyerDetails-->buyerPassportNum:Byte length
cannot be greater than 20!
1148 buyerDetails-->buyerLegalName:cannot be empty!
1149 buyerDetails-->buyerLegalName:Byte length cannot
be greater than 256!
1150 buyerDetails-->buyerBusinessName:cannot be empty!
1151 buyerDetails-->buyerBusinessName:Byte length
cannot be greater than 256!
1152 buyerDetails-->buyerAddress:cannot be empty!
1153 buyerDetails-->buyerAddress:Byte length cannot be
greater than 500!
1154 buyerDetails-->buyerEmail:cannot be empty!
1155 buyerDetails-->buyerEmail:The byte length cannot
be less than 6 and cannot be greater than50!
1156 buyerDetails-->buyerEmail:Must be an email
address
1157 buyerDetails-->buyerMobilePhone:cannot be empty!
1158 buyerDetails-->buyerMobilePhone:Byte length
cannot be greater than 30!
1159 buyerDetails-->buyerLinePhone:cannot be empty!
1160 buyerDetails-->buyerLinePhone:Byte length cannot
be greater than 30!
1161 buyerDetails-->buyerPlaceOfBusi:cannot be empty!
1162 buyerDetails-->buyerPlaceOfBusi:Byte length
cannot be greater than 500!
1163 buyerDetails-->buyerType:Invalid field value!
1164 buyerDetails-->buyerCitizenship:cannot be empty!
1165 buyerDetails-->buyerCitizenship:Byte length
cannot be greater than 128!
1166 buyerDetails-->buyerSector:cannot be empty!
1167 buyerDetails-->buyerSector:Byte length cannot be
greater than 200!
1168 buyerDetails-->buyerReferenceNo:cannot be empty!
1169 buyerDetails-->buyerReferenceNo:Byte length
cannot be greater than 50!
1170 goodsDetails-->deemedFlag:Invalid field value!
1171 goodsDetails-->discountFlag:Invalid field value!
1172 goodsDetails-->discountFlag:The first product
line cannot be a discount line, and 'discountFlag'
cannot be '0'!
1173 goodsDetails-->discountFlag:The previous line is
a discount line, this line must be a discount
line!
1174 goodsDetails-->discountFlag:The last line can not
be discounted line
1175 goodsDetails-->item:cannot be empty!
1176 goodsDetails-->item:Byte length cannot be greater
than 100!
1177 goodsDetails-->item:if the 'deemedFlag' is '1',
item + space + "(Deemed)"!
1178 goodsDetails-->item:if 'Discount' is '0', item +
space + "(Discount)"! If 'discountFlag' is '0' and
'deemedFlag' is '1' ,item + Space + "(Deemed)" +
Space + "(Discount)"
1179 goodsDetails-->itemCode:cannot be empty!
1180 goodsDetails-->itemCode:Byte length cannot be
greater than 50!
1181 goodsDetails-->qty:Discount line is the 'qty' must
be empty
1182 goodsDetails-->qty:cannot be empty!
1183 goodsDetails-->qtyThe integer character length
cannot exceed 12, and the decimal character length
cannot exceed 8!
1184 goodsDetails-->qty:Cannot be positive
1185 goodsDetails-->qty:Cannot be equal to 0
1186 goodsDetails-->qty:Cannot be negative
1187 goodsDetails-->unitPrice:If the merchandise line
is a discount line, the 'unitPrice' must be empty!
1188 goodsDetails-->unitPrice:cannot be empty!
1189 goodsDetails-->unitPrice:The integer character
length cannot exceed 12, and the decimal character
length cannot exceed 8!
1190 goodsDetails-->unitPrice:Cannot be positive
1191 goodsDetails-->unitPrice:Cannot be equal to 0
1192 goodsDetails-->unitPrice:Cannot be negative
1193 goodsDetails-->total:unitPrice:If the merchandise
line is a discount line, the 'total' must be empty
1194 goodsDetails-->total:cannot be empty!
1195 goodsDetails-->total:The integer character length
cannot exceed 12, and the decimal character length
cannot exceed 2!
1196 goodsDetails-->total:Cannot be positive
1197 goodsDetails-->total:Cannot be equal to 0
1198 goodsDetails-->total:Cannot be negative
1199 goodsDetails-->tax:Discount line is the 'tax' must
be empty
1200 goodsDetails-->tax:cannot be empty!
1201 goodsDetails-->tax:The integer character length
 cannot exceed 12, and the decimal character length
cannot exceed 2!
1202 goodsDetails-->tax:Cannot be positive
1203 goodsDetails-->tax:Cannot be equal to 0
1204 goodsDetails-->tax:Cannot be negative
1205 goodsDetails-->discountTotal:Normal and discount
lines are 'discountTotal' must be empty!
1206 goodsDetails-->total:Must be the same as the
discountTotal value of the discounted row!
1208 goodsDetails-->unitOfMeasure:Invalid field value!
1209 goodsDetails-->taxRate:cannot be empty!
1210 goodsDetails-->taxRateThe integer character
length cannot exceed 1, and the decimal character
length cannot exceed 4!
1211 goodsDetails-->taxRate:Cannot be positive
1212 goodsDetails-->taxRate:Cannot be equal to 0
1213 goodsDetails-->taxRate:Cannot be negative
1214 goodsDetails-->discountTaxRate:cannot be empty!
1215 goodsDetails-->discountTaxRate:The integer
character length cannot exceed 2, and the decimal
character length cannot exceed 4!
1216 goodsDetails-->discountTaxRate:Cannot be positive
1217 goodsDetails-->discountTaxRate:Cannot be equal to
0
1218 goodsDetails-->discountTaxRate:Cannot be negative
1219 goodsDetails-->orderNumber:Must start from zero
and add one each time
1220 goodsDetails-->exciseFlag:Invalid field value!
1221 goodsDetails-->categoryId:If 'exciseFlag' is '1',
it cannot be empty!
1222 goodsDetails-->categoryId:cannot be empty!
1223 goodsDetails-->categoryId:Byte length cannot be
greater than 18!
1224 goodsDetails-->categoryName:If 'exciseFlag' is
'1', it cannot be empty!
1225 goodsDetails-->categoryName:cannot be empty!
1226 goodsDetails-->categoryName:Byte length cannot be
greater than 1024!
1227 goodsDetails-->goodsCategoryId:cannot be empty!
1228 goodsDetails-->goodsCategoryId:Byte length cannot
be greater than 18!
1229 goodsDetails-->goodsCategoryName:cannot be empty!
1230 goodsDetails-->goodsCategoryName:Byte length
 cannot be greater than 100!
1231 goodsDetails-->exciseRate:If 'exciseFlag' is '1',
it cannot be empty!
1232 goodsDetails-->exciseRate:If 'exciseFlag' is '2',
it must be empty!
1233 goodsDetails-->exciseRate:cannot be empty!
1234 goodsDetails-->exciseRate:Byte length cannot be
greater than 21!
1235 goodsDetails-->exciseRule:If 'exciseFlag' is '1',
it cannot be empty!
1236 goodsDetails-->exciseRule:Invalid field value!
1237 goodsDetails-->exciseTax:If 'exciseFlag' is '1',
it cannot be empty!
1238 goodsDetails-->exciseTax:cannot be empty!
1239 goodsDetails-->exciseTax:The integer character
length cannot exceed 12, and the decimal character
length cannot exceed 2!
1240 goodsDetails-->exciseTax:Cannot be positive
1241 goodsDetails-->exciseTax:Cannot be equal to 0
1242 goodsDetails-->exciseTax:Cannot be negative
1243 goodsDetails-->pack:If 'exciseRule' is '2', it
cannot be empty!
1244 goodsDetails-->pack:cannot be empty!
1245 goodsDetails-->pack:The integer character length
cannot exceed 12, and the decimal character length
cannot exceed 8!
1246 goodsDetails-->pack:Cannot be positive
1247 goodsDetails-->pack:Cannot be equal to 0
1248 goodsDetails-->pack:Cannot be negative
1249 goodsDetails-->stick:If 'exciseRule' is '2', it
cannot be empty!
1250 goodsDetails-->stick:cannot be empty!
1251 goodsDetails-->stick:The integer character length
cannot exceed 12, and the decimal character length
cannot exceed 8!
1252 goodsDetails-->stick:Cannot be positive
1253 goodsDetails-->stick:Cannot be equal to 0
1254 goodsDetails-->stick:Cannot be negative
1255 goodsDetails-->exciseUnit:If 'exciseRule' is '2',
it cannot be empty!
1256 goodsDetails-->exciseUnit:Invalid field value!
1257 goodsDetails-->exciseCurrency:If 'exciseRule' is
'2', it cannot be empty!
1258 goodsDetails-->exciseCurrency:cannot be empty!
1259 goodsDetails-->exciseCurrency:Byte length cannot
be greater than 10!
1260 taxDetails-->taxCategory:cannot be empty!
1261 taxDetails-->taxCategory:Byte length cannot be
greater than 100!
1262 taxDetails-->netAmount:cannot be empty!
1263 taxDetails-->netAmountThe integer character
length cannot exceed 16, and the decimal character
length cannot exceed 2!
1264 taxDetails-->netAmount:Cannot be positive
1265 taxDetails-->netAmount:Cannot be equal to 0
1266 taxDetails-->netAmount:Cannot be negative
1267 goodsDetails-->qty:Required if discountFlag is 1
or 2!
1268 goodsDetails-->unitPrice:Required if discountFlag
is 1 or 2!
1269 taxDetails-->taxAmount:cannot be empty!
1270 taxDetails-->taxAmountThe integer character
length cannot exceed 16, and the decimal character
length cannot exceed 2!
1271 taxDetails-->taxAmount:Cannot be positive
1272 taxDetails-->taxAmount:Cannot be equal to 0
1273 taxDetails-->taxAmount:Cannot be negative
1274 taxDetails-->grossAmount:cannot be empty!
1275 taxDetails-->grossAmountThe integer character
length cannot exceed 16, and the decimal character
length cannot exceed 2!
1276 taxDetails-->grossAmount:Cannot be positive
1277 taxDetails-->grossAmount:Cannot be equal to 0
1278 taxDetails-->grossAmount:Cannot be negative
1279 taxDetails-->exciseUnit:cannot be empty!
1280 taxDetails-->exciseUnit:Byte length cannot be
greater than 3!
1284 taxDetails-->exciseCurrency:cannot be empty!
1285 taxDetails-->exciseCurrency:Byte length cannot be
greater than 10!
1289 summary-->netAmount:cannot be empty!
1290 summary-->netAmount:The integer character length
cannot exceed 16,and the decimal character length
cannot exceed 2!
1291 summary-->netAmount:Cannot be positive
1292 summary-->netAmount:Cannot be equal to 0
1293 summary-->netAmount:Cannot be negative
1294 summary-->taxAmount:cannot be empty!
1295 summary-->taxAmount:The integer character length
cannot exceed 16,and the decimal character length
cannot exceed 2!
1296 summary-->taxAmount:Cannot be positive
1297 summary-->taxAmount:Cannot be equal to 0
1298 summary-->taxAmount:Cannot be negative
1299 summary-->grossAmount:cannot be empty!
1300 summary-->grossAmount:The integer character
length cannot exceed 16,and the decimal character
length cannot exceed 2!
1301 summary-->grossAmount:Cannot be positive
1302 summary-->grossAmount:Cannot be equal to 0
1303 summary-->grossAmount:Cannot be negative
1304 summary-->itemCount:Must match the Number of all
product lines in goodsDetail-number of discount
lines!
1305 goodsDetails:The number of product lines cannot
exceed XX!
1306 summary-->modeCode:Invalid field value!
1307 summary-->remarks:cannot be empty!
1308 summary-->remarks:Byte length cannot be greater
than 500!
1310 summary-->qrCode:cannot be empty!
1311 summary-->qrCode:Byte length cannot be greater
than 500!
1312 extend-->reason:cannot be empty!
1313 extend-->reason:Byte length cannot be greater than
1024!
1314 extend-->reasonCode:cannot be empty!
1315 extend-->reasonCode:Byte length cannot be greater
than 3!
1316 goodsDetails-->total:Multiply the quantity by the
product of the unit price, and keep two decimals
after the decimal point (prior to a discarded
fraction (i.e., truncates))!
1317 taxDetails-->grossAmount:calculation error!
1318 goodsDetails-->goodsCategoryId:Invalid field
value!
1319 goodsDetails-->'goodsCategoryId':Dose not match
'goodsCategoryId'
1320 basicInformation-->invoiceNo:summary-->modeCode
 is 0, 'deviceNo' Can not be empty!
1321 basicInformation-->antiFakeCode:summary-
->modeCode is 0, 'antiFakeCode' Can not be empty!
1322 basicInformation-->qrCode:summary-->modeCode is
0, 'qrCode' Can not be empty!
1323 basicInformation-->invoiceNo:summary-->modeCode
is 1, ' invoiceNo ' Must be empty!
1324 basicInformation-->antiFakeCode:summary-
->modeCode is 1, 'antiFakeCode' Must be empty!
1325 basicInformation-->qrCode:summary-->modeCode is
1, 'qrCode' Must be empty!
1326 basicInformation-->invoiceKind:No VAT
registration, no invoice can be issued!
1327 goodsDetails-->categoryId:Invalid field value!
1328 goodsDetails-->categoryName:Does not match
'categoryId'!
1329 goodsDetails-->goodsCategoryId:Has been deleted!
1330 goodsDetails-->goodsCategoryId:Has been disabled!
1331 goodsDetails-->goodsCategoryId:Not a leaf node!
1332 goodsDetails-->taxRate:The tax rate for this
product is not tax-exempt!
1333 goodsDetails-->taxRate:This product is not in tax-
exempt period!
1334 goodsDetails-->taxRate:The tax rate for this
product is not tax-zero!
1335 goodsDetails-->taxRate:This product is not in tax-
zero period!
1336 goodsDetails-->taxRate:Invalid field value!
1337 goodsDetails-->categoryId:Has been deleted!
1338 goodsDetails-->categoryId:Not a leaf node!
1339 goodsDetails-->categoryId:Not effective!
1340 goodsDetails-->exciseRate:This product excise tax
cannot be Nil!
1341 goodsDetails-->exciseRate:Invalid field value!
1342 taxDetails-->:'netAmount' plus 'taxAmount' must
equal 'grossAmount'!
1343 summary-->netAmount:calculation mistake!
1344 summary-->taxAmount:Must be equal to the sum of
all taxAmount's in taxDetails!
1345 summary-->grossAmount:Must be equal to the sum of
all grossAmount's except 'taxCategory' is'Excise
Duty' in taxDetails!
1346 goodsDetails-->exciseTax:when exciseFlag is '1'
 and discountFlag is '0' Must be negative!
1347 goodsDetails-->exciseTax:When exciseFlag is '1'
and discountFlag is '1' or '2' Must be positive!
1400 The original invoice does not exist!
1401 Credit note for the original invoice has been
issued!
1402 Debit note for the original invoice has been
issued!
1403 oriInvoiceId must match oriInvoiceNo
1404 reasonCode:Invalid field value!
1405 Other reason can not be empty!
1406 reason:cannot be empty!
1407 reason:Byte length cannot be greater than 1024!
1408 applicationTime:cannot be empty!
1409 applicationTime:The time format must be:yyyy-MM-
dd HH:mm:ss!
1410 invoiceApplyCategoryCode:Invalid field value!
1411 currency:Must be the same as the original invoice!
1412 contactName:cannot be empty!
1413 contactName:Byte length cannot be greater than
200!
1414 contactMobileNum:cannot be empty!
1415 contactMobileNum:Byte length cannot be greater
than 30!
1416 contactEmail:cannot be empty!
1417 contactEmail:The byte length cannot be less than
6 and cannot be greater than 50!
1418 contactEmail:Must be an email address
1419 remark:cannot be empty!
1420 remark:Byte length cannot be greater than 500!
1421 sellersReferenceNo:cannot be empty!
1422 sellersReferenceNo:Byte length cannot be greater
than 50!
1423 goodsDetails-->orderNumber:cannot be empty!
1424 goodsDetails-->orderNumber:Must be numeric and
the byte length cannot be greater than 4!
1425 goodsDetails-->orderNumber:Cannot be greater than
-1
1426 goodsDetails-->orderNumber:Does not exist in the
original invoice!
1427 goodsDetails-->item:Must be the same as the
original invoice!
1428 goodsDetails-->itemCode:Must be the same as the
 original invoice!
1429 goodsDetails-->qty:cannot be empty!
1430 goodsDetails-->qty:The integer character length
cannot exceed 12, and the decimal character length
cannot exceed 8!
1431 goodsDetails-->qty:Cannot be positive!
1432 goodsDetails-->qty:Cannot be equal to 0!
1433 goodsDetails-->qty:Cannot be negative!
1434 goodsDetails-->qty:Cannot be larger than the
corresponding commodity line of the original
invoice!
1435 goodsDetails-->unitOfMeasure:Must be the same as
the original invoice!
1437 taxDetails-->taxRate:cannot be empty!
1438 taxDetails-->taxRate:The integer character length
cannot exceed 12, and the decimal character length
cannot exceed 8!
1439 taxDetails-->taxRate:Cannot be positive!
1440 taxDetails-->taxRate:Cannot be equal to 0!
1441 taxDetails-->taxRate:Cannot be negative!
1443 goodsDetails-->taxRate:Must be the same as the
original invoice!
1444 goodsDetails-->tax:cannot be empty!
1445 goodsDetails-->tax:The integer character length
cannot exceed 12, and the decimal character length
cannot exceed 2!
1446 goodsDetails-->tax:Cannot be positive!
1447 goodsDetails-->tax:Cannot be equal to 0!
1448 goodsDetails-->tax:Cannot be negative!
1449 goodsDetails-->tax:Cannot be larger than the
corresponding commodity line of the original
invoice!
1450 goodsDetails-->total:cannot be empty!
1451 goodsDetails-->total:The integer character length
cannot exceed 12, and the decimal character length
cannot exceed 2!
1452 goodsDetails-->total:Cannot be positive!
1453 goodsDetails-->total:Cannot be equal to 0!
1454 goodsDetails-->total:Cannot be negative!
1455 goodsDetails-->unitPrice:cannot be empty!
1456 goodsDetails-->unitPrice:The integer character
length cannot exceed 12, and the decimal character
length cannot exceed 8!
1457 goodsDetails-->unitPrice:Cannot be positive!
1458 goodsDetails-->unitPrice:Cannot be equal to 0!
1459 goodsDetails-->unitPrice:Cannot be negative!
1460 goodsDetails-->total:The absolute value cannot be
greater than the sum of the product amount and
discountTotal of the corresponding ticket!
1461 goodsDetails-->deemedFlag:Must be the same as the
original invoice!
1462 goodsDetails-->exciseFlag:Must be the same as the
original invoice!
1463 goodsDetails-->categoryId:Must be the same as the
original invoice!
1464 goodsDetails-->goodsCategoryId:Must be the same
as the original invoice!
1465 goodsDetails-->goodsCategoryName:Must be the same
as the original invoice!
1466 goodsDetails-->exciseRate:Must be the same as the
original invoice!
1467 goodsDetails-->exciseRule:Must be the same as the
original invoice!
1468 goodsDetails-->exciseTax:cannot be empty!
1469 goodsDetails-->exciseTax:The integer character
length cannot exceed 12, and the decimal character
length cannot exceed 2!
1470 goodsDetails-->exciseTax:Cannot be positive!
1471 goodsDetails-->exciseTax:Cannot be equal to 0!
1472 goodsDetails-->exciseTax:Cannot be negative!
1473 goodsDetails-->pack:Must be the same as the
original invoice!
1474 goodsDetails-->stick:Must be the same as the
original invoice!
1475 goodsDetails-->exciseUnit:Must be the same as the
original invoice!
1476 goodsDetails-->exciseCurrency:Must be the same as
the original invoice!
1477 goodsDetails-->exciseRateName:Must be the same as
the original invoice!
1478 taxDetails-->taxRateName:cannot be empty!
1479 taxDetails-->taxRateName:Byte length cannot be
greater than 100!
1480 Credit Note request is illegal!
1500 invoiceNo:cannot be empty!
1501 invoiceNo:Byte length cannot be greater than 20!
1502 deviceNo:cannot be empty!
1503 deviceNo:Byte length cannot be greater than 20!
1504 oriInvoiceNo:cannot be empty!
1505 oriInvoiceNo:Byte length cannot be greater than
20!
1506 buyerTin:cannot be empty!
1507 buyerTin:Byte length cannot be greater than 20!
1508 buyerNinBrn:cannot be empty!
1509 buyerNinBrn:Byte length cannot be greater than 20!
1510 buyerLegalName:cannot be empty!
1511 buyerLegalName:Byte length cannot be greater than
256!
1512 combineKeywords:cannot be empty!
1513 combineKeywords:Byte length cannot be greater than
20!
1514 invoiceType:Invalid field value!
1515 isInvalid:Invalid field value!
1516 isRefund:Invalid field value!
1517 startDate:cannot be empty!
1518 startDate:The time format must beyyyy-MM-dd
HH:mm:ss!
1519 endDate:cannot be empty!
1520 endDate:The time format must beyyyy-MM-dd
HH:mm:ss!
1521 pageNo:cannot be empty!
1522 pageNo:The byte length cannot be less than 0 and
cannot be greater than 20!
1523 pageNo:Cannot be greater than -1!
1524 pageSize:cannot be empty!
1525 pageSize:The byte length cannot be less than 0 and
cannot be greater than 3!
1526 pageSize:Cannot be greater than 100!
1550 referenceNo:cannot be empty!
1551 referenceNo:Byte length cannot be greater than 20!
1552 approveStatus:Invalid field value!
1553 queryType:Invalid field value!
1554 invoiceApplyCategoryCode:Invalid field value!
1555 id:cannot be empty!
1556 id:Byte length cannot be greater than 20!
1557 remark:cannot be empty!
1558 remark:Byte length cannot be greater than 1024!
1559 taskId:cannot be empty!
1560 taskId:Byte length cannot be greater than 20!
1561 invoiceNo:Invoice does not exist!
1562 oriInvoiceId:'oriInvoiceId' and 'invoiceNo' do
not match!
1563 invoiceApplyCategoryCode:This invoice is not
debitNote!
1564 invoiceApplyCategoryCode:This invoice is not
credit note!
1565 reason:cannot be empty!
1566 reason:Byte length cannot be greater than 1024!
1567 reasonCode:Invalid field value!
1568 reason:If 'reasonCode' is '103', it cannot be
empty!
1569 The size of the collection cannot be larger
than ? !
1570 id:cannot be empty!
1571 id:Byte length cannot be greater than 20!
1572 'tin' and 'ninBrn' cannot be empty at the same
time!
1573 tin:cannot be empty!
1574 tin:Byte length cannot be greater than 20!
1575 ninBrn:cannot be empty!
1576 ninBrn:Byte length cannot be greater than 20!
1577 businessKey:cannot be empty!
1578 businessKey:Byte length cannot be greater than 20!
1579 referenceNo:cannot be empty!
1580 referenceNo:Byte length cannot be greater than 20!
1581 currency:cannot be empty!
1582 currency:Byte length cannot be greater than 3!
1600 Inventory shortage
1610 invoiceContent:cannot be empty!
1611 invoiceSignature:cannot be empty!
1612 Invoice upload quantity cannot be greater than xx
1613 Batch upload has problematic invoices, please
check inner 'invoiceReturnCode' and
'invoiceReturnMessage'!
2000 basicInformation-->sadNumber:cannot be empty!
2001 basicInformation-->sadNumber:Byte length cannot
be greater than 20!
2002 basicInformation-->sadDate:cannot be empty!
2003 basicInformation-->sadDate:The time format must
beyyyy-MM-dd HH:mm:ss!
2004 basicInformation-->cpcCode:cannot be empty!
2005 basicInformation-->cpcCode:Byte length cannot be
 greater than 16!
2006 basicInformation-->cpcDescription:cannot be
empty!
2007 basicInformation-->cpcDescription:Byte length
cannot be greater than 256!
2008 basicInformation-->wareHouseNumber:cannot be
empty!
2009 basicInformation-->wareHouseNumber:Byte length
cannot be greater than 16!
2010 basicInformation-->wareHouseName:cannot be empty!
2011 basicInformation-->wareHouseName:Byte length
cannot be greater than 256!
2012 goodsDetails-->hsCode:cannot be empty!
2013 goodsDetails-->hsCode:Byte length cannot be
greater than 16!
2014 goodsDetails-->hsCode:Invalid field value!
2015 basicInformation-->sadNumber:SAD Number already
exists!
2016 tin:cannot be empty!
2017 tin:Byte length cannot be greater than 20!
2018 ninBrn:cannot be empty!
2019 ninBrn:Byte length cannot be greater than 100!
2020 taxpayerName:cannot be empty!
2021 taxpayerName:Byte length cannot be greater than
256!
2022 invoiceNo:cannot be empty!
2023 invoiceNo:Byte length cannot be greater than 20!
2024 sadNumber:cannot be empty!
2025 sadNumber:Byte length cannot be greater than 20!
2026 destinationCountry:cannot be empty!
2027 destinationCountry:Byte length cannot be greater
than 256!
2028 originCountry:cannot be empty!
2029 originCountry:Byte length cannot be greater than
256!
2030 sadNumber:SAD Number already exists!
2031 invoiceNo:Invoice does not exist!
2032 invoiceNo:Invoice has been exported!
2033 tin:The invoice was not issued by this tin
2034 tin:Cannot use customs interface!
2035 Already confirmed!
2036 Already canceled!
2037 invoiceNo or sadNumber does not exist!
2038 basicInformation-->office:cannot be empty!
2039 basicInformation-->office:Byte length cannot be
greater than 35!
2040 basicInformation-->cif:cannot be empty!
2041 basicInformation-->cif:Byte length cannot be
greater than 50!
2042 basicInformation-->valuationMethod:cannot be
empty!
2043 basicInformation-->valuationMethod:Byte length
cannot be greater than 128!
2044 summary-->prn:cannot be empty!
2045 summary-->prn:Byte length cannot be greater than
80!
2046 basicInformation-->office,cif:Already exists
2047 basicInformation-->invoiceIndustryCode:Invalid
field value!
2048 goodsDetails-->taxRate:taxRate error！
2049 Debit Note cannot be issued for export invoices
2050 Export invoice cannot apply for Credit Note
2051 basicInformation-->isBatch:Invalid field value!
2052 interruptionTypeCode:Invalid field value!
2053 description:cannot be empty!
2054 description:Byte length cannot be greater than
200!
2055 errorDetail:cannot be empty!
2056 errorDetail:Byte length cannot be greater than
200!
2057 interruptionTime:cannot be empty
2058 interruptionTime:The time format must be yyyy-MM-
dd HH:mm:ss
2059 commodityCategoryVersion cannot be empty
2060 referenceNo byte length cannot be greater than 50
2061 The application has been processed
2062 goodsDetails-->pack:cannot be empty!
2063 goodsDetails-->pack:Byte length cannot be greater
than 1024!
2064 basicInformation-->invoiceNo:summary-->modeCode
is 0, 'invoiceNo' error!
2065 basicInformation-->sellerDetails:ninBrn-->The
NinBrn is not correct!
2066 T109:data-->content:Illegal json format!
2067 sellerDetails-->cannot be empty!
2068 basicInformation-->cannot be empty!
2069 buyerDetails-->cannot be empty!
2070 T109:data-->content:cannot be empty!
2071 goodsDetails-->cannot be empty!
2072 summary-->cannot be empty!
2073 when invoiceType is 4,extend cannot be empty!
2074 Original invoice Id is not correct!
2075 Invoice amount exceeds the maximum limit!
2076 operationType:cannot be empty!
2077 operationType:Byte length cannot be greater than
3!
2078 operationType:Invalid field value!
2079 supplierTin:cannot be empty!
2080 supplierTin:Byte length cannot be greater than 50!
2081 If 'operationType : 101',supplierName cannot be
empty!
2082 supplierName:Byte length cannot be greater than
100!
2083 If 'operationType : 102',supplierName must be
empty!
2084 If 'operationType : 102',supplierTin must be
empty!
2085 If 'adjustType : 104',remarks cannot be empty!
2086 remarks:Byte length cannot be greater than 1024!
2087 If 'operationType : 101',adjustType must be empty!
2088 If 'operationType : 102',adjustType cannot be
empty!
2089 adjustType:Byte length cannot be greater than 3!
2090 adjustType:Invalid field value!
2091 Item is not in stock!
2092 Original inventory quantity cannot be less than
the reduced quantity!

Interface code table

EFD interface code table

Interface Name Interface Code Description

Get server time T101
Client initialization T102
log in T103
Get symmetric key and T104
signature information
forget password T105
Invoice /Receipt query T106
Query Normal Invoice/Receipt T107
Invoice details T108
Billing upload T109
Credit Application T110
Credit/Cancel Debit Note T111
Application List Query
Credit Note application T112
detail
Credit Note issue approval T113
Credit Note application T114
cancel
System dictionary update T115
Z-report Daily report upload T116
Invoice reconciliation T117
Query Credit Note Application T118
and Cancel of Debit Note
Application Details
Query Taxpayer Information By T119
TIN
Void Credit Debit/Note T120
Application
Acquiring exchange rate T121
Query invalid cedit note T122
details
Query Commodity Category T123
Query Commodity Category T124
pagination
Query Excise Duty T125
Get All Exchange Rates T126
Goods/Services Inquiry T127
Query the stock quantity by T128
goods id
Batch Invoice Upload T129
Goods Upload T130
Goods Stock Maintain T131
Upload exception log T132
TCS upgrade system file T133
download
Query Commodity Category T134
Maintenance by
commodityCategoryVersion
Get Tcs Latest Version T135

1. Get server time

Interface Name Get server time

Description The EFD time is synchronized with the server time.
Interface Code T101
Request
N
Encrypted
Response
N
Encrypted
Request Message Null
{
Response
"currentTime": "30/07/2019 15:30:01"
Message
}
Flow
Null
Description

Field description

Field Field Name Required Length Description

currentTime current time Y 20 dd/MM/yyyy HH:mm:ss

2. Client initialization

Interface Name Client initialization

Get the private key of the machine, the private key is encrypted by white
Description
box
Interface Code T102
Request
N
Encrypted
Response
N
Encrypted
Request Message Null
{
Response
"clientPriKey": "vovhW9PY7YUPA98X36BSM8V1OA3gSyF+nTNWAeiVsXMIc",
Message
"serverPubKey": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQ",
 "keyTable": "OiJ2b3ZoVzlQWTdZVVBBOThYMzZCU004VjFPQTN"
}
1. The client requests to obtain the client RSA private key.

2. The server verifies that tin matches deviceNo and the status is normal.
Flow 3. Get the private key clientPriKey of the device, call the white box encryption program,
Description encrypt the private key, the white box will return the encrypted clientPriKey and
keyTable, and the server will return these two values to the client.

4. The client receives the data and saves it to the library.

Field description

Field Field Name Required Length Description

clientPriKey Encrypted client 1000 The private key of the client,
private key Y used to decrypt the encrypted
string returned by the server.
serverPubKey Server public key Y
keyTable White box Used to decrypt the client
Y
private key

3. Sign in

Interface Name log in

Description Client login
Interface Code T103
Request
N
Encrypted
Response
Y
Encrypted
Request Message Null
{
"device": {
"deviceModel": "AE320",
"deviceNo": "20190611",
"deviceStatus": "252",
Response
"deviceType": "1",
Message
"validPeriod": "13/06/2019",
"offlineAmount": "10000000000",
"offlineDays": "90",
"offlineValue": "1000000000000"
},
"taxpayer": {
"id": "112312313213213213",
"tin": "123456",
"ninBrn": "2222",
"legalName": "admin",
"businessName": "1",
"taxpayerStatusId": "101",
"taxpayerRegistrationStatusId": "401",
"taxpayerType": "201",
"businessType": "501",
"departmentId": "000001",
"contactName": "admin",
"contactEmail": "123@qq.com",
"contactMobile": "18888888888",
"contactNumber": "010-88898888",
"placeOfBusiness": "beijing"
},
"taxpayerBranch": {
"branchCode": "02",
"branchName": "Delicious No.2 shop",
"branchType": "101",
"contactName": "admin",
"contactEmail": "123@qq.com",
"contactMobile": "18888888888",
"contactNumber": "010-88898888",
"placeOfBusiness": "beijing"
},
"taxType": [{
"taxTypeName": "Value Added Tax",
"taxTypeCode": "301",
"registrationDate": "04/09/2019",
"cancellationDate": "12/09/2019"
}, {
"taxTypeName": "Income Tax",
"taxTypeCode": "302",
"registrationDate": "04/09/2019",
"cancellationDate": "12/09/2019"
}],
"dictionaryVersion": "1",
"issueTaxTypeRestrictions": "1",
"taxpayerBranchVersion": "1",
"commodityCategoryVersion": "1",
"exciseDutyVersion": "1",
"sellersLogo": "1",
 "whetherEnableServerStock": "1",
"goodsStockLimit": "101",
"exportCommodityTaxRate": "0",
"exportInvoiceExciseDuty": "0",
"maxGrossAmount": "1000"
}
1. Return taxpayer information, device information

2. For the first login, the dictionaryVersion exists locally. The second comparison
Flow compares the local dictionaryVersion with the dictionaryVersion. If the
Description dictionaryVersion is greater than the local dictionaryVersion, the T115 interface is
called to update the dictionary information. If it is equal, it is not necessary to call
T115.

Field description

Field Field Name Required Length Description

device
deviceModel Equipment model Y
deviceNo Device number Y
deviceStatus equipment status Corresponding dictionary
Y
deviceStatus
offlineAmount The maximum
number of
Y
invoices that can
be issued
offlineDays Offline limit
Y
days
offlineValue The maximum
invoice amount
Y
that can be
issued
deviceType Equipment type Y
validPeriod Equipment
Y
expiration date
taxpayer
id Taxpayer ID Y
tin TIN Y
ninBrn ninBrn Y
legalName taxpayer name Y
businessName taxpayer name Y
businessType business type Y Corresponding dictionary
 businessType
taxpayerStatu Taxpayer status Corresponding dictionary
Y
sId taxpayerStatus
taxpayerRegis Taxpayer Corresponding dictionary
trationStatus registration Y registrationStatus
Id status
taxpayerType Taxpayer type Corresponding dictionary
Y
taxpayerType
departmentId Organization ID Y
contactEmail mailbox Y
contactMobile contact number Y
contactNumber Landline Y
contactName Contact Y
placeOfBusine Business place
Y
ss
taxpayerBranch
branchCode Branch code N
branchName Branch name N
branchType Branch type Corresponding dictionary
N
branchType
contactEmail mailbox N
contactMobile contact number N
contactNumber Landline N
contactName Contact N
placeOfBusine Business place
N
ss
taxType
taxTypeName Tax type name Y
taxTypeCode Tax type Corresponding dictionary
Y
taxType
registrationD effective date
Y
ate
cancellationD Obsolete date
Y
ate

dictionaryVer Dictionary
Y
sion version
issueTaxTypeR issueTaxTypeRest 0:No 1:Yes
Y
estrictions rictions
taxpayerBranc taxpayerBranchVe
Y
hVersion rsion
commodityCate commodityCategor
Y
goryVersion yVersion
 exciseDutyVer exciseDutyVersio
Y
sion n
sellersLogo Sellers Logo Y Base64 content
goodsStockLim goodsStockLimit 101: restricted, inventory
it cannot be negative
Y
102: unlimited, inventory can
be negative
exportCommodi exportCommodityT If the tax rate is 1%,
Y
tyTaxRate axRate deposit 0.01
exportInvoice exportInvoiceExc 0:No 1:Yes
Y
ExciseDuty iseDuty
maxGrossAmoun maxGrossAmount Max Gross Amount for
t Y Invoice(UGX)

4. Obtaining Symmetric Key and Signature

Interface Name Get symmetric key and signature information

Description Get symmetric key and signature information
Interface Code T104
Request
N
Encrypted
Response
N
Encrypted
Request Message Null
{
Response "passowrdDes": "12345678",
Message "sign": "213456"
}
1. The client gets a symmetric key every time you log in, and all
Flow subsequent encryption is encrypted by symmetric key.
Description 2. The server randomly generates an 8-bit symmetric key and a signature
value for encryption.

Field description

Field Field Name Required Length Description

passowrdDes Encrypted Used to encrypt and decrypt all
Y
symmetric key data after login
sign Signature value Y
 5. Forget Password

Interface Name forget password

Description forget password
Interface Code T105
Request
Y
Encrypted
Response
N
Encrypted
{
"userName": "admin",
Request Message
"changedPassword": "123456"
}
Response
Null
Message
1. The enterprise user forgets the password, resubmits the password
Flow
corresponding to the user name, and finds the enterprise user email to
Description
send the account information.

Field description

Field Field Name Required Length Description

userName username Y
changedPasswo Modified
Y
rd password

6. Invoice /Receipt query

Interface Name Invoice inquiry

Query all invoice information（Invoice /receipt CreditNode ,Debit
Description
Node,Cancel CreditNode ,Debit Node）
Interface Code T106
Request
Y
Encrypted
Response
Y
Encrypted
{
"oriInvoiceNo": "00000000002",
Request Message
"invoiceNo": "00000000001",
"deviceNo": "00031000092",
 "buyerTin": "7777777777",
"buyerNinBrn": "00000000001",
"buyerLegalName": "lisi",
"combineKeywords": "7777777",
"invoiceType": "1",
"invoiceKind": "1",
"isInvalid": "1",
"isRefund": "1",
"startDate": "2019-06-14",
"endDate": "2019-06-15",
"pageNo": "1",
"pageSize": "10",
"referenceNo": "425502528294126235"
}
{
"page": {
"pageNo": "1",
"pageSize": "10",
"totalSize": " Total number of articles ",
"pageCount": "total pages"
},
"records": [{
"id": "159078217852531032",
"invoiceNo": "00000000001",
"oriInvoiceId": "00000000003",
"oriInvoiceNo": "00000000002",
"issuedDate": "15/06/2019 02:00:00",
"buyerTin": "7777777777",
"buyerLegalName": "test",
Response Message
"buyerNinBrn": "00000000001",
"currency": "UGX",
"grossAmount ": "2000.00",
"taxAmount ": "2000.00",
"dataSource": "101",
"isInvalid": "1",
"isRefund": "1",
"invoiceType": "1",
"invoiceKind": "1",
"invoiceIndustryCode": "102"

}, {
"id": "159078217852531032",
"invoiceNo": "00000000001",
"oriInvoiceId": "00000000004",
 "oriInvoiceNo": "00000000002",
"issuedDate": "15/06/2019 02:00:03",
"buyerTin": "7777777777",
"buyerLegalName": "test",
"buyerNinBrn": "00000000001",
"currency": "UGX",
"grossAmount ": "2000.00",
"taxAmount ": "2000.00",
"dataSource": "101",
"isInvalid": "1",
"isRefund": "1",
"invoiceType": "1",
"invoiceKind": "1",
"invoiceIndustryCode": "102"

}]
}
The data is arranged in reverse order according to the date of issue.Only query the seller
Flow Description Tin equal to (the outer packet gets Tin)

Field description

Field Field Name Required Length Description

invoiceNo Invoice number 20 The query debitnote
N corresponds to the Invoice
No. of the positive ticket
deviceNo Device No N 20
oriInvoiceNo oriInvoiceNo N 20
buyerTin Buyer TIN N 10
buyerNinBrn Buyer NinBrn N 100
buyerLegalNam Buyer name 256
N
e
combineKeywor EFD query 20
N
ds conditions
invoiceType invoice type 1 1: Ticket 2: Credit 3:
Temporary ticket 4: debit
N
Corresponding dictionary
table invoiceType
invoiceKind invoice kind Y 1 1 :Invoice 2: Receipt
isInvalid Obsolete sign 1 Obsolete sign 1: Obsolete 0:
N Not invalid Note: Obsolete
only for negative and
 supplementary tickets
isRefund Is it open to a 1 Whether it is opened for a
credit ticket / Debit Note: 0 - not
note/Debit Note N issued a negative ticket /
Debit 1- is issued Credit 2-
is issued Debit
startDate start date N yyyy-MM-dd
endDate End date N yyyy-MM-dd
pageNo current page 10
Y
number
pageSize How many records 3 Cannot be greater than the
are displayed per Y integer 100
page
referenceNo referenceNo N 50 Seller‘s Reference No.

Field Field Name Required Length Description

id Invoice ID Y
invoiceNo Invoice number Y
oriInvoiceId Original invoice
Y
ID
oriInvoiceNo Original invoice
Y
number
issuedDate Billing date Y
businessName business name Y
buyerTin Buyer TIN
buyerLegalNam Buyer name
Y
e
taxAmount tax Y
buyerNinBrn Buyer NinBrn Y
currency Currency Y
grossAmount total amount Y
dataSource Data Sources 101:efd 102:cs
103:webService api 104:BS
Y
Corresponding dictionary
table invoiceApplySource
invoiceType invoice type 1:invoice 2:Credit 3:
Temporary 4:debit
Y
Corresponding dictionary
table invoiceType
invoiceKind invoice kind Y 1 1 :Invoice 2: Receipt
isInvalid Obsolete sign Obsolete sign 1：obsolete 0：
Y Not obsolete Note: Obsolete
only for positive and
 supplementary tickets
isRefund Is it open to a Whether it is opened for a
credit ticket / Debit Note: 0 - not
note/Debit Note N issued a negative ticket /
Debit 1- is issued Credit 2-
is issued Debit
pageNo current page
Y
number
pageSize How many records
are displayed per Y
page
totalSize Total number of
Y
articles
pageCount total pages Y
invoiceIndust invoiceIndustryC 101 general industry
ryCode ode N 102 export
103 import

7. Query Normal Invoice/Receipt

Interface Name Apply for invoice inquiry

Query all Invoice/Receipt invoice information that can be issued with
Description
Credit Note, Cancel Debit Note
Interface Code T107
Request
Y
Encrypted
Response
Y
Encrypted
{
"invoiceNo": "00000000001",
"deviceNo": "00031000092",
"buyerTin": "7777777777",
"buyerLegalName": "lisi",
Request Message "invoiceType": "1",
"startDate": "2019-06-14",
"endDate": "2019-06-15",
"pageNo": "1",
"pageSize": "10"
}
{
"page": {
Response Message
"pageNo": "1",
"pageSize": "10",
 "totalSize": "Total number of articles",
"pageCount": "total pages"
},
"records": [{
"id": "159078217852531032",
"invoiceNo": "00000000001",
"oriInvoiceId": "00000000004",
"oriInvoiceNo": "00000000005",
"issuedDate": "15/06/2019 02:00:04",
"buyerTin": "7777777777",
"buyerBusinessName": "URA",
"buyerLegalName": "test",
"tin": "8888888888",
"businessName": "URA1",
"legalName": "test",
"currency": "UGX",
"grossAmount ": "2000.00",
"dataSource": "101"
}, {
"id": "159078217852531032",
"invoiceNo": "00000000001",
"oriInvoiceId": "00000000004",
"issuedDate": "15/06/2019 02:04:05",
"buyerTin": "7777777777",
"buyerBusinessName": "URA",
"buyerLegalName": "test",
"currency": "UGX",
"grossAmount ": "2000.00",
"dataSource": "101"
}]
}
1. Display the positive invoices that the current taxpayer has opened, and filter out the
current positive invoices without submitting a credit note or Debit note application, and
Not obsolete
Flow Description
2. The data is arranged in reverse order according to the date of issue.

3. Only query the seller Tin equal to (the outer packet gets Tin)

Field description

Field Field Name Required Length Description

invoiceNo Invoice number N 20
deviceNo Device No N 20
buyerTin Buyer TIN N 100
buyerLegalNam Buyer Legal Name 20
N
e
invoiceType invoice type N 1 1:invoice 4:debit
startDate start date N 20 yyyy-MM-dd
endDate End date N 20 yyyy-MM-dd
pageNo current page 10
Y
number
pageSize How many records 3 Cannot be greater than the
are displayed Y integer 100
per page

Field Field Name Required Length Description

id Invoice ID Y
invoiceNo Invoice number Y
oriInvoiceId Original Invoice
Y
ID
oriInvoiceNo oriInvoiceNo Y
issuedDate Billing date Y
buyerTin Buyer TIN Y
buyerBusiness business name
Y
Name
buyerLegalNam Buyer Legal Name
Y
e
tin Seller TIN Y
businessName Seller business
Y
Name
legalName Seller legalName Y
currency currency Y
grossAmount Gross Amount Y
dataSource Data Source 101:efd 102:cs
103:webService api 104:BS
Y
Corresponding dictionary
table invoiceApplySource
pageNo current page
Y
number
pageSize How many records
are displayed Y
per page
totalSize Total number of
Y
articles
 pageCount total pages Y

8. Invoice details

Interface Name Invoice details

Description Invoice details are queried according to Invoice number.
Interface Code T108
Request
Y
Encrypted
Response
Y
Encrypted
{
Request Message "invoiceNo": "159078217852531032"
}
{
"sellerDetails": {
"tin": "201905081705",
"ninBrn": "201905081705",
"passportNumber": "201905081705",
"legalName": "zhangsan",
"businessName": "lisi",
"address": "beijin",
"mobilePhone": "15501234567",
"linePhone": "010-6689666",
"emailAddress": "123456@163.com",
"placeOfBusiness": "beijin",
"referenceNo": "00000000012"
},
Response Message "basicInformation": {
"invoiceId": "1000002",
"invoiceNo": "00000000001",
"oriInvoiceNo": "00000000002",
"antifakeCode": "201905081711",
"deviceNo": "201905081234",
"issuedDate": "08/05/2019 17:13:12",
"oriIssuedDate": "08/05/2019 17:13:12",
"oriGrossAmount": "9247",
"operator": "URA",
"currency": "UGX",
"oriInvoiceId": "1",
"invoiceType": "1",
"invoiceKind": "1",
"dataSource": "101",
 "isInvalid": "1",
"isRefund": "1",
"invoiceIndustryCode": "102"
},
"buyerDetails": {
"buyerTin": "201905081705",
"buyerNinBrn": "201905081705",
"buyerPassportNum": "201905081705",
"buyerLegalName": "zhangsan",
"buyerBusinessName": "lisi",
"buyerAddress": "beijin",
"buyerEmail": "123456@163.com",
"buyerMobilePhone": "15501234567",
"buyerLinePhone": "010-6689666",
"buyerPlaceOfBusi": "beijin",
"buyerType": "1",
"buyerCitizenship": "1",
"buyerSector": "1",
"buyerReferenceNo": "00000000001"
},
"goodsDetails": [{
"item": "apple",
"itemCode": "101",
"qty": "2",
"unitOfMeasure": "kg",
"unitPrice": "150.00",
"total": "1",
"taxRate": "0.18",
"tax": "12.88",
"discountTotal": "18.00",
"discountTaxRate": "0.18",
"orderNumber": "1",
"discountFlag": "1",
"deemedFlag": "1",
"exciseFlag": "2",
"categoryId": "5648",
"categoryName": "Test",
"goodsCategoryId": "5673",
"goodsCategoryName": "Test",
"exciseRate": "0.12",
"exciseRule": "1",
"exciseTax": "20.22",
"pack": "1",
"stick": "20",
 "exciseUnit": "101",
"exciseCurrency": "UGX",
"exciseRateName": "123"
}, {
"item": "car",
"itemCode": "101",
"qty": "2",
"unitOfMeasure": "kg",
"unitPrice": "150.00",
"total": "1",
"taxRate": "0.18",
"tax": "12.88",
"discountTotal": "18.00",
"discountTaxRate": "0.18",
"orderNumber": "2",
"discountFlag": "1",
"deemedFlag": "1",
"exciseFlag": "2",
"categoryId": "2",
"categoryName": "Test",
"goodsCategoryId": "5673",
"goodsCategoryName": "Test",
"exciseRate": "0.12",
"exciseRule": "1",
"exciseTax": "20.22",
"pack": "1",
"stick": "20",
"exciseUnit": "101",
"exciseCurrency": "UGX",
"exciseRateName": "123"
}],
"taxDetails": [{
"taxCategory": "'Standard",
"netAmount": "3813.55",
"taxRate": "0.18",
"taxAmount": "686.45",
"grossAmount": "4500.00",
"exciseUnit": "101",
"exciseCurrency": "UGX",
"taxRateName": "123"
}, {
"taxCategory": "''Excise Duty",
"netAmount": "1818.18",
"taxRate": "0.1",
 "taxAmount": "181.82",
"grossAmount ": "2000.00",
"exciseUnit": "101",
"exciseCurrency": "UGX",
"taxRateName": "123"
}],
"summary": {
"netAmount": "8379",
"taxAmount": "868",
"grossAmount": "9247",
"itemCount": "5",
"modeCode": "0",
"remarks": "This is another remark test.",
"qrCode": "asdfghjkl"
},
"payWay": [{
"paymentMode": "101",
"paymentAmount": "686.45",
"orderNumber": "a"
}, {
"paymentMode": "102",
"paymentAmount": "686.45",
"orderNumber": "a"
}],
"extend": {
"reason": "reason",
"reasonCode": "102"
},
"custom": {
"sadNumber": "8379",
"office": "Busia",
"cif": "cif",
"wareHouseNumber": "5",
"wareHouseName": " Busia ",
"destinationCountry": " China ",
"originCountry": " China",
"importExportFlag": "1",
"confirmStatus": "0",
"valuationMethod": "asdfghjkl",
"prn": "1"
}

}
Flow Description Invoice details are queried according to Invoice number.
 Field description

Field Field Name Required Length Description

invoiceNo Invoice number Y 20

Seller InformationInternal field:

Field Field Name Required Length Description
tin sellerTIN Y 10
ninBrn sellerNIN/BRN Y 20
passportNumbe Passport number 20
Y
r
legalName Legal Name Y 150
businessName Business Name Y 80
Adress seller Adress Y
mobilePhone Mobile Phone Y 33
linePhone Line Phone Y 33
emailAddress Seller email Y 50
placeOfBusine Place Of 220
Y
ss Business
referenceNo referenceNo Y 50

Basic InformationInternal field:

Field Field Name Required Length Description
invoiceId Invoice ID Y 32
invoiceNo Invoice number Y 20
oriInvoiceNo Original Invoice 20
Y
number
antifakeCode Antifake Code Y 20 Digital signature(20 digital)
deviceNo device Number Y 20 Device Number (20 digital)
issuedDate Invoice issued date date(DD/MM/YYYY HH24:mm:ss)
Y
Date stamp
oriIssuedDate Original Invoice date date(DD/MM/YYYY HH24:mm:ss)
Y
issued Date stamp
oriGrossAmoun Original invoice
Y
t amount
operator Operator Y 100
currency currency Y 10 UGX
oriInvoiceId Original Invoice When the credit is opened, it
ID is the original invoice
N
number. When the ticket is
opened, it is empty.
invoiceType Invoice Type Y 1:invoice 2:credit
 3:temporary 4:debit
Corresponding dictionary
table invoiceType
invoiceKind Invoice Kind Y 1 :invoice 2: receipt
dataSource Data Source 101:efd 102:cs
103:webService api 104:BS
Y
Corresponding dictionary
table invoiceApplySource
isInvalid Obsolete sign 1 Obsolete sign 1: Obsolete 0:
Not invalid Note: Obsolete
N
only for negative and
supplementary tickets
isRefund Is it open to a 1 Whether it is opened for a
credit ticket / Debit Note: 0 - not
note/Debit Note N issued a negative ticket /
Debit 1- is issued Credit 2- is
issued Debit
invoiceIndust invoiceIndustryC 101 general industry
ryCode ode N 102 export
103 import

Buyer Details Internal field :

Field Field Name Required Length Description
buyerTin Buyer TIN Y 10
buyerNinBrn Buyer NIN Y 20
buyerPassport Passport number 20
Y
Num
buyerLegalNam Legal name 150
Y
e
buyerBusiness Business name 80
Y
Name
buyerAddress Buyer Address Y
buyerEmail Buyer Email Y 50
buyerMobilePh Buyer Mobile
Y
one Phone
buyerLinePhon Buyer Line Phone
Y
e
buyerPlaceOfB Buyer Place Of 220
Y
usi Business
buyerType Buyer Type 1 : B2B or B2G
2 : B2C
Y
Corresponding dictionary
buyerType
buyerSector Buyer Sector N
buyerReferenc Buyer EFD and CS do not need to be
eNo ReferenceNo N transmitted, and the external
interface is used.

Goods DetailsInternal field:

Field Field Name Required Length Description
item item name Y 60
itemCode item code Y 50
qty Quantity Number(
Y
20,8)
unitOfMeasure unit of measure Y 20
unitPrice unit Price Number(
Y
20,8)
total Total prise Number(
Y
20,8)
taxRate tax rate Number( Save decimals, such as 18%
Y
20,8) deposit 0.18
tax tax Y
discountTotal discount total Y
discountTaxRa discount tax Save decimals, such as 18%
Y
te rate deposit 0.18
orderNumber order number Y
discountFlag Whether the 1: discount 2: non-discount
product line is Y
discounted
deemedFlag Whether deemed Y 1 : deemed 2: not deemed
exciseFlag Whether excise Y 1 : excise 2: not excise
categoryId exciseDutyCode Y exciseDutyCode
categoryName Excise Duty
Y
category name
goodsCategory goods Category Vat tax commodity
Id id Y classification, currently
stored is taxCode
goodsCategory goods Category
Y
Name Name
exciseRate Excise tax rate Y
exciseRule Excise 1: Calculated by tax rate 2
Calculation Calculated by Quantity
Y
Rules Corresponding dictionary
rateType
exciseTax Excise tax Y
pack pack Y
stick stick Y
exciseUnit exciseUnit Y
exciseCurrenc exciseCurrency
Y
y
exciseRateNam exciseRateName
Y
e
Tax DetailsInternal field:
Field Field Name Required Length Description
taxCategory tax category Y
netAmount net amount Y
taxRate tax rate Save decimals, such as 18%
Y
deposit 0.18
taxAmount tax Y
grossAmount gross amount Y
exciseUnit exciseUnit Y
exciseCurrenc exciseCurrency
Y
y
taxRateName taxRateName Y

SummaryInternal field:
Field Field Name Required Length Description
netAmount net amount Tax Receipt total net
Y
amount
taxAmount tax amount Y Tax Receipt total tax amount
grossAmount gross amount Tax Receipt total gross
Y
amount
oriGrossAmoun original invoice
N
t gross amount
itemCount Purchase item 10 Purchase item lines
Y
lines
mode mode Issuing receipt mode
Y (1:Online or 0:Offline) ,this
code is from dictionary table
remarks Remarks Y 220
qrCode qrCode Y

PayWay field:
Field Field Name Required Length Description
paymentMode paymentMode number payWay dictionary table
101 Credit
Y 102 Cash
103 Cheque
104 Demand draft
 105 Mobile money
106 Visa/Master card
107 EFT
108 POS
109 RTGS
110 Swift transfer
paymentAmount paymentAmount number Tax Receipt total tax amount
Must be positive or 0
Y
The number of integer digits
does not exceed 16 digits
orderNumber orderNumber Y 1 a b c d

Extend Internal field:

Field Field Name Required Length Description
reason Cancel reason Y
reasonCode Refund reason Corresponding dictionary
Y
code cancelRefundReason

Custom field:
Field Field Name Required Length Description
sadNumber SAD Number Y 20 SAD Number(20 digital)
office office Y 35 office for example busia
cif cif Y 50 CIF
wareHouseNumb Ware housing 16
Y
er Number
wareHouseName Ware housing 256
Y
Name
destinationCo destinationCount 256
Y
untry ry
originCountry originCountry Y 256
importExportF importExportFlag 1 1 import 2.export
Y
lag
confirmStatus confirmStatus 0:Unconfirmed Taxpayers cannot
enter the warehouse
1:Confirmed Taxpayers can put
in stock and add inventory
3 ： Cancelled Cancellation
status and the invoice is
invalid
valuationMeth Valuation Method 128 valuation method
Y
od
prn prn Y 80
 9. Invoice Upload

Interface Name Invoice Upload

Description Upload the Invoice/Receipt or Debit Note to the server.
Interface Code T109
Request
Y
Encrypted
Response
Y
Encrypted
{
"sellerDetails": {
"tin": "201905081705",
"ninBrn": "201905081705",
"legalName": "zhangsan",
"businessName": "lisi",
"address": "beijin",
"mobilePhone": "15501234567",
"linePhone": "010-6689666",
"emailAddress": "123456@163.com",
"placeOfBusiness": "beijin",
"referenceNo": "00000000012"
},
"basicInformation": {
"invoiceNo": "00000000001",
"antifakeCode": "201905081711",
"deviceNo": "201905081234",
Request Message
"issuedDate": "2019-05-08 17:13:12",
"operator": "URA",
"currency": "UGX",
"oriInvoiceId": "1",
"invoiceType": "1",
"invoiceKind": "1",
"dataSource": "101",
"invoiceIndustryCode": "102",
"isBatch": "0"
},
"buyerDetails": {
"buyerTin": "201905081705",
"buyerNinBrn": "201905081705",
"buyerPassportNum": "201905081705",
"buyerLegalName": "zhangsan",
"buyerBusinessName": "lisi",
"buyerAddress": "beijin",
 "buyerEmail": "123456@163.com",
"buyerMobilePhone": "15501234567",
"buyerLinePhone": "010-6689666",
"buyerPlaceOfBusi": "beijin",
"buyerType": "1",
"buyerCitizenship": "1",
"buyerSector": "1",
"buyerReferenceNo": "00000000001"
},
"goodsDetails": [{
"item": "apple",
"itemCode": "101",
"qty": "2",
"unitOfMeasure": "kg",
"unitPrice": "150.00",
"total": "1",
"taxRate": "0.18",
"tax": "12.88",
"discountTotal": "18.00",
"discountTaxRate": "0.18",
"orderNumber": "1",
"discountFlag": "1",
"deemedFlag": "1",
"exciseFlag": "2",
"categoryId": "1234",
"categoryName": "Test",
"goodsCategoryId": "5467",
"goodsCategoryName": "Test",
"exciseRate": "0.12",
"exciseRule": "1",
"exciseTax": "20.22",
"pack": "1",
"stick": "20",
"exciseUnit": "101",
"exciseCurrency": "UGX",
"exciseRateName": "123"
}, {
"item": "car",
"itemCode": "101",
"qty": "2",
"unitOfMeasure": "kg",
"unitPrice": "150.00",
"total": "1",
"taxRate": "0.18",
 "tax": "12.88",
"discountTotal": "18.00",
"discountTaxRate": "0.18",
"orderNumber": "2",
"discountFlag": "1",
"deemedFlag": "1",
"exciseFlag": "2",
"categoryId": "Test",
"categoryName": "Test",
"goodsCategoryId": "Test",
"goodsCategoryName": "Test",
"exciseRate": "0.12",
"exciseRule": "1",
"exciseTax": "20.22",
"pack": "1",
"stick": "20",
"exciseUnit": "101",
"exciseCurrency": "UGX",
"exciseRateName": "123"
}],
"taxDetails": [{
"taxCategory": "'Standard",
"netAmount": "3813.55",
"taxRate": "0.18",
"taxAmount": "686.45",
"grossAmount": "4500.00",
"exciseUnit": "101",
"exciseCurrency": "UGX",
"taxRateName": "123"
}, {
"taxCategory": "''Excise Duty",
"netAmount": "1818.18",
"taxRate": "0.1",
"taxAmount": "181.82",
"grossAmount": "2000.00",
"exciseUnit": "101",
"exciseCurrency": "UGX",
"taxRateName": "123"
}],
"summary": {
"netAmount": "8379",
"taxAmount": "868",
"grossAmount": "9247",
"itemCount": "5",
 "modeCode": "0",
"remarks": "This is another remark test.",
"qrCode": "asdfghjkl"
},
"payWay": [{
"paymentMode": "101",
"paymentAmount": "686.45",
"orderNumber": "a"
}, {
"paymentMode": "102",
"paymentAmount": "686.45",
"orderNumber": "a"
}],
"extend": {
"reason": "reason",
"reasonCode": "102"
}
}
{
"sellerDetails": {
"tin": "201905081705",
"ninBrn": "201905081705",
"passportNumber": "201905081705",
"legalName": "zhangsan",
"businessName": "lisi",
"address": "beijin",
"mobilePhone": "15501234567",
"linePhone": "010-6689666",
"emailAddress": "123456@163.com",
"placeOfBusiness": "beijin",
"referenceNo": "00000000012"
Response Message
},
"basicInformation": {
"invoiceId": "1000002",
"invoiceNo": "00000000001",
"antifakeCode": "201905081711",
"deviceNo": "201905081234",
"issuedDate": "2019-05-08 17:13:12",
"operator": "URA",
"currency": "UGX",
"oriInvoiceId": "1",
"invoiceType": "1",
"invoiceKind": "1",
"dataSource": "101",
 "invoiceIndustryCode": "102",
"isBatch": "0"
},
"buyerDetails": {
"buyerTin": "201905081705",
"buyerNinBrn": "201905081705",
"buyerPassportNum": "201905081705",
"buyerLegalName": "zhangsan",
"buyerBusinessName": "lisi",
"buyerAddress": "beijin",
"buyerEmail": "123456@163.com",
"buyerMobilePhone": "15501234567",
"buyerLinePhone": "010-6689666",
"buyerPlaceOfBusi": "beijin",
"buyerType": "1",
"buyerCitizenship": "1",
"buyerSector": "1",
"buyerReferenceNo": "00000000001"
},
"goodsDetails": [{
"item": "apple",
"itemCode": "101",
"qty": "2",
"unitOfMeasure": "kg",
"unitPrice": "150.00",
"total": "1",
"taxRate": "0.18",
"tax": "12.88",
"discountTotal": "18.00",
"discountTaxRate": "0.18",
"orderNumber": "1",
"discountFlag": "1",
"deemedFlag": "1",
"exciseFlag": "2",
"categoryName": "Test",
"goodsCategoryName": "Test",
"exciseRate": "0.12",
"exciseRule": "1",
"exciseTax": "20.22",
"pack": "1",
"stick": "20",
"exciseUnit": "101",
"exciseCurrency": "UGX",
"exciseRateName": "123"
}, {
"item": "car",
"itemCode": "101",
"qty": "2",
"unitOfMeasure": "kg",
"unitPrice": "150.00",
"total": "1",
"taxRate": "0.18",
"tax": "12.88",
"discountTotal": "18.00",
"discounttaxRate": "0.18",
"orderNumber": "2",
"discountFlag": "1",
"deemedFlag": "1",
"exciseFlag": "2",
"categoryName": "Test",
"goodsCategoryName": "Test",
"exciseRate": "0.12",
"exciseRule": "1",
"exciseTax": "20.22",
"pack": "1",
"stick": "20",
"exciseUnit": "101",
"exciseCurrency": "UGX",
"exciseRateName": "123"
}],
"taxDetails": [{
"taxCategory": "'Standard",
"netAmount": "3813.55",
"taxRate": "0.18",
"taxAmount": "686.45",
"grossAmount": "4500.00",
"exciseUnit": "101",
"exciseCurrency": "UGX",
"taxRateName": "123"
}, {
"taxCategory": "''Excise Duty",
"netAmount": "1818.18",
"taxRate": "0.1",
"taxAmount": "181.82",
"grossAmount ": "2000.00",
"exciseUnit": "101",
"exciseCurrency": "UGX",
"taxRateName": "123"
 }],
"summary": {
"netAmount": "8379",
"taxAmount": "868",
"grossAmount": "9247",
"itemCount": "5",
"modeCode": "0",
"remarks": "This is another remark test.",
"qrCode": "asdfghjkl"
},
"payWay": [{
"paymentMode": "101",
"paymentAmount": "686.45",
"orderNumber": "a"
}, {
"paymentMode": "102",
"paymentAmount": "686.45",
"orderNumber": "a"
}],
"extend": {
"reason": "reason",
"reasonCode": "102"
}
}
The operator operates the tax control machine and calculates and invoices
the guest.
Flow Description If the invoice upload time is greater than or less than 10 minutes of
server time, add a piece of data to the T_INVOICE_EXCEPTION invoice
exception table, EXCEPTION_TYPE_CODE = 101

Field description

Seller InformationInternal field:

Field Field Name Required Length Description
tin sellerTIN 10-20 Must be consistent with outer
Y
packet tin
ninBrn sellerNIN N 100
legalName legal name Y 256
businessName business name N 256
address Seller address N 500
mobilePhone mobile phone N 30
linePhone line phone N 30
emailAddress Sellere mail Y 50 Mailbox format
placeOfBusine place of 500
N
ss business
referenceNo referenceNo N 50

Basic InformationInternal field:

Field Field Name Required Length Description
invoiceNo Invoice number N 20
antifakeCode antifake code N 20 Digital signature(20 digital)
deviceNo device Number Y 20 Device Number (20 digital)
issuedDate invoice issued date yyyy-MM-dd HH24:mm:ss
Y
date
operator Operator Y 100
currency currency Y 10 UGX
oriInvoiceId originalInvoice 20 When the credit is opened, it
ID is the original invoice
N
number. When the ticket is
opened, it is empty.
invoiceType invoice type Y 1 1:invoice 4:debit
invoiceKind invoice kind Y 1 1 :invoice 2: receipt
dataSource data source 3 101:efd 102:cs
Y
103:webService api 104:BS
invoiceIndust invoiceIndustryC 1 101 general industry
ryCode ode N 102 export
103 import
isBatch isBatch 1 Not required, the value is 0 or
1, if it is empty, the default
N is 0.
0-not a batch summary invoice,
1-batch summary invoice

Buyer DetailsInternal field:

Field Field Name Required Length Description
buyerTin Buyer TIN N 10-20
buyerNinBRn Buyer NIN N 100
buyerPassport Passport number 20
N
Num
buyerLegalNam legal name 256
N
e
buyerBusiness business name 256
N
Name
buyerAddress buyeraddress N 500
buyerEmail buyeremail N 50 Mailbox format
buyerMobilePh mobile phone N 30
one
buyerLinePhon line phone 30
N
e
buyerPlaceOfB place of 500
N
usi business
buyerType Buyer Type 1 0 : B2B or B2G
Y 1 : B2C
2:Foreigner
buyerCitizens Buyer 128
N
hip Citizenship
buyerSector Buyer Sector N 200
buyerReferenc Buyer 50 EFD and CS do not need to be
eNo ReferenceNo N transmitted, and the external
interface is used.

Goods DetailsInternal field:

Field Field Name Required Length Description
item item name 100 discountFlag is 0, the name
of the discount line is equal
to the name of the discounted
line + space + "(discount)"
When deemedFlag is 1
Y
Name + space + ”(deemed)”
If discountFlag is 0 and
deemedFlag is 1
Name + Space + ”(deemed)” +
Space + ”(discount)”
itemCode item code Y 50
qty Quantity Number Required if discountFlag is 1
or 2 and must be positive
must be empty when
discountFlag is 0
N
The number of integer digits
does not exceed 12 digits and
the number of decimal places
does not exceed 8 digits
unitOfMeasure unit of measure 3 101 kg
102 pack
103 piece
104 meter
N
105 stick
106 litre
107 day of access
108 minute
unitPrice unit Price Number Required if discountFlag is 1
or 2 and must be positive
must be empty when
discountFlag is 0
N
The number of integer digits
does not exceed 12 digits and
the number of decimal places
does not exceed 8 digits
total total price Number must be positive when
discountFlag is 1 or 2
must be negative when
Y discountFlag is 0
No more than 12 digits for
integers and no more than 2
digits for decimals
taxRate tax rate Number Save decimals, such as 18%
deposit 0.18
Must be positive
Y The number of integer digits
does not exceed 12 digits and
the number of decimal places
does not exceed 8 digits
tax tax Number must be positive when
discountFlag is 1 or 2
must be negative when
discountFlag is 0
Y
The number of integer digits
does not exceed 12 digits and
the number of decimal places
does not exceed 2 digits
discountTotal discount total must be empty when
discountFlag is 0 or 2
must be negative when
N discountFlag is 1
And equal to the absolute
value of the total of the
discount line
discountTaxRa discount tax Save decimals, such as 18%
te rate deposit 0.18
N
Decimal places must not
exceed 5
orderNumber order number Y number Add one each time from zero
discountFlag Whether the Y 1 0:discount amount 1:discount
 product line is good, 2:non-discount good
discounted The first line cannot be 0
and the last line cannot be 1
deemedFlag Whether deemed Y 1 1 : deemed 2: not deemed
exciseFlag Whether excise Y 1 1 : excise 2: not excise
categoryId exciseDutyCode 18 Excise Duty id
N
Required when exciseFlag is 1
categoryName Excise Duty 1024 Required when exciseFlag is 1
N
category name
goodsCategory goods Category 18 Vat tax commodity
Id id Y classification, currently
stored is taxCode
goodsCategory goods Category 100
N
Name Name
exciseRate Excise tax rate 21 Required when exciseFlag is 1
null when exciseFlag is 2
Consistent with categoryId
data
When exciseRule is 1,
consumption tax is calculated
as a percentage. For example,
the consumption tax rate is
N
18%. Fill in: 0.18. If the
consumption tax rate is
‘Nil’, enter ‘-’
When exciseRule is 2, the
consumption tax is calculated
in units of measurement. For
example, the consumption tax
rate is 100. Fill in: 100
exciseRule Excise 1 1: Calculated by tax rate 2
Calculation Calculated by Quantity
Rules Required when exciseFlag is 1
N

exciseTax Excise tax number Required when exciseFlag is 1

Must be positive
The number of integer digits
N
does not exceed 12 digits and
the number of decimal places
does not exceed 2 digits
pack pack number Required when exciseRule is
N
2
 Must be positive
The number of integer digits
does not exceed 12 digits and
the number of decimal places
does not exceed 8 digits
stick stick number Required when exciseRule is 2
Must be positive
The number of integer digits
N
does not exceed 12 digits and
the number of decimal places
does not exceed 8 digits
exciseUnit exciseUnit 3 101 per stick
102 per litre
103 per kg
104 per user per day of access
N 105 per minute
106 per 1,000sticks
107 per 50kgs
108 -
109 per 1 g
exciseCurrenc exciseCurrency 10 Required when exciseRule is 2
N
y
exciseRateNam exciseRateName If exciseRule is 1, the value
e is (exciseRate * 100) plus
the character '%', for
example
exciseRate is 0.18, this
N value is 18%
If exciseRule is 2, this
value is exciseCurrency +
exciseRate + space +
exciseUnit, for example:
UGX650 per litre

Tax DetailsInternal field:

Field Field Name Required Length Description
taxCategory tax category Y 100
netAmount net amount number Must be positive or 0
The number of integer digits
does not exceed 16 digits
Y
and the number of decimal
places does not exceed 8
digits
taxRate tax rate Y number 18% corresponds to 0.18
 0 corresponds to 0
Tax-free correspondence ‘-’
in the database”
taxAmount tax Must be positive or 0
The number of integer digits
Y does not exceed 16 digits and
the number of decimal places
does not exceed 2 digits
grossAmount gross amount Must be positive or 0
The number of integer digits
Y does not exceed 16 digits and
the number of decimal places
does not exceed 2 digits
exciseUnit exciseUnit 3 When the tax type is Excise
Duty and the tax rate is
N
calculated per unit, it is
required
exciseCurrenc exciseCurrency 10 When the tax type is Excise
y Duty and the tax rate is
N
calculated per unit, it is
required
taxRateName Tax Rate Name Y 100

SummaryInternal field:
Field Field Name Required Length Description
netAmount net amount number Tax Receipt total net
amount
Must be positive or 0
Y The number of integer digits
does not exceed 16 digits and
the number of decimal places
does not exceed 2 digits
taxAmount tax amount number Tax Receipt total tax amount
Must be positive or 0
The number of integer digits
Y does not exceed 16 digits
and the number of decimal
places does not exceed 2
digits
grossAmount gross amount number Tax Receipt total gross
amount
Y Must be positive
The number of integer digits
does not exceed 16 digits and
 the number of decimal places
does not exceed 2 digits
itemCount Purchase item Number Must match the Number of all
lines Y （4） product lines in goodsDetail-
number of discount lines!
modeCode mode 1 Issuing receipt mode
Y (1:Online or 0:Offline) ,this
code is from dictionary table
remarks Remarks N 500
qrCode qrCode N 500 Required if mode is 0

PayWay field:
Field Field Name Required Length Description
paymentMode paymentMode number payWay dictionary table
101 Credit
102 Cash
103 Cheque
104 Demand draft
Y 105 Mobile money
106 Visa/Master card
107 EFT
108 POS
109 RTGS
110 Swift transfer
paymentAmount paymentAmount number Tax Receipt total tax amount
Must be positive or 0
Y
The number of integer digits
does not exceed 16 digits
orderNumber orderNumber Y 1 a b c d

ExtendInternal field:
Field Field Name Required Length Description
reason Cancel reason N 1024
reasonCode debitNoteReason 3 Corresponding dictionary
debitNoteReason
This field is required when
invoiceType4
When invoiceType is 4, use
N the following values:
101 Increase in the amount
payable/invoice value due to
extra products delivered or
products delivered charged at
an incorrect value.
 102 Others (Please specify)
If it is 102, reason is
required

10. Credit Note Application

Interface Name Credit Note Application

Description Credit Note Application
Interface Code T110
Request
Y
Encrypted
Response
Y
Encrypted
{
"oriInvoiceId": "0123456",
"oriInvoiceNo": "1234556789",
"reasonCode": "102",
"reason": "refundreason",
"applicationTime": "2019-06-15 15:02:02",
"invoiceApplyCategoryCode": "1",
"currency": "UGX",
"contactName": "1",
"contactMobileNum": "1",
"contactEmail": "1",
"source": "101",
"remarks": "Remarks",
"sellersReferenceNo": "00000000012",
Request Message "goodsDetails": [{
"item": "apple",
"itemCode": "101",
"qty": "2",
"unitOfMeasure": "kg",
"unitPrice": "150.00",
"total": "1",
"taxRate": "0.18",
"tax": "22.18",
"orderNumber": "1",
"deemedFlag": "1",
"exciseFlag": "2",
"categoryId": "1123",
"categoryName": "Test",
"goodsCategoryId": "1125",
 "goodsCategoryName": "Test",
"exciseRate": "0.12",
"exciseRule": "1",
"exciseTax": "20.22",
"pack": "1",
"stick": "20",
"exciseUnit": "101",
"exciseCurrency": "UGX",
"exciseRateName": "123"
}, {
"item": "car",
"itemCode": "101",
"qty": "2",
"unitOfMeasure": "kg",
"unitPrice": "150.00",
"total": "1",
"taxRate": "0.18",
"tax": "22.18",
"orderNumber": "2",
"deemedFlag": "1",
"exciseFlag": "2",
"categoryId": "1123",
"categoryName": "Test",
"goodsCategoryId": "1125",
"goodsCategoryName": "Test",
"exciseRate": "0.12",
"exciseRule": "1",
"exciseTax": "20.22",
"pack": "1",
"stick": "20",
"exciseUnit": "101",
"exciseCurrency": "UGX",
"exciseRateName": "123"
}],
"taxDetails": [{
"taxCategory": "'Standard",
"netAmount": "3813.55",
"taxRate": "0.18",
"taxAmount": "686.45",
"grossAmount": "4500.00",
"exciseUnit": "101",
"exciseCurrency": "UGX",
"taxRateName": "123"
}, {
 "taxCategory": "''Excise Duty",
"netAmount": "1818.18",
"taxRate": "0.1",
"taxAmount": "181.82",
"grossAmount ": "2000.00",
"exciseUnit": "101",
"exciseCurrency": "UGX",
"taxRateName": "123"
}],
"summary": {
"netAmount": "8379",
"taxAmount": "868",
"grossAmount": "9247",
"itemCount": "5",
"modeCode": "0",
"qrCode": "asdfghjkl"
},
"payWay": [{
"paymentMode": "101",
"paymentAmount": "686.45",
"orderNumber": "a"
}, {
"paymentMode": "102",
"paymentAmount": "686.45",
"orderNumber": "a"
}]
}
{
Response Message "referenceNo": "1234556789"
}
1. Original invoice billing time + credit Note Maximum InvoicingDays
Flow Description (type code corresponding to the dictionary table)
2. Current system time Cannot submit creditNode application

Field description

Field Field Name Required Length Description

oriInvoiceId originalInvoice The original invoice ID must
ID exist, and no debit note and
Y
credit note invoices have been
issued, matching oriInvoiceNo.
oriInvoiceNo originalInvoice Y 20 The original invoice number
 number must exist and no debit note or
credit note invoice has been
issued
reasonCode refundreasoncode 3 Corresponding
dictionaryrefundReason
The values are as follows:
101 Return of products due to
expiry or damage, etc.
102 Cancellation of the
purchase.
103 Invoice amount wrongly
Y
stated due to miscalculation
of price, tax, or discounts,
etc.
104 Partial or complete waive
off of the product sale after
the invoice is generated and
sent to customer.
105 Others (Please specify)
reason refundreason 1024 Required if ‘reasonCode’ is
N
‘105’
applicationTi refundSubmission yyyy-MM-dd HH24:mi:ss
Y
me time
invoiceApplyC invoice apply 3 invoice apply category code
ategoryCode category code Y from dictionary
from dictionary 101:creditNote
currency currency 10 Must be the same as the
Y
original invoice ‘currency’
contactName contact Name N 200
contactMobile contact mobile 30
N
Num number
contactEmail Contact email N 50 Mailbox format
source application 3 101:efd 102:cs
Y
source 103:webService api 104:BS
remarks Remarks N 500
sellersRefere Sellers 50
N
nceNo ReferenceNo

Goods DetailsInternal field:

Field Field Name Required Length Description
item item name Y 100 Same as original invoice
itemCode item code Y 50 Same as original invoice
qty Quantity Number( Must be negative, the
Y
20,8) absolute value cannot be
 greater than the number of
commodity rows corresponding
to the positive ticket
The integer part is 12 digits
long and the decimal part is
8 digits long
unitOfMeasure unit of measure Y 3 Same as original invoice
unitPrice unit Price Number(
Y
20,8)
total total price Number( Must be negative, the
20,8) absolute value cannot be
greater than the amount of
the product corresponding to
Y
the positive ticket
The integer part is 12 digits
long and the decimal part is
2 digits long
taxRate tax rate Number( Same as original invoice
Y
20,8)
tax tax Number( Must be negative, the
20,8) absolute value cannot be
greater than the amount of
the product corresponding to
Y
the positive ticket
The integer part is 12 digits
long and the decimal part is
2 digits long
orderNumber order number Y number Same as original invoice
deemedFlag whetherdeemed 1 1 : deemed 2: not deemed
Y
Same as original invoice
exciseFlag whetherexcise 1 1 : excise 2: not excise
Y
Same as original invoice
categoryId exciseDutyCode N 18 Same as original invoice
categoryName Excise tax 1024 Same as original invoice
N
category name
goodsCategory goods Category 18 Same as original invoice
Y
Id id
goodsCategory goods Category 100 Same as original invoice
Y
Name Name
exciseRate Excise tax rate N Same as original invoice
exciseRule Excise 1: Calculated by tax rate 2
Calculation N Calculated by Quantity
Rules Same as original invoice
exciseTax Excise tax N number Must be negative
pack pack N number Same as original invoice
stick stick N number Same as original invoice
exciseUnit exciseUnit N 3 Same as original invoice
exciseCurrenc exciseCurrency 10 Same as original invoice
N
y
exciseRateNam exciseRateName If exciseRule is 1, the value
e is (exciseRate * 100) plus
the character '%', for
example
exciseRate is 0.18, this
value is 18%
N
If exciseRule is 2, this
value is exciseCurrency +
exciseRate + space +
exciseUnit, for example:
UGX650 per litre
Same as original invoice

Tax DetailsInternal field:

Field Field Name Required Length Description
taxCategory tax category Y 100
netAmount net amount number Must be positive or 0
The number of integer digits
Y does not exceed 16 digits and
the number of decimal places
does not exceed 2 digits
taxRate tax rate number 18% corresponds to 0.18
0 corresponds to 0
Tax-free correspondence ‘-’
in the database”
Y
The number of integer digits
does not exceed 12 digits and
the number of decimal places
does not exceed 8 digits
taxAmount tax Must be positive or 0
The number of integer digits
Y does not exceed 16 digits and
the number of decimal places
does not exceed 2 digits
grossAmount gross amount Must be positive or 0
The number of integer digits
Y does not exceed 16 digits and
the number of decimal places
does not exceed 2 digits
exciseUnit exciseUnit 3 When the tax type is Excise
Duty and the tax rate is
N
calculated per unit, it is
required
exciseCurrenc exciseCurrency 10 When the tax type is Excise
y Duty and the tax rate is
N
calculated per unit, it is
required
taxRateName taxRateName Y

SummaryInternal field:
Field Field Name Required Length Description
netAmount net amount Tax Receipt total net
amount
Must be negative or 0
The number of integer digits
Y
does not exceed 16 digits
and the number of decimal
places does not exceed 2
digits
taxAmount tax amount Tax Receipt total tax amount
Must be negative or 0
The number of integer digits
Y does not exceed 16 digits
and the number of decimal
places does not exceed 2
digits
grossAmount gross amount Tax Receipt total gross
amount
Must be negative
Y The number of integer digits
does not exceed 16 digits and
the number of decimal places
does not exceed 2 digits
itemCount Purchase item 10 Purchase item lines
Y
lines
modeCode mode Issuing receipt mode
Y (1:Online or 0:Offline) ,this
code is from dictionary table
qrCode qrCode N 500

PayWay field:
Field Field Name Required Length Description
paymentMode paymentMode Y number payWay dictionary table
 101 Credit
102 Cash
103 Cheque
104 Demand draft
105 Mobile money
106 Visa/Master card
107 EFT
108 POS
109 RTGS
110 Swift transfer
paymentAmount paymentAmount number Tax Receipt total tax amount
Must be positive or 0
Y
The number of integer digits
does not exceed 16 digits
orderNumber orderNumber Y 1 a b c d

11. Credit /Cancel Debit Note Application List Query

Interface Name Credit/Cancel Debit Note Application List Query

Description Credit/Cancel Debit Note Application List Query
Interface Code T111
Request
Y
Encrypted
Response
Y
Encrypted
{
"referenceNo": "1234556789",
"oriInvoiceNo": "1234556789",
"invoiceNo": "1234556789",
"combineKeywords": "11111",
"approveStatus": "101",
Request Message "queryType": "1",
"invoiceApplyCategoryCode": "1",
"startDate": "2019-06-14",
"endDate": "2019-06-15",
"pageNo": "1",
"pageSize": "10"
}
{
"page": {
Response Message
"pageNo": "1",
"pageSize": "10",
 "totalSize": "Total number of articles",
"pageCount": "total pages"
},
"records": [{
"id": "1234556789",
"oriInvoiceNo": "1234556789",
"invoiceNo": "1234556789",
"referenceNo": "1234556789",
"approveStatus": "101",
"applicationTime": "16/06/2019 15:02:02",
"invoiceApplyCategoryCode": "1",
"grossAmount": "66.00",
"oriGrossAmount": "123.00",
"currency": "1",
"taskId": "1",
"buyerTin": "7777777777",
"buyerBusinessName": "URA",
"buyerLegalName": "test",
"tin": "8888888888",
"businessName": "URA1",
"legalName": "test",
"waitingDate": "1",
"dataSource": "101"
}, {
"id": "1234556789",
"oriInvoiceNo": "1234556789",
"invoiceNo": "1234556789",
"referenceNo": "1234556789",
"approveStatus": "101",
"applicationTime": "16/06/2019",
"invoiceApplyCategoryCode": "1",
"grossAmount": "1",
"oriGrossAmount": "123.00",
"currency": "1",
"taskId": "1",
"buyerTin": "7777777777",
"buyerBusinessName": "URA",
"buyerLegalName": "test",
"waitingDate": "1",
"dataSource": "101"
}]
}
Flow Description 1. Search and filter
 1) Enter the keyword and click go to query, match the two parameters of Reference No.
and Invoice/Receipt No., and the search result needs to contain keywords.

2) Filtering can be matched by date and approval state Approval State

Field description

Field Field Name Required Length Description

referenceNo referenceNo N 20
oriInvoiceNo originalInvoice 20
N
number
invoiceNo Invoice number N 20
approveStatus Approval Status 3 101 Approved
102 Submitted
103 Rejected
N
Associationdictionary
table
creditNoteApproveStatus
startDate application yyyy-MM-dd
N
start date
endDate application yyyy-MM-dd
N
enddate
pageNo current page 10
Y
number
pageSize How many records 3 Cannot be greater than the
are displayed Y integer 100
per page
queryType Query type 1 1. Current user's
application list
2. Query the negative votes
applied by other taxpayers,
Y
and the approver is the
current user's to-do list.
3. The current user
approval is completed.
invoiceApplyC invoice apply 3 101:creditNote 103:cancel
ategoryCode category code N of debitNote
from dictionary

Field Field Name Required Length Description

id Application bill
Y
Id
oriInvoiceNo originalInvoice
Y
number
invoiceNo Invoice number Y
referenceNo referenceNo Y
approveStatus Approval Status Y
applicationTi Refund
Y
me Submission time
invoiceApplyC invoice apply 101:creditNote 102:debitNote
ategoryCode category code Y 103:cancel of debitNote 104:
from dictionary cancel of credit note
grossAmount credit
applicationtotal Y
price
oriGrossAmoun Invoice total
Y
t price
currency currency Y
buyerTin Buyer TIN Y
buyerBusiness buyerbusiness
Y
Name Name
buyerLegalNam buyer Legal Name
Y
e
tin sellerTIN Y
businessName sellerbusiness
Y
Name
legalName sellerlegalName Y
waitingDate Application approveStatus = 102 System
waiting time Date - Application Date
approveStatus = 101 Approval
Y
Date - Application Date
approveStatus = 103 Approval
Date - Application Date
dataSource data source 101:efd 102:cs
103:webService api 104:BS
Y
Corresponding dictionary
table invoiceApplySource
taskId Tast Id Y
pageNo current page
number
pageSize How many records
are displayed
per page
totalSize Total number of
articles
pageCount total pages
 12. Credit Note Application Details

Interface Name credit application details

Description credit application details
Interface Code T112
Request
Y
Encrypted
Response
Y
Encrypted
{
Request Message "id": "229700709531101368"
}
{
"id": "229700709531101368",
"oriInvoiceNo": "27748703589774744343",
"oriInvoiceId": "27748703589774744343",
"refundInvoiceNo": "27748703589774744346",
"referenceNo": "181021206600004292110001",
"reason": "Buyer refused to accept the invoice incorrect
invoice/receipt",
"selectRefundReasonCode": "101",
"approveStatusCode": "101",
"updateTime": "16/06/2019",
"applicationTime": "16/06/2019",
"invoiceApplyCategoryCode": "101",
"contactName": "1",
"contactMobileNum": "1",
Response Message "contactEmail": "1",
"source": "102",
"taskId": "1",
"remarks": "Remarks",
"grossAmount": "1",
"totalAmount": "1",
"currency": "1",
"refundIssuedDate": "16/06/2019 15:02:02",
"issuedDate": "16/06/2019 15:02:02",
"tin": "7777777777",
"sellersReferenceNo": "0000000002",
"nin": "777777777700",
"legalName": "Struggle Software Development Co., Ltd.",
"businessName": "lisi",
"mobilePhone": "15501234567",
"address": "beijing",
 "emailAddress": "beijing",
"buyerTin": "7777777777",
"buyerNin": "777777777700",
"buyerLegalName": "Struggle Software Development Co., Ltd.",
"buyerBusinessName": "lisi",
"buyerAddress": "beijing",
"buyerEmailAddress": "email@163.com",
"buyerMobilePhone": "15674448569",
"buyerLinePhone": "132142324159",
"buyerCitizenship": "132142324159",
"buyerPassportNum": "CN1234567890",
"buyerPlaceOfBusi": "DistrictCountysub-County"
}
Flow Description Query details based on the application ID.

Field description

Field Field Name Required Length Description

id Application ID Y 20

Field Field Name Required Length Description

id Application ID Y
oriInvoiceNo Original Invoice
Y
number
oriReceiptId Original Invoice
Y
ID
refundInvoice Credit Invoice
Y
No number
referenceNo Reference No Y
Y
Reason Refund reason
selectRefundR Refund reason Corresponding dictionary
Y
easonCode code refund Reason
approveStatus Approval Status 101 Approved
Code 102 Pending
Y 103 Rejected
Association dictionary table
approveStatus
updateTime Processing time Y
applicationTi refundSubmission
Y
me time
invoiceApplyC invoice apply Y
ategoryCode category code
from dictionary
contactName contact Name Y
contactMobile contact mobile
Y
Num number
contactEmail Contact email
source application 101:efd 102:cs
source 103:webService api 104:BS
Y
Corresponding dictionary
invoiceApplySource
taskId task ID Y
remarks Remarks N
grossAmount Invoice gross
Y
amount
totalAmount creditgross
Y
amount
currency currency Y
refundIssuedD Credit Issue
Y
ate time
issuedDate Invoice issue
Y
time
tin Tin Y Seller's Information
nin NIN/BRN Y Seller's Information
legalName legalName Y Seller's Information
businessName businessName Y Seller's Information
mobilePhone Contact Number Y Seller's Information
address Address Y Seller's Informationn
emailAddress Email Address Y Seller's Information
buyerTin buyerTin Y Buyer's Information
buyerNin buyerNin Y Buyer's Information
buyerLegalNam buyerLegalName Buyer's Information
Y
e
buyerBusiness buyerBusinessNam Buyer's Information
Y
Name e
buyerAddress buyerAddress Y Buyer's Information
buyerEmailAdd buyerEmailAddres Buyer's Information
Y
ress s
buyerMobilePh buyerMobilePhone Buyer's Information
Y
one
buyerLinePhon buyerLinePhone Buyer's Information
Y
e
buyerCitizens buyerCitizenship Buyer's Information
Y
hip
 buyerPassport buyerPassportNum Buyer's Information
Y
Num
buyerPlaceOfB buyerPlaceOfBusi Buyer's Information
Y
usi
sellersRefere sellersReference
N
nceNo No

13. Credit /Debit Note approval

Interface Name credit application approval

Description credit application approval
Interface Code T113
Request
Y
Encrypted
Response
N
Encrypted
{
"referenceNo": "1234556789",
"approveStatus": "101",
Request Message
"taskId": "1",
"remark": "Remarks"
}

Response Message Null

Flow Description credit application approval

Field description

Field Field Name Required Length Description

referenceNo referenceNo Y 20
approveStatus Approval Status 3 101 Approved
103 Rejected
Y
Associationdictionary table
creditNoteApproveStatus
remark Remarks Y 1024
taskId task ID Y 20
 14. Cancel of credit /debit note Application

Interface Name Cancel Credit Note 、initiate Cancel of Debit Note Application
Description Cancel Credit Note 、initiate Cancel of Debit Note Application
Interface Code T114
Request
Y
Encrypted
Response
N
Encrypted
{
"oriInvoiceId": "31000000000000000001",
"invoiceNo": "786059685752403327",
Request Message "reason": "reason",
"reasonCode": "102",
"invoiceApplyCategoryCode": "103"
}

Response Message Null

103: cancel of debitNote initiates a workflow and submits a Debit Note request
Flow Description
104: cancel of credit note Do not take the workflow. Modify invoice status

Field description

Field Field Name Required Length Description

oriInvoiceId originalInvoice 20
Y
ID
invoiceNo Invoice number Y 20
reason cancelreason 1024 Required if ‘reasonCode’ is
N
‘103’
reasonCode refundreasoncode 3 Corresponding
dictionaryrefundReason
The values are as follows:
101 Buyer refused to accept
Y the invoice due to incorrect
invoice/receipt
102 Not delivered due to
incorrect invoice/receipt
103 Other reasons
 invoiceApplyC invoice apply 3 invoice apply category code
ategoryCode category code from dictionary
Y
from dictionary 103:cancel of debitNote 104:
cancel of credit note

15. System Dictionary Update

Interface Name System dictionary update

Description Query system parameters such as VAT, Excise Duty, and Currency
Interface Code T115
Request
N
Encrypted
Response
Y
Encrypted
Request Message Null
{
"creditNoteMaximumInvoicingDays": {
"value": "90",
"name": "Credit Node Maximum Invoicing days"
},
"currencyType": [{
"value": "101",
"name": "UGX",
"description": "shilling,shillings,cent,cents"
}, {
"value": "102",
"name": "USD",
"description": "dollar,dollars,cent,cents"
}],
Response Message
"creditNoteValuePercentLimit": {
"value": "0.6",
"name": "credit Note Value Percent Limit"
},
"rateUnit": [{
"value": "101",
"name": "per stick"
}, {
"value": "102",
"name": "per litre"
}],
"format": {
"dateFormat": "dd/MM/yyyy",
"timeFormat": "dd/MM/yyyy HH:mm:ss"
 },
"sector": [{
"code": "123",
"name": "Cigarettes",
"parentClass": "0",
"requiredFill": "0"
}, {
"code": "123",
"name": "Cigarettes",
"parentClass": "0",
"requiredFill": "1"
}],
"payWay": [{
"value": "101",
"name": "Credit"
}, {
"value": "102",
"name": "Cash"
}],
"taxType": [{
"value": "301",
"name": "Value Added Tax"
}, {
"value": "302",
"name": "Income Tax"
}],
"countryCode": [{
"value": "301",
"name": "Value Added Tax"
}, {
"value": "302",
"name": "Income Tax"
}]

}
At the time of initialization, the dictionary is updated, and later judged according to the
Flow Description version number version. If the version is always, there is no need to update the data. If it is
inconsistent, obtain the data!

Field description

Field Field Name Required Length Description

taxCode tax category 20
Y
code
name tax category 80
Y
name
rate tax rate 4 Correspond tax
ratecodeTAX_RATE_CODE
taxRate
Y -1 Representative is empty
101 - (duty free)
0 0
0.18 18%
parentClass Parent code Y 20
vatManagement VAT tax type 4 vat management code from
Y dictionary(101:Zero
Rate,102:Duty-free)
keyword keyword Y 512
goodService Good category 80
Y
name
parentClass Parent code Y 80
rateText tax rateText Y 50
exciseDutyId Good category ID 18 Corresponding
Y
dictionaryrateType
type tax rate 10 101 Percentage
Y
Calculate type 102 Unit of measurement
rate tax rate Y number
unit unit of type=101 is empty
measurement type=102 is not empty
Corresponding dictionarycode
rateUnit
currency currency N currencyType
value Dictionary value Y
name Correspond name Y
description Dictionary
description Shilling : integer singular

Shillings: integer complex

N
Cent : decimal singular

Cents : Decimal complex

dateFormat Date Format Y System date format
timeFormat Time Format Y System date format
requiredFill requiredFill Y 1:Y 0:N
countryCode countryCode Y
 16. Z-report Daily Upload

Interface Name Z-report Daily Upload

Description Z-report Daily Upload
Interface Code T116
Request
Y
Encrypted
Response
Y
Encrypted
{
Request Message To be determined
}
Response Message Null

Flow Description Z-report Daily Upload

Field description

Field Field Name Required Length Description

17. Invoice Checks

Interface Name Invoice Checks

Description Contrast client invoice with server invoice consistent
Interface Code T117
Request
Y
Encrypted
Response
Y
Encrypted
[{
"invoiceNo": "10239892399",
"invoiceType": "1"
}, {
Request Message
"invoiceNo": "10239892398",
"invoiceType": "2"
}]
 [{
"invoiceNo": "10239892399",
"invoiceType": "1"
Response Message }, {
"invoiceNo": "10239892398",
"invoiceType": "2"
}]
1. The client uploads a segment of invoiceNo and invoice category
2. Query the database in the background and compare the invoice type and
invoiceNo of the invoice.
3. Compare the inconsistent invoice number or return the invoice number
Flow Description
without results to the client.
4. If the comparison is consistent, return empty
5. Query sellerTin equals (outer packet gets Tin)
6. Query deviceNo equal to the deviceNo of the outer packet.

Field description

Field Field Name Required Length Description

invoiceNo invoiceNo Y 20
invoiceType invoice type 11:invoice 2:credit
Y
3:temporary 4:debit
The size of the collection cannot exceed the set value

18. Query Credit Note Application and Cancel of Debit Note Application Details

Query Credit Note Application and Cancel of Debit Note Application

Interface Name
Details
Description Query Credit Note and Cancel Debit Note to apply for details
Interface Code T118
Request
Y
Encrypted
Response
Y
Encrypted
{
Request Message "id": "229700709531101368"
}
{
"goodsDetails": [{
Response Message "itemName": "apple",
"itemCode": "101",
"qty": "2",
 "unit": "kg",
"unitPrice": "150.00",
"total": "1",
"taxRate": "0.18",
"tax": "12.88",
"discountTotal": "18.00",
"discountTaxRate": "0.18",
"orderNumber": "1",
"discountFlag": "1",
"deemedFlag": "1",
"exciseFlag": "2",
"categoryId": "1123",
"categoryName": "Test",
"goodsCategoryId": "1125",
"goodsCategoryName": "Test",
"exciseRate": "0.12",
"exciseRule": "1",
"exciseTax": "20.22",
"pack": "1",
"stick": "20",
"exciseUnit": "101",
"exciseCurrency": "UGX",
"exciseRateName": "123"
}, {
"itemName": "car",
"itemCode": "101",
"qty": "2",
"unitOfMeasure": "kg",
"unitPrice": "150.00",
"total": "1",
"taxRate": "0.18",
"tax": "12.88",
"discountTotal": "18.00",
"discounttaxRate": "0.18",
"orderNumber": "2",
"discountFlag": "1",
"deemedFlag": "1",
"exciseFlag": "2",
"categoryId": "1123",
"categoryName": "Test",
"goodsCategoryId": "1125",
"goodsCategoryName": "Test",
"exciseRate": "0.12",
"exciseRule": "1",
 "exciseTax": "20.22",
"pack": "1",
"stick": "20",
"exciseUnit": "101",
"exciseCurrency": "UGX",
"exciseRateName": "123"
}],
"taxDetails": [{
"taxCategory": "'Standard",
"netAmount": "3813.55",
"taxRate": "0.18",
"taxAmount": "686.45",
"grossAmount": "4500.00",
"exciseUnit": "101",
"exciseCurrency": "UGX",
"taxRateName": "123"
}, {
"taxCategory": "''Excise Duty",
"netAmount": "1818.18",
"taxRate": "0.1",
"taxAmount": "181.82",
"grossAmount ": "2000.00",
"exciseUnit": "101",
"exciseCurrency": "UGX",
"taxRateName": "123"
}],
"summary": {
"netAmount": "8379",
"taxAmount": "868",
"grossAmount": "9247",
"previousNetAmount": "8379",
"previousTaxAmount": "868",
"previousGrossAmount": "9247"
},
"payWay": [{
"paymentMode": "101",
"paymentAmount": "686.45",
"orderNumber": "a"
}, {
"paymentMode": "102",
"paymentAmount": "686.45",
"orderNumber": "a"
}],
"basicInformation": {
 "invoiceType": "2",
"invoiceKind": "1",
"invoiceIndustryCode": "102"
},

}
Flow Description Query credit application product information tax information

Field description

Field Field Name Required Length Description

id Application ID Y 20

Goods DetailsInternal field:

Field Field Name Required Length Description
item item name Y 60
itemCode item code Y 50
qty Quantity Number(
Y
20,8)
unit unit of measure Y 20
unitPrice unit Price Number(
Y
20,8)
total total price Number(
Y
20,8)
taxRate tax rate Number( Save decimals, such as 18%
Y
20,8) deposit 0.18
tax tax Y
discountTotal discount total Y
discountTaxRa discount tax Save decimals, such as 18%
Y
te rate deposit 0.18
orderNumber order number Y
discountFlag Whether the 1: discount 2: non-discount
product line is Y
discounted
deemedFlag whetherdeemed Y 1 : deemed 2: not deemed
exciseFlag whetherexcise Y 1 : excise 2: not excise
categoryName Excise tax
Y
category name
goodsCategory goods Category
Y
Name Name
exciseRate Excise tax rate Y
exciseRule Excise Y 1: Calculated by tax rate 2
 Calculation Calculated by Quantity
Rules
exciseTax Excise tax Y
pack pack Y
stick stick Y
exciseUnit exciseUnit Y
exciseCurrenc exciseCurrency
Y
y
exciseRateNam exciseRateName
Y
e
Tax DetailsInternal field:
Field Field Name Required Length Description
taxCategory tax category Y
netAmount net amount Y
taxRate tax rate Save decimals, such as 18%
Y
deposit 0.18
taxAmount tax Y
grossAmount gross amount Y
exciseUnit exciseUnit Y
exciseCurrenc exciseCurrency
Y
y
taxRateName taxRateName Y

SummaryInternal field:
Field Field Name Required Length Description
netAmount net amount Y Apply credit node
taxAmount tax amount Y Apply credit node
grossAmount gross amount Y Apply credit node
previousNetAm previousNetAmoun original invoice
Y
ount t
previousTaxAm previousTaxAmoun original invoice
Y
ount t
previousGross previousGrossAmo original invoice
Y
Amount unt

PayWay field:
Field Field Name Required Length Description
paymentMode paymentMode number payWay dictionary table
101 Credit
102 Cash
Y
103 Cheque
104 Demand draft
105 Mobile money
 106 Visa/Master card
107 EFT
108 POS
109 RTGS
110 Swift transfer
paymentAmount paymentAmount number Tax Receipt total tax amount
Must be positive or 0
Y
The number of integer digits
does not exceed 16 digits
orderNumber orderNumber Y 1 a b c d

BasicInformation field:
Field Field Name Required Length Description
invoiceKind invoiceKind Y 1 :invoice 2: receipt
invoiceType invoiceType Y 2:credit 4:debit
invoiceIndust invoiceIndustryC 101 general industry
ryCode ode Y 102 export
103 import

19. Query Taxpayer Information By TIN

Interface Name Query Taxpayer Information By TIN or ninBrn

Description Query Taxpayer Information By TIN or ninBrn
Interface Code T119
Request
Y
Encrypted
Response
Y
Encrypted
{
"tin": "7777777777",
Request Message
"ninBrn": "7777777777"
}
{
"taxpayer": {
"tin": "123456",
"ninBrn": "2222",
Response Message "legalName": "admin",
"businessName": "1",
"contactNumber": "18888888888",
"contactEmail": "123@qq.com",
"address": "beijing"
 }
}

Flow Description Query Taxpayer Information By TIN or ninBrn buyer information

Field description

Field Field Name Required Length Description

tin TIN N 20
ninBrn NIN/BRN N 100

Goods DetailsInternal field:

Field Field Name Required Length Description
tin TIN Y
ninBrn ninBrn Y
legalName legalName Y
businessName businessName Y
contactNumber contactNumber Y
contactEmail contactemail Y
address address Y

20. Void Credit Debit/Note Application

Interface Name Void Credit Debit/Note Application

Description Void Credit Debit/Note Application
Interface Code T120
Request
Y
Encrypted
Response
N
Encrypted
{
"businessKey": "12345678901",
Request Message
"referenceNo": "23121212134"
}

Response Message null

Flow Description Void Credit Debit/Note Application

Field description

Field Field Name Required Length Description

businessKey businessKey 20
Y
referenceNo referenceNo 20
Y

21. Acquiring exchange rate

Interface Name Acquiring exchange rate

Description Acquiring exchange rate
Interface Code T121
Request
Y
Encrypted
Response
Y
Encrypted
{
Request Message "currency": "USD"
}
{
"currency": "USD",
Response Message
"rate": "3700"
}
Flow Description Acquiring exchange rate

Field description

Field Field Name Required Length Description

currency currency Y 3

Field Field Name Required Length Description

currency currency Y 3
rate rate Exchange rate of target
Y currency to ugx eg: 1usd =
3700ugx
 22. Query invalid cedit note details

Interface Name Query invalid cedit note details

Description Query invalid cedit note details
Interface Code T122
Request
Y
Encrypted
Response
Y
Encrypted
{
Request Message "invoiceNo": "22970000531455"
}
{
"invoiceNo": "22970000531455",
"currency": "UGX",
"issueDate": "08/05/2019 17:13:12",
Response Message
"grossAmount": "3700.00",
"reasonCode": "101",
"reason": "",
}
Flow Description Query invalid cedit note details

Field description

Field Field Name Required Length Description

invoiceNo invoiceNo Y 20

Field Field Name Required Length Description

invoiceNo invoiceNo Y
currency currency Y
issueDate issueDate Y
grossAmount grossAmount Y
reason Cancel reason Y
reasonCode Refund reason Corresponding dictionary
Y
code cancelRefundReason
 23. Query Commodity Category

Interface Name Query Commodity Category

Description Query Commodity Category
Interface Code T123
Request
N
Encrypted
Response
N
Encrypted
Request Message Null
[{
"commodityCategoryCode": "100000000",
"parentCode": "0",
"commodityCategoryName": "Standard",
"commodityCategoryLevel": "1",
"rate": "0.18",
"isLeafNode": "101",
"serviceMark": "101",
"isZeroRate": "101",
"zeroRateStartDate": "01/12/2019",
"zeroRateEndDate": "05/12/2019",
"isExempt": "101",
"exemptRateStartDate": "06/12/2019",
"exemptRateEndDate": "10/12/2019",
"enableStatusCode": "1",
"exclusion": "1"
Response Message }, {
"commodityCategoryCode": "100000000",
"parentCode": "0",
"commodityCategoryName": "Standard",
"commodityCategoryLevel": "1",
"rate": "0.18",
"isLeafNode": "101",
"serviceMark": "101",
"isZeroRate": "101",
"zeroRateStartDate": "01/12/2019",
"zeroRateEndDate": "05/12/2019",
"isExempt": "101",
"exemptRateStartDate": "06/12/2019",
"exemptRateEndDate": "10/12/2019",
"enableStatusCode": "1",
"exclusion": "1"
}]
Flow Description Query Commodity Category

Field description

Field Field Name Required Length Description

commodityCate commodityCategor
Y
goryCode yCode
parentCode parentCode Y
commodityCate commodityCategor
Y
goryName yName
commodityCate commodityCategor
Y
goryLevel yLevel
rate rate Correspond tax
ratecodeTAX_RATE_CODE
Y
taxRate
0.18 18%
isLeafNode isLeafNode Y 101:Y 102:N
serviceMark serviceMark Y 101:Y 102:N
isZeroRate isZeroRate Y 101:Y 102:N
zeroRateStart zeroRateStartDat
N
Date e
zeroRateEndDa zeroRateEndDate
N
te
isExempt isExempt Y 101:Y 102:N
exemptRateSta exemptRateStartD
N
rtDate ate
exemptRateEnd exemptRateEndDat
N
Date e
enableStatusC enableStatusCode 1:enable: 0:disable
Y
ode
exclusion exclusion 0:Zero
Y 1:Exempt
2:No exclusion

24. Query Commodity Category Pagination

Interface Name Query Commodity Category pagination

Description Query Commodity Category pagination
Interface Code T124
Request
N
Encrypted
 Response
N
Encrypted
{
"pageNo": "1",
Request Message
"pageSize": "10"
}
{
"page": {
"pageNo": "1",
"pageSize": "10",
"totalSize": " Total number of articles ",
"pageCount": "total pages"
},
"records": [{
"commodityCategoryCode": "100000000",
"parentCode": "0",
"commodityCategoryName": "Standard",
"commodityCategoryLevel": "1",
"rate": "0.18",
"isLeafNode": "101",
"serviceMark": "101",
"isZeroRate": "101",
"zeroRateStartDate": "01/12/2019",
"zeroRateEndDate": "05/12/2019",
"isExempt": "101",
Response Message
"exemptRateStartDate": "06/12/2019",
"exemptRateEndDate": "10/12/2019",
"enableStatusCode": "1",
"exclusion": "1"
}, {
"commodityCategoryCode": "100000000",
"parentCode": "0",
"commodityCategoryName": "Standard",
"commodityCategoryLevel": "1",
"rate": "0.18",
"isLeafNode": "101",
"serviceMark": "101",
"isZeroRate": "101",
"zeroRateStartDate": "01/12/2019",
"zeroRateEndDate": "05/12/2019",
"isExempt": "101",
"exemptRateStartDate": "06/12/2019",
"exemptRateEndDate": "10/12/2019",
"enableStatusCode": "1",
 "exclusion": "1"
}]
}

Flow Description Query Commodity Category pagination

Field description

Field Field Name Required Length Description

pageNo current page 10
Y
number
pageSize How many records 3 Cannot be greater than the
are displayed per Y integer 100
page

Field Field Name Required Length Description

commodityCate commodityCategor
Y
goryCode yCode
parentCode parentCode Y
commodityCate commodityCategor
Y
goryName yName
commodityCate commodityCategor
Y
goryLevel yLevel
rate rate Correspond tax
ratecodeTAX_RATE_CODE
Y
taxRate
0.18 18%
isLeafNode isLeafNode Y 101:Y 102:N
serviceMark serviceMark Y 101:Y 102:N
isZeroRate isZeroRate Y 101:Y 102:N
zeroRateStart zeroRateStartDat
N
Date e
zeroRateEndDa zeroRateEndDate
N
te
isExempt isExempt Y 101:Y 102:N
exemptRateSta exemptRateStartD
N
rtDate ate
exemptRateEnd exemptRateEndDat
N
Date e
enableStatusC enableStatusCode 1:enable: 0:disable
Y
ode
exclusion exclusion Y 0:Zero
 1:Exempt
2:No exclusion
pageNo current page
Y
number
pageSize How many records
are displayed per Y
page
totalSize Total number of
Y
articles
pageCount total pages Y

25. Query Excise Duty

Interface Name Query Excise Duty

Description Query Excise Duty
Interface Code T125
Request
N
Encrypted
Response
N
Encrypted
Request Message Null
{
"exciseDutyList": [{
"id": "000023",
"exciseDutyCode": "LED060000",
"goodService": "Soft cup",
"parentCode": "LED000000",
"rateText": "18.00%,shs.100.00 Per minute",
"isLeafNode": "0",
"effectiveDate": "29/08/2019",
"exciseDutyDetailsList": [{
Response Message
"exciseDutyId": "000023",
"type": "101",
"rate": "0.18",
"unit": "",
"currency": "101"
}, {
"exciseDutyId": "000023",
"type": "102",
"rate": "100",
"unit": "101",
 "currency": "101"
}]
}, {
"id": "000023",
"exciseDutyCode": "LED060000",
"goodService": "Soft cup",
"parentCode": "LED000000",
"rateText": "18.00%,shs.100.00 Per minute",
"isLeafNode": "0",
"effectiveDate": "29/08/2019",
"exciseDutyDetailsList": [{
"exciseDutyId": "000024",
"type": "101",
"rate": "0.18",
"unit": ""
}, {
"exciseDutyId": "000024",
"type": "102",
"rate": "100",
"unit": "101"
}]
}]
}
Flow Description Query Excise Duty

Field description

Field Field Name Required Length Description

id id Y 20
exciseDutyCod exciseDutyCode 20
Y
e
goodService goodService Y 500
parentCode Good parentCode Y 20
rateText tax rateText Y 50
exciseDutyId Good category ID 18 Corresponding
Y
dictionaryrateType
isLeafNode isLeafNode Y 1 1:Y 0:N
effectiveDate effectiveDate Y
exciseDutyId exciseDutyId Y 20
type tax rate 10 101 Percentage
Y
Calculate type 102 Unit of measurement
rate tax rate Y number
 unit unit of type=101 is empty
measurement type=102 is not empty
Corresponding dictionarycode
rateUnit

26. Get All Exchange Rates

Interface Name get all exchange rates

Description get all exchange rates
Interface Code T126
Request
N
Encrypted
Response
Y
Encrypted
Request Message Null
[
{
"currency": "USD",
Response Message
"rate": "3700"
}
]
Flow Description Acquiring exchange rate

Field description

Field Field Name Required Length Description

currency currency Y 3

Field Field Name Required Length Description

currency currency Y 3
rate rate Exchange rate of target
Y currency to ugx eg: 1usd =
3700ugx

27. Goods/Services Inquiry

Interface Name Goods/Services Inquiry

 Description Goods/Services Inquiry
Interface Code T127
Request
Y
Encrypted
Response
Y
Encrypted
{
"goodsCode": "0001",
"goodsName ": "cat",
Request Message "commodityCategoryName": "cat",
"pageNo": "10",
"pageSize": "10"
}
{
"page": {
"pageNo": "1",
"pageSize": "10",
"totalSize": " Total number of articles ",
"pageCount": "total pages"
},
"records": [{
"id": "000023",
"goodsName": "cat",
"goodsCode": "0001",
"measureUnit": "101",
"unitPrice": "13.99",
"currency": "101",
"stock": "12",
Response Message "stockPrewarning": "12",
"source": "101",
"statusCode": "101",
"commodityCategoryCode": "13101501",
"commodityCategoryName": "tax",
"taxRate": "0.18",
"isZeroRate": "101",
"isExempt": "102",
"haveExciseTax": "101",
"exciseDutyCode": "LED010100",
"exciseDutyName": "LED010100",
"exciseRate": "0.12",
"pack": "1",
"stick": "1",
"remarks": "1",
"packageScaledValue": "12",
 "pieceScaledValue": "1",
"pieceMeasureUnit": "101",
"havePieceUnit": "102",
"pieceUnitPrice": "110"，
"exclusion": "1"
},]
}
Flow Description Goods/Services Inquiry

Field description

Field Field Name Required Length Description

goodsCode goodsCode N 50
goodsName goodsName N 100
commodityCate commodityCategor 200
goryName yName N
pageNo current page 10
Y
number
pageSize How many records 3 Cannot be greater than the
are displayed per Y integer 100
page

Field Field Name Required Length Description

id Goods id Y
goodsName Goods Name Y
goodsCode Goods Code Y
measureUnit Measure Unit Y T115 rateUnit
unitPrice unitPrice Y
currency currency Y currencyType
stock stock Y
stockPrewarni stockPrewarning
Y
ng
source source source(101:URA ;
Y
102:Taxpayer)
statusCode status Y 101:enable ; 102 disable
commodityCate commodityCategor
Y
goryCode yCode
commodityCate commodityCategor
Y
goryName yName
taxRate taxRate Correspond tax
Y ratecodeTAX_RATE_CODE
taxRate
 0.18 18%
isZeroRate isZeroRate Y 101:Y 102:N
isExempt isExempt Y 101:Y 102:N
haveExciseTax haveExciseTax Is there excise tax
Y
(101:yes ; 102:no)
exciseDutyCod exciseDutyCode
Y
e
exciseDutyNam exciseDutyName
Y
e
exciseRate exciseRate Y
pack pack Y
stick stick Y
remarks remarks Y
totalSize Total number of
Y
articles
pageCount total pages Y
packageScaled packageScaledVal
Y
Value ue
pieceScaledVa pieceScaledValue
Y
lue
pieceMeasureU pieceMeasureUnit
Y
nit
havePieceUnit havePieceUnit Y
pieceUnitPric pieceUnitPrice
Y
e
exclusion exclusion 0:Zero
Y 1:Exempt
2:No exclusion

28. Query the stock quantity by goods id

Interface Name Query the stock quantity by goods id

Description Query the stock quantity by goods id
Interface Code T128
Request
Y
Encrypted
Response
Y
Encrypted
{
Request Message "id": "290707933831281139"
}
 {
"stock": "12",
Response Message
"stockPrewarning": "10"
}
Flow Description Query the stock quantity by goods id

Field description

Field Field Name Required Length Description

id Goods id Y 18

Field Field Name Required Length Description

stock currency Y
stockPrewarni stockPrewarning
Y
ng

29. Batch Invoice Upload

Interface Name Batch Invoice Upload

Description Batch Invoice Upload
Interface Code T129
Request
Y
Encrypted
Response
Y
Encrypted
[
{
"invoiceContent": "T109 Request information plaintext",
Request Message
"invoiceSignature": "JKQWJK34K32JJEK2JQWJ5678"
}
]
[
{
"invoiceContent": "T109 Response information plaintext",
Response Message "invoiceReturnCode": "00",
"invoiceReturnMessage": "SUCCESS"
}
]
Flow Description Query the stock quantity by goods id
 Field description

Field Field Name Required Length Description

invoiceConten invoiceContent
Y
t
invoiceSignat Signature value
Y
ure

Field Field Name Required Length Description

invoiceConten Invoice Content
Y
t
invoiceReturn Invoice Return
Y
Code Message
invoiceReturn Invoice Return When the "returnCode" value is
Message Message Y 99, the exception information will
be assigned to the field.

30. Goods Upload

Interface Name Goods Upload

Description Goods Upload
Interface Code T130
Request
Y
Encrypted
Response
Y
Encrypted
[
{
"goodsName": "apple",
"goodsCode": "001",
"measureUnit": "101",
"unitPrice": "6999.99",
"currency": "101",
Request Message
"commodityCategoryId": "10111301",
"haveExciseTax": "101",
"description": "1",
"stockPrewarning": "10",
"pieceMeasureUnit": "101",
"havePieceUnit": "101",
"pieceUnitPrice": "12.34",
 "packageScaledValue": "1",
"pieceScaledValue": "1",
"exciseDutyCode": "1"
},
]
[
{
"goodsName": "apple",
"goodsCode": "001",
"measureUnit": "101",
"unitPrice": "6999.99",
"currency": "101",
"commodityCategoryId": "10111301",
"haveExciseTax": "101",
"description": "1",
Response Message "stockPrewarning": "10",
"pieceMeasureUnit": "101",
"havePieceUnit": "101",
"pieceUnitPrice": "12.34",
"packageScaledValue": "1",
"pieceScaledValue": "1",
"exciseDutyCode": "1",
"returnCode": "601",
"returnMessage": "MeasureUnit:Invalid field value!"
},
]
All goods are uploaded successfully, and the return message is empty. If
Flow Description there is any failure, the goods will be returned

Field description

Field Field Name Required Length Description

goodsName Goods Name 100 Goodsname cannot be empty,
Y cannot be greater than 50
characters
goodsCode Goods Code 50 Goodscode cannot be empty,
Y cannot be greater than 50
characters
measureUnit Measure Unit Y 3 T115 rateUnit
unitPrice Unit Price Number The number of integer digits
Y does not exceed 12 digits and
the number of decimal places
 does not exceed 8 digits
currency currency Y 3 T115 currencyType
commodityCate commodityCategor 18 Commodity Category Id
Y
goryId yId
haveExciseTax haveExciseTax Y 3 101:Yes 102:No
description description N 1024
stockPrewarni stockPrewarning 24 The number of integer digits
ng does not exceed 12 digits and
Y the number of decimal places
does not exceed 8 digits，
can be zero
pieceMeasureU pieceMeasureUnit 3 havePieceUnit is 102
nit pieceMeasureUnit must be
empty!

N havePieceUnit is 101
pieceMeasureUnit cannot be
empty

T115 rateUnit
havePieceUnit havePieceUnit 3 haveExciseTax is 102
havePieceUnit must be empty!
N
101:Yes 102:No
pieceUnitPric pieceUnitPrice Number havePieceUnit is 102
e pieceUnitPrice must be empty!

havePieceUnit is 101
pieceUnitPrice cannot be
N empty

The number of integer digits

does not exceed 12 digits and
the number of decimal places
does not exceed 8 digits
packageScaled packageScaledVal Number havePieceUnit is 102
Value ue packageScaledValue must be
empty!

N havePieceUnit is 101
packageScaledValue cannot be
empty

The number of integer digits

 does not exceed 12 digits and
the number of decimal places
does not exceed 8 digits
pieceScaledVa pieceScaledValue Number havePieceUnit is 102
lue pieceScaledValue must be
empty!

havePieceUnit is 101
N pieceScaledValue cannot be
empty
The number of integer digits
does not exceed 12 digits and
the number of decimal places
does not exceed 8 digits
exciseDutyCod exciseDutyCode haveExciseTax is 102
N
e exciseDutyCode must be empty!
returnCode returnCode N response
returnMessage returnMessage N response

31. Goods Stock Maintain

Interface Name Goods Stock Maintain

Description Goods Stock Maintain
Interface Code T131
Request
Y
Encrypted
Response
Y
Encrypted
{
"goodsStockIn": {
"operationType": "101",
"supplierTin": "1010039929",
"supplierName": "Mr. EMUR SAM",
"adjustType": "101",
"remarks": "Increase inventory"
Request Message
},
"goodsStockInItem": [{
"commodityGoodsId": "287700992426868373",
"quantity": "100",
"unitPrice": "6999"
}]
}
 [
{
"commodityGoodsId": "287700992426868373",
"quantity": "100",
Response Message "unitPrice": "6999",
"returnCode": "601",
"returnMessage": "MeasureUnit:Invalid field value!"
},
]
The goods inventory is uploaded successfully, and the return message is
Flow Description empty. If there is any failure, the data will be returned

Field description

Field Field Name Required Length Description

operationType OperationType 3 101:Increase inventory
Y
102:Inventory reduction
supplierTin SupplierTin 50 If operationType = 102，
N
supplierTin must be empty
supplierName supplierName 100 If operationType = 102，
supplierName must be empty
N
If operationType = 101，
supplierName cannot be empty

adjustType adjustType 3 101:Expired Goods

102:Damaged Goods
103:Personal Uses
104:Raw Material(s)
105:Others. (Please specify)
N
If operationType = 101，
adjustType must be empty

If operationType = 102，
adjustType cannot be empty

remarks remarks 1024 If operationType = 102，

N adjustType = 104 remarks
cannot be empty
commodityGood commodityGoodsId 20 Commodity Goods Id
Y
sId
 quantity quantity Number The number of integer digits
does not exceed 12 digits and
Y
the number of decimal places
does not exceed 8 digits
unitPrice unitPrice Number Commodity purchase price
The number of integer digits
Y does not exceed 12 digits and
the number of decimal places
does not exceed 8 digits
returnCode returnCode N response
returnMessage returnMessage N response

32. Upload exception log

Interface Name Upload exception log

Description Goods Stock Maintain
Interface Code T132
Request
Y
Encrypted
Response
N
Encrypted
[{
"interruptionTypeCode": "101",
"description": "Login failed",
"errorDetail": "Login failed",
"interruptionTime": "2020-04-26 17:13:12"

Request Message },{

"interruptionTypeCode": "101",
"description": "Login failed",
"errorDetail": "Login failed",
"interruptionTime": "2020-04-26 17:13:12"

}]

Response Message Null

When the cash in machine logs in, upload the abnormal log information in
Flow Description the last login period.
 Field description

Field Field Name Required Length Description

interruptionT interruptionType 3 101:Number of Disconnected
ypeCode Code 102:Login Failure
Y 103:Receipt Upload Failure
104:System related errors
105:Paper roll replacement
description description Y 3000
errorDetail errorDetail N 4000
interruptionT interruptionTime Date yyyy-MM-dd HH24:mm:ss
Y
ime

33. TCS upgrade system file download

Interface Name TCS upgrade system file download

Query the files needed to upgrade the system by version number and
Description operation type number, including uploading attachments and required sql
files!
Interface Code T133
Request
Y
Encrypted
Response
Y
Encrypted
{
"tcsVersion": "1",
Request Message
"osType": "1"
}
{
"precommand": "/as/",
"precommandurl": "./jmeter/bin",
"precommandfilename": "abc.txt",
"command": "000",
"commandurl": "./home/tomcat",
Response Message "commandfilename": "a.docx",
"tcsversion": "1",
"fileList": [
{
"updatefile": "?????",
"iszip": "1",
"updateurl": "/asd/fsd",
 "deleteurl": "/ad/fsads",
"ordernumber": "1"
}
],
"sqlList": [
{
"updatesql": "select * from T_INVOICE_DETAILS;",
"ordernumer": 3
}
]
}
Return the file information required for system upgrade through request
Flow Description parameters

Field description

Field Field Name Required Length Description

tcsVersion tcsVersion TCS version is a number
Y
starting from 1
osType osType Y 1 0:linumx 1:windows
precommand precommand clob Precommand FileStream Base64
Y
string
precommandurl precommandurl Y 256 precommandurl
precommandfil precommandfilena 500 precommandfilename
N
ename me
command command clob Command FileStream Base64
Y
string
commandurl commandurl Y 256 commandurl
commandfilena commandfilename 500 commandfilename
N
me
updatefile updatefile Y CLOB updatefile
iszip iszip N iszip
updateurl updateurl Y 256 updateurl
deleteurl deleteurl Y 256 deleteurl
ordernumber ordernumber Y Execution sequence
updatesql updatesql Y CLOB Sql file
 34. Commodity category incremental update

Interface Name Commodity category incremental update

Description Commodity category incremental update
Interface Code T134
Request
Y
Encrypted
Response
Y
Encrypted
{
Request Message "commodityCategoryVersion": "1.0"
}
[{
"commodityCategoryCode": "100000000",
"parentCode": "0",
"commodityCategoryName": "Standard",
"commodityCategoryLevel": "1",
"rate": "0.18",
"isLeafNode": "101",
"serviceMark": "101",
"isZeroRate": "101",
"zeroRateStartDate": "01/12/2019",
"zeroRateEndDate": "05/12/2019",
"isExempt": "101",
"exemptRateStartDate": "06/12/2019",
"exemptRateEndDate": "10/12/2019",
"enableStatusCode": "1",
Response Message "exclusion": "1"
}, {
"commodityCategoryCode": "100000000",
"parentCode": "0",
"commodityCategoryName": "Standard",
"commodityCategoryLevel": "1",
"rate": "0.18",
"isLeafNode": "101",
"serviceMark": "101",
"isZeroRate": "101",
"zeroRateStartDate": "01/12/2019",
"zeroRateEndDate": "05/12/2019",
"isExempt": "101",
"exemptRateStartDate": "06/12/2019",
"exemptRateEndDate": "10/12/2019",
"enableStatusCode": "1",
 "exclusion": "1"
}]

The client logs in to determine whether T103 commodityCategoryVersion is

consistent with the local commodityCategoryVersion. If it is not
consistent, call T134
Flow Description
T134 returns the latest version of the commodity category data, delete
the local data according to the returned commodityCategoryCode, and then
save the returned data!

Field description

Field Field Name Required Length Description

commodityCate commodityCategor local
Y
goryVersion yVersion commodityCategoryVersion
commodityCate commodityCategor
Y
goryCode yCode
parentCode parentCode Y
commodityCate commodityCategor
Y
goryName yName
commodityCate commodityCategor
Y
goryLevel yLevel
rate rate Correspond tax
ratecodeTAX_RATE_CODE
Y
taxRate
0.18 18%
isLeafNode isLeafNode Y 101:Y 102:N
serviceMark serviceMark Y 101:Y 102:N
isZeroRate isZeroRate Y 101:Y 102:N
zeroRateStart zeroRateStartDat
N
Date e
zeroRateEndDa zeroRateEndDate
N
te
isExempt isExempt Y 101:Y 102:N
exemptRateSta exemptRateStartD
N
rtDate ate
exemptRateEnd exemptRateEndDat
N
Date e
enableStatusC enableStatusCode 1:enable: 0:disable
Y
ode
 exclusion exclusion 0:Zero
Y 1:Exempt
2:No exclusion

35. Get Tcs Latest Version

Interface Name Get Tcs Latest Version

Description Get Tcs Latest Version
Interface Code T135
Request
N
Encrypted
Response
Y
Encrypted
Request Message NULL

{
Response Message "latesttcsversion": 5
}

Flow Description Get Tcs Latest Version

Field description

Field Field Name Required Length Description

latesttcsvers latesttcsversion
Y
ion

Customs interface code table

Interface Name Interface Code Description

Upload import invoice C101
Upload Export SAD C102
Confirm import invoice C103
information
Cancel import invoice C104
 1. Upload import invoice

Interface Name Customs import Invoice Upload

Description Customs upload the Invoice to the server.
Interface Code C101
Request
Y
Encrypted
Response
Y
Encrypted
{
"basicInformation": {
"invoiceNo": "00000000001",
"antifakeCode": "201905081711",
"deviceNo": "201905081234",
"sadNumber": "201905081234",
"sadDate": "2019-05-08 17:13:12",
"wareHouseNumber": "11111",
"wareHouseName": "xxxxxxxx",
"office": "xxxxxxxx",
"cif": "xxxxxxxx",
"valuationMethod": "xxxxxxxx",
"operator": "URA",
"currency": "UGX"
},
"buyerDetails": {
"buyerTin": "201905081705",
Request Message
"buyerNinBrn": "201905081705",
"buyerPassportNum": "201905081705",
"buyerLegalName": "zhangsan",
"buyerBusinessName": "lisi",
"buyerAddress": "beijin",
"buyerEmail": "123456@163.com",
"buyerMobilePhone": "15501234567",
"buyerLinePhone": "010-6689666",
"buyerPlaceOfBusi": "beijin"
},
"goodsDetails": [{
"item": "apple",
"itemCode": "101",
"qty": "2",
"unitOfMeasure": "kg",
"unitPrice": "150.00",
"total": "1",
 "taxRate": "0.18",
"tax": "12.88",
"orderNumber": "0",
"hsCode": "5467",
"hsCodeDescription": "Test",
"pack": "1 Box"
}],
"taxDetails": [{
"taxCategory": "'Standard",
"netAmount": "3813.55",
"taxRate": "0.18",
"taxAmount": "686.45",
"grossAmount": "4500.00"
"taxRateName": "123"
}, {
"taxCategory": "''Excise Duty",
"netAmount": "1818.18",
"taxRate": "0.1",
"taxAmount": "181.82",
"grossAmount": "2000.00"
"taxRateName": "123"
}],
"summary": {
"netAmount": "8379",
"taxAmount": "868",
"grossAmount": "9247",
"itemCount": "5",
"remarks": "This is another remark test.",
"qrCode": "asdfghjkl",
"prn": "201905081234",

},
"extend": {
}
}
{
"basicInformation": {
"invoiceId": "1000002",
"invoiceNo": "00000000001",
Response Message "antifakeCode": "201905081711",
"deviceNo": "201905081234",
"sadNumber": "201905081234",
"sadDate": "2019-05-08 17:13:12",
"wareHouseNumber": "11111",
 "wareHouseName": "xxxxxxxx",
"office": "xxxxxxxx",
"cif": "xxxxxxxx",
"valuationMethod": "xxxxxxxx",
"operator": "URA",
"currency": "UGX"
},
"buyerDetails": {
"buyerTin": "201905081705",
"buyerNinBrn": "201905081705",
"buyerPassportNum": "201905081705",
"buyerLegalName": "zhangsan",
"buyerBusinessName": "lisi",
"buyerAddress": "beijin",
"buyerEmail": "123456@163.com",
"buyerMobilePhone": "15501234567",
"buyerLinePhone": "010-6689666",
"buyerPlaceOfBusi": "beijin"
},
"goodsDetails": [{
"item": "apple",
"itemCode": "101",
"qty": "2",
"unitOfMeasure": "kg",
"unitPrice": "150.00",
"total": "1",
"taxRate": "0.18",
"tax": "12.88"
"orderNumber": "1",
"hsCode": "5467",
"hsCodeDescription": "Test"
}],
"taxDetails": [{
"taxCategory": "'Standard",
"netAmount": "3813.55",
"taxRate": "0.18",
"taxAmount": "686.45",
"grossAmount": "4500.00"
"taxRateName": "123"
}, {
"taxCategory": "''Excise Duty",
"netAmount": "1818.18",
"taxRate": "0.1",
"taxAmount": "181.82",
 "grossAmount ": "2000.00"
"taxRateName": "123"
}],
"summary": {
"netAmount": "8379",
"taxAmount": "868",
"grossAmount": "9247",
"itemCount": "5",
"remarks": "This is another remark test.",
"qrCode": "asdfghjkl",
"prn": "201905081234",
},
"extend": {
}

}
Flow Description

Field description

Basic InformationInternal field:

Field Field Name Required Length Description
invoiceNo Invoice number N 20
antifakeCode antifake code N 20 Digital signature(20 digital)
deviceNo device Number Y 20 Device Number (20 digital)
sadNumber SAD Number Y 20 SAD Number(20 digital)
sadDate SAD Date Y date yyyy-MM-dd HH24:mm:ss
wareHouseNumb Ware housing 16
Y
er Number
wareHouseName Ware housing 256
Y
Name
office office Y 35 office for example busia
cif cif Y 50 CIF
valuationMeth Valuation Method 128 valuation method
Y
od
operator Operator Y 100
currency currency Y 10 UGX

Buyer DetailsInternal field:

Field Field Name Required Length Description
buyerTin Buyer TIN N 10-20
buyerNinBRn Buyer NIN N 100
buyerPassport Passport number 20
N
Num
buyerLegalNam legal name 256
N
e
buyerBusiness business name 256
N
Name
buyerAddress buyeraddress N 500
buyerEmail buyeremail N 50 Mailbox format
buyerMobilePh mobile phone 30
N
one
buyerLinePhon line phone 30
N
e
buyerPlaceOfB place of 500
N
usi business

Goods DetailsInternal field:

Field Field Name Required Length Description
item item name 100 discountFlag is 0, the name
of the discount line is equal
to the name of the discounted
line + space + "(discount)"
When deemedFlag is 1
Y
Name + space + ”(deemed)”
If discountFlag is 0 and
deemedFlag is 1
Name + Space + ”(deemed)” +
Space + ”(discount)”
itemCode item code Y 50
qty Quantity Number Required if discountFlag is 1
or 2 and must be positive
must be empty when
discountFlag is 0
N
The number of integer digits
does not exceed 12 digits and
the number of decimal places
does not exceed 8 digits
unitOfMeasure unit of measure 3 101 kg
102 pack
103 piece
104 meter
N
105 stick
106 litre
107 day of access
108 minute
unitPrice unit Price Number Required if discountFlag is 1
or 2 and must be positive
must be empty when
discountFlag is 0
N
The number of integer digits
does not exceed 12 digits and
the number of decimal places
does not exceed 8 digits
total total price Number must be positive when
discountFlag is 1 or 2
must be negative when
Y discountFlag is 0
No more than 12 digits for
integers and no more than 2
digits for decimals
taxRate tax rate Number Save decimals, such as 18%
deposit 0.18
Must be positive
Y The number of integer digits
does not exceed 12 digits and
the number of decimal places
does not exceed 8 digits
tax tax Number must be positive when
discountFlag is 1 or 2
must be negative when
discountFlag is 0
Y
The number of integer digits
does not exceed 12 digits and
the number of decimal places
does not exceed 2 digits
orderNumber order number Y number Add one each time from zero
hsCode HSC code 18
Y
hsCodeDescrip HSC code 100
Y
tion Description
pack Pack N 1024

Tax DetailsInternal field:

Field Field Name Required Length Description
taxCategory tax category Y 100
netAmount net amount number Must be positive or 0
Y The number of integer digits
does not exceed 16 digits
 and the number of decimal
places does not exceed 8
digits
taxRate tax rate number 18% corresponds to 0.18
0 corresponds to 0
Y
Tax-free correspondence ‘-’
in the database”
taxAmount tax Must be positive or 0
The number of integer digits
Y does not exceed 16 digits and
the number of decimal places
does not exceed 2 digits
grossAmount gross amount Must be positive or 0
The number of integer digits
Y does not exceed 16 digits and
the number of decimal places
does not exceed 2 digits
taxRateName Tax Rate Name Y 100

SummaryInternal field:
Field Field Name Required Length Description
netAmount net amount number Tax Receipt total net
amount
Y Must be positive or 0
The number of integer digits
does not exceed 16 digits
taxAmount tax amount number Tax Receipt total tax amount
Must be positive or 0
Y
The number of integer digits
does not exceed 16 digits
grossAmount gross amount number Tax Receipt total gross
amount
Y Must be positive
The number of integer digits
does not exceed 16 digits
itemCount Purchase item Number Must match the Number of all
lines Y （4） product lines in goodsDetail-
number of discount lines!
remarks Remarks N 500
qrCode qrCode N 500 Required if mode is 0
prn payment 80 payment registration number
registration Y
number
 2. Upload Export SAD

Interface Name Upload Export invoice

Description Upload Export invoice
Interface Code C102
Request
Y
Encrypted
Response
Y
Encrypted
{
"tin": "201905081705",
"ninBrn": "201905081705",
"taxpayerName": "xxxxxxxx",
Request Message "invoiceNo": "22970000531455",
"sadNumber": "22970000531455",
"destinationCountry": "Ugand",
"originCountry": "22970000531455"
}

Response Message Null

Flow Description

Field description

Field Field Name Required Length Description

tinBrnNin Tin Y 20 Tin or Brn or Nin
ninBrn NIN or Brn N 100
taxpayerName Taxpayer Name Y 256 Taxpayer Name
invoiceNo Invoice No Y 20 Invoice No
sadNumber SAD Number Y 20 SAD Number
destinationCo Destination 256 Destination Country
Y
untry Country
originCountry Origin Country Y 256 Origin Country
 3. Confirm import invoice information

Interface Name Confirm import invoice information

Description Confirm import invoice information
Interface Code C103
Request
Y
Encrypted
Response
Y
Encrypted
{
"invoiceNo": "22970000531455",
Request Message
"sadNumber": "22323232443433"
}

Response Message Null

Flow Description

Field description

Field Field Name Required Length Description

invoiceNo Invoice No Y 20 Invoice No
sadNumber SAD Number Y 20 SAD Number

4. Cancel import invoice

Interface Name Cancel import invoice

Description Cancel import invoice
Interface Code C104
Request
Y
Encrypted
Response
Y
Encrypted
{
"invoiceNo": "22970000531455",
Request Message
"sadNumber": "22323232443433"
}
Response Message Null

Flow Description

Field description

Field Field Name Required Length Description

invoiceNo Invoice No Y 20 Invoice No
sadNumber SAD Number Y 20 SAD Number

Request/Response code table

Code Name description

TP Taxpayer Side
TA URA Side