Schema / Quote Pro Data Relationships

 

This document complements the Eqt3Schema.xsd and Cust3Schema.xsd schemas that define the data standard for interchange of equipment and customer data. 

 

When it comes to data types, especially for text fields, the schemas place minimal restrictions on lengths.  The reason for this is to gain maximum acceptance of the tags, their names and their meanings.  A more rigorous schema to match a particular database implementation can be derived from these high level schemas.

 

Unless otherwise specified, elements should be considered as optional. All date data types are expressed in UTC format as YYYY-MM-DD.

 

Note that exact spelling, including case, is important in expressing the schema tags.

 

Eqt3Schema.xsd

 

Eqt3Schema tag

Data Type

Description / Notes

 

Adjust_FP_For

int

0=for hours, 1=for options, 3=both

 

AdvOptions

string

MaxLength=80.  Advertise options.  Provides a list of options that are to appear when displaying or reporting equipment information in advertisements.

 

Advertise

string

Semi-colon delimited field that lists the listing services on which this unit is advertised.

 

Amount

decimal

This is the dollar amount in the Work_order element.

 

AmtOver

decimal

(not used)

 

Amt_Accs

decimal

Dollar amount of accessories

 

Amt_Appraised

decimal

Dollar amount of current appraisal

 

Amt_Base_Over

decimal

Dollar amount of dealer override of TradeGuide cash value

 

Amt_Cost

decimal

Invoice cost plus all ‘other costs’ (eg. Delivery, warranty, freight, etc), less programs.

 

Amt_Delivery

decimal

Dollar amount of delivery charge.

 

Amt_Floor_Plan

decimal

Dollar amount of floor plan.

 

Amt_Freight

decimal

Dollar amount of freight charge.

 

Amt_Hours_over

decimal

Dollar amount of dealer override on hours adjust

 

Amt_Invoice

decimal

Dollar amount of total of extended cost of all equipment codes.

 

Amt_List

decimal

Dollar amount of retail total.

 

Amt_Misc

decimal

Dollar amount of miscellaneous costs of equipment.

 

Amt_Option_Over

decimal

Dollar amont of dealer override amount of all options.

 

Amt_PDI

decimal

Dollar amount of total setup and PDI costs, or total of all workorders if there are any workorders.

 

Amt_RetailAccs

decimal

Retail dollar amount of accessories (margin applied to cost)

 

Amt_RetailDelivery

decimal

Retail dollar amount of delivery (margin applied to cost)

 

Amt_RetailFreight

decimal

Retail dollar amount of freight (margin applied to cost)

 

Amt_RetailMisc

decimal

Retail dollar amount of miscellaneous costs (margin applied to cost)

 

Amt_RetailPDI

decimal

Retail dollar amount of PDI (margin applied to cost)

 

Amt_RetailWarranty

decimal

Retail dollar amount of warranty (margin applied to cost)

 

Amt_Warranty

decimal

Dollar amount of warranty

 

Amt_Work_Order

decimal

(not used)

 

Amt_fp_over

decimal

Dollar amount of dealer override amount of floor plan

 

Amt_saleable_over

decimal

Dollar amount of dealer override of saleability total of appraisal.

 

AppraisalImage

int

0 if normal customer equipment, appraisal number if image associated with traded unit appraisal.

 

Appraisal_No

int

Current appraisal number of appraisal associated with this equipment.  Also used to uniquely identify appraisals associated with equipment.

 

AppraiseOn

int

(not used)

 

Attach_No

string

Maxlength=15.  Attachment description for equipment code (information only).

 

AttachToEmail

boolean

Flag image to be attached to email.

 

AuthorityType

string

(not used)

 

BasedOrder

int

Index that determines ordering of programs

 

Business_Dealer_No

string

Dealer number of external business system.

 

Business_Description

string

Equipment description of external business system.

 

Business_Tag

string

Equipment identifier of external business system.

 

Business_Make

string

EquipmentMake has a MaxLength=5.  Business_Make is the make code associated with the external business system.  If the standard <Make> is not available, the Business_Make is used on the target application to cross-reference to the standard Make code using a lookup table.

 

Business_Type

string

EquipmentType has a MaxLength=5.  See notes for Business_Make.

 

Cash_Price

decimal

Dollar amount of resale cash price.

 

Cash_Value

decimal

Cash amount of equipment code item.

 

Cash_Value_Can

decimal

Cash amount of equipment code item in Canadian dollars.

 

Cash_Value_US

decimal

Cash amount of equipment code item in US dollars.

 

Category

string

MaxLength=50.  The schema tag was originally set up to accommodate the UsedXpress Category code to track equipment types.

 

Charge_Type

string

MaxLength=2.  This tag belongs to the <Work_order> element and has values such as WO, TA (Trade Allowance), RE (Rental).

 

City

string

MaxLength=50.  The city of the equipment.

 

Code

string

MaxLength=15.  This tag identifies records in the <EqtCode> element.  Schema uses <EqtCode> child elements of <Equipment> for attachments.

 

Code_Order

float

Identifier for equipment codes.  Code_Order values are grouped within Group_Order.

 

Comments

string

Comments associated with equipment code item.

 

CommentsOnQuote

boolean

Flag indicating whether comments should appear on quote when printed.

 

Condition

int

Values from 0-10.  0 means unknown condition, 1=poorest condition, 10=best condition

 

ConditionAdjust

decimal

Dollar amount of adjustment on appraised amount based on condition.

 

ConditionComments

string

MaxLength=100.  Comments related to the condition.

 

Config_No

int

Configuration number for equipment code (information only).

 

ContactCity

string

The city of the contact of the equipment

 

ContactCountry

string

The country name of the contact of the equipment

 

ContactContryCode

string

The country code of the contact of the equipment

 

ContactEmail

string

The email of the contact of the equipment

 

ContactFax

string

The fax of the contact of the equipment

 

ContactName

string

The name of the contact of the equipment

 

ContactPhone

string

The phone number of the contact of the equipment

 

ContactState

string

The state of the contact of the equipment

 

ContactWebSite

string

The web site of the contact of the equipment

 

Cost

decimal

This is the cost of items in <EqtCodes>

 

CostComments

string

MaxLength=50.  Additional comments on Other Costs dialog.

 

Country

string

MaxLength=50  Country location of the equipment.

 

CountryCode

string

MaxLength=3  Country code of equipment location.

 

CustID

string

MaxLength=10  Customer ID of equipment if part of customer equipment.

 

Date

date

This is the date of the <Work_Order> element.

 

DateRecorded

dateTime

Date that the image is recorded (same date on listing service)

 

DateStamp

dateTime

The <DateStamp> tag is used by a number of elements to indicate the date of the last change.

 

DateStampISLocal

dateTime

Local datestamp of when item was uploaded to listing service

 

DateStampUEDLocal

dateTime

Local datestamp of when item was uploaded to UsedXpress listing service

 

DateStampFCTLocal

dateTime

Local datestamp of when item was uploaded to FCT listing service

 

Date_Added

date

Date equipment added to inventory.

 

Date_Appraised

date

Refers to the <Equipment> element.  Date when the associated current appraisal was created.

 

Date_End

date

Expiry date of associated program.

 

Date_Ordered

date

Date when equipment was ordered.

 

Date_Priced

date

Date when equipment was priced.

 

Date_Purchased

date

Date when equipment was purchased.

 

Date_Recd

date

Date when equipment was received.

 

Date_Sold

date

Date when equipment was sold.

 

Date_Wants_Sell

date

Date by when equipment is desired to be sold.

 

Date_WarrantyEnd

date

Date of end of warranty for equipment.

 

Date_WarrantyStart

date

Date of start of warranty for equipment.

 

DealerNotes

string

Confidential dealer notes for equipment.

 

DealerFactor

int

Percentage factor applied to TradeGuide values for appraisal to arrive at dealer totals.

 

Dealer_No

string

MaxLength=10  Dealer index number

 

Dealership

string

MaxLength=100.  Dealership name

 

DefaultAmount

decimal

(not used)

 

DefaultGMPer

decimal

Default calculated gross margin for this equipment based on cost amount.

 

Description

string

Schema needs to differentiate the description for Equipment, Appraisal and Work_Order.

 

Dlr_Line

string

MaxLength=5.  Main dealer line of dealer (not used)

 

Email

string

Email address to be used to send information about the equipment.

 

EqtClass

string

List of classes this equipment belongs to, separated by semi-colons.

 

ExDescription

string

MaxLength=30.  Detail description of exchange.

 

ExID

string

Unique index of exchange record.

 

ExInvoice

float

Stored currency of exchange invoice.

 

ExRate

float

Exchange rate

 

ExSale

decimal

Displayed currency of exchange amount.

 

ExStartDate

date

Start date of currency exchange, 0 if none specified

 

Expiry

date

Part of AuthorityType (not used)

 

Extended_Cost

decimal

Cost amount of equipment code times quantity.

 

Extended_List

decimal

List amount of equipment code times quantity.

 

FirstName

string

MaxLength=20  First name of person for whom appraisal is done.

 

FP_On_Value

int

Index value indicating choice of TradeGuide maximum floor plan.  0=Wholesale 1=Trade Rough 2=Trade Premium

 

FPFactor

int

Dealer preference percentage factor to be applied to adjust floor plan amount.

 

FixedUserDefSalePrice

decimal

Dollar amount to be used when calculating taxes instead of retail amount.

 

GMFreeze

int

Determines mode of calculating gross margin in appraisal  0=freeze percentage 1=freeze dollar amount

 

Group_Order

float

Identifier for equipment codes.  Code_Order values are grouped within Group_Order.

 

History

boolean

True if historical equipment.

 

Hours_Adjust

decimal

Dollar amount of default TradeGuide hours adjustment or default Dealer hours adjustment, based on choice specified in Hour_Adjust_Use.

 

Hour_Adjust_Use

int

Choice of default hours adjustment  0=TradeGuide  1=Dealer

 

Hrs_PDI

float

Total PDI hours of equipment codes.

 

IW_NO

integer

Index number for IRON Search listings

 

Equip_ID

integer

Index number for UsedXpress listings

 

FCTIW_NO

integer

Index number for FCT listings

 

Image

base64Binary

The base64 representative of an image associated with this equipment in order to be able to transmit the image itself as part of the XML.

 

ImageURL

anyURI

A URL referencing an image associated with this equipment.

 

Image_No

int

Unique image number associated with an image of the equipment.

 

ImageCt

int

Count of images associated with equipment.

 

In_Base

int

0=not in base  1,-1=In Base  2=TBA  3=Included  4=Standard

 

In_Invoice

boolean

Yes if Amount is included in Invoice.

 

In_Retail

boolean

Yes if Amount is included in Retail (advertised) price.

 

IncludeInReports

boolean

True if image is to be included in reports.

 

ListingImageID

string

MaxLength=32.  Unique identifier of image on listing service.

 

Issue

string

Guide issue for reporting sales (not used)

 

LastName

string

MaxLength=20.  Last name of person for whom appraisal is done

 

List

decimal

Dollar amount of list for equipment code item, single quantity.

 

Location

string

MaxLength=25.  Where the equipment is located now.

 

Make

string

MaxLength=5.  Standard Make code for this equipment.

 

MaxRepairs

decimal

Maximum amount to allow for repairs and reconditioning of equipment.

 

Meter_Reading

float

Primary meter reading for equipment, based on Meter_Type.

 

Meter_Reading2

float

Secondary meter reading for equipment, based on Meter_Type2.

 

Meter_Type

string

MaxLength=10.  Primary meter type for equipment.

 

Meter_Type2

string

MaxLength=10.  Secondary meter type for equipment.

 

MinRepairs

decimal

Minimum amount to allow for repairs and reconditioning of equipment.

 

Model

string

MaxLength=20.  Model code used for equipment.

 

Model_Key

integer

Reference to unique TradeGuide model identifier

 

New

string

MaxLength=1.  Values N or U

 

Notes

string

Typically used to list all options, separated by commas.

 

OptionList

string

MaxLength=100.  List of options for equipment, typically used in communicating this information with listing services.

 

       
       
       

Option_Val

decimal

Total dollar amount of the value of all options for used equipment.

 

Order_Number

string

MaxLength=10.  **This refers to WO Order Number.

 

OtherCostLabel1

string

MaxLength=16.  User-specified label for first other cost.

 

OtherCostLabel2

string

MaxLength=16.  User-specified label for second other cost

 

OverAllowance

decimal

Dollar amount of slack in trade discount.

 

PAAmount

decimal

Amount of price adjust

 

PADescription

string

Detail description of price adjustment.

 

PAEffectiveDate

date

Effective Start Date for Price Adjustment

 

PAID

string

MaxLength=10.  Reference ID of Price Adjustment record.

 

PAPercent

float

Percentage of price adjust

 

PARetail

decimal

Flat retail amount

 

PASelect

int

Select 0-2 of 0 (Percentage of price adjust), 1 (amount of price adjust), or 2 (flat retail amount of price adjust).

 

PBBEffectiveDate

date

Date for which prices are effective in PBB.

 

Percent_Program

float

Percentage amount to be used by program.

 

Percent_Trade_GM_Over

float

Gross Profit (Margin) amount.

 

Prev_Owner

string

MaxLength=53.  Name of previous owner of equipment              

 

Price_Notes

string

Description of equipment as it is to appear on advertising reports.

 

PrintFlag

boolean

Include this program on report.

 

PrivateNotes

string

Pricing notes (i.e. OBO, cash only, etc.)

 

Program_Desc

string

MaxLength=30  Description of program.

 

Program_ID

string

MaxLength=10  Unique identifier of program.

 

Program_Total

decimal

Dollar amount of program.

 

Prov_State

string

MaxLength=2.  Province or state code of equipment.

 

Publish_Year

int

Year when equipment is published in the TradeGuide (not used)

 

Qty

int

Refers to the <EqtCode> element.  Quantity of an equipment code item.

 

Quote_no

int

Quote number assigned to a quote.  Note that these values do not have to be unique for all quotes for a customer, but typically they are unique per account manager.

 

Rate

decimal

(not used)

 

Reconditioning

decimal

Override repairs, sum of repairs

 

Region

string

MaxLength=1 Values: A-G N,I,O,S

 

RentalRate0

decimal

Note that suffixes are staggered (0,1,2,3).  Hourly rental rate.

 

RentalRate1

decimal

(see above) Daily rental rate.

 

RentalRate2

decimal

(see above) Weekly rental rate.

 

RentalRate3

decimal

(see above) Monthly rental rate.

 

Repairs

string

Tuples of section/component/cost/comment for reconditioning estimates for appraisals.

 

RetailMargin

decimal

List margin applied to cost.

 

SalePriceOption

int

Determines the basis on which tax is calculated  0=retail price  1=user defined (see FixedUserDefSalePrice)

 

SaleType

string

MaxLength=1.  Used to indicate type of sale when equipment is sold.      0=NOTRADE  1=WITHTRADE  2=AUCTION  3=WHOLESALE

Saleability

int

Total saleability amount in appraisal.

Sales_Rep

string

MaxLength=20.  Account Manager associated with piece of equipment or quote or customer.

Section

string

(not used)

 

SendToIRONSearch

boolean

Image flagged to 'send to any(all) listing service(s)'

 

Serial_Label0

string

MaxLength=16.  Label of associated serial number.

 

Serial_Label1

string

MaxLength=16.  Label of associated serial number.

 

Serial_Label2

string

MaxLength=16.  Label of associated serial number.

 

Serial_Label3

string

MaxLength=16.  Label of associated serial number.

 

Serial_No0

string

MaxLength=20. First serial number.

 

Serial_No1

string

MaxLength=20. Second serial number.

 

Serial_No2

string

MaxLength=20. Third serial number.

 

Serial_No3

string

MaxLength=20. Fourth serial number.

 

Size

float

Machine size, based on units specified by SizeUnits.

 

SizeUnits

string

MaxLength=12.  Unit of measurement used to specify machine size.

 

SoldAs

string

Same as SaleType, except expressed as a full text string.

 

Sold_Price

decimal

Dollar amount of sale.

 

StarCost

boolean

If we are in Canada, and US pricing applies, then this item is priced in Canadian funds.

 

State

string

MaxLength=2

 

Status

string

MaxLength=10

 

Stock_No

string

MaxLength=12

 

StoreLocation

int

Numerical identifier for the store location of this equipment.

 

SubCategory

string

MaxLength=50.  This schema tag was originally included to accommodate the identification of equipment types from UsedXpress, together with the Category tag.

 

Support

string

(not used)

 

Tax_Exists0

boolean

Whether Federal / GST Tax 1 is used

 

Tax_Exists1

boolean

Whether Federal / GST Tax 2 is used

 

Tax_Exists2

boolean

Whether State / Prov Tax 1 is used

 

Tax_Exists3

boolean

Whether State / Prov Tax 2 is used

 

Tax_Rate0

decimal

Federal / GST Tax 1

 

Tax_Rate1

decimal

Federal / GST Tax 2

 

Tax_Rate2

decimal

State / Prov Tax 1

 

Tax_Rate3

decimal

State / Prov Tax 2

 

TotalOptionAdjust

decimal

(not used)

 

Total_User

decimal

Fixed dollar amount of program specified by user

 

Trade_GM_Over

decimal

Actual gross margin dollar amount.

 

Type

string

MaxLength=5.  Standard equipment Type code.

 

USExchange

decimal

Actual rate selected.

 

USExchangeAmt

decimal

US exchange amount.

 

USExchangeIndex

float

Index to identify whether CA (0), CPA (1) or other (2) applies.

 

Unit_No

int

Unique identifier of equipment belonging to customer.

 

Unit_Origin

string

Code indicating source of quoted unit  C-Customer equipment  Q-Other quoted unit  P-price book  M-Manual  S-Inventory

 

Updated_By

string

MaxLength=20.  (not used)

 

UseRepairMinMax

boolean

True if user-specified minimum and maximum limits to reconditioning apply.

 

UserDefined

string

Tag available for user-defined purposes.

 

Username

string

Username of user making any changes to equipment record.

 

Verify

boolean

Belongs to equipment code.  (not used)

 

Wants_Sell

boolean

True if the owner of equipment wants to sell the item.

 

Weight_KG

float

Weight in kilograms of item.

 

Weight_LB

float

Weight in pounds of item.

 

WholeSalePrice

decimal

Auction value of equipment.

 

Year

int

Year when equipment was new.