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=supplierdetails	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:

http://<SERVER>/jsonapi/suppliers.json?user=user&password=user&version=4&modelstructure=supplierdetails&company=1&supplier=1/A001

Example response:

{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 1,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"synapiversion": 3.8,
"data": [
{
"supplieruuid": "367FDBB9CF1B4AD798A5C75A4355BF8A",
"supplierTimeStampModified": 1617891671,
"supplierRecordVersionNumber": 299,
"supplierCustomField317": "pulldown 1",
"supplierCustomField336": "2019-04-03",
"supplierCustomField409": "5",
"supplierCustomField418": true,
"supplierCustomField596": "Child 1",
"supplierCode": "1/A001",
"supplierName": "Able Printers Limited",
"supplierExpense": false,
"supplierInactive": false,
"supplierGeneric": false,
"supplierOnHold": false,
"supplierProspect": false,
"supplierStreet": "22 High Street",
"supplierAddress1": "",
"supplierAddress2": "Chester",
"supplierCounty": "Cheshire",
"supplierPostcode": "CH6 7TF",
"supplierCountry": "United Kingdom",
"supplierCountryCode": "UK",
"supplierCountryName": "United Kingdom",
"supplierPhone": "0161 456 1897",
"supplierFax": "0161 456 7777",
"supplierVATReg": "",
"supplierUserID": 0,
"supplierFullName": "",
"supplierISDN": "",
"supplierWebURL": "www.xxyx.com",
"supplierMainEmail": "awson@synergist.co.uk",
"supplierSupplytype": "1/ELE",
"supplierSupplytypeDescription": "Electrical Work"
"supplierDepartmentCode": "1/D2",
"supplierDepartment": "Design"
}
]
}