ZRA SMART INVOICE API VER ISHYIGA 1.4 INGWE

ZRA SMART INVOICE API Documentation VER ISHYIGA 1.4 INGWE , API for SMART INVOICE INTEGRATION DOCUMENTATION VCIS/VSDC

This document describes the API specification to integrate with Electronic Invoicing Systems (Smart invoice)

Overview
The following specific requirements are for the systems to communicate with Smart invoice VCIS, the Certified Invoicing System to be used together with a Virtual Sales Data Controller (VSDC).

DATA FLOW DIAGRAM : https://wirepickpay.com/DataFlow.php

This Api have an Authentication

"COMPANY_TPIN": "1004097050",
"COMPANY_NAMES": "WIREPICK INC ",
"COMPANY_SECURITY_KEY": "AQPBBLMHBBKGGGC3FVVOAGLDWL32GGLF"

SMART INVOICE API Receive data in two ways

1.XML FORMAT
2.JSON FORMAT.

TAX TYPE & TAX CODE MAPPING

ZRA TAX CODE	SYSTEM TAX CODE	DESCRIPTION	TAX RATE
A	A	Standard Rated(16%)	16
B	B	Minimum Taxable Value (MTV-16%)	16
C1	C	C1 (Exports(0%))	0
C2	D	C2 (Zero-rating LPO)	0
C3	E	C3 (Zero-rated by nature)	0
D	F	Exempt	0

ERROR CODE LIST

CODE	ERROR	ACCEPTED
B05	CLIENT NAME MISSING	<2 char
B051	TAX NUMBER FORMAT NOT ACCEPTED	!EMPTY or !10
B06	CLIENT NAME DIFFERENT FOR PREVIOUS ONE	PREVIOUS TPIN NUMBER
B07	CODE MISSING	null
B09	DESCRIPTION MISSING	null
B10	QUANTITY MISSING	>0
B11	QUANTITY IS NEGATIVE	<0
B12	QUANTITY NOT A NUMBER	character
B13	TAX_RATE NOT ACCEPTED	!0 or !16
B16	INVOICE TOTAL AMOUNT DIFFERENT TO GROSS_AMOUNT	>0.05
B18	INVOICE TOTAL TAXES AMOUNT DIFFERENT TAXES	>0.05
B19	INVOICE REFERENCE MISSING	null
B20	INVOICE REFERENCE ALREADY SENT	TRUE
B21	NEGATIVE SALE PRICE NOT ALLOWED	<=0
B22	ZERO TOTAL INVOICE NOT SUPPORTED	<=0
R1	REFUND TOTAL AMOUNT DIFFERENT TO ORIGINAL INVOICE AMOUNT
R2	REFUND TOTAL VAT AMOUNT DIFFERENT TO ORIGINAL INVOICE VAT AMOUNT
R3	REFUND ITEM MISSING , ITEM NOT FOUND
R4	REFUND ITEM DIFFERENT FROM INVOICE ITEM , CHECK ITEM NAME AND CODE
R5	MISSING REFUND_ID	REFUND_ID
F01	FLAG NUMBER FORMAT	INVOICE, REFUND, PROFORMA, PARTIAL REFUND, INVENTORY, ITEM
F02	INVOICE ALREADY REFUNDED
B70	WRONG CURRENCY	ZMW when EXCHANGE_RATE is 1
IS100	INTERNAL ERROR
B15	CHECK NUMBER OF ITEMS WITH EXPECTED SIZE
B27	TAXRATE DIFFERENT FROM PREVIOUS ONE
B061	ITEM CODE DIFFERENT FOR PREVIOUS ONE
B28	CLIENT TAX NUMBER DIFFERENT FROM PREVIOUS ONE
B29	CLIENT TAX NUMBER IS FOR ANOTHER CLIENT
B31	LEVY A AMOUNT ARE DIFFERENT
B32	LEVY B AMOUNT ARE DIFFERENT
B33	LEVY C AMOUNT ARE DIFFERENT
B34	TOTAL LEVY AMOUNT ARE DIFFERENT
B35	LEVY D AMOUNT ARE DIFFERENT
B01	INCORRECT CLIENT TPIN PIN
A01	COMPANY_NAMES: COMPANY_TPIN: COMPANY_SECURITY_KEY: DOES NOT EXISTS
A02	EMPTY LIST
A03	REFUND BYPASS( EXCEEDING ORGINAL INVOICE AMOUNT)
A04	UNKNOWN FLAG NAME	INVOICE,REFUND
A05	MISSING ORIGINAL INVOICE NUMBER
A06	INVALID UNITY PRICE
A07	INVALID DISCOUNT
A08	INVALID TAXCODE	A,B,C1,C2,C3 ,D
A09	INVALID TAXRATE	0 OR 16
A12	INCOME MSG FAILED TO BE LOGGED	SEND INVOICE FIRST
A10	NOT ENGINE SIZE FOUND (CONTACT AUTHORITY TECH TEAM)	ENGINE SHOULD HAVE SIZE
A11	ITEM COUNT NOT A NUMBER	>0
A13	EVAT NOT ABLE TO REACH ITS DATABASE
A14	ENCOUTED ITEMS SYS ERROR CONTACT TECH TEAM
D01	INVOICE ALREADY EXIST
D02	MISSING ITEM NAME
D03	MISSING ITEM CODE
D07	MISSING ITEM ORIGIN COUNTRY CODE	08Default (ZMW) FOR ZAMBIA
D08	MISSING PACKAGING UNIT
D09	MISSING QUANTITY UNIT
D10	MISSING ITEM CATEGORY NAME
T03	TPIN NUMBER NOT FOUND	When the requestED TPIN NUMBER is not found in synchronized ZRA data
T04	TPIN STOPPED
T05	TPIN PROTECTED
T06	INCORRECT CLIENT TPIN
N01	ITEM NOT FOUND
N02	ITEM NOT VALIDATED, PENDING
D04	NO RESPONSE FOUND SEND INVOICE FIRST	SEND INVOICE
D05	INVOICE UNDER STAMPING	PULL RESPONSE AFTER 3 SECOND
D06	STAMPING ENGINE IS DOWN	CHECK IF SDK OR SERVER MACHINE IS RUNNING
P01	PRODUCT ALREADY EXIST
H01	WRONG COMMAND	ID REQUEST
H02	WRONG TIME FORMAT
H03	INVENTORY EXISTS
H04	INVENTORY NOT RECEIVED

INVOICE

Invoice
Invoce (Normal Sale) refers to a receipt that shall be produced and offered to the client. It is any receipt produced while the Electronic Billing Machine is in its normal registration mode, used to register sales of goods and/or services, including corrections and discounts.

The following is an example of how data to be sent should be structured.