DIdigitax
Items

Create an item

Create an item

post/items

Request

  • Base URL
    https://api.digitax.tech/ke/v2
  • Auth
    API key in header X-API-Key

Request body

item_class_codestring required

The item class code of the item. <br>Refer to the DigiTax Kenya eTIMS Item Classification Code list for more information.

item_type_codestring required

The item type code of the item. <br>Refer to the DigiTax Kenya eTIMS Item Type code list for more information.

item_namestring required

The name of the item.

origin_nation_codestring required

The country of origin code of the item. <br>Refer to the DigiTax Kenya eTIMS Country Codes list for more information.

package_unit_codestring required

The package unit code of the item. <br>Refer to the DigiTax Kenya eTIMS Package Unit Codes list for more information.

quantity_unit_codestring required

The quantity unit code of the item. <br>Refer to the DigiTax Kenya eTIMS Quantity Unit Codes list for more information.

tax_type_codestring required

The tax type code of the item. <br>Refer to the DigiTax Kenya eTIMS Tax Type Codes list for more information.

default_unit_pricenumber required

The default unit price of the item.

stock_quantitynumber

The starting stock quantity of the item.

callback_urlstring

Optional URL where DigiTax sends an HTTP POST callback with event item.sync when the item is successfully synced to eTIMS. See Callback URLs for the payload.

item_bar_codestring

The bar code of the item. <br>EAN-13 barcodes are recommended, but not required. <br>Ideally set your internal item ID here. It comes in handy during reconciliation when you are comparing data reports between DigiTax and your system.

leviesstring[]

The levy codes to apply to the item, e.g. CTL for the 2% Catering Levy. Unrecognised codes are rejected.

Example request

{
  "item_class_code": "99020000",
  "item_type_code": "3",
  "item_name": "DigiTax Product 01",
  "origin_nation_code": "KE",
  "package_unit_code": "NT",
  "quantity_unit_code": "U",
  "tax_type_code": "D",
  "default_unit_price": 1000,
  "stock_quantity": 100,
  "callback_url": "https://example.site/services/digitaxQueueReceiverPROXY",
  "item_bar_code": "7994391127606",
  "levies": [
    "CTL"
  ]
}

Response

Success

idstring required

The DigiTax ID of the item.

item_class_codestring required

The item class code of the item. <br>Refer to the DigiTax Kenya eTIMS Item Classification Code list for more information.

item_type_codestring required

The item type code of the item.

item_namestring required

The name of the item.

origin_nation_codestring required

The country of origin code of the item.

package_unit_codestring required

The package unit code of the item.

quantity_unit_codestring required

The quantity unit code of the item.

tax_type_codestring required

The tax type code of the item.

default_unit_pricenumber required

The default price of the item.

etims_item_codestring required

The eTIMS item code of the item.

is_stock_itemboolean required

Indicates whether the item is stockable, meaning its quantity can be tracked as inventory. Physical goods are stockable; services are not.

stock_quantitynumber required

The quantity of items in stock.

activeboolean required

Indicates whether the item is active or not

status'PENDING' | 'FAILED' | 'COMPLETE'

sync status against eTIMS

item_bar_codestring

The bar code or unique product code(UPC) of the item

leviesstring[]

Levy codes applied to the item.

Example response

{
  "id": "item_01HC3J1VVVM05YCTS61G7V3KC6",
  "item_name": "DigiTax Product 01",
  "origin_nation_code": "KE",
  "package_unit_code": "NT",
  "quantity_unit_code": "U",
  "tax_type_code": "D",
  "default_unit_price": 1000,
  "etims_item_code": "DT-67717-E7GcGbvYDy",
  "is_stock_item": true,
  "stock_quantity": 1000,
  "active": true,
  "status": "COMPLETE",
  "item_bar_code": "012345678905"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.