Create Item Purchase Order

This API is used to create a new purchase order of item type in the system. In create Invoice details order type must be set 2 to create item type purchase order. It allows you to submit the relevant details for a new purchase order, such as the supplier, items, quantities, and other necessary information.

Request

The request is a POST method, and the body must include the details of the purchase order.

Response

The response will include the details of the newly created purchase order, including the unique order number, transaction type, item details, and other details.

Request

Authorization

Add parameter in header

ApiKey

Example:

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

Body Params application/json

title

integer

required

Defines the title ID assigned to purchase order, which is configured in the settings.

order_number

string

required

The unique purchase order number is system-generated and assigned to each order and Typically fetched from the Next Invoice Number API.

order_date

string

required

The order date represents the date on which an order is issued, and the date is set within the applicable financial year.

party_ledger_id

integer

required

The unique ID of the supplier from whom the purchase was originally made.you get it from Ledger List API.

billing_address

object

required

The registered address of the supplier, including street details, country, state, city, and pin code.

country_id

integer

required

Unique identifiers representing the supplier’s country. it get from Country API.

state_id

integer

required

Unique identifiers representing the supplier’s state. it get from State API.

address_1

string

optional

Supplier's business address, split into two fields for completeness.

address_2

string

optional

Supplier's business address, split into two fields for completeness.

city_id

integer

optional

Unique identifiers representing the supplier’s city. it get from City API.

pin_code

string

optional

The postal code for the billing address.

items

array [object {15}]

required

item_id

integer

required

Unique identifier for the returned item. you get it from Item List.

ledger_id

integer

required

Ledger reference associated with the item.

unit_id

integer

required

This field holds the identifier for the unit of measurement used for the item, such as pieces etc.

quantity

number

required

The number of units being ordered.

rpu

number

required

Represents the Rate Per Unit of the item, the selling price for each unit before taxes and discounts.

with_tax

integer

required

This indicates whether the price is inclusive of tax. A value of 0 means the price is exclusive of tax.

discount_type

integer

required

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

gst_id

integer

required

This field represents the GST tax rate for the item and is required if your company is GST applicable. It should be retrieved from Gst Rates API.

total

number

required

This is the final total for the item after all calculations, including discounts.

additional_description

string | null

optional

Additional details or remarks about the item.

mrp

number

optional

Refers to the Maximum Retail Price of the item.

discount_value

number

optional

Represents the discount amount applied to the item.

discount_type_2

integer

optional

Similar to discount_type applicable on the second discount amount.

discount_value_2

number

optional

Represents the second discount amount applied.

cess

number

optional

Represents the cess (additional tax) applied to the item.

order_type

integer

required

Indicates the type of invoice here is must 2, such as item invoice (2) and accounting invoice (1). This field is nullable. If no specific type is provided, the system will automatically assign the item invoice (2) type by default.

gross_value

number

required

Represents the total value of the transaction before applying any discounts, taxes, or additional charges.

taxable_value

number

required

The total value of the invoice, after applying discounts and additional charges but before adding any taxes.

main_classification_nature_type

string

required

pecifies whether the transaction is an interstate or intrastate taxable purchase return. you get it from Classification-nature-type.

is_rcm_applicable

boolean

required

Specifies whether Reverse Charge Mechanism (RCM) is applicable (1 = Yes, 0 = No).

cgst

number

required

These fields represent the Central GST

sgst

number

required

These fields represent the State GST

igst

number

required

These fields represent the Integrated GST

cess

number

required

Represents the cess (additional tax) applied to the transaction.

grand_total

number

required

The final amount of the invoice, which includes all items, taxes, additional charges, and rounding adjustments.

is_gst_enabled

boolean

required

Indicates whether GST is enabled for the transaction.

is_cgst_sgst_igst_calculated

boolean

required

Indicates whether CGST, SGST, or IGST has been calculated.

is_gst_na

boolean

required

Indicates if GST is not applicable to the transaction.

is_round_off_not_changed

boolean

required

check if adjustments are made to the rounding of the invoice total.

valid_for

integer

optional

This field specifies the validity period of the order, indicating how long it valid for acceptance. The value can be in number of days or months.

valid_for_type

integer

optional

This field specifies the type of order validity, where 1 represents months and 2 represents days.

gstin

string | null

optional

The GSTIN (Goods and Services Tax Identification Number) is a unique number assigned to the customer for claim tax credits.

shipping_address

object

optional

The location where the returned goods are being shipped, which may differ or same from the billing address.

country_id

integer

required

Reference ID for the country. it get from Country API.

state_id

integer

required

Reference ID for the state of the selected country. it get from State API.

shipping_name

string

optional

Define the shipping supplier's name.

address_1

string

optional

Primary address line (e.g., office or building name).

address_2

string

optional

Secondary address line, often for road or area name.

city_id

integer

optional

Reference ID for the city of the selected state. it get from City API.

pin_code

integer

optional

Postal code of the address.

shipping_gstin

string

optional

Define the shipping supplier's GSTIN number.

broker_details

object

optional

Contains broker information, including broker_id, brokerage percentage, and how it is calculated on value.

broker_id

integer

optional

The broker id is the unique identifier assigned to the broker involved in the transaction or deal. it get from List of Broker API.

brokerage_for_sale

number

optional

The brokerage value is the percentage fee that the broker receives for facilitating the deal.

brokerage_on_value_type

integer

optional

This field determines the basis on which the brokerage fee is calculated such as invoice value (1) and taxable value (2).

transport_details

object

optional

transport_id

integer

required

The broker id is the unique identifier assigned to the broker involved in the transaction or deal. it get from List of Broker API.

transporter_document_number

integer

required

Refers to the document number issued by the transporter, such as a bill.

transporter_document_date

string

required

This is the date when the transporter's document was issued.

narration

string | null

optional

An optional narrative field for providing additional notes or descriptions related to the transaction

additional_charges

array [object {5}]

optional

This section lists any extra charges that are added to the invoice, such as shipping .

ac_ledger_id

integer

required

This field represents the unique identifier for the ledger account that records the additional charge.

ac_type

integer

required

Indicates the type of charge being applied (2 = Percentage, 1 = Fixed amount).

ac_value

number

required

Represents the value or amount of the additional charge.

ac_total_without_tax

number

required

This indicates the total amount of the additional charge.

ac_gst_rate_id

integer

optional

This field specifies the GST tax rate applied to the additional charge. get it from Gst Rates API.

add_less

array [object {4}]

optional

Contains adjustments that either increase (add) or decrease (less) the total transaction amount.

al_ledger_id

integer

required

This is the unique identifier for the ledger account associated with the add or less charge.

al_is_show_in_print

boolean

required

This field determines whether the charge should be displayed in the printed invoice.

al_type

integer

required

Indicates the type of charge being applied (2 = Percentage, 1 = Fixed amount).

al_value

number

required

Represents the value or amount of the add or less charge.

rounding_amount

number | null

optional

The rounding adjustment to make the total amount a round figure. This is usually done for simplifying invoice totals.

Example

{
    "title": 1,
    "order_number": "4",
    "order_date": "12-02-2025",
    "party_ledger_id": 2702,
    "valid_for": 10,
    "valid_for_type": 1,
    "gstin": "37AAGAA2385M1ZE",
    "billing_address": {
        "address_1": "2121, 3RD FLOOR, RADHA RAMAN TEXTILE MARKET",
        "address_2": "KADODARA ROAD",
        "country_id": 101,
        "state_id": 4030,
        "city_id": 134096,
        "pin_code": "395008"
    },
    "shipping_address": {
        "shipping_name": null,
        "address_1": "2121, 3RD FLOOR, RADHA RAMAN TEXTILE MARKET",
        "address_2": "KADODARA ROAD",
        "country_id": 101,
        "state_id": 4030,
        "city_id": 134096,
        "pin_code": "395008"
    },
    "broker_details": {
        "broker_id": null,
        "brokerage_for_sale": null,
        "brokerage_on_value_type": null
    },
    "transport_details": {
        "transport_id": null,
        "transporter_document_number": null,
        "transporter_document_date": null
    },
    "order_type": 2,
    "items": [
        {
            "item_id": 93,
            "additional_description": "test",
            "ledger_id": 848,
            "unit_id": 29,
            "quantity": 1,
            "mrp": null,
            "rpu": 100,
            "with_tax": 0,
            "discount_type": 1,
            "discount_value": null,
            "discount_type_2": 1,
            "discount_value_2": null,
            "gst_id": 10,
            "cess": 0,
            "total": 100
        }
    ],
    "gross_value": 100,
    "narration": "Hello World",
    "additional_charges": [
        {
            "ac_ledger_id": 79971,
            "ac_type": 1,
            "ac_value": 100,
            "ac_total": 100
        }
    ],
    "taxable_value": 100,
    "add_less": [
        {
            "al_ledger_id": 7655,
            "al_is_show_in_print": 0,
            "al_type": 1,
            "al_value": 100
        }
    ],
    "main_classification_nature_type": "Interstate Purchase Taxable",
    "is_rcm_applicable": 0,
    "cgst": 0,
    "sgst": 0,
    "igst": 0,
    "cess": 0,
    "rounding_amount": null,
    "grand_total": 100,
    "is_gst_enabled": 0,
    "is_cgst_sgst_igst_calculated": 0,
    "is_gst_na": 1,
    "is_round_off_not_changed": false
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://app.hisabkitab.co/third-party/purchase-order-transactions' \
--header 'Content-Type: application/json' \
--header 'ApiKey;' \
--data-raw '{
    "title": 1,
    "order_number": "4",
    "order_date": "12-02-2025",
    "party_ledger_id": 2702,
    "valid_for": 10,
    "valid_for_type": 1,
    "gstin": "37AAGAA2385M1ZE",
    "billing_address": {
        "address_1": "2121, 3RD FLOOR, RADHA RAMAN TEXTILE MARKET",
        "address_2": "KADODARA ROAD",
        "country_id": 101,
        "state_id": 4030,
        "city_id": 134096,
        "pin_code": "395008"
    },
    "shipping_address": {
        "shipping_name": null,
        "address_1": "2121, 3RD FLOOR, RADHA RAMAN TEXTILE MARKET",
        "address_2": "KADODARA ROAD",
        "country_id": 101,
        "state_id": 4030,
        "city_id": 134096,
        "pin_code": "395008"
    },
    "broker_details": {
        "broker_id": null,
        "brokerage_for_sale": null,
        "brokerage_on_value_type": null
    },
    "transport_details": {
        "transport_id": null,
        "transporter_document_number": null,
        "transporter_document_date": null
    },
    "order_type": 2,
    "items": [
        {
            "item_id": 93,
            "additional_description": "test",
            "ledger_id": 848,
            "unit_id": 29,
            "quantity": 1,
            "mrp": null,
            "rpu": 100,
            "with_tax": 0,
            "discount_type": 1,
            "discount_value": null,
            "discount_type_2": 1,
            "discount_value_2": null,
            "gst_id": 10,
            "cess": 0,
            "total": 100
        }
    ],
    "gross_value": 100,
    "narration": "Hello World",
    "additional_charges": [
        {
            "ac_ledger_id": 79971,
            "ac_type": 1,
            "ac_value": 100,
            "ac_total": 100
        }
    ],
    "taxable_value": 100,
    "add_less": [
        {
            "al_ledger_id": 7655,
            "al_is_show_in_print": 0,
            "al_type": 1,
            "al_value": 100
        }
    ],
    "main_classification_nature_type": "Interstate Purchase Taxable",
    "is_rcm_applicable": 0,
    "cgst": 0,
    "sgst": 0,
    "igst": 0,
    "cess": 0,
    "rounding_amount": null,
    "grand_total": 100,
    "is_gst_enabled": 0,
    "is_cgst_sgst_igst_calculated": 0,
    "is_gst_na": 1,
    "is_round_off_not_changed": false
}'

Responses

🟢200Create Item Purchase Order

application/json

Body

data

object

required

purchase_order_transaction

object

required

transaction_id

integer

required

A unique identifier is assigned to the purchase order transaction.

success

boolean

required

message

string

required

Example

{
    "data": {
        "purchase_order_transaction": {
            "id": 1,
            "company_id": 6,
            "title": 1,
            "order_number": "4",
            "full_order_number": "4",
            "order_date": "2025-02-11T18:30:00.000000Z",
            "valid_for": 10,
            "valid_for_type": 1,
            "valid_till_date": "2025-12-11T18:30:00.000000Z",
            "party_ledger_id": 6,
            "gstin": null,
            "broker_id": null,
            "brokerage": null,
            "brokerage_on_value_type": null,
            "shipping_name": null,
            "shipping_gstin": null,
            "transport_id": null,
            "transporter_document_number": null,
            "transporter_document_date": null,
            "transporter_vehicle_number": null,
            "order_type": 2,
            "cgst": 0,
            "sgst": 0,
            "igst": 0,
            "cess": 0,
            "round_off_amount": null,
            "total": 100,
            "grand_total": 100,
            "taxable_value": 100,
            "gross_value": 100,
            "narration": "Hello World",
            "is_gst_enabled": 0,
            "status": "Open",
            "is_cgst_sgst_igst_calculated": 0,
            "is_gst_na": 1,
            "is_round_off_not_changed": false,
            "transaction_items": [
                {
                    "id": 2,
                    "transactions_id": 1,
                    "item_id": 5,
                    "ledger_id": 3,
                    "additional_description": "test",
                    "unit_id": 1,
                    "quantity": 1,
                    "with_tax": false,
                    "rpu_with_gst": null,
                    "rpu_without_gst": 100,
                    "discount_type": 1,
                    "discount_value": null,
                    "discount_type_2": 1,
                    "discount_value_2": null,
                    "total_discount_amount": 0,
                    "gst_id": 10,
                    "gst_tax_percentage": 18,
                    "total": 100,
                    "cess_rate": 0,
                    "cess_amount": 0,
                    "classification_igst_tax": null,
                    "classification_cgst_tax": null,
                    "classification_sgst_tax": null,
                    "classification_cess_tax": null,
                    "classification_is_rcm_applicable": 0,
                    "classification_nature_type": null,
                    "consolidating_items_to_invoice": "0",
                    "taxable_value": 100,
                    "created_at": "2025-02-12T12:40:55.000000Z",
                    "updated_at": "2025-02-12T12:40:55.000000Z"
                }
            ],
            "via_api": false,
            "created_by": 8,
            "created_at": "2025-02-12T12:40:55.000000Z",
            "updated_at": "2025-02-12T12:40:55.000000Z"
        },
        "transaction_id": 1
    },
    "success": true,
    "message": "Purchase Order Transaction Created Successfully."
}

Create Item Purchase Order

Request#

Response#

Request

Request samples

Responses

Request

Response