Skip to main content
PUT
Update an item

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is an API key from the API Integration section of your dashboard. Keys are scoped to the company they are generated in — for testing, add a separate test company and generate the key there, so requests never touch your real books.

Body

application/json
id
string
required

Unique id for each item.

Example:

"ITEM123"

name
string
required

Name of the Product

Example:

"Item Name"

quantity
number
required

Opening Quantity

Example:

1

unit_price
number
required

Price per item without Tax

Example:

100

price_with_tax
number
required

Price per item with Tax

Example:

118

item_type
string
required

Product or Service enum

Example:

"Product"

tax_rate
number

Tax percentage for each item . Only valid tax rates are accepted

Example:

18

discount_percent
number
default:0

Default Discount Percent

Example:

10

description
string

Item Description

Example:

"Item Description"

hsn_code
string

HSN Code

Example:

"1234"

unit
string

Item quantity unit. You can find the GST-approved units in the UQC Codes section at: https://einvoice1.gst.gov.in/Others/MasterCodes.

Example:

"kg"

category
string

Category

Example:

"Electronics"

status
string

Status of the Item

Example:

"Active"

Response

Success

success
boolean

Success flag

Example:

true

message
string

Response message

Example:

"Product added successfully"