Supplier list

Parameter	Mandatory	Description	Examples	More Info
API	Yes	The API area	suppliers.json
General	Yes	Parameters described in overview	see overview	Structure of an API call
Model Structure	Yes	Name of model required	modelstructure=supplierslist	Using data models
View	No	Stored filter applied		Using views
Sort	No	Change the view's default sort order	sort=SUPPLIER	Sorting
Filters	No	Filter by a key field		Filters
Company	Yes	The company number	company=1

Example request (OAuth 2.0):

Authorization: Bearer <access_token>
http://<SERVER>/jsonapi/suppliers.json?&version=6&modelstructure=supplierslist&company=1

Example request (legacy username/password):

http://<SERVER>/jsonapi/suppliers.json?&version=6&modelstructure=supplierslist&company=1&user=<username>&password=<password>

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 229,
  "totalpages": 1,
  "responsemessage": "",
  "pagerows": 0,
  "pagenumber": 1,
  "success": true,
  "data": [
    {
      "supplieruuid": "6630AB400A50714ABC8F7947A828ED6F",
      "supplierTimeStampModified": 1603367508,
      "supplierRecordVersionNumber": 40,
      "supplierCustomField317": "",
      "supplierCustomField336": "0000-00-00",
      "supplierCustomField409": "www.thebigprintingcompany.com",
      "supplierCustomField418": false,
      "supplierName": "The Big Printing Company EURO",
      "supplierCode": "1/56",
      "supplierPhone": "0161 555 0001",
      "supplierExpense": true,
      "supplierInactive": false,
      "supplierOnHold": false,
      "supplierMainEmail": "@yahoo.com",
      "supplierSupplytypeDescription": "Printers",
      "supplierMarkup": 1,
      "supplierWebURL": "www.thebigprintingcompany.co.uk",
      "supplierProspect": false
    }
  ]
}

CSV_request:

This call will return the same data as above but as a simple downloaded CSV file

If "modelstructure=view", and a view number also specified, the CSV will contain the columns associated with the view - rather than a standard model

Authorization: Bearer <access_token>
http://<SERVER>/csvapi/suppliers.csv?&version=6&modelstructure=supplierslist&company=1

Example request (legacy username/password):

http://<SERVER>/csvapi/suppliers.csv?&version=6&modelstructure=supplierslist&company=1&user=<username>&password=<password>