Clients List

Returns the list of clients.

Clients List

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areatspending.json
GeneralYesParameters described in overviewsee overviewStructure of an API call
CompanyYesThe company numbercompany=1
ActionYesThe action to performaction=clientslist

Example request (OAuth 2.0):

Authorization: Bearer <access_token>
http://<SERVER>/jsonapi/tspending.json?&version=6&action=clientslist&company=1

Example request (legacy username/password):

http://<SERVER>/jsonapi/tspending.json?&version=6&action=clientslist&company=1&user=<username>&password=<password>

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 170,
  "totalpages": 1,
  "responsemessage": "",
  "pagerows": 0,
  "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"
    }
  ]
}