Description Of Calculator-Specific Request Elements
clientFirstName Data type: xs:string Valid values: 0 to 999999999 spouseFirstName Data type: xs:string Valid values: 0 to 999999999 clientLastName Data type: xs:string Valid values: 0 to 999999999 spouseLastName Data type: xs:string Valid values: 0 to 999999999 scenarioDescription Data type: xs:string Valid values: 0 to 999999999 clientAddress Data type: xs:string Valid values: 0 to 999999999 clientCity Data type: xs:string Valid values: 0 to 999999999 clientState Data type: xs:string Valid values: 0 to 999999999 clientZip Data type: xs:string Valid values: 0 to 999999999 clientPhone Data type: xs:string Valid values: 0 to 999999999 advisorName Data type: xs:string Valid values: 0 to 999999999 advisorTitle Data type: xs:string Valid values: 0 to 999999999 advisorCompanyName Data type: xs:string Valid values: 0 to 999999999 companyAddress1 Data type: xs:string Valid values: 0 to 999999999 companyAddress2 Data type: xs:string Valid values: 0 to 999999999 companyCity Data type: xs:string Valid values: 0 to 999999999 companyState Data type: xs:string Valid values: 0 to 999999999 companyZip Data type: xs:string Valid values: 0 to 999999999 companyPhone Data type: xs:string Valid values: 0 to 999999999 color1 Data type: xs:string Valid values: 0 to 999999999 color2 Data type: xs:string Valid values: 0 to 999999999 color3 Data type: xs:string Valid values: 0 to 999999999 color4 Data type: xs:string Valid values: 0 to 999999999 color5 Data type: xs:string Valid values: 0 to 999999999 color6 Data type: xs:string Valid values: 0 to 999999999 disclaimer1 Data type: xs:string Valid values: 0 to 999999999 disclaimer2 Data type: xs:string Valid values: 0 to 999999999 disclaimer3 Data type: xs:string Valid values: 0 to 999999999 disclaimer4 Data type: xs:string Valid values: 0 to 999999999 ppid Data type: xs:string Valid values: 0 to 999999999 moduleTitle Data type: xs:string Valid values: 0 to 999999999 creditor1 Data type: xs:string Valid values: 0 to 999999999 balance1 Data type: xs:double Valid values: 0 to 999999999 minimumPayment1 Data type: xs:double Valid values: 0 to 999999999 actualPayment1 Data type: xs:double Valid values: 0 to 999999999 rate1 Data type: xs:float Valid values: 0 to .4 creditor2 Data type: xs:string Valid values: 0 to 999999999 balance2 Data type: xs:double Valid values: 0 to 999999999 minimumPayment2 Data type: xs:double Valid values: 0 to 999999999 actualPayment2 Data type: xs:double Valid values: 0 to 999999999 rate2 Data type: xs:float Valid values: 0 to .4 creditor3 Data type: xs:string Valid values: 0 to 999999999 balance3 Data type: xs:double Valid values: 0 to 999999999 minimumPayment3 Data type: xs:double Valid values: 0 to 999999999 actualPayment3 Data type: xs:double Valid values: 0 to 999999999 rate3 Data type: xs:float Valid values: 0 to .4 creditor4 Data type: xs:string Valid values: 0 to 999999999 balance4 Data type: xs:double Valid values: 0 to 999999999 minimumPayment4 Data type: xs:double Valid values: 0 to 999999999 actualPayment4 Data type: xs:double Valid values: 0 to 999999999 rate4 Data type: xs:float Valid values: 0 to .4 creditor5 Data type: xs:string Valid values: 0 to 999999999 balance5 Data type: xs:double Valid values: 0 to 999999999 minimumPayment5 Data type: xs:double Valid values: 0 to 999999999 actualPayment5 Data type: xs:double Valid values: 0 to 999999999 rate5 Data type: xs:float Valid values: 0 to .4 creditor6 Data type: xs:string Valid values: 0 to 999999999 balance6 Data type: xs:double Valid values: 0 to 999999999 minimumPayment6 Data type: xs:double Valid values: 0 to 999999999 actualPayment6 Data type: xs:double Valid values: 0 to 999999999 rate6 Data type: xs:float Valid values: 0 to .4 creditor7 Data type: xs:string Valid values: 0 to 999999999 balance7 Data type: xs:double Valid values: 0 to 999999999 minimumPayment7 Data type: xs:double Valid values: 0 to 999999999 actualPayment7 Data type: xs:double Valid values: 0 to 999999999 rate7 Data type: xs:float Valid values: 0 to .4 creditor8 Data type: xs:string Valid values: 0 to 999999999 balance8 Data type: xs:double Valid values: 0 to 999999999 minimumPayment8 Data type: xs:double Valid values: 0 to 999999999 actualPayment8 Data type: xs:double Valid values: 0 to 999999999 rate8 Data type: xs:float Valid values: 0 to .4 creditor9 Data type: xs:string Valid values: 0 to 999999999 balance9 Data type: xs:double Valid values: 0 to 999999999 minimumPayment9 Data type: xs:double Valid values: 0 to 999999999 actualPayment9 Data type: xs:double Valid values: 0 to 999999999 rate9 Data type: xs:float Valid values: 0 to .4 creditor10 Data type: xs:string Valid values: 0 to 999999999 balance10 Data type: xs:double Valid values: 0 to 999999999 minimumPayment10 Data type: xs:double Valid values: 0 to 999999999 actualPayment10 Data type: xs:double Valid values: 0 to 999999999 rate10 Data type: xs:float Valid values: 0 to .4 creditor11 Data type: xs:string Valid values: 0 to 999999999 balance11 Data type: xs:double Valid values: 0 to 999999999 minimumPayment11 Data type: xs:double Valid values: 0 to 999999999 actualPayment11 Data type: xs:double Valid values: 0 to 999999999 rate11 Data type: xs:float Valid values: 0 to .4 creditor12 Data type: xs:string Valid values: 0 to 999999999 balance12 Data type: xs:double Valid values: 0 to 999999999 minimumPayment12 Data type: xs:double Valid values: 0 to 999999999 actualPayment12 Data type: xs:double Valid values: 0 to 999999999 rate12 Data type: xs:float Valid values: 0 to .4 creditor13 Data type: xs:string Valid values: 0 to 999999999 balance13 Data type: xs:double Valid values: 0 to 999999999 minimumPayment13 Data type: xs:double Valid values: 0 to 999999999 actualPayment13 Data type: xs:double Valid values: 0 to 999999999 rate13 Data type: xs:float Valid values: 0 to .4 creditor14 Data type: xs:string Valid values: 0 to 999999999 balance14 Data type: xs:double Valid values: 0 to 999999999 minimumPayment14 Data type: xs:double Valid values: 0 to 999999999 actualPayment14 Data type: xs:double Valid values: 0 to 999999999 rate14 Data type: xs:float Valid values: 0 to .4 creditor15 Data type: xs:string Valid values: 0 to 999999999 balance15 Data type: xs:double Valid values: 0 to 999999999 minimumPayment15 Data type: xs:double Valid values: 0 to 999999999 actualPayment15 Data type: xs:double Valid values: 0 to 999999999 rate15 Data type: xs:float Valid values: 0 to .4 creditor16 Data type: xs:string Valid values: 0 to 999999999 balance16 Data type: xs:double Valid values: 0 to 999999999 minimumPayment16 Data type: xs:double Valid values: 0 to 999999999 actualPayment16 Data type: xs:double Valid values: 0 to 999999999 rate16 Data type: xs:float Valid values: 0 to .4 creditor17 Data type: xs:string Valid values: 0 to 999999999 balance17 Data type: xs:double Valid values: 0 to 999999999 minimumPayment17 Data type: xs:double Valid values: 0 to 999999999 actualPayment17 Data type: xs:double Valid values: 0 to 999999999 rate17 Data type: xs:float Valid values: 0 to .4 creditor18 Data type: xs:string Valid values: 0 to 999999999 balance18 Data type: xs:double Valid values: 0 to 999999999 minimumPayment18 Data type: xs:double Valid values: 0 to 999999999 actualPayment18 Data type: xs:double Valid values: 0 to 999999999 rate18 Data type: xs:float Valid values: 0 to .4 creditor19 Data type: xs:string Valid values: 0 to 999999999 balance19 Data type: xs:double Valid values: 0 to 999999999 minimumPayment19 Data type: xs:double Valid values: 0 to 999999999 actualPayment19 Data type: xs:double Valid values: 0 to 999999999 rate19 Data type: xs:float Valid values: 0 to .4 creditor20 Data type: xs:string Valid values: 0 to 999999999 balance20 Data type: xs:double Valid values: 0 to 999999999 minimumPayment20 Data type: xs:double Valid values: 0 to 999999999 actualPayment20 Data type: xs:double Valid values: 0 to 999999999 rate20 Data type: xs:float Valid values: 0 to .4 extraPayment Data type: xs:double Valid values: 0 to 999999999 oneTimePaymentAmount Data type: xs:double Valid values: 0 to 999999999 oneTimePaymentMonth Data type: xs:string Valid values: 1 (January), 2 (February), 3 (March), 4 (April), 5 (May), 6 (June), 7 (July), 8 (August), 9 (September), 10 (October), 11 (November), 12 (December) oneTimePaymentYear Data type: xs:integer Valid values: 2016 to 2050 debtOrderMethod Data type: xs:integer Valid values: 1 (Lowest to Highest Balance), 2 (Highest to Lowest Interest Rate), 3 (Shortest to Longest Payoff Period) savingsRate Data type: xs:float Valid values: -.12 to .12
username - Provided by CalcXML password - Provided by CalcXML responseType - While there are various responseTypes, the only values that really make sense for REST integrations are raw, raw2 and pdf. raw2 includes result paragraphs/text where raw does not. pdf returns a URL to the generated PDF. Default: raw2. returnDataTable - Indicates whether the detailed data table should be included in the response. Valid values: true or false. Default: true chartLibrary - Indicates what type of chart should be generated. Valid values: image or flash. Default value: image language - 2-character language code. Conform to ISO 639-1 Code. Used in conjunction with countryCode to format currency values. Find the full list here: http://www.loc.gov/standards/iso639-2/php/English_list.php. Default: en countryCode - 2-character country code. Conform to ISO 3166-1-alpha-2. Used to format currency values that are returned in the response. Find the full list here: http://www.iso.org/iso/english_country_names_and_code_elements OR here: http://countrycode.org/. Default: US version - The version of the schema being used for this request. Current/Default = 1.3 chartTitle - Change the chart title for the image. threeD - Use a 3d effect when rendering the chart. Use 0 to disable. Use 1 to enable. Default = 1 chartHeight - Specify a height in pixels for the image. Default = 300 chartWidth - Specify a width in pixels for the image. Default = 400 barColor1 - Specify a custom chart color in hexadecimal. barColor2 - Specify a custom chart color in hexadecimal. barColor3 - Specify a custom chart color in hexadecimal. barColor4 - Specify a custom chart color in hexadecimal. barColor5 - Specify a custom chart color in hexadecimal. barColor6 - Specify a custom chart color in hexadecimal.