API Document
Overview
Version information
Version 0.0.1
Contact information
Contact: EValue Support - support@ev.uk
URI scheme
Schemes: HTTP, HTTPS
Consumes
application/json
Produces
application/json
Paths
/schemeContributionCalc/calculate
Description
The Scheme Contribution takes the pension scheme reference and employee contribution percentage and calculates the employer contribution percentage. Please refer to the Pricing Plan and the Credits Plan for the number of credits required to call this API.
Parameters
| Type | Name | Description | Schema | Required |
|---|---|---|---|---|
| BodyParameter | body | Parameters for scheme contribution calculation | SchemeContributionCalcParameters | true |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | successful operation | SchemeContributionResult |
| 400 | Validation errors | ValidationErrors |
| 500 | System error | SystemError |
Definitions
Request
Please note that only the following Definitions will be used when calculating the Result of this API call. Any other data submitted will not be validated or used in the calculation.
SchemeContributionCalcParameters
| Name | Description | Schema | Required | Range |
|---|---|---|---|---|
| typeReference | The type of asset held, this could be in the form of an ISA, Personal Pension, Cash deposit or any other pension or investment. | String | true | |
| employeeContribution | The employee contribution percentage | Double | true | |
| dateOfBirth | ISO-8601 formatted date of birth for the forcastee | String (date) | ||
| salary | The users salary. Optional: if omitted the salary is defaulted to 10,000 | Double | ||
| dateJoinedScheme | The date the user joined the scheme. | String (date) |
Response
SchemeContributionResult
| Name | Description | Schema |
|---|---|---|
| employerContribution | The employer contribution percentage | Double |
ValidationErrors
| Name | Description | Schema |
|---|---|---|
| errors | A list of errors from validating the API input parameters | List of ValidationError |
ValidationError
| Name | Description | Schema |
|---|---|---|
| field | The field that is invalid | String |
| code | The type of validation error that has occurred | Enum - REQUIRED, OUT_OF_RANGE, INVALID, INVALID_TOTAL |
| message | The validation error message | String |
| value | The value that is invalid | String |
SystemError
| Name | Description | Schema |
|---|---|---|
| systemError | The system error message. | String |