CalcXML REST Web Services - bud03 Calculator

URL

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

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","monthlyIncome": "0","fundsAvailable": "0","fundsLast": "6","beforeTaxReturn": ".08","taxBracket": ".22","monthsAccumulate": "36","monthlyExpenses": "0","mortgage": "0","vacation": "0","autoloan": "0","persloan": "0","cc": "0","fedtaxes": "0","statetaxes": "0","fica": "0","retaxes": "0","othertaxes": "0","utilities": "0","repairs": "0","food": "0","clothing": "0","education": "0","childcare": "0","autoexp": "0","transexp": "0","lifeins": "0","homeowners": "0","autoins": "0","medical": "0","entertain": "0","travel": "0","club": "0","hobbies": "0","gifts": "0","homeimp": "0","services": "0","charity": "0","other": "0"}

Minimal JSON Request

Optional elements will be defaulted

{"username": "XXXXXX","password": "XXXXXX","monthlyIncome": "0","fundsAvailable": "0","fundsLast": "6","beforeTaxReturn": ".08","taxBracket": ".22","monthsAccumulate": "36","monthlyExpenses": "0","mortgage": "0","vacation": "0","autoloan": "0","persloan": "0","cc": "0","fedtaxes": "0","statetaxes": "0","fica": "0","retaxes": "0","othertaxes": "0","utilities": "0","repairs": "0","food": "0","clothing": "0","education": "0","childcare": "0","autoexp": "0","transexp": "0","lifeins": "0","homeowners": "0","autoins": "0","medical": "0","entertain": "0","travel": "0","club": "0","hobbies": "0","gifts": "0","homeimp": "0","services": "0","charity": "0","other": "0"}

Description Of Calculator-Specific Request Elements

monthlyIncome Data type: xs:double Valid values: 0 to 999999999
fundsAvailable Data type: xs:double Valid values: 0 to 999999999
fundsLast Data type: xs:integer Valid values: 1 to 360
beforeTaxReturn Data type: xs:float Valid values: -.12 to .12
taxBracket Data type: xs:float Valid values: 0 to .75
monthsAccumulate Data type: xs:integer Valid values: 1 to 360
monthlyExpenses Data type: xs:double Valid values: 0 to 999999999
mortgage Data type: xs:double Valid values: 0 to 999999999
vacation Data type: xs:double Valid values: 0 to 999999999
autoloan Data type: xs:double Valid values: 0 to 999999999
persloan Data type: xs:double Valid values: 0 to 999999999
cc Data type: xs:double Valid values: 0 to 999999999
fedtaxes Data type: xs:double Valid values: 0 to 999999999
statetaxes Data type: xs:double Valid values: 0 to 999999999
fica Data type: xs:double Valid values: 0 to 999999999
retaxes Data type: xs:double Valid values: 0 to 999999999
othertaxes Data type: xs:double Valid values: 0 to 999999999
utilities Data type: xs:double Valid values: 0 to 999999999
repairs Data type: xs:double Valid values: 0 to 999999999
food Data type: xs:double Valid values: 0 to 999999999
clothing Data type: xs:double Valid values: 0 to 999999999
education Data type: xs:double Valid values: 0 to 999999999
childcare Data type: xs:double Valid values: 0 to 999999999
autoexp Data type: xs:double Valid values: 0 to 999999999
transexp Data type: xs:double Valid values: 0 to 999999999
lifeins Data type: xs:double Valid values: 0 to 999999999
homeowners Data type: xs:double Valid values: 0 to 999999999
autoins Data type: xs:double Valid values: 0 to 999999999
medical Data type: xs:double Valid values: 0 to 999999999
entertain Data type: xs:double Valid values: 0 to 999999999
travel Data type: xs:double Valid values: 0 to 999999999
club Data type: xs:double Valid values: 0 to 999999999
hobbies Data type: xs:double Valid values: 0 to 999999999
gifts Data type: xs:double Valid values: 0 to 999999999
homeimp Data type: xs:double Valid values: 0 to 999999999
services Data type: xs:double Valid values: 0 to 999999999
charity Data type: xs:double Valid values: 0 to 999999999
other Data type: xs:double Valid values: 0 to 999999999

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

Description Of Shared Request Elements

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.

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