Requests to list clients.
Client List
| Parameter | Mandatory | Description | Examples | More Info |
|---|---|---|---|---|
| API | Yes | The API area | expenselines.json | |
| General | Yes | Parameters described in overview | Authorization: Bearer <access_token> header — see Synergist API Authentication | Structure of an API call |
| Company | Yes | The company number | company=1 | |
| Action | Yes | The action to perform | action=clientslist |
Example request (OAuth 2.0):
Authorization: Bearer <access_token>
http://<SERVER>/jsonapi/expenselines.json?&version=6&company=1&action=clientslist
Example request (legacy username/password):
http://<SERVER>/jsonapi/expenselines.json?&version=6&company=1&action=clientslist&user=<username>&password=<password>
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 170,
"totalpages": 85,
"responsemessage": "",
"pagerows": 2,
"pagenumber": 1,
"success": true,
"data": [
{
"clientUuid": "D1C36202C5824E35B9AAE1F50DA90B0B",
"clientTimeStampModified": 1519135641,
"clientRecordVersionNumber": 121,
"clientCode": "1/A001",
"clientName": "Proton Cars plc"
},
{
"clientUuid": "47CC0AD8205C41AE83AED401F57B4736",
"clientTimeStampModified": 1519135641,
"clientRecordVersionNumber": 195,
"clientCode": "1/BLOGGS",
"clientName": "Barclaycard Merchant 3"
}
]
}