Duplicate purchase Order

This API allows users to retrieve the details of an existing purchase order to facilitate duplication. By providing the order ID in the request URL, users can fetch all relevant details of a specific purchase order. This information can then be used to create a new purchase order with similar data.

Request

The API uses a GET request to retrieve the details of an existing purchase order for duplication. The request does not require a body.

Response

The response will contain the details of the specified purchase order, including party details, item lists, total invoice amount, and order status. This data can be used to create a new purchase order with modifications if necessary.

Responses

🟢200Duplicate purchase Order

application/json

Body

data

object

required

integer

required

A unique identifier is assigned to the purchase order transaction.

company_id

integer

required

The ID of the company making the order, helping to associate transactions with specific business entities.

title

integer

required

Defines the title ID assigned to the 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 Endpoint.

full_order_number

string

required

The complete formatted order number, which may include prefixes or suffixes (e.g., "PO-1").

order_type

integer

required

Indicates the type of order such as item invoice (2) and accounting invoice (1).

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.

valid_for

integer

required

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

required

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

valid_till_date

string

required

The final date until the purchase order is valid.

party_ledger_id

integer

required

Represents the unique identifier of the customer for whom the invoice is being created, linking the invoice to the relevant business entity.

gstin

string

required

The GST identification number of the supplier, ensuring compliance with tax regulations.

broker_id

integer

required

The ID of the broker involved in the transaction, if any.

brokerage

number

required

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

brokerage_on_value_type

integer

required

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

transport_id

integer

required

Represents the unique identifier for the transport service provider that is responsible for delivering the goods.

transporter_document_number

string

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.

transporter_vehicle_number

string

required

Represents the vehicle number used for transporting the goods.

shipping_name

string

required

Define the shipping supplier's name.

shipping_gstin

string

required

Define the shipping supplier's gstin number.

shipping_freight

number

required

This field represents the cost of shipping or freight for transporting the goods.

shipping_freight_with_gst

number

required

This field represents the shipping freight charges, including GST.

shipping_freight_cgst_amount

number

required

GST tax Detail of shipping freight including SGST, CGST and IGST.

shipping_freight_sgst_amount

number

required

shipping_freight_igst_amount

number

required

packing_charge

number

required

This field refers to the cost associated with packaging the goods.

packing_charge_with_gst

number

required

This field represents the packing charges, including GST.

packing_charge_cgst_amount

number

required

GST tax Detail of packing charges including SGST, CGST and IGST.

packing_charge_sgst_amount

number

required

packing_charge_igst_amount

number

required

cgst

number

required

The total amount of Central Goods and Services Tax (CGST) applied to the transaction.

sgst

number

required

The total amount of State Goods and Services Tax (SGST) applied to the transaction.

igst

number

required

The total amount of Integrated Goods and Services Tax (IGST) applicable to the transaction.

cess

number

required

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

round_off_amount

number

required

The amount adjusted for rounding off the total bill.

total

number

required

The total value of the sale transaction before tax.

grand_total

number

required

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

taxable_value

number

required

The amount on which tax is calculated.

gross_value

number

required

The total gross value of the sale before deductions.

narration

string

required

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

is_gst_enabled

boolean

required

Indicates whether GST is enabled for the transaction.

is_gst_na

boolean

required

Indicates if GST is not applicable to the transaction.

is_cgst_sgst_igst_calculated

boolean

required

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

is_round_off_not_changed

boolean

required

A flag indicating whether the rounding amount has been manually adjusted or remains unchanged.

status

string

required

The status of the order: Open, Expired, Fully Invoiced, Partially Invoiced.

supplier_ledger_name

string

required

The name of the supplier ledger, which linked to the transaction.

media

array[string]

required

Stores media-related data associated with the transaction.

billing_address

object

required

Contains details about the billing address linked to the transaction.

shipping_address

object

required

Contains details about the shipping address linked to the transaction.

transaction_items

array [object {37}]

required

A list containing details of items.

transaction_ledgers

array[string]

required

A list containing details of ledger.

party

object

required

The supplier from whom the transaction was made.

additional_charges

array[string]

required

Holds any extra charges applied to the transaction.

add_less

array[string]

required

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

via_api

boolean

required

created_by

integer

required

A unique identifier of the user who created the transaction.

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": 1,
        "company_id": 6,
        "title": 1,
        "order_number": "4",
        "full_order_number": "4",
        "order_type": 2,
        "order_date": "2025-02-12",
        "valid_for": 10,
        "valid_for_type": 1,
        "valid_till_date": "2025-12-12",
        "party_ledger_id": 2702,
        "gstin": null,
        "broker_id": null,
        "brokerage": null,
        "brokerage_on_value_type": null,
        "transport_id": null,
        "transporter_document_number": null,
        "transporter_document_date": null,
        "transporter_vehicle_number": null,
        "shipping_name": null,
        "shipping_gstin": null,
        "shipping_freight": null,
        "shipping_freight_with_gst": 0,
        "shipping_freight_cgst_amount": null,
        "shipping_freight_sgst_amount": null,
        "shipping_freight_igst_amount": null,
        "packing_charge": null,
        "packing_charge_with_gst": 0,
        "packing_charge_cgst_amount": null,
        "packing_charge_sgst_amount": null,
        "packing_charge_igst_amount": null,
        "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,
        "is_gst_na": 1,
        "is_cgst_sgst_igst_calculated": 0,
        "status": "Open",
        "is_round_off_not_changed": 0,
        "supplier_ledger_name": "AAW",
        "billing_address": {
            "id": 3,
            "address_1": "2121, 3RD FLOOR, RADHA RAMAN TEXTILE MARKET",
            "address_2": "KADODARA ROAD",
            "country_id": 1,
            "state_id": 2,
            "city_id": 1,
            "pin_code": "395008",
            "model_id": 6,
            "model_type": "App\\Models\\PurchaseOrderTransaction",
            "address_type": 1,
            "created_at": "2025-02-12T12:40:55.000000Z",
            "updated_at": "2025-02-12T12:40:55.000000Z"
        },
        "shipping_address": {
            "id": 2,
            "address_1": "2121, 3RD FLOOR, RADHA RAMAN TEXTILE MARKET",
            "address_2": "KADODARA ROAD",
            "country_id": 1,
            "state_id": 2,
            "city_id": 1,
            "pin_code": "395008",
            "model_id": 6,
            "model_type": "App\\Models\\PurchaseOrderTransaction",
            "address_type": 2,
            "created_at": "2025-02-12T12:40:55.000000Z",
            "updated_at": "2025-02-12T12:40:55.000000Z"
        },
        "transaction_items": [
            {
                "id": 2,
                "transactions_id": 1,
                "item_id": 4,
                "item_name": "Accounting Service",
                "ledger_id": 5,
                "ledger_name": "Consultancy",
                "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",
                "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"
                    }
                ],
                "decimal_places": 0,
                "decimal_places_for_rate": 2,
                "secondary_unit_of_measurement": null,
                "conversion_rate": null,
                "taxable_value": 100,
                "created_at": "2025-02-12T12:40:55.000000Z",
                "updated_at": "2025-02-12T12:40:55.000000Z"
            }
        ],
        "transaction_ledgers": [],
        "party": {
            "id": 5,
            "name": "AAW",
            "company_id": 6,
            "group_id": 2,
            "parent_id": null,
            "model_id": 2,
            "model_type": "App\\Models\\Master\\Supplier",
            "ledgers_data": {
                "Supplier": {
                    "gstin": "24ABCPM4732A1ZA",
                    "phone_1": "7359971320",
                    "phone_2": null,
                    "website": null,
                    "brokerage": null,
                    "reference": true,
                    "cin_number": "",
                    "entity_type": 9,
                    "person_name": null,
                    "person_email": "vishalinfyom@gmail.com",
                    "broker_master": null,
                    "reference_name": null,
                    "opening_balance": 789679,
                    "pan_card_number": "ABCPM4732A",
                    "rate_of_interest": null,
                    "gst_return_status": null,
                    "reference_address": null,
                    "brokerage_on_value": 3,
                    "credit_period_type": 1,
                    "credit_limit_period": null,
                    "gst_registration_type": 1,
                    "opening_balance_dr_cr": 2,
                    "billing_address_city_id": 1,
                    "billing_address_pin_code": "395008",
                    "billing_address_state_id": 2,
                    "shipping_address_city_id": 1,
                    "billing_address_address_1": "2121, 3RD FLOOR, RADHA RAMAN TEXTILE MARKET",
                    "billing_address_address_2": "KADODARA ROAD",
                    "reference_contact_details": null,
                    "shipping_address_pin_code": "395008",
                    "shipping_address_state_id": 2,
                    "billing_address_country_id": 1,
                    "shipping_address_address_1": "2121, 3RD FLOOR, RADHA RAMAN TEXTILE MARKET",
                    "shipping_address_address_2": "KADODARA ROAD",
                    "shipping_address_country_id": 1
                }
            },
            "opening_balance": 789679,
            "opening_balance_dr_cr": 2,
            "is_default": false,
            "via_api": 0,
            "is_import": 0,
            "created_at": "2023-06-17T09:20:33.000000Z",
            "updated_at": "2024-07-11T06:57:17.000000Z"
        },
        "additional_charges": [],
        "add_less": [],
        "media": [],
        "via_api": 0,
        "created_by": 8,
        "created_at": "2025-02-12T12:40:55.000000Z",
        "updated_at": "2025-02-12T12:40:55.000000Z"
    },
    "success": true,
    "message": "Purchase Order Transaction Retrieved Successfully"
}

Duplicate purchase Order

Request#

Response#

Request

Request samples

Responses

Request

Response