client element

Type: client
Namespace: http://api.crunch.co.uk/rest
XML Schema: api.xsd

Represents a client element

Example XML

<?xml version="1.0" encoding="UTF-8"?> <client xmlns="http://api.crunch.co.uk/rest" clientId="..." resourceUrl="..." defaultCurrency="..."> <name>...</name> <telephone>...</telephone> <fax>...</fax> <email>...</email> <website>...</website> <companyRegistrationNumber>...</companyRegistrationNumber> <vatRegistrationNumber>...</vatRegistrationNumber> <paymentTermsDays>...</paymentTermsDays> <contacts count="..."> <contact includeInEmail="..." primaryContact="..."> <name>...</name> <email>...</email> <telephone>...</telephone> <role>...</role> </contact> <contact includeInEmail="..." primaryContact="..."> <!--...--> </contact> <!--...more "contact" elements...--> </contacts> <billingAddress> <line1>...</line1> <line2>...</line2> <line3>...</line3> <line4>...</line4> <postcode>...</postcode> <country>...</country> </billingAddress> <shipToAddress> <line1>...</line1> <line2>...</line2> <line3>...</line3> <line4>...</line4> <postcode>...</postcode> <country>...</country> </shipToAddress> <note>...</note> </client>

Example JSON

{ "clientId" : ..., "resourceUrl" : "...", "defaultCurrency" : "...", "name" : "...", "telephone" : "...", "fax" : "...", "email" : "...", "website" : "...", "companyRegistrationNumber" : "...", "vatRegistrationNumber" : "...", "paymentTermsDays" : ..., "contacts" : { "count" : ..., "contact" : [ { "includeInEmail" : false, "primaryContact" : false, "name" : "...", "email" : "...", "telephone" : "...", "role" : "..." }, ... ] }, "billingAddress" : { "line1" : "...", "line2" : "...", "line3" : "...", "line4" : "...", "postcode" : "...", "country" : "..." }, "shipToAddress" : { "line1" : "...", "line2" : "...", "line3" : "...", "line4" : "...", "postcode" : "...", "country" : "..." }, "note" : "..." }