GET api/Document/{id}?userId={userId}&incomeOffered={incomeOffered}&costOffered={costOffered}&pensionFundNotes={pensionFundNotes}&commission={commission}&remunerationStatement={remunerationStatement}
Returns the annuity income comparison document for the supplied quote id.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Quote id. Required |
integer |
None. |
| userId |
Provider user id. Required |
globally unique identifier |
None. |
| incomeOffered |
Annual annuity income offered (fund-driven quotes only). This will be used instead of any annual income quoted by your organisation in the real-time quote results. Optional |
decimal number |
None. |
| costOffered |
Cost offered (costed quotes only). This will be used instead of any cost quoted by your organisation in the real-time quote result. Optional |
decimal number |
None. |
| pensionFundNotes |
Additional notes to be included in the document. Optional |
string |
None. |
| commission |
Commission amount to show on the document. This will be used instead of any commission amount returned by your organisation in the real-time quote results. Optional |
decimal number |
None. |
| remunerationStatement |
Remuneration statement to show on the document. This will be used instead of any auto-generated remuneration statement. Optional |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |