Auto Prompts - Request

Please see the Legend to understand the conventions used to document each element and attribute. Note that for requests, the XML elements are documented in alphabetical order by parent element.

🟥 <inAUTO>

This is the root element of the XML auto prompts request, and is required. This element is empty, and thus contains neither data nor child elements.

Attributes: None

🟦 <CashDown>

The value of this element represents a cash down payment made at closing. If specified and greater than zero, this amount will be deducted from the Price, reducing the principal balance. If not specified, the cash down payment will default to zero.

Attributes: None

🟦 <Format>

The <Format> element is one of the first elements parsed from a request, as the attributes of this empty element affect how date and numeric values are parsed and validated.

Attributes: 🔹CurrencyDecimals, 🔹DateFormat, 🔹DateSeparator, 🔹DecimalSeparator, 🔹StrictDP, 🔹ThousandSeparator

🔹 CurrencyDecimals

When displaying and parsing Currency values, the value of this attribute determines the maximum number of decimal places allowed after the DecimalSeparator.

🔹 DateFormat

When displaying and parsing Date values, this field determines the expected format for all Date fields. The following DateFormat options are allowed:

• YMD - All dates should be formatted as YYYY-MM-DD.
• MDY - All dates should be formatted as MM-DD-YYYY.
• DMY - All dates should be formatted as DD-MM-YYYY.

Note that the character which separates the individual month, day, and year portions of the date is configurable via the DateSeparator attribute.

🔹 DateSeparator

When displaying and parsing Date values, this attribute determines the character used to separate the individual month, day, and year portions of a date.

🔹 DecimalSeparator

When displaying and parsing Currency or Decimal numeric values, this attribute determines the character used to separate the fractional part from the whole.

🔹 StrictDP

If the value of this attribute is true, then the SCE will strictly verify the number of decimal places allowed for currency input values. Thus, if the calling application sends in a request with a currency amount of 1000.005, the SCE will return an error code.

If the value of this attribute is false, then currency values sent in with an invalid number of decimal places will be rounded to the correct number of decimal places by the SCE (using five/four rounding), and a warning message with this information will be returned with the response.

🔹 ThousandSeparator

When displaying numeric values, this attribute determines the character used to separate the thousands places from the hundreds. Note that when parsing numeric values, the value of this attribute is ignored.

🟦 <GrossTrade>

The gross dollar value of the trade in. If specified and greater than zero, this amount will be deducted from the price, reducing the principal balance. If not specified, the gross trade value will default to zero.

Attributes: None

🟦 <Lien>

The value of this element should hold any payoff amount required for the trade-in. If specified and greater than zero, this amount will be added to the price, increasing the principal balance. If not specified, then the lien amount will default to zero.

Attributes: None

🟦 <LuxTax>

A luxury tax is a tax on non-essential goods (such as expensive cars, boats, etc.). The element itself is empty, and if not present, the luxury tax will be set to zero. To compute the luxury tax, the following attributes need to be specified:

Attributes: 🔸Rate, 🔸Threshold

🔸 Rate

This attribute specifies the rate to be used to compute the luxury tax.

🔸 Threshold

If the vehicle price exceeds this threshold amount, then luxury tax is computed on the difference between the vehicle price and the threshold amount. If the vehicle price is less than or equal to the threshold amount, then there will be no luxury tax.

🟦 <NonTaxedFees>

This element represents the sum of all financed fees on which tax will not be computed. If specified and greater than zero, then this amount will be added to the principal balance and total vehicle fees amount. If not specified, this amount will default to zero.

Attributes: None

🟥 <Price>

This element specifies the cost of a vehicle. The dollar amount should be expressed as a number. For example, if a vehicle costs $55,000, then you would include <Price>55000.00</Price> in the XML request.

Attributes: None

🟦 <Rebate>

This element represents a rebate amount given to the customer at time of purchase. If specified and greater than zero, this amount will either be deducted from the price plus tax amount, or may be considered as a separate amount returned to the borrower (see the ApplyToBalance attribute definition below for further information). If not specified, the rebate amount will default to zero. This element has a single possible attribute:

Attributes: 🔹ApplyToBalance

🔹 ApplyToBalance (#rebate.applytobalance)

If set to true, then the rebate amount specified above is applied o the, balance, l, wering it by the rebate amount. If false, then the rebate does not decrease the balance and is assumed to be given directly to the borrower.

🟦 <ServiceContract>

This element represents the cost of an extended warranty or service contract sold at the time of closing. If specified and greater than zero, this amount will be added to the principal balance and added to the total vehicle fees. If not specified, the service contract amount will default to zero.

Attributes: None

🟦 <Tax>

The Tax element determines how and if sales tax is computed. If a precomputed tax amount is being sent to the SCEX, then the value of this element should contain the tax amount. If this element is not present, then a tax amount of zero will be assumed. The following attributes determine how tax is computed:

Attributes: 🔹Method, 🔸Rate, 🔹RebateReduce

🔹 Method

This attribute determines whether or not the SCEX will accept a precomputed tax amount, or if it needs to compute the tax. PromptTax means that the tax amount has already been computed, and this value is contained in the element. The other three values indicate that tax will be computed by the SCEX, and each specified the base amount on which the tax will be computed.

• PromptTax - Tax has already been computed as a side-calculation, and is directly entered as input.
• Price - Base amount is entered vehicle price.
• PriceTrade - Base amount is entered vehicle price less gross trade value.
• PriceTradeLien - Base amount is entered vehicle price less gross trade value
  • any lien.

🔸 Rate

This attribute specifies the rate to be used to compute the tax, should the value of the Method attribute above be anything other than PromptTax.

🔹 RebateReduce

The value of this attribute determines if any rebate amount specified reduces the amount on which tax is computed. A value of true will reduce the taxable amount by the specified rebate amount, whereas a value of false will not change the taxable amount.

🟦 <TaxedFees>

The value of this element holds the sum of all financed fees which are taxable. If specified and greater than zero, then this amount will be added to the principal balance, price plus tax amount, and total vehicle fees amount. If not specified, this amount will default to zero.

Attributes: None