Codelayer API Documentation

  • Introduction

    • General Information
  • API Reference

    • Fetch

      • Account Group
      • Account Heads
      • Firm Details
      • Purchase
      • Sales Invoice
      • Stock Item
      • UOM
      • Vouchers
    • Purchase

      • Purchase Invoice
    • Sales

      • Invoice
      • StockItem
      • UOM
    • System

      • Authentication
    • Accounts

      • Account Group
      • Account Heads
      • Firm Details
      • Vouchers
    • Response Codes
Codelayer API Documentation
Stock Item

Item List

URL

fetch/stockitem

Method

POST

Request Media type

application/json

Response Media type

application/json

Request Parameters
Parameter Data Type Min Max M/O Sample Value Comments
key String 32 32 M EKqRtWAsI1wMkEjQijN9RDP4UrGQZB9F Key obtained from authentiaction.
clientid String M CTPL Client ID

 

Response Values
Name Data Type Min Length Max Length M/O Sample Value Comments
stockitem Array M Item List
itemname String M Item Name Item Name
itemcode Integer M 1 Item Code
tfirmid Integer M 1 Firm ID
clientid String M CTPL Client ID
tuom String M kg Unit Of Measurement
stdrate Decimal M 0.0 Standard Rate
gsttypeofsupply String M Goods Type of Supply - Goods or Service
applicablefrom String M 2020-7-20 Applicable From
hsncode String M 789456 HSN Code
hsndescription String M HSN Description HSN Description
isnongstgoods String M No Is Non GST Goods - Yes/ No
taxability String M Taxable Nill Rated,Exempt,Taxable
gstrate Decimal M 0.00 GST Rate

 

Sample Request
{
    "key": "QH7LlQ3wQMK9oYEKjeG5QOIVJQT4emeq",
    "clientid": "CTPL"
}
Sample Success Response
{
    "stockitem": [
        {
            "itemname": "Item Name",
            "itemcode": "1",
            "tfirmid": "1",
            "clientid": "CTPL",
            "tuom": "kg",
            "stdrate": "0.0",
            "gsttypeofsupply": "Goods",
            "applicablefrom": "2020-7-20",
            "hsncode": "789456",
            "hsndescription": "HSN Description",
            "isnongstgoods": "No",
            "taxability": "Taxable",
            "gstrate": "0.00"
        }
    ],
    "e": 200,
    "msg": "Success"
}