Client Complex Type

Description

Client information.

Namespace

http://www.FatTail.com/api

Base Type

Extension of Account Complex Type

Overview

Client Extension of Account Complex Type

Client information.

Sequence

Address optional xs:string

Number and street.

City optional xs:string

City element of the address.

Country optional xs:string

Country element of the address.

ExternalID optional xs:string

Third party system ID used for mapping external entities to AdBook clients and agencies.

Fax optional xs:string

Fax number for the client or agency.

Name xs:string

Name of the account entity.

Notes optional xs:string

Free form text field assigned to the account.

Phone optional xs:string

Phone number of the account.

PostalCode optional xs:string

Postal code for the account address.

State optional xs:string

State the account resides in.

URL optional xs:string

URL for the account.

CRMID optional xs:string

Mapping ID for a CRM entity if the Client is associated with an entity in a CRM system.

IsCreditRisk optional xs:boolean

Flag to indicate credit status of the Client.

ReadonlyProperties optional ArrayOfReadonlyPropertyValue Complex Type

Sequence

ReadonlyPropertyValue 0..∞ ReadonlyPropertyValue Complex Type

Sequence

PropertyName optional xs:string

Value optional xs:string

ClientID optional xs:long

Primary key of the Client object.

CustomerCode optional xs:string

Third party system ID. Usually used for mapping a Client to the appropriate entity in a billing/invoicing system.

ParentClientID optional xs:long

Reference to the parent company of the Client. This will be the ClientID of another Client.

ClientDynamicProperties optional ArrayOfDynamicPropertyValue Complex Type

User defined properties for the Client.

Sequence

DynamicPropertyValue 0..∞ DynamicPropertyValue Complex Type

Sequence

DynamicPropertyID optional xs:long

AdBook system ID for the DynamicProperty.

Value optional xs:string

Value being assigned to the dynamic property. The format of the value depends on the type specified in the DynamicProperty definition.

Used By

Client Element
Client Element
client Element
CreateClientResult Element
GetClientResult Element
client Element

Source

<xs:complexType name="Client" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension xmlns:q201="http://www.FatTail.com/api" base="q201:Account">
      <xs:sequence>
        <xs:element minOccurs="0" name="ClientID" type="xs:long">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;Primary key of the Client object.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="CustomerCode" nillable="true" type="xs:string">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
            </xs:appinfo>
            <xs:documentation>&lt;summary&gt;Third party system ID.  Usually used for mapping a Client to the appropriate entity in a billing/invoicing system.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="ParentClientID" nillable="true" type="xs:long">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="ClientDynamicProperties" nillable="true" type="q201:ArrayOfDynamicPropertyValue">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>