v1

latestOpenAPI 3.1.02026-08-045901.5 MB

List Purchase Order

get/purchase-order

Query parameters

start_frominteger required

Starting index for pagination

sizeinteger required

Number of records to retrieve

from_datestring date

Start date for filtering

to_datestring date

End date for filtering

searchstring

Keyword or text to search

order_by'asc' | 'desc'

Sorting order

order_column'porder_number' | 'seller_name' | 'total_amount' | 'supplier_name'

Column name to sort by

converted_status'Not Converted' | 'Converted'

Converted status of purchase order

statusstring

Used to filter deleted records

Headers

api-tokenstring

Generate token from authentication api

x-api-keystring

This will shared while register

Response

200

statusinteger

Example response

{
  "status": 200,
  "data": {
    "total_count": 377,
    "data": [
      {
        "id": 1135,
        "porder_number": "san-1-86",
        "porder_date": "2025-04-21",
        "porder_valid_date": "2025-04-21",
        "tax_id1_type": "0",
        "business_info": {
          "id": 413,
          "pos": "DAMAN AND DIU",
          "city": "MOTI",
          "name": "STOCK HOLDING CORPORATION OF INDIA LIMITED",
          "addr1": "ESTAMPING OFFICE, PWD, DIVISION -1",
          "addr2": "NEAR FATIMA CONVENT SCHOOL",
          "email": "test87899@gmail.com",
          "state": "DAMAN AND DIU",
          "tax_no": "25AABCS1429B1ZY",
          "country": "INDIA",
          "pincode": "396220"
        },
        "contact_id": 4673,
        "business_branch_id": 413,
        "seller_branch_id": 2,
        "seller_name": "afro test",
        "seller_info": {
          "supplier_id": 4673,
          "supplier_city": "Leh Ladakh",
          "supplier_name": "afro test",
          "supplier_addr1": "SKITCHAN NGODUP COMPLEX, SHOP NO.F2",
          "supplier_addr2": "NEAR OLD BUS STAND, LEH, Leh",
          "supplier_state": "ODISHA",
          "business_country": "india",
          "supplier_country": "INDIA",
          "supplier_business_name": "M/s New Friends Jewellers"
        },
        "billing_details": {
          "bill_city": "MOTI",
          "bill_addr1": "ESTAMPING OFFICE, PWD, DIVISION -1",
          "bill_addr2": "NEAR FATIMA CONVENT SCHOOL",
          "bill_state": "DAMAN AND DIU",
          "bill_company": "Billing Company",
          "bill_country": "INDIA",
          "bill_pincode": "396220"
        },
        "shipping_details": {
          "ship_city": "MOTI",
          "ship_addr1": "ESTAMPING OFFICE, PWD, DIVISION -1",
          "ship_addr2": "NEAR FATIMA CONVENT SCHOOL",
          "ship_state": "DAMAN AND DIU",
          "ship_company": "Shipping Company",
          "ship_country": "INDIA",
          "ship_pincode": "396220"
        },
        "export_details": {
          "export_type": "Not Applicable"
        },
        "items": [
          {
            "pid": 2997,
            "sku": "99398",
            "vid": 1,
            "rate": 952.3809523809524,
            "units": "BOU-BILLIONS OF UNITS",
            "status": 1,
            "added_by": 1,
            "added_on": "2025-04-21 08:48:43",
            "quantity": 1,
            "cess_type": "flat_value",
            "item_code": "2323",
            "item_name": "Test New Import 2025 | Test Variant 2025",
            "item_type": 1,
            "expense_id": 381,
            "updated_by": 1,
            "taxable_amt": 952.3809523809524,
            "expense_type": "purchase of traded goods",
            "discount_type": "flat_value",
            "item_total_amt": 952.3809523809524,
            "converted_amount": 952.3809523809524,
            "item_description": "Test Description 2025"
          }
        ],
        "pur_odr_others": "null",
        "currency": "INR",
        "taxable_amount": "952.38095238095",
        "non_taxable_amount": "0",
        "gst_amount": "0",
        "adjust_amount": "0",
        "addvalue_amount": "0",
        "cess_amount": "0",
        "total_amount": "952.38095238095",
        "payable_amount": "952.38095238095",
        "basic_custom_duty": "0",
        "counter_duty": "0",
        "counter_duty_add": "0",
        "gst_tax_credit": "0",
        "added_on": "2025-04-21 14:18:18",
        "added_by": 2051784300,
        "edit_log": [
          {
            "updated_by": 2051784300,
            "updated_on": "2025-04-21 14:18:43"
          }
        ],
        "tax_status": 1,
        "invoice_status": 1,
        "status": 1,
        "data_source": 1,
        "ip_address": "172.31.78.56",
        "req_by": "[[]]",
        "apr_by": "[[]]",
        "rec_by": "[[]]",
        "auto_mode": 1,
        "type": 1,
        "seller_phone": "9876543210",
        "currency_info": "{\"to\": \"INR\", \"from\": \"INR\", \"currency_rate\": 1, \"converted_amount\": 952.3809523809524, \"currency_default_rate\": 1}",
        "converted_status": "Converted",
        "purchase_amount": "952.38"
      }
    ]
  }
}