CalcXML REST Web Services - adv06 Calculator

URL

http://www.calcxml.com/rest/adv06

Properties / Request Headers

Required property: content-type=application/json
Required property: charset=UTF-8
Required header: accept=application/json

Full JSON Request

{"username": "XXXXXX","password": "XXXXXX","responseType": "raw2","returnDataTable": "true","chartLibrary": "image","language": "en","countryCode": "US","version": "1.3", "chartTitle": "Custom Chart Title", "threeD": "0", "chartHeight": "300", "chartWidth": "300","barColor1": "ddeeaa", "barColor2": "00ffff", "barColor3": "ffeb00","barColor4": "aabbcc","barColor5": "ff00ff","barColor6": "bbaa00","clientFirstName": "null","spouseFirstName": "null","clientLastName": "null","spouseLastName": "null","scenarioDescription": "null","clientAddress": "null","clientCity": "null","clientState": "null","clientZip": "null","clientPhone": "null","advisorName": "null","advisorTitle": "null","advisorCompanyName": "null","companyAddress1": "null","companyAddress2": "null","companyCity": "null","companyState": "null","companyZip": "null","companyPhone": "null","color1": "null","color2": "null","color3": "null","color4": "null","color5": "null","color6": "null","disclaimer1": "null","disclaimer2": "null","disclaimer3": "null","disclaimer4": "null","ppid": "null","moduleTitle": "null","creditor1": "Creditor 1","balance1": "0","minimumPayment1": "0","actualPayment1": "0","rate1": "0","creditor2": "Creditor 2","balance2": "0","minimumPayment2": "0","actualPayment2": "0","rate2": "0","creditor3": "Creditor 3","balance3": "0","minimumPayment3": "0","actualPayment3": "0","rate3": "0","creditor4": "Creditor 4","balance4": "0","minimumPayment4": "0","actualPayment4": "0","rate4": "0","creditor5": "Creditor 5","balance5": "0","minimumPayment5": "0","actualPayment5": "0","rate5": "0","creditor6": "Creditor 6","balance6": "0","minimumPayment6": "0","actualPayment6": "0","rate6": "0","creditor7": "Creditor 7","balance7": "0","minimumPayment7": "0","actualPayment7": "0","rate7": "0","creditor8": "Creditor 8","balance8": "0","minimumPayment8": "0","actualPayment8": "0","rate8": "0","creditor9": "Creditor 9","balance9": "0","minimumPayment9": "0","actualPayment9": "0","rate9": "0","creditor10": "Creditor 10","balance10": "0","minimumPayment10": "0","actualPayment10": "0","rate10": "0","creditor11": "Creditor 11","balance11": "0","minimumPayment11": "0","actualPayment11": "0","rate11": "0","creditor12": "Creditor 12","balance12": "0","minimumPayment12": "0","actualPayment12": "0","rate12": "0","creditor13": "Creditor 13","balance13": "0","minimumPayment13": "0","actualPayment13": "0","rate13": "0","creditor14": "Creditor 14","balance14": "0","minimumPayment14": "0","actualPayment14": "0","rate14": "0","creditor15": "Creditor 15","balance15": "0","minimumPayment15": "0","actualPayment15": "0","rate15": "0","creditor16": "Creditor 16","balance16": "0","minimumPayment16": "0","actualPayment16": "0","rate16": "0","creditor17": "Creditor 17","balance17": "0","minimumPayment17": "0","actualPayment17": "0","rate17": "0","creditor18": "Creditor 18","balance18": "0","minimumPayment18": "0","actualPayment18": "0","rate18": "0","creditor19": "Creditor 19","balance19": "0","minimumPayment19": "0","actualPayment19": "0","rate19": "0","creditor20": "Creditor 20","balance20": "0","minimumPayment20": "0","actualPayment20": "0","rate20": "0","extraPayment": "0","oneTimePaymentAmount": "0","oneTimePaymentMonth": "1","oneTimePaymentYear": "2016","debtOrderMethod": "2","savingsRate": "0.05"}

Minimal JSON Request

Optional elements will be defaulted

{"username": "XXXXXX","password": "XXXXXX","clientFirstName": "null","spouseFirstName": "null","clientLastName": "null","spouseLastName": "null","scenarioDescription": "null","clientAddress": "null","clientCity": "null","clientState": "null","clientZip": "null","clientPhone": "null","advisorName": "null","advisorTitle": "null","advisorCompanyName": "null","companyAddress1": "null","companyAddress2": "null","companyCity": "null","companyState": "null","companyZip": "null","companyPhone": "null","color1": "null","color2": "null","color3": "null","color4": "null","color5": "null","color6": "null","disclaimer1": "null","disclaimer2": "null","disclaimer3": "null","disclaimer4": "null","ppid": "null","moduleTitle": "null","creditor1": "Creditor 1","balance1": "0","minimumPayment1": "0","actualPayment1": "0","rate1": "0","creditor2": "Creditor 2","balance2": "0","minimumPayment2": "0","actualPayment2": "0","rate2": "0","creditor3": "Creditor 3","balance3": "0","minimumPayment3": "0","actualPayment3": "0","rate3": "0","creditor4": "Creditor 4","balance4": "0","minimumPayment4": "0","actualPayment4": "0","rate4": "0","creditor5": "Creditor 5","balance5": "0","minimumPayment5": "0","actualPayment5": "0","rate5": "0","creditor6": "Creditor 6","balance6": "0","minimumPayment6": "0","actualPayment6": "0","rate6": "0","creditor7": "Creditor 7","balance7": "0","minimumPayment7": "0","actualPayment7": "0","rate7": "0","creditor8": "Creditor 8","balance8": "0","minimumPayment8": "0","actualPayment8": "0","rate8": "0","creditor9": "Creditor 9","balance9": "0","minimumPayment9": "0","actualPayment9": "0","rate9": "0","creditor10": "Creditor 10","balance10": "0","minimumPayment10": "0","actualPayment10": "0","rate10": "0","creditor11": "Creditor 11","balance11": "0","minimumPayment11": "0","actualPayment11": "0","rate11": "0","creditor12": "Creditor 12","balance12": "0","minimumPayment12": "0","actualPayment12": "0","rate12": "0","creditor13": "Creditor 13","balance13": "0","minimumPayment13": "0","actualPayment13": "0","rate13": "0","creditor14": "Creditor 14","balance14": "0","minimumPayment14": "0","actualPayment14": "0","rate14": "0","creditor15": "Creditor 15","balance15": "0","minimumPayment15": "0","actualPayment15": "0","rate15": "0","creditor16": "Creditor 16","balance16": "0","minimumPayment16": "0","actualPayment16": "0","rate16": "0","creditor17": "Creditor 17","balance17": "0","minimumPayment17": "0","actualPayment17": "0","rate17": "0","creditor18": "Creditor 18","balance18": "0","minimumPayment18": "0","actualPayment18": "0","rate18": "0","creditor19": "Creditor 19","balance19": "0","minimumPayment19": "0","actualPayment19": "0","rate19": "0","creditor20": "Creditor 20","balance20": "0","minimumPayment20": "0","actualPayment20": "0","rate20": "0","extraPayment": "0","oneTimePaymentAmount": "0","oneTimePaymentMonth": "1","oneTimePaymentYear": "2016","debtOrderMethod": "2","savingsRate": "0.05"}

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

See a functioning version of this calculator here: http://www.calcxml.com/do/adv06

Description Of Shared Request Elements

username - Provided by CalcXML
password - Provided by CalcXML
responseType - While there are various responseTypes, the only two that really make sense for REST integrations are raw and raw2. raw2 includes result paragraphs/text where raw does not. 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.

Sample JSON Response

Click Submit to send the JSON request below to be processed. The JSON response will be displayed in a new tab/window. You can modify the JSON request prior to sending it as well.

JSON request