Clients

This section contains code samples related to clients.
 
Example Code
 
GET available clients
Topal can contain multiple clients. With this request a list of clients can be retrieved. The list depends on the granted/assigned clients to the user account. 
 
    
    [TestMethod]
    public void REST_Clients_GET()
    {
        state = new ErrorState { passed = false };
        var clients = GET.clients(manager);

        if (clients.Count > 0)
        {
            state.passed = true;
        }
        Assert.AreEqual(true, state.passed, state.message);
    }

    class GET
    {
        public static List<Client> clients(Manager manager)
        {
            List clients = null;

            string request = "clients";
            var response = manager.httpClient.GetAsync(string.Format(request)).Result;

            if (response.StatusCode == HttpStatusCode.OK)
            {
                clients = JsonConvert.DeserializeObject<List<Client>>(response.Content.ReadAsStringAsync().Result);
            }

            return clients;
        }
    }
Load Clients
    
class GET:
  
    @staticmethod
    def clients(manager):
        
        url = '{0}clients'.format(manager.baseURL())
        response = requests.get(url, headers = manager.headers())

        return response.json()
JSON representation of a client
    
{
	"id": 1,
	"guid": "3d5d8cd8-0443-4678-bb47-2f425eac4ce1",
	"fiscalYearFID": 55,
	"currencyFID": 19,
	"name": "Mon_Bijou_AG_API",
	"code": "T3000",
	"person": "",
	"city": "Bern",
	"street": "",
	"remarks": "",
	"telephone": "000 111 22 33",
	"zip": "3000",
	"vatNumber": "CHE-111.222.333 MWST",
	"backupTS": "2018-06-22T15:55:43.37",
	"lastTimestamp": "2019-06-07T16:15:03.81",
	"isDiscountSwissRounded": false,
	"isKCSwissRounded": false,
	"isTemplate": false,
	"isVATSwissRounded": false,
	"vatAgreed": true,
	"vatPaymentBased": false,
	"vatRequired": true,
	"vatSimplefied": false,
	"isCurrent": true,
	"currencyCode": "CHF",
	"fiscalYears": [
		{
			"id": 1,
			"name": "2014",
			"dateFrom": "2014-01-01T00:00:00",
			"dateUntil": "2014-12-31T00:00:00",
			"docDateFrom": "2014-01-01T00:00:00",
			"docDateUntil": "2014-12-31T00:00:00",
			"closed": true
		},
		{
			"id": 2,
			"name": "2015",
			"dateFrom": "2015-01-01T00:00:00",
			"dateUntil": "2015-12-31T00:00:00",
			"docDateFrom": "2015-01-01T00:00:00",
			"docDateUntil": "2015-12-31T00:00:00",
			"closed": false
		},
		{
			"id": 3,
			"name": "2016",
			"dateFrom": "2016-01-01T00:00:00",
			"dateUntil": "2016-12-31T00:00:00",
			"docDateFrom": "2016-01-01T00:00:00",
			"docDateUntil": "2016-12-31T00:00:00",
			"closed": false
		},
		{
			"id": 4,
			"name": "2017",
			"dateFrom": "2017-01-01T00:00:00",
			"dateUntil": "2017-12-31T00:00:00",
			"docDateFrom": "2017-01-01T00:00:00",
			"docDateUntil": "2017-12-31T00:00:00",
			"closed": false
		},
		{
			"id": 5,
			"name": "2018",
			"dateFrom": "2018-01-01T00:00:00",
			"dateUntil": "2018-12-31T00:00:00",
			"docDateFrom": "2018-01-01T00:00:00",
			"docDateUntil": "2018-12-31T00:00:00",
			"closed": false
		},
		{
			"id": 55,
			"name": "2019",
			"dateFrom": "2019-01-01T00:00:00",
			"dateUntil": "2019-12-31T00:00:00",
			"docDateFrom": "2019-01-01T00:00:00",
			"docDateUntil": "2019-12-31T00:00:00",
			"closed": false
		}
	],
	"vatPeriods": [
		{
			"id": 1,
			"dateFrom": "2011-01-01T00:00:00"
		},
		{
			"id": 2,
			"dateFrom": "2017-10-01T00:00:00"
		},
		{
			"id": 3,
			"dateFrom": "2018-01-01T00:00:00"
		}
	]
}