The EqtSchema describes entities associated with the inventory, advertising and sale of agricultural equipment. Entities associated with Equipment include the TGOption, EqtProgram, Work_Order, EqtImage, EqtCode, and Appraisal. Entities associated with Appraisal include the TGOption. An Action attribute associated or implied with each entity describes how the entity is to be processed by the receiving system.
IRON Solutions Inc..
Box 910, Outlook, Saskatchewan, Canada S0L 2N0
admin@ironsolutions.com
IRON Solutions Inc. - author of schema and primary contact
admin@ironsolutions.com
General use for identification and description of Equipment entities and basic operations such as Add, Modify, Delete, and Sell.
The EqtSchema has been created in order to support data interchange between software from business vendors of equipment dealerships and the various products of IRON Solutions, including IRON Manager™, IRON QuotePro™, IRON Appraiser™, IRON Search™, and IRON Web™. Any limitations resulting from this intended purpose are identified in the Technical Information and Field Data section below.
Unless otherwise specified, elements should be considered as optional. All date data types are expressed as CCYYMMDD.
| Field Name | Elem/Attr | Data Type | Usage | Description |
|---|---|---|---|---|
| Equipment | Element | Equipment information | ||
| Action | attribute | string | Used by the Business Vendor XML Interface (BVX) to direct the activity of the element against IRON Search. | values="D A M MA P S" D=Delete A=Add M=Modify MA=Modify if it exists; else Add P=Position S=Sold. 'P' is used typically in situations where Action=P for the Equipment node and Action for some child node of Equipment is NOT P. If the action is not specified, MA is the generally accepted default value. |
| Stock_No | element | string | Posted to IRON Search by BVX | Stock number used to identify equipment. This, in conjunction with the dealer_no, guarantees uniqueness of the equipment records. The maximum length is 12 characters. |
| Status | element | string | Not used by BVX; IRON Manager uses this field to differentiate between My Inventory and 'Virtual' inventory. | Values for Status are largely user-defined, but there are some standard frequently used values, such as SOLD and INVENTORY. Length should be limited to 10 characters. |
| Dealer_No | element | string | Posted to IRON Search by BVX | The Dealer_No, together with the Stock_No, guarantees the uniqueness of the Equipment record. The Dealer_No should be limited to 10 characters. This dealer number is the value associated with the equipment record on the target system. |
| Dealership | element | string | Posted to IRON Search by BVX | The dealer name of the Dealer_No. The Dealership is limited to 100 characters. |
| Region | element | string | Posted to IRON Search by BVX | The region of the Dealer_No, described as a one letter code of the NAEDA regions (A, B, C, D, E, F or G). |
| Dlr_Line | element | string | Posted to IRON Search by BVX | The main vendor line of the dealer. This is a code of up to five characters drawn from the standard Make codes. |
| Prov_State | element | string | Posted to IRON Search by BVX | The province or state of the dealer, expressed as a two character code. |
| SaleType | element | string | Posted to IRON Search by BVX | SaleType is a coded value indicating the type of sale, assuming that the Action of the associated equipment if 'Sold'. The type of sale can be Dealer (0), Wholesale/Auction (1), or Retail/Advertised (2). |
| Business_Dealer_No | element | string | Not used by BVX | The Business_Dealer_No field is provided to allow a cross-reference dealer number from a business system vendor, the source system, to be identified. There is no restriction on the length. |
| IW_NO | element | integer | Posted to IRON Search by BVX | The IW_NO is a number identifying the equipment on IRON Search. Unless the target system is ,IRON Search this value is optional. |
| Type | element | string | Posted to IRON Search by BVX | The Type identifies the type of equipment, such as Tractor, Combine, Round Baler, etc. The Type has a maximum length of 5 characters. This field should be considered a required field. IRON Solutions provides a standard table of Type codes that are all five characters in length. This table is available on www.ironsolutions.com/xml. |
| Business_Type | element | string | Used to determine the Type code using a cross-reference table. | The Business_Type is provided to allow a cross-reference Type code from a business system vendor, the source system, to be identified. There is no restriction on the length. |
| Make | element | string | Posted to IRON Search by BVX | The Make identifies the manufacturer of equipment, such as Kubota, John Deere, New Holland, etc. The Make has a maximum length of 5 characters. This field should be considered a required field. IRON Solutions provides a standard table of Make codes that are all five characters in length. This table is available on www.ironsolutions.com/xml. |
| Business_Make | element | string | Used to determine the Make code using a cross-reference table. | The Business_Make is provided to allow a cross-reference Make code from a business system vendor, the source system, to be identified. There is no restriction on the length. |
| Category | element | string | Not used by BVX | The Category tag is provided to allow a vendor to describe the category of the equipment. A Category example might be 'Asphalt' or 'Attachment'. The use of the field is application dependent. The maximum length of the field is 50 characters. |
| SubCategory | element | string | Not used by BVX | The SubCategory tag is provided to allow a vendor to describe the sub-category of the equipment. A SubCategory example might be 'Patcher' within the 'Asphalt' Category, or 'Boom' within the 'Aerial Work Platform' Category. The use of the field is application dependent. The maximum length of the field is 50 characters. |
| Model | element | string | Posted to IRON Search by BVX | The Model identifies the model of equipment, such as 9600, 600A, TR-97, etc. The Model has a maximum length of 20 characters. This field should be considered a required field. |
| Size | element | real | Posted to IRON Search by BVX | The Size, together with SizeUnits, indicates the size of some component of the equipment. The Size has the numeric value, and SizeUnits identifies the unit of measurement, such as HP, FT, METERS, INCH. |
| SizeUnits | element | string | Posted to IRON Search by BVX | Refer to the description for Size. The maximum length is 12 characters. |
| Year | element | integer | Posted to IRON Search by BVX | This is the year of the equipment if known. Generally expressed as a four digit numeric value, but in general the receiving system should be intelligent enough to correctly interpret a two digit numeric value. |
| Location | element | string | Posted to IRON Search by BVX | This is the location of the equipment if known. Maximum length is 25 characters. |
| Meter_Reading | element | real | Posted to IRON Search by BVX | Meter_Reading is the most important numeric odometer reading of the equipment. In most cases for equipment, this refers to the engine hours. For combines separator hours may be more typical. |
| Meter_Type | element | string | Posted to IRON Search by BVX | This is the type of meter reading given in the previous element. Maximum length is 5 characters. Typical values are EngHr and SepHr. |
| Meter_Reading2 | element | real | Posted to IRON Search by BVX | Meter_Reading2 is a second meter reading value for the equipment. |
| Meter_Type2 | element | string | Posted to IRON Search by BVX | This is a second meter type of meter reading given in the previous element. Maximum length is 5 characters. |
| Prev_Owner | element | string | Not used by BVX | Prev_Owner is a free-format field that describes the previous owner of the equipment. Maximum length is 53 characters. |
| Date_Purchased | element | date | Not used by BVX | Date_Purchased describes when the equipment was purchased. |
| Amt_Floor_Plan | element | currency | Not used by BVX | Amt_Floor_Plan describes the amount of floor plan for the equipment. |
| Amt_Invoice | element | currency | Not used by BVX | Amt_Invoice describes the invoice amount of the equipment. |
| Amt_Freight | element | currency | Not used by BVX | Amt_Freight describes the amount of freight associated with the equipment. |
| Amt_Delivery | element | currency | Not used by BVX | Amt_Delivery describes the amount of delivery associated with the equipment. |
| Amt_PDI | element | currency | Not used by BVX | Amt_PDI describes the amount of PDI associated with the equipment. |
| Amt_Misc | element | currency | Not used by BVX | Amt_Misc describes the amount of miscellaneous costs associated with the equipment. |
| Amt_Accs | element | currency | Not used by BVX | Amt_Accs describes the amount of accessory costs associated with the equipment. |
| Amt_Warranty | element | currency | Not used by BVX | Amt_Warranty describes the amount of warranty costs associated with the equipment. |
| Amt_RetailFreight | element | currency | Not used by BVX | Amt_RetailFreight describes the amount of freight costs plus retail margin if applicable associated with the equipment. |
| Amt_RetailDelivery | element | currency | Not used by BVX | Amt_RetailDelivery describes the amount of delivery costs plus retail margin if applicable associated with the equipment. |
| Amt_RetailPDI | element | currency | Not used by BVX | Amt_RetailPDI describes the amount of PDI costs plus retail margin if applicable associated with the equipment. |
| Amt_RetailMisc | element | currency | Not used by BVX | Amt_RetailMisc describes the amount of miscellaneous costs plus retail margin if applicable associated with the equipment. |
| Amt_RetailAccs | element | currency | Not used by BVX | Amt_RetailAccs describes the amount of accessory costs plus retail margin if applicable associated with the equipment. |
| Amt_RetailWarranty | element | currency | Not used by BVX | Amt_RetailWarranty describes the amount of warranty costs plus retail margin if applicable associated with the equipment. |
| Amt_Cost | element | currency | Posted to IRON Search by BVX | Amt_Cost describes the basic wholesale cost of the equipment. |
| Amt_List | element | currency | Posted to IRON Search by BVX | Amt_List describes the retail price of the equipment. |
| Amt_Work_Order | element | currency | Posted to IRON Search by BVX | Amt_Work_Order describes the total repair amount of the equipment. There are separate work order amounts recorded in the Work_Order element. If amounts are specified in both the Work_Order element and the Amt_Work_Order tag, the value in the Amt_Work_Order tag should be the total of the values in the Work_Order element. |
| Option_Val | element | currency | Posted to IRON Search by BVX | Option_Val describes the total option value of the equipment. There are separate option values recorded in the TGOption element. If amounts are specified in both the TGOption element and the Option_Val tag, the value in the Option_Val tag should be the total of the values in the TGOption element. |
| OptionList | element | string | Posted to IRON Search by BVX | OptionList is a comma separated list of options associated with the equipment. This list may appear in lieu of itemized options in the TGOptions element. The maximum length of this list is 100 characters. |
| Cash_Price | element | currency | Posted to IRON Search by BVX | Cash_Price describes the actual selling price of the equipment. |
| RetailMargin | element | real | Not used by BVX | RetailMargin describes the retail margin percentage of the equipment, expressed as a number between 0 and 100. |
| Amt_Appraised | element | currency | Not used by BVX | Amt_Appraised describes the appraised value of the equipment. |
| Date_Appraised | element | date | Not used by BVX | Date_Appraised is the date when the equipment was last appraised. |
| Date_Priced | element | date | Not used by BVX | Date_Priced is the date when the equipment was last priced. |
| Date_Ordered | element | date | Not used by BVX | Date_Ordered is the date when the equipment was ordered. |
| Date_Recd | element | date | Not used by BVX | Date_Recd is the date when the equipment was received. |
| Date_Sold | element | date | Posted to IRON Search by BVX | Date_Sold is the date when the equipment was sold. |
| WholeSalePrice | element | currency | Posted to IRON Search by BVX | WholeSalePrice is the auction value of the equipment. |
| Sold_Price | element | currency | Posted to IRON Search by BVX | Sold_Price describes the amount received from the sale of the equipment. |
| OverAllowance | element | currency | Not used by BVX | OverAllowance describes the additional amount allowed on trade for the sale of the equipment. |
| Date_Wants_Sell | element | date | Not used by BVX | Date_Wants_Sell describes the date by when the owner wants to sell the equipment. This element is only meaningful if the following element, Wants_Sell, is 1. |
| Wants_Sell | element | boolean | Not used by BVX | Wants_Sell has a value of 1 if the owner wishes to sell, and 0 if the equipment is not for sale. |
| Notes | element | string | Posted to IRON Search by BVX | Notes is a free-format field used to describe the equipment. The maximum length is 50 characters. The value of this element is intended to be used on price quotes and reports for public consumption. |
| AdvNotes | element | string | Not used by BVX | AdvNotes describes information related to the advertisement of the equipment. The maximum length is 64 characters. |
| DealerNotes | element | string | Posted to IRON Search by BVX | DealerNotes is a free-format field used to describe the equipment, but used more for internal purposes. There is no limit on the length. |
| New | element | string | Posted to IRON Search by BVX | New indicates whether the equipment is considered new or used. There are only two values for this element, either N or U. If not specified, the default is U. |
| Unit_Origin | element | string | Not used by BVX | Unit_Origin indicates the origin of the equipment. This is a one-character code with values of S P M C I or Q. These codes refer to S=Traded Unit P=Price book M=Manual C=Customer Equipment I=Inventory Q=Quoted Unit. If not specified, the default is M. |
| FixedUserDefSalePrice | element | integer | Not used by BVX | FixedUserDefSalePrice allows the user to enter a sale price that will be used no matter what other margin settings may exist that would otherwise offer a calculated selling price. |
| SalePriceOption | element | integer | Not used by BVX | SalePriceOption is a fixed price for a specific option. |
| PBBEffectiveDate | element | date | Not used by BVX | PBBEffectiveDate is the effective date of the prices to be drawn from the price book when assembling the equipment codes for the equipment. |
| OtherCostLabel1 | element | string | Not used by BVX | OtherCostLabel1 is a user-defined label for the miscellaneous costs associated with the equipment. The maximum length is 16 characters. |
| OtherCostLabel2 | element | string | Not used by BVX | OtherCostLabel2 is a user-defined label for the accessory costs associated with the equipment. The maximum length is 16 characters. |
| CostComments | element | string | Not used by BVX | CostComments is a free-format field used to add information about the costs associated with the equipment. The maximum length is 50 characters. |
| Price_Notes | element | string | Posted to IRON Search by BVX | Price_Notes is a free-format field used to add information about the pricing associated with the equipment. The maximum length is 50 characters. |
| ExID | element | string | Posted to IRON Search by BVX | ExID is a value identifying the exchange rate applicable to the currency amounts of the equipment. The maximum length is 10 characters. |
| ExRate | element | real | Not used by BVX | ExRate is the exchange rate applicable to the currency amounts of the equipment. |
| ExInvoice | element | currency | Not used by BVX | ExInvoice is amount of the dollar adjustment to the invoice amount of the equipment. |
| ExSale | element | currency | Not used by BVX | ExSale is amount of the dollar adjustment to the sale amount of the equipment. |
| ExStartDate | element | date | Not used by BVX | ExStartDate is the effective date of the exchange rate that applies to the currency amounts of the equipment. |
| ExDescription | element | string | Not used by BVX | ExDescription is a description of the nature of the exchange rate applicable to the currency amounts of the equipment. The maximum length is 30 characters. |
| USExchangeAmt | element | currency | Not used by BVX | USExchangeAmt is an exchange amount applicable to the currency amounts of the equipment. This is included primarily for backward compatibility. Use the Ex... elements instead to describe exchange rates and amounts. |
| PAID | element | string | Not used by BVX | PAID is a value identifying the price adjustment applicable to the currency amounts of the equipment. The maximum length is 10 characters. |
| PASelect | element | integer | Not used by BVX | Three possible price adjustments applicable are a percentage of retail, a flat amount added to retail, and a flat total retail amount. The PASelect field has values of 0, 1 or 2, respectively selecting one of these three possible adjustments. |
| PAPercent | element | real | Not used by BVX | Percentage to be applied to retail for this price adjustment. |
| PAAmount | element | currency | Not used by BVX | Fixed amount to be applied to retail for this price adjustment. |
| PARetail | element | currency | Not used by BVX | Fixed amount that represents the final desired retail amount. |
| PAEffectiveDate | element | date | Not used by BVX | Effective date of the price adjustment. |
| PADescription | element | string | Not used by BVX | A free-format description of the price adjustment. |
| StoreLocation | element | integer | Not used by BVX | Store locations are numbered sequentially. This value indicates the store location of the equipment. |
| City | attribute | string | Not used by BVX | The City identifies the city where the equipment is located. The length is limited to 50 characters. |
| State | attribute | string | Not used by BVX | The State identifies the province or state where the equipment is located. The length is limited to 2 characters. |
| Country | attribute | string | Not used by BVX | The Country identifies the full name of the country where the equipment is located. The length is limited to 50 characters. |
| CountryCode | attribute | string | Not used by BVX | The CountryCode identifies the code of the country where the equipment is located. The length is limited to 3 characters. |
| Date_WarrantyStart | element | date | Not used by BVX | The starting date of warranty on the equipment. |
| Date_WarrantyEnd | element | date | Not used by BVX | The ending date of warranty on the equipment. |
| History | element | boolean | Not used by BVX | Equipment records that have been deleted may be retained, and this field is given a value of 1 to indicate that these are historical records. The normal value for this field is 0. |
| EqtClass | element | string | Not used by BVX | Equipment units may fall into several classes, such as four-wheel drive, Class IV, etc. The maximum length of this field is unlimited, but values are delimited by the pipe character (vertical bar). |
| Advertise | element | string | Not used by BVX | The Advertise element identifies the various media outlets where this equipment is advertised. The maximum length of this field is unlimited, but values are delimited by the pipe character (vertical bar). |
| RentalRate0 | element | currency | Not used by BVX | This is the first of four elements that contain rental rates. This rate is the daily rate. |
| RentalRate1 | element | currency | Not used by BVX | This is the second of four elements that contain rental rates. This rate is the daily rate. |
| RentalRate2 | element | currency | Not used by BVX | This is the third of four elements that contain rental rates. This rate is the weekly rate. |
| RentalRate3 | element | currency | Not used by BVX | This is the fourth of four elements that contain rental rates. This rate is the monthly rate. |
| Tax_Exists0 | element | boolean | Not used by BVX | This field has a value 1 if the first tax of the first of two categories of tax exists, 0 otherwise. This usually is related to a federal tax rate. |
| Tax_Exists1 | element | boolean | Not used by BVX | This field has a value 1 if the second tax of the first category of tax exists, 0 otherwise. This usually is related to a federal tax rate. |
| Tax_Exists2 | element | boolean | Not used by BVX | This field has a value 1 if the first tax of the second of two categories of tax exists, 0 otherwise. This usually is related to a state tax rate. |
| Tax_Exists3 | element | boolean | Not used by BVX | This field has a value 1 if the second tax of the second category of tax exists, 0 otherwise. This usually is related to a state tax rate. |
| Serial_No0 | element | string | Posted to IRON Search by BVX | The Serial_No0 is the serial number of the unit. The maximum length is 20 characters. |
| Serial_No1 | element | string | Not used by BVX | The Serial_No1 is the second serial number associated with the unit. The SerialLabel0 element identifies where the serial number comes from, be it engine, transmission, etc. The maximum length is 20 characters. |
| Serial_No2 | element | string | Not used by BVX | The Serial_No2 is the third serial number associated with the unit. The SerialLabel1 element identifies where the serial number comes from, be it engine, transmission, etc. The maximum length is 20 characters. |
| Serial_No3 | element | string | Not used by BVX | The Serial_No3 is the third serial number associated with the unit. The SerialLabel2 element identifies where the serial number comes from, be it engine, transmission, etc. The maximum length is 20 characters. |
| SerialLabel0 | element | string | Not used by BVX | The SerialLabel0 element identifies where the Serial_No1 serial number comes from, be it engine, transmission, etc. The maximum length is 16 characters. |
| SerialLabel1 | element | string | Not used by BVX | The SerialLabel1 element identifies where the Serial_No2 serial number comes from, be it engine, transmission, etc. The maximum length is 16 characters. |
| SerialLabel2 | element | string | Not used by BVX | The SerialLabel2 element identifies where the Serial_No3 serial number comes from, be it engine, transmission, etc. The maximum length is 16 characters. |
| CustID | element | string | Not used by BVX | The CustID element identifies the customer associated with this equipment. The maximum length is 10 characters. |
| Sales_Rep | element | string | Not used by BVX | The Sales_Rep element identifies the sales representative associated with this equipment. The maximum length is 20 characters. |
| Quote_no | element | integer | Not used by BVX | If the equipment is participating in a quote, the Quote_no element identifies the quote number. |
| Unit_No | element | integer | Not used by BVX | If the equipment is participating in a quote, the Unit_No element identifies the relative unit number within the quote. |
| Appraisal_No | element | integer | Not used by BVX | The Appraisal_No element identifies the current appraisal associated with this equipment. |
| FirstName | element | string | Not used by BVX | In cases where the customer is not identified by CustID, the FirstName element identifies the customer's name. |
| LastName | element | string | Not used by BVX | In cases where the customer is not identified by CustID, the LastName element identifies the customer's name. |
| Appraisal | Element | Appraisal for Equipment | ||
| Saleability | element | integer | Not used by BVX | On a scale of 1 to 10, Saleability indicates the degree of saleability of the equipment. |
| Repairs | element | string | Not used by BVX | Repairs is a complex element containing the information about the cost of repairs associated with the equipment in this appraisal. |
| Amt_Base_Over | element | currency | Not used by BVX | User specified amount to override the default base resale value. |
| Amt_Option_over | element | currency | Not used by BVX | Amt_Option_over represents the user specified amount to override the default option value. |
| Hours_Adjust_Use | element | integer | Not used by BVX | There are three possible choices for evaluating the default hour adjustment value, based on the Trade Guide, based on dealer defaults, and as a user specified amount. These three choices are numbered 0, 1 and 2, and the HOurs_Adjust_Use element identifies this choice. |
| Amt_Hours_over | element | currency | Not used by BVX | Amt_Hours_over identifies the amount of the user specified amount for the hours adjustment value. |
| Amt_saleable_over | element | currency | Not used by BVX | Amt_saleable_over is the user specified amount to be applied for Saleability allowance, which covers the carry and interest cost of the unit. |
| UseRepairMinMax | element | boolean | Not used by BVX | The UseRepairMinMax element has a value of 1 if the minimum and maximum values for repairs should be applied to this appraisal, 0 otherwise. |
| MinRepairs | element | currency | Not used by BVX | MinRepairs is the minimum repair amount for this appraisal. |
| MaxRepairs | element | currency | Not used by BVX | MaxRepairsis the maximum repair amount for this appraisal. |
| Reconditioning | element | currency | Not used by BVX | Reconditioning is the value of recondition cost for this appraisal. |
| Amt_fp_over | element | currency | Not used by BVX | User specified amount to override the default floor plan amount for this appraisal. |
| Hours_Adjust | element | currency | Not used by BVX | Hours_Adjust is the actual amount of the hours adjustment value for this appraisal. |
| Condition | element | integer | Posted to IRON Search by BVX | Condition is a rating from 1 to 10 of the condition of the equipment in this appraisal. The Condition element also occurs in the Equipment itself. |
| ConditionComments | element | string | Posted to IRON Search by BVX | Comments related to the condition rating for the equipment in this appraisal. The ConditionComments element also occurs in the Equipment itself. |
| ConditionAdjust | element | currency | Not used by BVX | ConditionAdjust is the amount by which the equipment value is adjusted for condition. |
| Percent_Trade_GM_Over | element | real | Not used by BVX | This element is the user specified override percentage amount for the gross margin to be applied on this appraisal. |
| Trade_GM_Over | element | currency | Not used by BVX | This element is the actual value of the gross margin applied on this appraisal. |
| Adjust_FP_For | element | integer | Not used by BVX | The appraisal floor plan can be adjusted for hours and options, with choices to include or exclude either or both. If Adjust_FP_For = 0, adjustment for options is excluded. If Adjust_FP_For = 2, adjustment for options is included. If Adjust_FP_For = 1, adjustment for hours is excluded. If Adjust_FP_For = 3, adjustment for hours is included. |
| Section | element | string | Not used by BVX | The appraisal Section would relate to the general area of the machine, ie. Powertrain, Operator Station, etc. |
| Component | element | string | Not used by BVX | This identifies the component being appraised - ie. Fuel Pump, Transmission, Tires, etc. |
| DefaultAmount | element | currency | Not used by BVX | The default amount of repairs normally required for this component. |
| Rate | element | real | Not used by BVX | The flat-rate hour rating to repair this component |
| AmtOver | element | currency | Not used by BVX | The appraiser's extimated repair amount for this component - if different than the default. |
| Comment | element | string | Not used by BVX | This is a free format field with comments related to the appraisal. |
| Updated_By | element | string | Not used by BVX | Updated_By is a free format field indicating the user who last updated the appraisal. |
| Date_Added | element | date | Not used by BVX | Date_Added is a date field indicating the date when the appraisal was first added. |
| UserDefined | element | string | Not used by BVX | This element is provided to contain any user-defined value not adequately provided for in any of the standard elements. It also occurs with all other entities. |
| EqtCode | Element | Equipment Codes | ||
| Config_No | attribute | integer | Not used by BVX | (Reserved for future use) |
| Group_Order | element | real | Not used by BVX | Equipment codes are grouped and indexed by group order and code order. This element defines the first of the two. |
| Code_Order | element | real | Not used by BVX | Equipment codes are grouped and indexed by group order and code order. This element defines the second of the two. |
| Code | element | string | Not used by BVX | This is the code value of the equipment code. The maximum length is 15 characters. |
| StarCost | element | boolean | Not used by BVX | The StarCost element have a value of 1 when the cost of this equipment code is to be excluded from programs. |
| Attach_No | element | string | Not used by BVX | Reserved for future use. |
| Verify | element | boolean | Not used by BVX | Reserved for future use. |
| Qty | element | integer | Not used by BVX | This element defines the number of occurrences of this equipment code. |
| Description | element | string | Not used by BVX | This element contains a description of the equipment code. The description has a maximum length of 50 characters. |
| Extended_Cost | element | currency | Not used by BVX | The Extended_Cost is the Cost of the equipment code multiplied by the Qty. |
| Extended_List | element | currency | Not used by BVX | The Extended_List is the List of the equipment code multiplied by the Qty. |
| Cost | element | currency | Not used by BVX | This is the Cost of a single unit of the equipment code. |
| List | element | currency | Not used by BVX | This is the List of a single unit of the equipment code. |
| Weight_LB | element | real | Not used by BVX | This is the weight of a single unit of the equipment code in pounds. |
| Weight_KG | element | real | Not used by BVX | This is the weight of a single unit of the equipment code in kilograms. |
| Hrs_PDI | element | real | Not used by BVX | This is the hours attributed to Pre-Delivery Inspection of the equipment code. |
| Comments | element | string | Not used by BVX | The Comments element contains comments associated and printed with the equipment code. There is no limit on the length. |
| CommentsOnQuote | element | boolean | Not used by BVX | The CommentsOnQuote element has a value of 1 if the comments for the equipment code are to appear on the quote when printed. |
| In_Base | element | integer | Not used by BVX | In_Base indicates whether the cost of this equipment code is included in the base value of the equipment. |
| USExchangeIndex | element | real | Not used by BVX | USExchangeIndex is the rate of exchange in the case where the cost of this equipment code is expressed in USD funds. |
| USExchange | element | currency | Not used by BVX | USExchange is the amount of exchange where the cost of this equipment code is expressed in USD funds. |
| EqtImage | Element | Equipment Images - This element conveys the information about an image, but XML does not transmit the image itself. It is transmitted as a separate process. In addition to the elements listed here, other elements that also appear with the Equipment entity are CustID, Sales_Rep, Quote_no, Unit_no, Stock_No, IW_NO, Notes and UserDefined. | ||
| Image_No | element | integer | Posted to IRON Search by BVX | Each image is assigned a unique image number. An Image_No is required. |
| Image_ID | element | string | Posted to IRON Search by BVX | The Image_ID describes the actual path of the image in the application system. The element has a maximum length of 32 characters. |
| IronSearchImage_ID | element | string | Posted to IRON Search by BVX | The IronSearchImage_ID describes the Image_ID of the image assigned to the image on IRON Search. The element has a maximum length of 32 characters. |
| Image | element | string | Posted to IRON Search by BVX | The Image tag contains the actual image. Either the Image tag or the ImageURL tag must be specified, but not both. The image data is encoded using bin.base64 encoding. |
| ImageURL | element | string | Posted to IRON Search by BVX | The ImageURL tag contains a URL pointing to an image on the Internet (eg. Http://78.77.6.20/Images/tractor9.jpg). Either the Image tag or the ImageURL tag must be specified, but not both. |
| Notes | element | string | Posted to IRON Search by BVX | The Notes tag contains a description of the image. It is limited to 50 characters. |
| DateRecorded | element | date | Posted to IRON Search by BVX | This is the date that the image was recorded in the application database. |
| TGOption | Element | Equipment Options - This entity can appear as a child of Equipment, but it more correctly appears as a child of Appraisal. In addition to the elements listed here, the TGOption entity also has a UserDefined element, defined under Equipment. | ||
| Option_Code | attribute | string | Not used by BVX | The Option_Code is the key value identifying the equipment option. The maximum length is 15 characters. |
| Option_Desc | element | string | Not used by BVX | The Option_Desc elements contains a description of the equipment option. The maximum length is 30 characters. |
| Cash_Value | element | currency | Not used by BVX | The Cash_Value is the best estimate of the value of the equipment option. |
| Cash_Value_Can | element | currency | Not used by BVX | The Cash_Value_Can is the last selling price of this option in Canadian funds. |
| Cash_Value_US | element | currency | Not used by BVX | The Cash_Value_US is the US currency amount of cash value of the last selling price of this option. |
| Work_Order | Element | The Work_Order entity - in addition to the elements listed here, this entity contains the CustID, Quote_No, Unit_No, Stock_No, Dealer_No, and UserDefined elements that are defined under the Equipment entity. | ||
| Date | element | date | The Date element identifies the date this work order was created. | |
| Order_Number | element | string | Not used by BVX | The Order_Number element is a key value that identifies the work order. The maximum length is 10 characters. |
| Charge_Type | element | string | Not used by BVX | The Charge_Type element defines the type of work order. There are several pref-defined two character codes. These are AT, WO (work order), TA (Trade Allowance), RE (rental), and PT. |
| Amount | element | currency | Not used by BVX | The Amount element identifies the amount of the work order. |
| In_Invoice | element | boolean | Not used by BVX | The In_Invoice element has a value of 1 if the amount of the work order is included in the invoice cost. |
| EqtProgram | Element | The EqtProgram element - in addition to the elements listed here, the EqtProgram also contains the CustID, Sales_Rep, Quote_No, Unit_No, Stock_No, Dealer_No and UserDefined elements described in the Equipment entity. | ||
| Date_End | attribute | date | Not used by BVX | The Date_End identifies when the equipment program expires. |
| Program_Desc | element | string | Not used by BVX | This element contains a free-form description of the program. It has a maximum length of 30 characters. |
| Program_ID | element | string | Not used by BVX | The Program_ID element is a key value in identifying the program. It has a maximum length of 10 characters. |
| Total_User | element | currency | Not used by BVX | The Total_User element contains a user-defined fixed amount to describe a program amount. |
| Percent_Program | element | real | Not used by BVX | The Percent_Program element contains the percentage to apply to a base amount, as defined by the BasedOrder element. |
| Program_Total | element | currency | Not used by BVX | The Program_Total is the total calculated amount of this program. |
| BasedOrder | element | integer | Not used by BVX | The BasedOrder element has a value from 1 to 9, defining how to apply the program. The meanings of these values are: 1-Fixed $ Amt Before %, 2-Invoice Cost x %, 3-Total All Costs x %, 4-Inv. Cost After 1-3 x %, 5-Inv.Cost After 1-4 x %, 6-Inv. Cost After 1-6 x %, 7-Invoice Retail x %, 8-Other Amt x %, 9-Fixed $ Amt After All. |
| PrintFlag | element | boolean | Not used by BVX | The PrintFlag element has a value of 1 if the program is to be printed on a quote. |
| Contact | Element | The Contact element - describes a contact associated with the Equipment entity. Note that the Contact element is defined in such a way that it may appear as a child element of the Equipment element, or at the same level as the Equipment element. | ||
| ContactName | attribute | string | Not used by BVX | The ContactName identifies the full name of the contact. The length is limited to 50 characters. | ContactPhone | attribute | string | Not used by BVX | The ContactPhone identifies the phone number of the contact. | ContactFax | attribute | string | Not used by BVX | The ContactFax identifies the fax number of the contact. | ContactEmail | attribute | string | Not used by BVX | The ContactEmail identifies the email address of the contact. It must be recorded in lower case characters. | ContactWebSite | attribute | string | Not used by BVX | The ContactWebSite identifies the URL of the web site of the contact. |
| ContactCity | attribute | string | Not used by BVX | The ContactCity identifies the city of the contact. The length is limited to 50 characters. |
| ContactState | attribute | string | Not used by BVX | The ContactState identifies the province or state of the contact. The length is limited to 2 characters. |
| ContactCountry | attribute | string | Not used by BVX | The ContactCountry identifies the full name of the country of the contact. The length is limited to 50 characters. |
| ContactCountryCode | attribute | string | Not used by BVX | The ContactCountryCode identifies the code of the country of the contact. The length is limited to 3 characters. |
BizTalk™ is a registered trademark of Microsoft Corporation. IRON Manager™, IRON QuotePro™, IRON Appraiser™, IRON Search™, and IRON Web™ are registered trademarks of IRON Solutions Inc.
© 2006 Microsoft Corporation and IRON Solutions Inc.