Create Service Item

This endpoint makes an HTTP POST request to add a new Service type item to the system. It allows users to create a new service entry by providing essential details.

Request

The request body must be sent service type item details to create the item.

Response

Upon successful creation, the API will return a response confirming the item's addition along with its item detail.

Request

Authorization

Add parameter in header

ApiKey

Example:

ApiKey: ********************

Body Params application/json

create an item or service

item_name

string

required

The unique name of the item or service, used for identification.

group_id

integer

required

The group id represents the category under which an item or service falls and it must exist in item groups. It should be retrieved from the Item Form Details API.

item_type

integer

required

This field must contain value 1(service type). There are two item types used: 1 for Goods and 2 for Services.

Default:

primary_unit_of_measurement

integer

required

The main unit (id) in which the item is measured (e.g., "Pieces" or "Kg"). It should be retrieved from the Item Form Details API.

secondary_unit_of_measurement

integer

optional

An optional secondary unit (id) can be specified if dual units are used (e.g., "Gram"). It should be retrieved from the Item Form Details API. Ensure that the primary and secondary units are not the same.

conversion_rate

number <double>

optional

Defines the conversion factor between the primary and secondary units (e.g., 1 Kg = 1000 Grams) and it require when secondary unit used.

sale_price_type

integer

required

Specifies whether the sale price is inclusive (1) or exclusive (2) of GST.

Default:

sale_price

number <double> | null

optional

The price at which the item is sold in income transactions, which may or may not include GST.

discount_type

integer

required

Type of discount applied to the sale price (1 = Percentage, 2 = Fixed amount).

Default:

discount

number | null

optional

The actual discount value is applied according to the discount type.

income_ledger_id

integer | null

optional

The ledger account where sales income is recorded. It should be retrieved from the Item Form Details API.

purchase_price_type

integer

required

Defines whether the purchase price is inclusive (1) or exclusive (2) of GST.

Default:

purchase_price

number <double>

optional

The price at which the item is sold in expense transactions, which may or may not include GST.

purchase_discount_type

integer

required

Specifies the discount type on purchase (1 = Percentage, 2 = Fixed amount).

Default:

purchase_discount_value

number

optional

Discount value applied on purchase according to the purchase discount type.

expense_ledger_id

integer

optional

The ledger account where expenses related to this item are recorded. It should be retrieved from the Item Form Details API..

is_description_same_as_item_name

boolean

required

If set to 1, the system automatically copies the item name as the description. If set to 0, a custom description must be provided.

Default:

false

description

string | null

optional

A detailed description of the item provides additional clarity.

decimal_places

integer

optional

The number of decimal places allowed for quantity values (e.g., 2 means values like 10.25).

is_gst_applicable

boolean

required

Specifies if the item is taxable under GST (1 = Yes, 0 = No).

Default:

false

gst_tax_id

integer

optional

The GST tax ID links the item to a predefined tax rate, and it is required if gst applicable true (e.g., 8%, 12%). It should be retrieved from the Item Form Details API.

hsn_sac_code

string | null

optional

The Harmonized System of Nomenclature (HSN) or Service Accounting Code (SAC) for GST classification (e.g., 1001).

gst_cess_rate

integer | null

optional

The GST cess (additional tax) rate applicable on the item in percentage if item is taxable under GST. It should be retrieved from the Item Form Details API.

is_rcm_applicable

boolean

required

Indicates if Reverse Charge Mechanism (RCM) applies (0 = No, 1 = Yes), meaning the buyer must pay GST instead of the seller.

Default:

false

decimal_places_for_rate

integer

optional

Defines how many decimal places are allowed for pricing calculations (e.g., 3 means values like 10.256)

quantity_unit

integer | null

optional

Defines the unit (id) in which the opening stock quantity is measured.It should be retrieved from the unitOfMeasurement Item Form Details API..

quantity

number <double> | null

optional

Represents the initial stock quantity available at the time of recording. If null, it means no predefined opening stock is set.

rate

number <double> | null

optional

The cost amount per unit of the item at the time of opening balance entry.

opening_balance_type

integer

optional

Determines whether the opening balance is inclusive (1) or exclusive (2) of GST.

Default:

Example

{
    "item_name": "Set Service item",
    "group_id": "5",
    "item_type": "2",
    "primary_unit_of_measurement": "29",
    "secondary_unit_of_measurement": null,
    "conversion_rate": null,
    "decimal_places": "2",    
    "description": null,
    "is_description_same_as_item_name": 1,
    "is_gst_applicable": "1",
    "gst_tax_id": "10",
    "hsn_sac_code": "1001",
    "is_rcm_applicable": "0",
    "gst_cess_rate": 136,    
    "sale_price": 100,
    "sale_price_type": 2, // 1 = with GST, 2 = without GST
    "discount_type": 1,
    "discount": 0,
    "income_ledger_id": 1196,
    "purchase_price": null,
    "purchase_price_type": 2, // 1 = with GST, 2 = without GST
    "purchase_discount_type": 1,
    "purchase_discount_value": 0,
    "expense_ledger_id": 1197,
    "decimal_places_for_rate": 3,
    "quantity_unit": "6",
    "quantity": null,
    "rate": null,
    "opening_balance_type": 2
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Create Item

application/json

Body

data

object

required

integer

required

This is the unique identifier for the product or service.

item_name

string

required

The unique name of the item or service, used for identification.

group_id

string

required

The group id represents the category under which an item or service falls and it must exist in item groups.

item_type

string

required

There are two item types used: 1 for Goods and 2 for Services.

item_type_name

string

required

There is a name of item types used: Goods and Services.

company_id

integer

required

Represents the unique identifier of the company to which the item belongs.

sku

string

required

Stock Keeping Unit (SKU) is a unique code assigned to track inventory.

units_of_array

array [object {9}]

required

Contains information about the measurement unit used for the item.

model

object

required

item_image

string

required

These fields allow you to upload an image of the item

media

array[string]

required

These fields allow you to upload an image of the item

via_api

boolean

required

is_import

boolean

required

created_at

string

required

The date and time indicating when the record was initially created in the system.

updated_at

string

required

The date and time indicating when the record was last modified or updated in the system.

success

boolean

required

message

string

required

Example

{
    "data": {
        "id": 3,
        "item_name": "Set Service item",
        "group_id": "5",
        "item_type": "1",
        "model_type": "App\\Models\\Master\\ItemMasterService",
        "company_id": 6,
        "sku": null,
        "units_of_array": [
            {
                "id": 1,
                "name": "PIECES",
                "code": "PCS",
                "full_name": "PCS-PIECES",
                "is_default": true,
                "for_gst_use_name": null,
                "company_id": null,
                "created_at": "2023-02-10T04:22:56.000000Z",
                "updated_at": "2023-02-10T04:22:56.000000Z"
            }
        ],
        "model": {
            "id": 1,
            "unit_of_measurement": 1,
            "alternate_unit": null,
            "secondary_unit_of_measurement": null,
            "decimal_places": 2,
            "sale_price_type": 2,
            "selling_price_with_gst": 118,
            "selling_price_without_gst": 100,
            "purchase_price_type": 2,
            "purchase_price_with_gst": null,
            "purchase_price_without_gst": null,
            "decimal_places_for_rate": 3,
            "conversion_rate": null,
            "is_gst_applicable": true,
            "hsn_sac_code": "1001",
            "description": "Set SER1",
            "is_description_same_as_item_name": true,
            "is_rcm_applicable": false,
            "gst_tax_id": 1,
            "gst_cess_rate": 136,
            "income_ledger_id": 1196,
            "expense_ledger_id": 1197,
            "quantity_unit": 6,
            "quantity": null,
            "rate": null,
            "mrp": 100,
            "purchase_discount_type": 1,
            "discount_type": 1,
            "purchase_discount_value": null,
            "discount_value": null,
            "opening_balance": null,
            "method_of_stock_valuation": null,
            "conversion_of_unit": null,
            "gst_tax_rate": 18,
            "cess_rate": null,
            "gst_tax": {
                "id": 1,
                "name": "18%",
                "tax_rate": 18,
                "company_id": null,
                "created_at": "2023-02-10T04:22:55.000000Z",
                "updated_at": "2023-02-10T04:22:55.000000Z"
            },
            "gst_gst_cess_rate": null,
            "via_api": 0,
            "created_at": "2025-02-11T09:56:20.000000Z",
            "updated_at": "2025-02-11T09:56:20.000000Z"
        },
        "via_api": false,
        "is_import": false,
        "media": [],
        "item_image": "",
        "created_at": "2025-01-28T10:13:24.000000Z",
        "updated_at": "2025-01-28T10:13:24.000000Z"
    },
    "success": true,
    "message": "Item Master Created Successfully."
}

Request#

Response#

Request

Request samples

Responses

Request

Response