Query Related REST API

I want to fetch all the field of a particular doc type through REST API .
Please suggest me some way .
I am following this link , but I am able to fetch only few fields of a doc type .
https://frappe.io/docs/user/en/guides/integration/rest_api

2 Likes

@Nivedita_Roychowdhur

Just specify required document in rest api, by default it will return all fields.

eg: http://tran.erpnext:8001/api/resource/Sales%20Order/SO-00004

{
	"data": {
		"billing_status": "Not Billed",
		"modified_by": "Administrator",
		"title": "Saurabh Palande",
		"packed_items": [],
		"selling_price_list": "Standard Selling",
		"base_grand_total": 118.0,
		"base_in_words": "INR One Hundred And Eighteen only.",
		"ignore_pricing_rule": 0,
		"base_discount_amount": 0.0,
		"base_total_taxes_and_charges": 18.0,
		"discount_amount": 0.0,
		"name": "SO-00004",
		"taxes": [{
			"creation": "2018-02-10 13:20:25.953818",
			"doctype": "Sales Taxes and Charges",
			"included_in_print_rate": 0,
			"rate": 9.0,
			"tax_amount_after_discount_amount": 9.0,
			"cost_center": "Main - TT",
			"total": 109.0,
			"charge_type": "On Net Total",
			"modified_by": "Administrator",
			"item_wise_tax_detail": "{\"ads\":[9.0,9.0]}",
			"base_total": 109.0,
			"owner": "Administrator",
			"docstatus": 1,
			"description": "SGST @ 9.0",
			"parent": "SO-00004",
			"base_tax_amount_after_discount_amount": 9.0,
			"base_tax_amount": 9.0,
			"account_head": "SGST - TT",
			"tax_amount": 9.0,
			"name": "INVTD000007",
			"idx": 1,
			"modified": "2018-02-10 13:20:30.260838",
			"parenttype": "Sales Order",
			"parentfield": "taxes"
		}, {
			"creation": "2018-02-10 13:20:25.953818",
			"doctype": "Sales Taxes and Charges",
			"included_in_print_rate": 0,
			"rate": 9.0,
			"tax_amount_after_discount_amount": 9.0,
			"cost_center": "Main - TT",
			"total": 118.0,
			"charge_type": "On Net Total",
			"modified_by": "Administrator",
			"item_wise_tax_detail": "{\"ads\":[9.0,9.0]}",
			"base_total": 118.0,
			"owner": "Administrator",
			"docstatus": 1,
			"description": "CGST @ 9.0",
			"parent": "SO-00004",
			"base_tax_amount_after_discount_amount": 9.0,
			"base_tax_amount": 9.0,
			"account_head": "CGST - TT",
			"tax_amount": 9.0,
			"name": "INVTD000008",
			"idx": 2,
			"modified": "2018-02-10 13:20:30.260838",
			"parenttype": "Sales Order",
			"parentfield": "taxes"
		}],
		"base_rounding_adjustment": 0.0,
		"delivery_date": "2018-02-28",
		"creation": "2018-02-10 13:20:25.953818",
		"party_account_currency": "INR",
		"modified": "2018-02-10 13:20:30.260838",
		"price_list_currency": "INR",
		"contact_display": "Saurabh Palande",
		"terms": "",
		"advance_paid": 0.0,
		"total_commission": 0.0,
		"delivery_status": "Not Delivered",
		"base_net_total": 100.0,
		"language": "es",
		"items": [{
			"stock_qty": 1.0,
			"base_price_list_rate": 0.0,
			"image": "",
			"creation": "2018-02-10 13:20:25.953818",
			"base_amount": 100.0,
			"qty": 1.0,
			"margin_rate_or_amount": 0.0,
			"rate": 100.0,
			"total_weight": 0.0,
			"owner": "Administrator",
			"stock_uom": "Nos",
			"base_net_amount": 100.0,
			"page_break": 0,
			"modified_by": "Administrator",
			"base_net_rate": 100.0,
			"discount_percentage": 0.0,
			"item_name": "ads",
			"amount": 100.0,
			"actual_qty": 0.0,
			"net_rate": 100.0,
			"conversion_factor": 1.0,
			"base_rate_with_margin": 0.0,
			"docstatus": 1,
			"uom": "Nos",
			"ordered_qty": 0.0,
			"doctype": "Sales Order Item",
			"description": "ads",
			"parent": "SO-00004",
			"gross_profit": 0.0,
			"returned_qty": 0.0,
			"base_rate": 100.0,
			"item_code": "ads",
			"produced_qty": 0.0,
			"projected_qty": 0.0,
			"warehouse": "Stores - TT",
			"margin_type": "",
			"billed_amt": 0.0,
			"rate_with_margin": 0.0,
			"delivered_qty": 0.0,
			"delivered_by_supplier": 0,
			"price_list_rate": 0.0,
			"transaction_date": "2018-02-10",
			"name": "036d122435",
			"idx": 1,
			"item_tax_rate": "{}",
			"item_group": "Services",
			"planned_qty": 0.0,
			"modified": "2018-02-10 13:20:30.260838",
			"weight_per_unit": 0.0,
			"parenttype": "Sales Order",
			"valuation_rate": 0.0,
			"net_amount": 100.0,
			"delivery_date": "2018-02-28",
			"parentfield": "items"
		}],
		"shipping_address_name": "",
		"apply_discount_on": "Grand Total",
		"contact_person": "Saurabh Palande-Saurabh Palande - 1",
		"in_words": "INR One Hundred And Eighteen only.",
		"additional_discount_percentage": 0.0,
		"conversion_rate": 1.0,
		"owner": "Administrator",
		"total": 100.0,
		"customer_name": "Saurabh Palande",
		"commission_rate": 0.0,
		"base_total": 100.0,
		"territory": "All Territories",
		"other_charges_calculation": "<div class=\"tax-break-up\" style=\"overflow-x: auto;\">\n\t<table class=\"table table-bordered table-hover\">\n\t\t<thead>\n\t\t\t<tr>\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t<th class=\"text-left\">HSN/SAC</th>\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t<th class=\"text-right\">Taxable Amount</th>\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t<th class=\"text-right\">SGST @ 9.0</th>\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t<th class=\"text-right\">CGST @ 9.0</th>\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t</tr>\n\t\t</thead>\n\t\t<tbody>\n\t\t\t\n\t\t\t\t<tr>\n\t\t\t\t\t<td>None</td>\n\t\t\t\t\t<td class='text-right'>\n\t\t\t\t\t\t\u20b9 100.00\n\t\t\t\t\t</td>\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t<td class='text-right'>\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t(9.0%) \n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\u20b9 9.00\n\t\t\t\t\t\t\t</td>\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\n\t\t\t\t\t\t\t<td class='text-right'>\n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\t(9.0%) \n\t\t\t\t\t\t\t\t\n\t\t\t\t\t\t\t\t\u20b9 9.00\n\t\t\t\t\t\t\t</td>\n\t\t\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t</tr>\n\t\t\t\n\t\t</tbody>\n\t</table>\n</div>",
		"company": "Test Trans",
		"base_rounded_total": 0.0,
		"customer": "Saurabh Palande - 1",
		"grand_total": 118.0,
		"idx": 0,
		"doctype": "Sales Order",
		"rounding_adjustment": 0.0,
		"rounded_total": 0.0,
		"customer_group": "Individual",
		"naming_series": "SO-",
		"currency": "INR",
		"order_type": "Sales",
		"transaction_date": "2018-02-10",
		"docstatus": 1,
		"per_delivered": 0.0,
		"status": "To Deliver and Bill",
		"group_same_items": 0,
		"taxes_and_charges": "In State GST - TT",
		"per_billed": 0.0,
		"total_net_weight": 0.0,
		"net_total": 100.0,
		"payment_schedule": [{
			"due_date": "2018-02-10",
			"modified_by": "Administrator",
			"name": "985d4b630e",
			"parent": "SO-00004",
			"creation": "2018-02-10 13:20:26.172362",
			"modified": "2018-02-10 13:20:30.260838",
			"doctype": "Payment Schedule",
			"idx": 1,
			"parenttype": "Sales Order",
			"payment_amount": 118.0,
			"invoice_portion": 100.0,
			"owner": "Administrator",
			"docstatus": 1,
			"parentfield": "payment_schedule"
		}],
		"plc_conversion_rate": 1.0,
		"total_taxes_and_charges": 18.0,
		"contact_email": "saurabh6790@gmail.com",
		"sales_team": []
	}
}

Thank you so much sir .
It is working .