Retirement Annuities - Response
Please see the Legend to understand the conventions used to document each element and attribute. Note that for responses, the XML elements are documented in the order that they appear in the response.
| Element | Attributes |
|---|---|
<outANNUITY> | |
<CalcResult> | |
<XMLDetail>[] | |
<BeginBalance> | |
<IntRate> | |
<MonthlyIncome> | |
<MonthsOfIncome> | |
<TotalIncome> | |
<Gain> |
🟥 <outANNUITY>
| Element Type | Data Type |
|---|---|
| Parent | - |
This is the root element of the response, and is required. This element simply acts as a container for all of the result child elements.
Attributes: None
🟥 <CalcResult>
| Element Type | Data Type |
|---|---|
| Data | Text |
If the calculation was completed successfully, then this element will contain
the value Valid Calculation. Otherwise, this element will contain a
description of the problem encountered during the attempted computation.
Attributes: None
🟦 <XMLDetail>[]
| Element Type | Data Type | Default |
|---|---|---|
| Data | Text | NULL |
The <XMLDetail> elements are messages passed back to the calling application
which detail the status of the XML request. If the SCE issues any warnings
regarding unrecognized elements or attributes, then each warning message will be
displayed in an <XMLDetail> element.
Attributes: None
🟥 <BeginBalance>
| Element Type | Data Type |
|---|---|
| Data | Currency |
The beginning balance is the amount which is present in the retirement account when the annuity starts.
Attributes: None
🟥 <IntRate>
| Element Type | Data Type |
|---|---|
| Data | Decimal |
The rate at which interest will accrue on the balance during the term of the annuity.
Attributes: None
🟥 <MonthlyIncome>
| Element Type | Data Type |
|---|---|
| Data | Currency |
The amount of the monthly disbursement.
Attributes: None
🟥 <MonthsOfIncome>
| Element Type | Data Type |
|---|---|
| Data | Integer |
This element returns the number of months of income provided by the annuity.
Attributes: None
🟥 <TotalIncome>
| Element Type | Data Type |
|---|---|
| Data | Currency |
The total income is the sum of all monthly disbursements made during the term of the annuity.
Attributes: None
🟥 <Gain>
| Element Type | Data Type |
|---|---|
| Data | Currency |
The gain is the difference between the total income and the beginning balance. It is the total amount of interest accrued over the term of the annuity.
Attributes: None