Clients List

Clientslist

ParameterTypeDescription
[IN] Parameters described in Overview
CompanyString[IN] The users default company number for the companies list
ActionString[IN] Identifier for the list requested
ResourceString[IN] Identifier for the resource context
Search [OPTIONAL]String[IN] search parameter to filter list
ResponseXML/JSON[OUT] An XML tree / JSON string containing clients the user has access to

Description

Calling the timesheets API with an action of clientslist retrieves a list of client codes and associated client names.

Return Values

Response – List of clients.

The structure of the response is:

<clients MorePages="False" TotalPages="1" TotalRows="1">
<client clients_uuid="D1C36202C5824E35B9AAE1F50DA90B0B">
<clients_clientcode>1/A001</clients_clientcode>
<clients_clientname>Proton Cars plc</clients_clientname>
</client>
</clients>
{
    "errormessage": "",
    "responsecode": 1,
    "pagerows": 0,
    "totalrows": 1,
    "responsestatus": "OK",
    "success": true,
    "responsemessage": "",
    "errorcode": 0,
    "totalpages": 1,
    "pagenumber": 1,
    "data": [
        {
            "clients_uuid": "D1C36202C5824E35B9AAE1F50DA90B0B",
            "clients_clientcode": "1/A001",
            "clients_clientname": "Proton Cars plc"
        }    ]
}