Update an Item

PUT/api/v1/items/{itemCd}

Update an existing item registered with Kenya Revenue Authority eTIMS. Kenya Revenue Authority uses upsert semantics, re-submitting an item with the same itemCd updates it in place. Use this to change price, description, or active status.

Requires x-api-key

http://localhost:8100/api/v1/items/{itemCd}

Path Parameters

FieldTypeRequiredDescription
itemCdstringRequiredThe Kenya Revenue Authority item code to update (e.g. SV0000000Z001). Must match an item already registered with Kenya Revenue Authority.

Request Body

FieldTypeRequiredDescription
itemClsCdstringRequired10-character Kenya Revenue Authority classification code.
itemTyCdstringRequiredItem type: 1=Raw, 2=Finished, 3=Service.
itemNmstringRequiredItem name (max 200 chars).
orgnNatCdstringRequired2-letter origin country code (e.g. KE).
pkgUnitCdstringRequiredPackaging unit code.
qtyUnitCdstringRequiredQuantity unit code.
taxTyCdstringRequiredTax type: A=Exempt, B=16% VAT, C=0%, D=Non-VAT, E=Tourism levy.
dftPrcnumberRequiredDefault price.
isrcAplcbYnstringRequiredInsurance applicable: Y or N.
useYnstringOptionalActive status: Y=Active, N=Inactive. Defaults to 'Y'.
regrIdstringRequiredRegistering user ID.
regrNmstringRequiredRegistering user name.
modrIdstringRequiredModifying user ID.
modrNmstringRequiredModifying user name.

Request

{
  "itemClsCd": "5020230000",
  "itemTyCd": "3",
  "itemNm": "Monthly SaaS Subscription - Updated",
  "orgnNatCd": "KE",
  "pkgUnitCd": "NT",
  "qtyUnitCd": "U",
  "taxTyCd": "B",
  "dftPrc": 6000,
  "isrcAplcbYn": "N",
  "useYn": "Y",
  "regrId": "USR01",
  "regrNm": "Admin",
  "modrId": "USR01",
  "modrNm": "Admin"
}

Response

{
  "success": true,
  "message": "Item updated in Kenya Revenue Authority eTIMS.",
  "data": {
    "itemCd": "SV0000000Z001",
    "updated": true
  }
}
curl -X PUT http://localhost:8100/api/v1/items/SV0000000Z001 \\
  -H "x-api-key: YOUR_API_KEY" \\
  -H "Content-Type: application/json" \\
  -d '{
    "itemClsCd": "5020230000",
    "itemTyCd": "3",
    "itemNm": "Monthly SaaS Subscription - Updated",
    "orgnNatCd": "KE",
    "pkgUnitCd": "NT",
    "qtyUnitCd": "U",
    "taxTyCd": "B",
    "dftPrc": 6000,
    "isrcAplcbYn": "N",
    "regrId": "USR01",
    "regrNm": "Admin",
    "modrId": "USR01",
    "modrNm": "Admin"
  }'