client

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

Represents a client element

XML

Attributes

name type description
clientId long ID
resourceUrl string Returns the API uri to call this element again
defaultCurrency string The three digit country code, e.g. GBP

Elements

name (type) min/max
occurs
description
name (string) 0/1 The client name
telephone (string) 0/1 Telephone number
fax (string) 0/1 Fax number
email (string) 0/1 Email
website (string) 0/1 The client website
companyRegistrationNumber (string) 0/1 Company registration number
vatRegistrationNumber (string) 0/1 The vat registration number
paymentTermsDays (int) 0/1 Default payment term days for a client
contacts (contacts) 0/1 A collection of contact elements
billingAddress (address) 0/1 The billing address for this client
shipToAddress (address) 0/1 The address to ship to for this client
note (string) 0/1 A brief note for this client

JSON

property type description
clientId long ID
resourceUrl string Returns the API uri to call this element again
defaultCurrency string The three digit country code, e.g. GBP
name name (string) The client name
telephone telephone (string) Telephone number
fax fax (string) Fax number
email email (string) Email
website website (string) The client website
companyRegistrationNumber companyRegistrationNumber (string) Company registration number
vatRegistrationNumber vatRegistrationNumber (string) The vat registration number
paymentTermsDays paymentTermsDays (int) Default payment term days for a client
contacts contacts (contacts) A collection of contact elements
billingAddress billingAddress (address) The billing address for this client
shipToAddress shipToAddress (address) The address to ship to for this client
note note (string) A brief note for this client