Items: General Data Attributes
Peruse further details of attributes filled-in in Items endpoint
The /items endpoint has these two HTTP methods you can interact with:
The /items/{item_id} endpoint has these three HTTP methods you can interact with:
Below are the attributes used in the API requests and responses above.
Item attributes table
Attribute ID | Required | Data Type | Description - Sample (JSON) |
|---|---|---|---|
id | string | item_id represents the UUID (Item ID) as generated by DigiTax API - | |
active | Only in PUT | boolean | Represents whether the item concerned is used OR unused - |
item_class_code | Yes | string | Represents Item Classification Code. See Items classification table for context - |
item_type_code | Yes | string | Represents Item Type Code. See Item Type codes table for context - |
item_name | Yes | string | Represents the Item Name |
origin_nation_code | Yes | string | Represents the code of the item's origin (Nation). See Country Codes table for context - |
package_unit_code | Yes | string | Represents the item's packaging unit. See Packaging Unit table for context - |
quantity_unit_code | Yes | string | Represents the Quantity Unit Code. See Quantity Unit table for context - |
tax_type_code | Yes | string | Represents the Taxation Type Code. See Taxation Type table - |
default_unit_price | Yes | number | Represents the Default Unit Price - |
callback_url | No | string | Represents the URL to be called by DigiTax API when we have new information about the item, usually after syncing with ZRA Smart Invoice System |
Item Type codes
| Code | Code Name | Code Description |
|---|---|---|
| 1 | Raw Material | Raw Material |
| 2 | Finished Product | Finished Product |
| 3 | Service | Service without stock |
Country Codes
| Code | Code Name | Code Description |
|---|---|---|
| AC | ASCENSION ISLAND | ASCENSION ISLAND |
| AD | ANDORRA | ANDORRA |
| AE | UNITED ARAB EMIRATES | UNITED ARAB EMIRATES |
| AG | ANTIGUA AND BARBUDA | ANTIGUA AND BARBUDA |
| AI | ANGUILLA | ANGUILLA |
| AL | ALBANIA | ALBANIA |
| AM | ARMENIA | ARMENIA |
| AN | NETHERLANDS ANTILLES | NETHERLANDS ANTILLES |
| AO | ANGOLA | ANGOLA |
| AQ | ANTARCTICA | ANTARCTICA |
| AR | ARGENTINA | ARGENTINA |
| AS | AMERICAN SAMOA | AMERICAN SAMOA |
| AT | AUSTRIA | AUSTRIA |
| AU | AUSTRALIA | AUSTRALIA |
| AW | ARUBA | ARUBA |
| AX | ALAND ISLANDS | ALAND ISLANDS |
| AZ | AZERBAIJAN | AZERBAIJAN |
| BA | BOSNIA AND HERZEGOVINA | BOSNIA AND HERZEGOVINA |
| BB | BARBADOS | BARBADOS |
| BD | BANGLADESH | BANGLADESH |
| BE | BELGIUM | BELGIUM |
| BF | BURKINA FASO | BURKINA FASO |
| BG | BULGARIA | BULGARIA |
| BH | BAHRAIN | BAHRAIN |
| BI | BURUNDI | BURUNDI |
| BJ | BENIN | BENIN |
| BM | BERMUDA | BERMUDA |
| BN | BRUNEI DARUSSALAM | BRUNEI DARUSSALAM |
| BO | BOLIVIA | BOLIVIA |
| BR | BRAZIL | BRAZIL |
| BS | BAHAMAS | BAHAMAS |
| BT | BHUTAN | BHUTAN |
| BV | BOUVET ISLAND | BOUVET ISLAND |
| BW | BOTSWANA | BOTSWANA |
| BY | BELARUS | BELARUS |
| BZ | BELIZE | BELIZE |
| CA | CANADA | CANADA |
| CC | COCOS (KEELING) ISLANDS | COCOS (KEELING) ISLANDS |
| CD | CONGO, DEMOCRATIC REPUBLIC | CONGO, DEMOCRATIC REPUBLIC |
| CF | CENTRAL AFRICAN REPUBLIC | CENTRAL AFRICAN REPUBLIC |
| CG | CONGO | CONGO |
| CH | SWITZERLAND | SWITZERLAND |
| CI | COTE D'IVOIRE (IVORY COAST) | COTE D'IVOIRE (IVORY COAST) |
| CK | COOK ISLANDS | COOK ISLANDS |
| CL | CHILE | CHILE |
| CM | CAMEROON | CAMEROON |
| CN | CHINA | CHINA |
| CO | COLOMBIA | COLOMBIA |
| CR | COSTA RICA | COSTA RICA |
| CS | CZECHOSLOVAKIA (FORMER) | CZECHOSLOVAKIA (FORMER) |
| CU | CUBA | CUBA |
| CV | CAPE VERDE | CAPE VERDE |
| CX | CHRISTMAS ISLAND | CHRISTMAS ISLAND |
| CY | CYPRUS | CYPRUS |
| CZ | CZECH REPUBLIC | CZECH REPUBLIC |
| DE | GERMANY | GERMANY |
| DJ | DJIBOUTI | DJIBOUTI |
| DK | DENMARK | DENMARK |
| DM | DOMINICA | DOMINICA |
| DO | DOMINICAN REPUBLIC | DOMINICAN REPUBLIC |
| DZ | ALGERIA | ALGERIA |
| EC | ECUADOR | ECUADOR |
| EE | ESTONIA | ESTONIA |
| EG | EGYPT | EGYPT |
| EH | WESTERN SAHARA | WESTERN SAHARA |
| ER | ERITREA | ERITREA |
| ES | SPAIN | SPAIN |
| ET | ETHIOPIA | ETHIOPIA |
| EU | EUROPEAN UNION | EUROPEAN UNION |
| FI | FINLAND | FINLAND |
| FJ | FIJI | FIJI |
| FK | FALKLAND ISLANDS (MALVINAS) | FALKLAND ISLANDS (MALVINAS) |
| FM | MICRONESIA | MICRONESIA |
| FO | FAROE ISLANDS | FAROE ISLANDS |
| FR | FRANCE | FRANCE |
| FX | FRANCE, METROPOLITAN | FRANCE, METROPOLITAN |
| GA | GABON | GABON |
| GB | GREAT BRITAIN (UK) | GREAT BRITAIN (UK) |
| GD | GRENADA | GRENADA |
| GE | GEORGIA | GEORGIA |
| GF | FRENCH GUIANA | FRENCH GUIANA |
| GG | GUERNSEY | GUERNSEY |
| GH | GHANA | GHANA |
| GI | GIBRALTAR | GIBRALTAR |
| GL | GREENLAND | GREENLAND |
| GM | GAMBIA | GAMBIA |
| GN | GUINEA | GUINEA |
| GP | GUADELOUPE | GUADELOUPE |
| GQ | EQUATORIAL GUINEA | EQUATORIAL GUINEA |
| GR | GREECE | GREECE |
| GS | S. GEORGIA AND S. SANDWICH ISLS. | S. GEORGIA AND S. SANDWICH ISLS. |
| GT | GUATEMALA | GUATEMALA |
| GU | GUAM | GUAM |
| GW | GUINEA BISSAU | GUINEA BISSAU |
| GY | GUYANA | GUYANA |
| HK | HONG KONG | HONG KONG |
| HM | HEARD AND MCDONALD ISLANDS | HEARD AND MCDONALD ISLANDS |
| HN | HONDURAS | HONDURAS |
| HR | CROATIA (HRVATSKA) | CROATIA (HRVATSKA) |
| HT | HAITI | HAITI |
| HU | HUNGARY | HUNGARY |
| ID | INDONESIA | INDONESIA |
| IE | IRELAND | IRELAND |
| IL | ISRAEL | ISRAEL |
| IM | ISLE OF MAN | ISLE OF MAN |
| IN | INDIA | INDIA |
| IO | BRITISH INDIAN OCEAN TERRITORY | BRITISH INDIAN OCEAN TERRITORY |
| IQ | IRAQ | IRAQ |
| IR | IRAN | IRAN |
| IS | ICELAND | ICELAND |
| IT | ITALY | ITALY |
| JE | JERSEY | JERSEY |
| JM | JAMAICA | JAMAICA |
| JO | JORDAN | JORDAN |
| JP | JAPAN | JAPAN |
| KE | KENYA | KENYA |
| KG | KYRGYZSTAN | KYRGYZSTAN |
| KH | CAMBODIA | CAMBODIA |
| KI | KIRIBATI | KIRIBATI |
| KM | COMOROS | COMOROS |
| KN | SAINT KITTS AND NEVIS | SAINT KITTS AND NEVIS |
| KP | NORTH KOREA | NORTH KOREA |
| KR | SOUTH KOREA | SOUTH KOREA |
| KW | KUWAIT | KUWAIT |
| KY | CAYMAN ISLANDS | CAYMAN ISLANDS |
| KZ | KAZAKHSTAN | KAZAKHSTAN |
| LA | LAOS | LAOS |
| LB | LEBANON | LEBANON |
| LC | SAINT LUCIA | SAINT LUCIA |
| LI | LIECHTENSTEIN | LIECHTENSTEIN |
| LK | SRI LANKA | SRI LANKA |
| LR | LIBERIA | LIBERIA |
| LS | LESOTHO | LESOTHO |
| LT | LITHUANIA | LITHUANIA |
| LU | LUXEMBOURG | LUXEMBOURG |
| LV | LATVIA | LATVIA |
| LY | LIBYA | LIBYA |
| MA | MOROCCO | MOROCCO |
| MC | MONACO | MONACO |
| MD | MOLDOVA | MOLDOVA |
| ME | MONTENEGRO | MONTENEGRO |
| MG | MADAGASCAR | MADAGASCAR |
| MH | MARSHALL ISLANDS | MARSHALL ISLANDS |
| MK | F.Y.R.O.M. (MACEDONIA) | F.Y.R.O.M. (MACEDONIA) |
| ML | MALI | MALI |
| MM | MYANMAR | MYANMAR |
| MN | MONGOLIA | MONGOLIA |
| MO | MACAU | MACAU |
| MP | NORTHERN MARIANA ISLANDS | NORTHERN MARIANA ISLANDS |
| MQ | MARTINIQUE | MARTINIQUE |
| MR | MAURITANIA | MAURITANIA |
| MS | MONTSERRAT MONTSERRAT | |
| MT | MALTA | MALTA |
| MU | MAURITIUS | MAURITIUS |
| MV | MALDIVES | MALDIVES |
| MW | MALAWI | MALAWI |
| MX | MEXICO | MEXICO |
| MY | MALAYSIA | MALAYSIA |
| MZ | MOZAMBIQUE | MOZAMBIQUE |
| NA | NAMIBIA | NAMIBIA |
| NC | NEW CALEDONIA | NEW CALEDONIA |
| NE | NIGER | NIGER |
| NF | NORFOLK ISLAND | NORFOLK ISLAND |
| NG | NIGERIA | NIGERIA |
| NI | NICARAGUA | NICARAGUA |
| NL | NETHERLANDS | NETHERLANDS |
| NO | NORWAY | NORWAY |
| NP | NEPAL | NEPAL |
| NR | NAURU | NAURU |
| NT | NEUTRAL ZONE | NEUTRAL ZONE |
| NU | NIUE | NIUE |
| NZ | NEW ZEALAND (AOTEAROA) | NEW ZEALAND (AOTEAROA) |
| OM | OMAN | OMAN |
| PA | PANAMA | PANAMA |
| PE | PERU | PERU |
| PF | FRENCH POLYNESIA | FRENCH POLYNESIA |
| PG | PAPUA NEW GUINEA | PAPUA NEW GUINEA |
| PH | PHILIPPINES | PHILIPPINES |
| PK | PAKISTAN | PAKISTAN |
| PL | POLAND | POLAND |
| PM | ST. PIERRE AND MIQUELON | ST. PIERRE AND MIQUELON |
| PN | PITCAIRN | PITCAIRN |
| PR | PUERTO RICO | PUERTO RICO |
| PS | PALESTINIAN TERRITORY, OCCUPIED | PALESTINIAN TERRITORY, OCCUPIED |
| PT | PORTUGAL | PORTUGAL |
| PW | PALAU | PALAU |
| PY | PARAGUAY | PARAGUAY |
| QA | QATAR | QATAR |
| RE | REUNION | REUNION |
| RO | ROMANIA | ROMANIA |
| RS | SERBIA | SERBIA |
| RU | RUSSIAN FEDERATION | RUSSIAN FEDERATION |
| RW | RWANDA | RWANDA |
| SA | SAUDI ARABIA | SAUDI ARABIA |
| SB | SOLOMON ISLANDS | SOLOMON ISLANDS |
| SC | SEYCHELLES | SEYCHELLES |
| SD | SUDAN | SUDAN |
| SE | SWEDEN | SWEDEN |
| SG | SINGAPORE | SINGAPORE |
| SH | ST. HELENA | ST. HELENA |
| SI | SLOVENIA | SLOVENIA |
| SJ | SVALBARD & JAN MAYEN ISLANDS | SVALBARD & JAN MAYEN ISLANDS |
| SK | SLOVAK REPUBLIC | SLOVAK REPUBLIC |
| SL | SIERRA LEONE | SIERRA LEONE |
| SM | SAN MARINO | SAN MARINO |
| SN | SENEGAL | SENEGAL |
| SO | SOMALIA | SOMALIA |
| SR | SURINAME | SURINAME |
| ST | SAO TOME AND PRINCIPE | SAO TOME AND PRINCIPE |
| SU | USSR (FORMER) | USSR (FORMER) |
| SV | EL SALVADOR | EL SALVADOR |
| SY | SYRIA | SYRIA |
| SZ | SWAZILAND | SWAZILAND |
| TC | TURKS AND CAICOS ISLANDS | TURKS AND CAICOS ISLANDS |
| TD | CHAD | CHAD |
| TF | FRENCH SOUTHERN TERRITORIES | FRENCH SOUTHERN TERRITORIES |
| TG | TOGO | TOGO |
| TH | THAILAND | THAILAND |
| TJ | TAJIKISTAN | TAJIKISTAN |
| TK | TOKELAU | TOKELAU |
| TM | TURKMENISTAN | TURKMENISTAN |
| TN | TUNISIA | TUNISIA |
| TO | TONGA | TONGA |
| TP | EAST TIMOR | EAST TIMOR |
| TR | TURKEY | TURKEY |
| TT | TRINIDAD AND TOBAGO | TRINIDAD AND TOBAGO |
| TV | TUVALU | TUVALU |
| TW | TAIWAN | TAIWAN |
| TZ | TANZANIA | TANZANIA |
| UA | UKRAINE | UKRAINE |
| UG | UGANDA | UGANDA |
| UK | UNITED KINGDOM | UNITED KINGDOM |
| UM | US MINOR OUTLYING ISLANDS | US MINOR OUTLYING ISLANDS |
| US | UNITED STATES | UNITED STATES |
| UY | URUGUAY | URUGUAY |
| UZ | UZBEKISTAN | UZBEKISTAN |
| VA | VATICAN CITY STATE (HOLY SEE) | VATICAN CITY STATE (HOLY SEE) |
| VC | SAINT VINCENT & THE GRENADINES | SAINT VINCENT & THE GRENADINES |
| VE | VENEZUELA | VENEZUELA |
| VG | BRITISH VIRGIN ISLANDS | BRITISH VIRGIN ISLANDS |
| VI | VIRGIN ISLANDS (U.S.) | VIRGIN ISLANDS (U.S.) |
| VN | VIET NAM | VIET NAM |
| VU | VANUATU | VANUATU |
| WF | WALLIS AND FUTUNA ISLANDS | WALLIS AND FUTUNA ISLANDS |
| WS | SAMOA | SAMOA |
| YE | YEMEN | YEMEN |
| YT | MAYOTTE | MAYOTTE |
| YU | SERBIA AND MONTENEGRO (FORMER) | SERBIA AND MONTENEGRO (FORMER) |
| ZA | SOUTH AFRICA | SOUTH AFRICA |
| ZM | ZAMBIA | ZAMBIA |
| ZR | (ZAIRE) (See CD CONGO, DEMOCRATIC REPUBLIC) | (ZAIRE) (See CD CONGO, DEMOCRATIC REPUBLIC) |
| ZW | ZIMBABWE | ZIMBABWE |
Packaging Unit Codes
| Code | Code Name | Code Description |
|---|---|---|
| AM | Ampoule | Ampoule |
| BA | Barrel | Barrel |
| BC | Bottlecrate | Bottlecrate |
| BE | Bundle | Bundle |
| BF | Balloon, non- protected | Balloon, non-protected |
| BG | Bag | Bag |
| BJ | Bucket | Bucket |
| BK | Basket | Basket |
| BL | Bale | Bale |
| BQ | Bottle, protected cylindrical | Bottle, protected cylindrical |
| BR | Bar | Bar |
| BV | Bottle, bulbous | Bottle, bulbous |
| BZ | Bag | Bag |
| CA | Can | Can |
| CH | Chest | Chest |
| CJ | Coffin | Coffin |
| CL | Coil | Coil |
| CR | Wooden Box, Wooden Case | Wooden Box, Wooden Case |
| CS | Cassette | Cassette |
| CT | Carton | Carton |
| CTN | Container | Container |
| CY | Cylinder | Cylinder |
| DR | Drum | Drum |
| GT | Extra Countable Item | Extra Countable Item |
| HH | Hand Baggage | Hand Baggage |
| IZ | Ingots | Ingots |
| JR | Jar | Jar |
| JU | Jug | Jug |
| JY | Jerry CAN Cylindrical | Jerry CAN Cylindrical |
| KZ | Canester | Canester |
| LZ | Logs, in bundle/bunch/truss | Logs, in bundle/bunch/truss |
| NT | Net | Net |
| OU | Non-Exterior Packaging Unit | Non-Exterior Packaging Unit |
| PD | Poddon | Poddon |
| PG | Plate | Plate |
| PI | Pipe | Pipe |
| PO | Pilot | Pilot |
| PU | Traypack | Traypack |
| RL | Reel | Reel |
| RO | Roll | Roll |
| RZ | Rods, in bundle/bunch/truss | Rods, in bundle/bunch/truss |
| SK | Skeletoncase | Skeletoncase |
| TY | Tank, cylindrical | Tank, cylindrical |
| VG | Bulk,gas(at 1031 mbar 15 oC) | Bulk,gas(at 1031 mbar 15 oC) |
| VL | Bulk,liquid(at normal temperature/pressure ) | Bulk,liquid(at normal temperature/pressure) |
| VO | Bulk, solid, large particles(nodules) | Bulk, solid, large particles("nodules") |
| VQ | Bulk, gas (liquefied at abnormal temperature/pressure ) | Bulk, gas(liquefied at abnormal temperature/pressure) |
| VR | Bulk, solid, granular particles(grains) | Bulk, solid, granular particles("grains") |
| VT | Extra Bulk Item | Extra Bulk Item |
| VY | Bulk, fine particles(powder) | Bulk, fine particles("powder") |
| ML | Mills | cigarette Mills |
| TN | TAN | 1 TAN refers to 20 bags |
Quantity Unit Codes
| Code | Code Name | Code Description |
|---|---|---|
| 4B | Pair | Pair |
| AV | Cap | Cap |
| BA | Barrel | Barrel |
| BE | bundle | bundle |
| BG | bag | bag |
| BL | block | block |
| BLL | BLL Barrel | BLL Barrel (petroleum) (158,987 dm3) |
| BX | box | box |
| CA | Can | Can |
| CEL | Cell | Cell |
| CMT | centimetre | centimetre |
| CR | CARAT | CARAT |
| DR | Drum | Drum |
| DZ | Dozen | Dozen |
| GLL | Gallon | Gallon |
| GRM | Gram | Gram |
| GRO | Gross | Gross |
| KG | Kilo-Gramme | Kilo-Gramme |
| KTM | kilometre | kilometre |
| KWT | kilowatt | kilowatt |
| L | Litre | Litre |
| LBR | pound | pound |
| LK | link | link |
| LTR | Litre | Litre |
| M | Metre | Metre |
| M2 | Square Metre | Square Metre |
| M3 | Cubic Metre | Cubic Metre |
| MGM | milligram | milligram |
| MTR | metre | metre |
| MWT | megawatt hour (1000 kW.h) | megawatt hour (1000 kW.h) |
| NO | Number | Number |
| NX | part per thousand | part per thousand |
| PA | packet | packet |
| PG | plate | plate |
| PR | pair | pair |
| RL | reel | reel |
| RO | roll | roll |
| SET | set | set |
| ST | sheet | sheet |
| TNE | tonne (metric ton) | tonne (metric ton) |
| TU | tube | tube |
| U | Pieces/item [Number] | Pieces/item [Number] |
| YRD | yard | yard |
Taxation Type Codes
| TAX TYPE CODE | TAX CATEGORY CODE | TAX CATEGORY NAME | TAX RATE |
| VAT | A | Standard Rated | 16% |
| B | Minimum Taxable Value (MTV) | MTV | |
| C1 | Exports | 0% | |
| C2 | Zero-rating Local Purchases Order transactions | 0% | |
| C3 | Zero-rated by nature | 0% | |
| D | Exempt | No tax charge | |
| RVAT | Reverse VAT | 16% | |
| E | Disbursement | No tax charge | |
| IPL | IPL-1 | Insurance Premium Levy | 5% |
| IPL-2 | Re-insurance | Exempt | |
| TL | TL | Tourism Levy | 1.50% |
| F | 10% Statutory Service Charge | No tax charge | |
| LED | ECM | Excise on Coal | 5% |
| EXEEG | Excise Electricity | 3% | |
| TOT | TOT | Turnover Tax | N/A |
| GTX | GTX | Gaming and Betting | N/A |
| ITX | ITX | Income Tax | N/A |
| RTX | RTX | Rental Tax | N/A |
Tax Category Combinations
Based on how ZRA has structured their API, certain tax combinations are designed to work together. Below is a breakdown of each tax combination we currently support
Tax Category | Combined with |
|---|---|
VAT - A, B, C1, C2, C3 and D | Works with all tax categories |
Tourism Levy (TL) | Any VAT Category |
LED ( ECM and EXEEG) Excise on Coal and Electricity | Any VAT Category |
Insurance Premium Levy (IPL-1 and IPL-2) | Exempt (D) and Zero Rated (C3) |
Turn Over Tax (TOT) | Exempt (D) |
Updated 7 months ago
