{ "opencollection": "1.0.0", "info": { "name": "Frappe / ERPNext Method Resource API", "version": "0.0.1" }, "items": [ { "info": { "name": "Resource", "type": "folder" }, "items": [ { "info": { "name": "Get a list of documents", "type": "http" }, "http": { "method": "GET", "url": "https://demo.erpnext.com/api/resource/:DocType", "params": [ { "name": "DocType", "value": "", "type": "path", "description": "The DocType you'd like to receive. For example Customer, Supplier, \nEmployee, Account, Lead, Company, Sales Invoice, Purchase Invoice, Stock Entry, etc.\n" }, { "name": "fields", "value": "", "type": "query", "description": "By default, only the \"name\" field is included in the listing, to add more fields, \nyou can pass the fields param to GET request. For example, fields=[\"name\",\"country\"]\n" }, { "name": "filters", "value": "", "type": "query", "description": "You can filter the listing using sql conditions by passing them as the filters GET param.\nEach condition is an array of the format, [{doctype}, {field}, {operator}, {value}].\nFor example, filters=[[\"Customer\", \"country\", \"=\", \"India\"]]\n" }, { "name": "limit_page_length", "value": "", "type": "query", "description": "By default, all listings are returned paginated. With this parameter you can change the \npage size (how many items are teturned at once).\n" }, { "name": "limit_start", "value": "", "type": "query", "description": "To request successive pages, pass a multiple of your limit_page_length as limit_start. \nFor Example, to request the second page, pass limit_start as 20.\n" } ] }, "docs": "Returns a list of documents of the given type" }, { "info": { "name": "Create a new document", "type": "http" }, "http": { "method": "POST", "url": "https://demo.erpnext.com/api/resource/:DocType", "params": [ { "name": "DocType", "value": "", "type": "path", "description": "The DocType you'd like to receive. For example, Customer.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new document" }, { "info": { "name": "Get a specific document", "type": "http" }, "http": { "method": "GET", "url": "https://demo.erpnext.com/api/resource/:DocType/:DocumentName", "params": [ { "name": "DocType", "value": "", "type": "path", "description": "The DocType you'd like to receive. For example Customer, Supplier, \nEmployee, Account, Lead, Company, Sales Invoice, Purchase Invoice, Stock Entry, etc.\n" }, { "name": "DocumentName", "value": "", "type": "path", "description": "The name (ID) of the document you'd like to receive. For example EMP001 (of type Employee).\n" } ] }, "docs": "Get a document by it's name, for example EMP001 of DocType Employee." }, { "info": { "name": "Update a specific document", "type": "http" }, "http": { "method": "PUT", "url": "https://demo.erpnext.com/api/resource/:DocType/:DocumentName", "params": [ { "name": "DocType", "value": "", "type": "path", "description": "The DocType you'd like to update. For example Customer, Supplier, \nEmployee, Account, Lead, Company, Sales Invoice, Purchase Invoice, Stock Entry, etc.\n" }, { "name": "DocumentName", "value": "", "type": "path", "description": "The name (ID) of the document you'd like to update. For example EMP001 (of type Employee).\n" } ] }, "docs": "TBD" }, { "info": { "name": "Delete a specific document", "type": "http" }, "http": { "method": "DELETE", "url": "https://demo.erpnext.com/api/resource/:DocType/:DocumentName", "params": [ { "name": "DocType", "value": "", "type": "path", "description": "The type of the document you'd like to delete. For example Customer, Supplier, \nEmployee, Account, Lead, Company, Sales Invoice, Purchase Invoice, Stock Entry, etc.\n" }, { "name": "DocumentName", "value": "", "type": "path", "description": "The name (ID) of the document you'd like to delete. For example EMP001 (of type Employee).\n" } ] }, "docs": "TBD" } ] } ], "bundled": true }