http://www.FatTail.com/api
Order Complex Type
http://www.FatTail.com/api : Order Complex Type
Description
Contains all information for an order or proposal.
Namespace http://www.FatTail.com/api
Base Type
Extension of AdBookConnectEntity Complex Type
Overview
Order Extension of AdBookConnectEntity Complex Type
Contains all information for an order or proposal.
Sequence
AgencyCommission optional xs:int

Agency commission to use when calculating net and gross price and cost for orders that are billed to an agency.

Starting from version 36, please refer to Appendix D for additional details and changes regarding commission handling.

AgencyContactID optional xs:long
Agency contact ID for use when assigning an agency contact to an order.
AgencyID optional xs:long
Agency ID assigned to the order.
BillTo BillTo Simple Type
Indicates whether the client or agency will be billed for the order.
BillTypeName BillType Simple Type
Indicates if price/cost should be displayed as net or gross values.
BillingComments optional xs:string
This is a free form text field to save notes on an order.
BillingContactID optional xs:long
The contact ID for the client or agency who takes care of billing issues.
BillingModel BillingModel Simple Type
Default revenue calculation method for all drops on the order.
ClientContactID optional xs:long
System ID of the client contact associated with the order.
ClientID xs:long
ID of the client the order is created for.
CurrencyID xs:long
ID associated with a currency.
EstimateNumber optional xs:string
Publisher specified estimate number.
ExternalID optional xs:string
Third party system ID used to map external entities to AdBook orders.
InvoiceNumber optional xs:string
User defined value used for mapping to invoicing system.
MaterialsContactID optional xs:long
Contact ID for the materials contact at the client/agency assigned to an order.
OrderConfigurationID optional xs:long
System ID for the configuration used to define the fields and validation rules for the order.
OrderID optional xs:long
System ID of the order.
OrderName xs:string
Text descriptor for the order.
OrderRepList ArrayOfOrderRep Complex Type
Collection of OrderRep objects for the order.
Sequence
OrderRep 0..∞ OrderRep Complex Type
Sequence
RepContactId xs:long
System ID of the order rep.
RepSplit optional xs:double
Percentage of the order commission for the rep.
RepTypeId xs:long
System ID for the configured rep group.
OrderStatusID xs:long
System ID for the order status.
PONumber optional xs:string
User defined text field for PO identifier.
RateCardNameID optional xs:long
System ID of the configured rate card name being used as the default on an order.
ThirdPartyAdServerID optional xs:long
System ID for the default ThirdPartyAdServer to use for drops on the order.
OrderDynamicProperties optional ArrayOfDynamicPropertyValue Complex Type
Collection of values for custom fields configured at the order level for your organization.
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.
IONumber optional xs:string
User defined text for IO number.
OrderNotes optional xs:string
User notes associated with the order.
InternalOrderNotes optional xs:string
Notes that are not included on the PDF version of the order.
OrderManagerRepTypeIdList optional ArrayOflong Complex Type
Collection of RepTypeIDs when access to the order is restricted by campaign managers.
Sequence
long 0..∞ xs:long
StartDate optional xs:dateTime
The start date for the Order, based on the minimum start date of the Drops on the order.
EndDate optional xs:dateTime
The end date for the Order, based on the maximum start date of the Drops on the order.
ReadonlyProperties optional ArrayOfReadonlyPropertyValue Complex Type
Sequence
ReadonlyPropertyValue 0..∞ ReadonlyPropertyValue Complex Type
Sequence
PropertyName optional xs:string
Value optional xs:string
Used By
Order Element
Order Element
GetOrderResult Element
order Element
order Element
CreateOrderResult Element
Source
<xs:complexType name="Order" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexContent mixed="false">
    <xs:extension xmlns:q225="http://www.FatTail.com/api" base="q225:AdBookConnectEntity">
      <xs:sequence>
        <xs:element minOccurs="0" name="AgencyCommission" nillable="true" type="xs:int">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;Agency commission to use when calculating net and gross price and cost for orders that are billed to an agency.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="AgencyContactID" type="xs:long">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;Agency contact ID for use when assigning an agency contact to an order.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="AgencyID" type="xs:long">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;Agency ID assigned to the order.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="BillTo" type="q225:BillTo">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;Indicates whether the client or agency will be billed for the order.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="BillTypeName" type="q225:BillType">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;Indicates if price/cost should be displayed as net or gross values.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="BillingComments" nillable="true" type="xs:string">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;This is a free form text field to save notes on an order.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="BillingContactID" type="xs:long">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;The contact ID for the client or agency who takes care of billing issues.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="BillingModel" type="q225:BillingModel">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;Default revenue calculation method for all drops on the order.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="ClientContactID" type="xs:long">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;System ID of the client contact associated with the order.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="ClientID" type="xs:long">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;ID of the client the order is created for.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="CurrencyID" type="xs:long">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;ID associated with a currency.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="EstimateNumber" nillable="true" type="xs:string">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;Publisher specified estimate number.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="ExternalID" nillable="true" type="xs:string">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;Third party system ID used to map external entities to AdBook orders.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="InvoiceNumber" nillable="true" type="xs:string">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;User defined value used for mapping to invoicing system.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="MaterialsContactID" type="xs:long">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;Contact ID for the materials contact at the client/agency assigned to an order.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="OrderConfigurationID" type="xs:long" />
        <xs:element minOccurs="0" name="OrderID" type="xs:long">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;Identity ID of the order.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="OrderName" nillable="true" type="xs:string">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;Text descriptor for the order.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="OrderRepList" nillable="true" type="q225:ArrayOfOrderRep">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;Collection of OrderRep objects for the order.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="OrderStatusID" type="xs:long">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;System ID for the order status.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="PONumber" nillable="true" type="xs:string">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;User defined text field for PO identifier.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="RateCardNameID" type="xs:long">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;System ID of the configured rate card name being used as the default on an order.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="ThirdPartyAdServerID" type="xs:long">
          <xs:annotation>
            <xs:appinfo />
            <xs:documentation>&lt;summary&gt;System ID for the default ThirdPartyAdServer to use for drops on the order.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="OrderDynamicProperties" nillable="true" type="q225:ArrayOfDynamicPropertyValue">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
            </xs:appinfo>
            <xs:documentation>&lt;summary&gt;Collection of values for custom fields configured at the order level for your organization.&lt;/summary&gt;</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element minOccurs="0" name="IONumber" nillable="true" type="xs:string">
          <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="OrderNotes" nillable="true" type="xs:string">
          <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="InternalOrderNotes" nillable="true" type="xs:string">
          <xs:annotation>
            <xs:appinfo>
              <DefaultValue EmitDefaultValue="false" xmlns="http://schemas.microsoft.com/2003/10/Serialization/" />
            </xs:appinfo>
          </xs:annotation>
        </xs:element>
        <xs:element xmlns:q23="http://schemas.microsoft.com/2003/10/Serialization/Arrays" minOccurs="0" name="OrderManagerRepTypeIdList" nillable="true" type="q23:ArrayOflong">
          <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="StartDate" type="xs:dateTime">
          <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="EndDate" type="xs:dateTime">
          <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="ReadonlyProperties" nillable="true" type="q225:ArrayOfReadonlyPropertyValue">
          <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>
See Also
http://www.FatTail.com/api

 

 

FatTail, Inc. © 2024 All Rights Reserved.

Send comments on this topic.