Clients List

clientslist

Parameter

Type

I/O

Description

IN

Parameters described in Overview

Company

String

IN

The company context

Action

String

IN

Identifier for the list requested

Supplier

String

IN

Identifier for the supplier context

Response

XML / JSON

OUT

An XML tree / JSON string containing clients the user has access to

Description

Calling the expenses API with an action of clientslist retrieves a list of clients and associated names.

Return Values

Response – List of clients.

The structure of the response is:

<clients morepages="False" totalpages="1" totalrows="2">
  <client clients_uuid="D1C36202-C582-4E35-B9AA-E1F50DA90B0B">
    <clients_clientcode>1/A001</clients_clientcode>
    <clients_clientname>Proton Cars plc</clients_clientname>
  </client>
  <client clients_uuid="47CC0AD8-205C-41AE-83AE-D401F57B4736">
    <clients_clientcode>1/BLOGGS</clients_clientcode>
    <clients_clientname>Barclaycard Merchant Serv Branch 3</clients_clientname>
  </client>
</clients>
"errormessage": "",
"responsecode": 1,
"pagerows": 0,
"totalrows": 2,
"responsestatus": "OK",
"success": true,
"responsemessage": "",
"errorcode": 0,
"totalpages": 1,
"pagenumber": 1,
"data": [
    {
        "clients_uuid": "D1C36202-C582-4E35-B9AA-E1F50DA90B0B",
        "clients_clientcode": "1/A001",
        "clients_clientname": "Proton Cars plc"
    },
    {
        "clients_uuid": "47CC0AD8-205C-41AE-83AE-D401F57B4736",
        "clients_clientcode": "1/BLOGGS",
        "clients_clientname": "Barclaycard Merchant Serv Branch 3"
    }
]