CalcXML REST Web Services - adv01 Calculator

URL

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

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","clientDOB": "null","clientAge": "null","spouseDOB": "null","spouseAge": "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","clientIncome": "null","spouseIncome": "null","clientPayIncrease": "0.05","spousePayIncrease": "0.05","clientRetirementAge": "67","spouseRetirementAge": "67","clientDeathAge": "95","spouseDeathAge": "95","assetDescription1": "null","assetValue1": "null","assetOwner1": "Client","assetType1": "Liquid","assetDescription2": "null","assetValue2": "0","assetOwner2": "Client","assetType2": "Liquid","assetDescription3": "null","assetValue3": "0","assetOwner3": "Client","assetType3": "Liquid","assetDescription4": "null","assetValue4": "0","assetOwner4": "Client","assetType4": "Liquid","assetDescription5": "null","assetValue5": "0","assetOwner5": "Client","assetType5": "Liquid","assetDescription6": "null","assetValue6": "0","assetOwner6": "Client","assetType6": "Liquid","assetDescription7": "null","assetValue7": "0","assetOwner7": "Client","assetType7": "Liquid","assetDescription8": "null","assetValue8": "0","assetOwner8": "Client","assetType8": "Liquid","assetDescription9": "null","assetValue9": "0","assetOwner9": "Client","assetType9": "Liquid","assetDescription10": "null","assetValue10": "0","assetOwner10": "Client","assetType10": "Liquid","assetDescription11": "null","assetValue11": "null","assetOwner11": "Client","assetType11": "Liquid","assetDescription12": "null","assetValue12": "0","assetOwner12": "Client","assetType12": "Liquid","assetDescription13": "null","assetValue13": "0","assetOwner13": "Client","assetType13": "Liquid","assetDescription14": "null","assetValue14": "0","assetOwner14": "Client","assetType14": "Liquid","assetDescription15": "null","assetValue15": "0","assetOwner15": "Client","assetType15": "Liquid","assetDescription16": "null","assetValue16": "0","assetOwner16": "Client","assetType16": "Liquid","assetDescription17": "null","assetValue17": "0","assetOwner17": "Client","assetType17": "Liquid","assetDescription18": "null","assetValue18": "0","assetOwner18": "Client","assetType18": "Liquid","assetDescription19": "null","assetValue19": "0","assetOwner19": "Client","assetType19": "Liquid","assetDescription20": "null","assetValue20": "0","assetOwner20": "Client","assetType20": "Liquid","clientQualAnnual": "2000","spouseQualAnnual": "2000","qualIncreases": "N","clientRothAnnual": "0","spouseRothAnnual": "0","rothIncreases": "N","clientNonQualAnnual": "0","spouseNonQualAnnual": "0","nonQualIncreases": "N","forceRMD": "N","clientPension": "15000","clientPensionLS": "0","spousePension": "0","spousePensionLS": "0","clientPensionIncreases": "N","spousePensionIncreases": "N","clientPensionAge": "67","spousePensionAge": "67","otherIncomeDescription1": "null","otherIncomeAmount1": "null","otherIncomeStartAge1": "null","otherIncomeEndAge1": "null","otherIncomeIncreases1": "0.05","otherIncomeReceiptType1": "Receipt","otherIncomeTaxable1": "Y","otherIncomeDescription2": "null","otherIncomeAmount2": "null","otherIncomeStartAge2": "null","otherIncomeEndAge2": "null","otherIncomeIncreases2": "0.05","otherIncomeReceiptType2": "Receipt","otherIncomeTaxable2": "Y","otherIncomeDescription3": "null","otherIncomeAmount3": "null","otherIncomeStartAge3": "null","otherIncomeEndAge3": "null","otherIncomeIncreases3": "0.05","otherIncomeReceiptType3": "Receipt","otherIncomeTaxable3": "Y","otherIncomeDescription4": "null","otherIncomeAmount4": "null","otherIncomeStartAge4": "null","otherIncomeEndAge4": "null","otherIncomeIncreases4": "0.05","otherIncomeReceiptType4": "Receipt","otherIncomeTaxable4": "Y","otherIncomeDescription5": "null","otherIncomeAmount5": "null","otherIncomeStartAge5": "null","otherIncomeEndAge5": "null","otherIncomeIncreases5": "0.05","otherIncomeReceiptType5": "Receipt","otherIncomeTaxable5": "Y","otherIncomeDescription6": "null","otherIncomeAmount6": "null","otherIncomeStartAge6": "null","otherIncomeEndAge6": "null","otherIncomeIncreases6": "0.05","otherIncomeReceiptType6": "Receipt","otherIncomeTaxable6": "Y","retirementGoalPercentage": ".75","retirementGoalAmount": "0","legacyAmount": "0","legacyIncreases": "N","includeSS": "N","inflationSS": ".03","ssBenefitsTaxable": "1","clientSSEligible": "Y","spouseSSEligible": "Y","clientSSOverrideAge": "0","spouseSSOverrideAge": "0","clientSSOverride": "0","spouseSSOverride": "0","recommendedSavingsIncreases": "N","preRetirementReturn": ".06","postRetirementReturn": ".06","preRetirementTaxRate": ".22","postRetirementTaxRate": ".22","inflation": ".03","color1": "null","color2": "null","color3": "null","color4": "null","color5": "null","color6": "null","disclaimer1": "null","disclaimer2": "null","disclaimer3": "null","disclaimer4": "null","ppid": "null","salesAssistantName": "null","salesAssistantPhone": "null","moduleTitle": "null","earlyRetirementGoal": "null","earlyRetirementYears": "null","middleRetirementGoal": "null","middleRetirementYears": "null","assetContribution1": "null","assetContribution2": "null","assetContribution3": "null","assetContribution4": "null","assetContribution5": "null","assetContribution6": "null","assetContribution7": "null","assetContribution8": "null","assetContribution9": "null","assetContribution10": "null"}

Minimal JSON Request

Optional elements will be defaulted

{"username": "XXXXXX","password": "XXXXXX","clientFirstName": "null","spouseFirstName": "null","clientLastName": "null","spouseLastName": "null","scenarioDescription": "null","clientDOB": "null","clientAge": "null","spouseDOB": "null","spouseAge": "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","clientIncome": "null","spouseIncome": "null","clientPayIncrease": "0.05","spousePayIncrease": "0.05","clientRetirementAge": "67","spouseRetirementAge": "67","clientDeathAge": "95","spouseDeathAge": "95","assetDescription1": "null","assetValue1": "null","assetOwner1": "Client","assetType1": "Liquid","assetDescription2": "null","assetValue2": "0","assetOwner2": "Client","assetType2": "Liquid","assetDescription3": "null","assetValue3": "0","assetOwner3": "Client","assetType3": "Liquid","assetDescription4": "null","assetValue4": "0","assetOwner4": "Client","assetType4": "Liquid","assetDescription5": "null","assetValue5": "0","assetOwner5": "Client","assetType5": "Liquid","assetDescription6": "null","assetValue6": "0","assetOwner6": "Client","assetType6": "Liquid","assetDescription7": "null","assetValue7": "0","assetOwner7": "Client","assetType7": "Liquid","assetDescription8": "null","assetValue8": "0","assetOwner8": "Client","assetType8": "Liquid","assetDescription9": "null","assetValue9": "0","assetOwner9": "Client","assetType9": "Liquid","assetDescription10": "null","assetValue10": "0","assetOwner10": "Client","assetType10": "Liquid","assetDescription11": "null","assetValue11": "null","assetOwner11": "Client","assetType11": "Liquid","assetDescription12": "null","assetValue12": "0","assetOwner12": "Client","assetType12": "Liquid","assetDescription13": "null","assetValue13": "0","assetOwner13": "Client","assetType13": "Liquid","assetDescription14": "null","assetValue14": "0","assetOwner14": "Client","assetType14": "Liquid","assetDescription15": "null","assetValue15": "0","assetOwner15": "Client","assetType15": "Liquid","assetDescription16": "null","assetValue16": "0","assetOwner16": "Client","assetType16": "Liquid","assetDescription17": "null","assetValue17": "0","assetOwner17": "Client","assetType17": "Liquid","assetDescription18": "null","assetValue18": "0","assetOwner18": "Client","assetType18": "Liquid","assetDescription19": "null","assetValue19": "0","assetOwner19": "Client","assetType19": "Liquid","assetDescription20": "null","assetValue20": "0","assetOwner20": "Client","assetType20": "Liquid","clientQualAnnual": "2000","spouseQualAnnual": "2000","qualIncreases": "N","clientRothAnnual": "0","spouseRothAnnual": "0","rothIncreases": "N","clientNonQualAnnual": "0","spouseNonQualAnnual": "0","nonQualIncreases": "N","forceRMD": "N","clientPension": "15000","clientPensionLS": "0","spousePension": "0","spousePensionLS": "0","clientPensionIncreases": "N","spousePensionIncreases": "N","clientPensionAge": "67","spousePensionAge": "67","otherIncomeDescription1": "null","otherIncomeAmount1": "null","otherIncomeStartAge1": "null","otherIncomeEndAge1": "null","otherIncomeIncreases1": "0.05","otherIncomeReceiptType1": "Receipt","otherIncomeTaxable1": "Y","otherIncomeDescription2": "null","otherIncomeAmount2": "null","otherIncomeStartAge2": "null","otherIncomeEndAge2": "null","otherIncomeIncreases2": "0.05","otherIncomeReceiptType2": "Receipt","otherIncomeTaxable2": "Y","otherIncomeDescription3": "null","otherIncomeAmount3": "null","otherIncomeStartAge3": "null","otherIncomeEndAge3": "null","otherIncomeIncreases3": "0.05","otherIncomeReceiptType3": "Receipt","otherIncomeTaxable3": "Y","otherIncomeDescription4": "null","otherIncomeAmount4": "null","otherIncomeStartAge4": "null","otherIncomeEndAge4": "null","otherIncomeIncreases4": "0.05","otherIncomeReceiptType4": "Receipt","otherIncomeTaxable4": "Y","otherIncomeDescription5": "null","otherIncomeAmount5": "null","otherIncomeStartAge5": "null","otherIncomeEndAge5": "null","otherIncomeIncreases5": "0.05","otherIncomeReceiptType5": "Receipt","otherIncomeTaxable5": "Y","otherIncomeDescription6": "null","otherIncomeAmount6": "null","otherIncomeStartAge6": "null","otherIncomeEndAge6": "null","otherIncomeIncreases6": "0.05","otherIncomeReceiptType6": "Receipt","otherIncomeTaxable6": "Y","retirementGoalPercentage": ".75","retirementGoalAmount": "0","legacyAmount": "0","legacyIncreases": "N","includeSS": "N","inflationSS": ".03","ssBenefitsTaxable": "1","clientSSEligible": "Y","spouseSSEligible": "Y","clientSSOverrideAge": "0","spouseSSOverrideAge": "0","clientSSOverride": "0","spouseSSOverride": "0","recommendedSavingsIncreases": "N","preRetirementReturn": ".06","postRetirementReturn": ".06","preRetirementTaxRate": ".22","postRetirementTaxRate": ".22","inflation": ".03","color1": "null","color2": "null","color3": "null","color4": "null","color5": "null","color6": "null","disclaimer1": "null","disclaimer2": "null","disclaimer3": "null","disclaimer4": "null","ppid": "null","salesAssistantName": "null","salesAssistantPhone": "null","moduleTitle": "null","earlyRetirementGoal": "null","earlyRetirementYears": "null","middleRetirementGoal": "null","middleRetirementYears": "null","assetContribution1": "null","assetContribution2": "null","assetContribution3": "null","assetContribution4": "null","assetContribution5": "null","assetContribution6": "null","assetContribution7": "null","assetContribution8": "null","assetContribution9": "null","assetContribution10": "null"}

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
clientDOB Data type: xs:string Valid values: 0 to 999999999
clientAge Data type: xs:string Valid values: 0 to 999999999
spouseDOB Data type: xs:string Valid values: 0 to 999999999
spouseAge 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
clientIncome Data type: xs:double Valid values: 0 to 999999999
spouseIncome Data type: xs:double Valid values: 0 to 999999999
clientPayIncrease Data type: xs:float Valid values: 0 to .20
spousePayIncrease Data type: xs:float Valid values: 0 to .20
clientRetirementAge Data type: xs:integer Valid values: 0 to 120
spouseRetirementAge Data type: xs:integer Valid values: 0 to 120
clientDeathAge Data type: xs:integer Valid values: 0 to 120
spouseDeathAge Data type: xs:integer Valid values: 0 to 120
assetDescription1 Data type: xs:string Valid values: 0 to 999999999
assetValue1 Data type: xs:double Valid values: 0 to 999999999
assetOwner1 Data type: xs:string Valid values: Client, Spouse, Joint (Joint Tenancy), ComProp (Community Property)
assetType1 Data type: xs:string Valid values: Liquid, Business, QualTrad (Traditional Qualified Plan), QualRoth (Roth Qualified Plan), NonQualInv (Taxable Investment)
assetDescription2 Data type: xs:string Valid values: 0 to 999999999
assetValue2 Data type: xs:double Valid values: 0 to 999999999
assetOwner2 Data type: xs:string Valid values: Client, Spouse, Joint (Joint Tenancy), ComProp (Community Property)
assetType2 Data type: xs:string Valid values: Liquid, Business, QualTrad (Traditional Qualified Plan), QualRoth (Roth Qualified Plan), NonQualInv (Taxable Investment)
assetDescription3 Data type: xs:string Valid values: 0 to 999999999
assetValue3 Data type: xs:double Valid values: 0 to 999999999
assetOwner3 Data type: xs:string Valid values: Client, Spouse, Joint (Joint Tenancy), ComProp (Community Property)
assetType3 Data type: xs:string Valid values: Liquid, Business, QualTrad (Traditional Qualified Plan), QualRoth (Roth Qualified Plan), NonQualInv (Taxable Investment)
assetDescription4 Data type: xs:string Valid values: 0 to 999999999
assetValue4 Data type: xs:double Valid values: 0 to 999999999
assetOwner4 Data type: xs:string Valid values: Client, Spouse, Joint (Joint Tenancy), ComProp (Community Property)
assetType4 Data type: xs:string Valid values: Liquid, Business, QualTrad (Traditional Qualified Plan), QualRoth (Roth Qualified Plan), NonQualInv (Taxable Investment)
assetDescription5 Data type: xs:string Valid values: 0 to 999999999
assetValue5 Data type: xs:double Valid values: 0 to 999999999
assetOwner5 Data type: xs:string Valid values: Client, Spouse, Joint (Joint Tenancy), ComProp (Community Property)
assetType5 Data type: xs:string Valid values: Liquid, Business, QualTrad (Traditional Qualified Plan), QualRoth (Roth Qualified Plan), NonQualInv (Taxable Investment)
assetDescription6 Data type: xs:string Valid values: 0 to 999999999
assetValue6 Data type: xs:double Valid values: 0 to 999999999
assetOwner6 Data type: xs:string Valid values: Client, Spouse, Joint (Joint Tenancy), ComProp (Community Property)
assetType6 Data type: xs:string Valid values: Liquid, Business, QualTrad (Traditional Qualified Plan), QualRoth (Roth Qualified Plan), NonQualInv (Taxable Investment)
assetDescription7 Data type: xs:string Valid values: 0 to 999999999
assetValue7 Data type: xs:double Valid values: 0 to 999999999
assetOwner7 Data type: xs:string Valid values: Client, Spouse, Joint (Joint Tenancy), ComProp (Community Property)
assetType7 Data type: xs:string Valid values: Liquid, Business, QualTrad (Traditional Qualified Plan), QualRoth (Roth Qualified Plan), NonQualInv (Taxable Investment)
assetDescription8 Data type: xs:string Valid values: 0 to 999999999
assetValue8 Data type: xs:double Valid values: 0 to 999999999
assetOwner8 Data type: xs:string Valid values: Client, Spouse, Joint (Joint Tenancy), ComProp (Community Property)
assetType8 Data type: xs:string Valid values: Liquid, Business, QualTrad (Traditional Qualified Plan), QualRoth (Roth Qualified Plan), NonQualInv (Taxable Investment)
assetDescription9 Data type: xs:string Valid values: 0 to 999999999
assetValue9 Data type: xs:double Valid values: 0 to 999999999
assetOwner9 Data type: xs:string Valid values: Client, Spouse, Joint (Joint Tenancy), ComProp (Community Property)
assetType9 Data type: xs:string Valid values: Liquid, Business, QualTrad (Traditional Qualified Plan), QualRoth (Roth Qualified Plan), NonQualInv (Taxable Investment)
assetDescription10 Data type: xs:string Valid values: 0 to 999999999
assetValue10 Data type: xs:double Valid values: 0 to 999999999
assetOwner10 Data type: xs:string Valid values: Client, Spouse, Joint (Joint Tenancy), ComProp (Community Property)
assetType10 Data type: xs:string Valid values: Liquid, Business, QualTrad (Traditional Qualified Plan), QualRoth (Roth Qualified Plan), NonQualInv (Taxable Investment)
assetDescription11 Data type: xs:string Valid values: 0 to 999999999
assetValue11 Data type: xs:double Valid values: 0 to 999999999
assetOwner11 Data type: xs:string Valid values: Client, Spouse, Joint (Joint Tenancy), ComProp (Community Property)
assetType11 Data type: xs:string Valid values: Liquid, Business, QualTrad (Traditional Qualified Plan), QualRoth (Roth Qualified Plan), NonQualInv (Taxable Investment)
assetDescription12 Data type: xs:string Valid values: 0 to 999999999
assetValue12 Data type: xs:double Valid values: 0 to 999999999
assetOwner12 Data type: xs:string Valid values: Client, Spouse, Joint (Joint Tenancy), ComProp (Community Property)
assetType12 Data type: xs:string Valid values: Liquid, Business, QualTrad (Traditional Qualified Plan), QualRoth (Roth Qualified Plan), NonQualInv (Taxable Investment)
assetDescription13 Data type: xs:string Valid values: 0 to 999999999
assetValue13 Data type: xs:double Valid values: 0 to 999999999
assetOwner13 Data type: xs:string Valid values: Client, Spouse, Joint (Joint Tenancy), ComProp (Community Property)
assetType13 Data type: xs:string Valid values: Liquid, Business, QualTrad (Traditional Qualified Plan), QualRoth (Roth Qualified Plan), NonQualInv (Taxable Investment)
assetDescription14 Data type: xs:string Valid values: 0 to 999999999
assetValue14 Data type: xs:double Valid values: 0 to 999999999
assetOwner14 Data type: xs:string Valid values: Client, Spouse, Joint (Joint Tenancy), ComProp (Community Property)
assetType14 Data type: xs:string Valid values: Liquid, Business, QualTrad (Traditional Qualified Plan), QualRoth (Roth Qualified Plan), NonQualInv (Taxable Investment)
assetDescription15 Data type: xs:string Valid values: 0 to 999999999
assetValue15 Data type: xs:double Valid values: 0 to 999999999
assetOwner15 Data type: xs:string Valid values: Client, Spouse, Joint (Joint Tenancy), ComProp (Community Property)
assetType15 Data type: xs:string Valid values: Liquid, Business, QualTrad (Traditional Qualified Plan), QualRoth (Roth Qualified Plan), NonQualInv (Taxable Investment)
assetDescription16 Data type: xs:string Valid values: 0 to 999999999
assetValue16 Data type: xs:double Valid values: 0 to 999999999
assetOwner16 Data type: xs:string Valid values: Client, Spouse, Joint (Joint Tenancy), ComProp (Community Property)
assetType16 Data type: xs:string Valid values: Liquid, Business, QualTrad (Traditional Qualified Plan), QualRoth (Roth Qualified Plan), NonQualInv (Taxable Investment)
assetDescription17 Data type: xs:string Valid values: 0 to 999999999
assetValue17 Data type: xs:double Valid values: 0 to 999999999
assetOwner17 Data type: xs:string Valid values: Client, Spouse, Joint (Joint Tenancy), ComProp (Community Property)
assetType17 Data type: xs:string Valid values: Liquid, Business, QualTrad (Traditional Qualified Plan), QualRoth (Roth Qualified Plan), NonQualInv (Taxable Investment)
assetDescription18 Data type: xs:string Valid values: 0 to 999999999
assetValue18 Data type: xs:double Valid values: 0 to 999999999
assetOwner18 Data type: xs:string Valid values: Client, Spouse, Joint (Joint Tenancy), ComProp (Community Property)
assetType18 Data type: xs:string Valid values: Liquid, Business, QualTrad (Traditional Qualified Plan), QualRoth (Roth Qualified Plan), NonQualInv (Taxable Investment)
assetDescription19 Data type: xs:string Valid values: 0 to 999999999
assetValue19 Data type: xs:double Valid values: 0 to 999999999
assetOwner19 Data type: xs:string Valid values: Client, Spouse, Joint (Joint Tenancy), ComProp (Community Property)
assetType19 Data type: xs:string Valid values: Liquid, Business, QualTrad (Traditional Qualified Plan), QualRoth (Roth Qualified Plan), NonQualInv (Taxable Investment)
assetDescription20 Data type: xs:string Valid values: 0 to 999999999
assetValue20 Data type: xs:double Valid values: 0 to 999999999
assetOwner20 Data type: xs:string Valid values: Client, Spouse, Joint (Joint Tenancy), ComProp (Community Property)
assetType20 Data type: xs:string Valid values: Liquid, Business, QualTrad (Traditional Qualified Plan), QualRoth (Roth Qualified Plan), NonQualInv (Taxable Investment)
clientQualAnnual Data type: xs:double Valid values: 0 to 999999999
spouseQualAnnual Data type: xs:double Valid values: 0 to 999999999
qualIncreases Data type: xs:string Valid values: N (No), Y (Yes)
clientRothAnnual Data type: xs:double Valid values: 0 to 999999999
spouseRothAnnual Data type: xs:double Valid values: 0 to 999999999
rothIncreases Data type: xs:string Valid values: N (No), Y (Yes)
clientNonQualAnnual Data type: xs:double Valid values: 0 to 999999999
spouseNonQualAnnual Data type: xs:double Valid values: 0 to 999999999
nonQualIncreases Data type: xs:string Valid values: N (No), Y (Yes)
forceRMD Data type: xs:string Valid values: N (No), Y (Yes)
clientPension Data type: xs:double Valid values: 0 to 999999999
clientPensionLS Data type: xs:double Valid values: 0 to 999999999
spousePension Data type: xs:double Valid values: 0 to 999999999
spousePensionLS Data type: xs:double Valid values: 0 to 999999999
clientPensionIncreases Data type: xs:string Valid values: N (No), Y (Yes)
spousePensionIncreases Data type: xs:string Valid values: N (No), Y (Yes)
clientPensionAge Data type: xs:integer Valid values: 0 to 120
spousePensionAge Data type: xs:integer Valid values: 0 to 120
otherIncomeDescription1 Data type: xs:string Valid values: 0 to 999999999
otherIncomeAmount1 Data type: xs:double Valid values: 0 to 999999999
otherIncomeStartAge1 Data type: xs:integer Valid values: 0 to 120
otherIncomeEndAge1 Data type: xs:integer Valid values: 0 to 120
otherIncomeIncreases1 Data type: xs:float Valid values: 0 to .20
otherIncomeReceiptType1 Data type: xs:string Valid values: Receipt, Expense
otherIncomeTaxable1 Data type: xs:string Valid values: N (No), Y (Yes)
otherIncomeDescription2 Data type: xs:string Valid values: 0 to 999999999
otherIncomeAmount2 Data type: xs:double Valid values: 0 to 999999999
otherIncomeStartAge2 Data type: xs:integer Valid values: 0 to 120
otherIncomeEndAge2 Data type: xs:integer Valid values: 0 to 120
otherIncomeIncreases2 Data type: xs:float Valid values: 0 to .20
otherIncomeReceiptType2 Data type: xs:string Valid values: Receipt, Expense
otherIncomeTaxable2 Data type: xs:string Valid values: N (No), Y (Yes)
otherIncomeDescription3 Data type: xs:string Valid values: 0 to 999999999
otherIncomeAmount3 Data type: xs:double Valid values: 0 to 999999999
otherIncomeStartAge3 Data type: xs:integer Valid values: 0 to 120
otherIncomeEndAge3 Data type: xs:integer Valid values: 0 to 120
otherIncomeIncreases3 Data type: xs:float Valid values: 0 to .20
otherIncomeReceiptType3 Data type: xs:string Valid values: Receipt, Expense
otherIncomeTaxable3 Data type: xs:string Valid values: N (No), Y (Yes)
otherIncomeDescription4 Data type: xs:string Valid values: 0 to 999999999
otherIncomeAmount4 Data type: xs:double Valid values: 0 to 999999999
otherIncomeStartAge4 Data type: xs:integer Valid values: 0 to 120
otherIncomeEndAge4 Data type: xs:integer Valid values: 0 to 120
otherIncomeIncreases4 Data type: xs:float Valid values: 0 to .20
otherIncomeReceiptType4 Data type: xs:string Valid values: Receipt, Expense
otherIncomeTaxable4 Data type: xs:string Valid values: N (No), Y (Yes)
otherIncomeDescription5 Data type: xs:string Valid values: 0 to 999999999
otherIncomeAmount5 Data type: xs:double Valid values: 0 to 999999999
otherIncomeStartAge5 Data type: xs:integer Valid values: 0 to 120
otherIncomeEndAge5 Data type: xs:integer Valid values: 0 to 120
otherIncomeIncreases5 Data type: xs:float Valid values: 0 to .20
otherIncomeReceiptType5 Data type: xs:string Valid values: Receipt, Expense
otherIncomeTaxable5 Data type: xs:string Valid values: N (No), Y (Yes)
otherIncomeDescription6 Data type: xs:string Valid values: 0 to 999999999
otherIncomeAmount6 Data type: xs:double Valid values: 0 to 999999999
otherIncomeStartAge6 Data type: xs:integer Valid values: 0 to 120
otherIncomeEndAge6 Data type: xs:integer Valid values: 0 to 120
otherIncomeIncreases6 Data type: xs:float Valid values: 0 to .20
otherIncomeReceiptType6 Data type: xs:string Valid values: Receipt, Expense
otherIncomeTaxable6 Data type: xs:string Valid values: N (No), Y (Yes)
retirementGoalPercentage Data type: xs:float Valid values: 0 to 1
retirementGoalAmount Data type: xs:double Valid values: 0 to 999999999
legacyAmount Data type: xs:double Valid values: 0 to 999999999
legacyIncreases Data type: xs:string Valid values: N (No), Y (Yes)
includeSS Data type: xs:string Valid values: N (No), Y (Yes)
inflationSS Data type: xs:float Valid values: 0 to .10
ssBenefitsTaxable Data type: xs:integer Valid values: 1 (85%), 2 (50%), 3 (n/a)
clientSSEligible Data type: xs:string Valid values: N (No), Y (Yes)
spouseSSEligible Data type: xs:string Valid values: N (No), Y (Yes)
clientSSOverrideAge Data type: xs:integer Valid values: 0 to 120
spouseSSOverrideAge Data type: xs:integer Valid values: 0 to 120
clientSSOverride Data type: xs:double Valid values: 0 to 999999999
spouseSSOverride Data type: xs:double Valid values: 0 to 999999999
recommendedSavingsIncreases Data type: xs:string Valid values: N (No), Y (Yes)
preRetirementReturn Data type: xs:float Valid values: -.12 to .12
postRetirementReturn Data type: xs:float Valid values: -.12 to .12
preRetirementTaxRate Data type: xs:float Valid values: 0 to .75
postRetirementTaxRate Data type: xs:float Valid values: 0 to .75
inflation Data type: xs:float Valid values: 0 to .10
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
salesAssistantName Data type: xs:string Valid values: 0 to 999999999
salesAssistantPhone Data type: xs:string Valid values: 0 to 999999999
moduleTitle Data type: xs:string Valid values: 0 to 999999999
earlyRetirementGoal Data type: xs:double Valid values: 0 to 999999999
earlyRetirementYears Data type: xs:integer Valid values: 0 to 120
middleRetirementGoal Data type: xs:double Valid values: 0 to 999999999
middleRetirementYears Data type: xs:integer Valid values: 0 to 120
assetContribution1 Data type: xs:double Valid values: 0 to 999999999
assetContribution2 Data type: xs:double Valid values: 0 to 999999999
assetContribution3 Data type: xs:double Valid values: 0 to 999999999
assetContribution4 Data type: xs:double Valid values: 0 to 999999999
assetContribution5 Data type: xs:double Valid values: 0 to 999999999
assetContribution6 Data type: xs:double Valid values: 0 to 999999999
assetContribution7 Data type: xs:double Valid values: 0 to 999999999
assetContribution8 Data type: xs:double Valid values: 0 to 999999999
assetContribution9 Data type: xs:double Valid values: 0 to 999999999
assetContribution10 Data type: xs:double Valid values: 0 to 999999999

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

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