Create an estimate
post
/hcmRestApi/resources/11.13.18.05/healthSavingsAccountCalculator
Request
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AnnualContribution: string
Annual deductible amount of the employee.
-
AnnualLimit: number
Annual limit of the HSA.
-
AnnualMedicalExpense: string
Annual medical expenses of the employee.
-
ContributionPeriodYears: string
Contribution period for the health savings account.
-
Currency: string
Maximum Length:
80
Symbol of the currency. -
CurrentBalance: string
Current balance amount of the employee.
-
EstimatedEarnings: string
Estimated earnings of the employee.
-
EstimatedFutureValue: string
Estimated future value of the HSA.
-
EstimatedTaxRate: string
Estimated tax rate applicable for the employee.
-
EstimatedTaxSavings: string
Estimated tax savings of the employee.
-
PlanTypeCode: string
Maximum Length:
255
Plan type of the HSA. -
PlanTypeMeaning: string
Maximum Length:
80
Meaning of the plan type. -
RateOfReturn: string
Expected rate of return of the HSA.
-
TaxYear: string
Maximum Length:
80
Start year for taxes.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : healthSavingsAccountCalculator-item-response
Type:
Show Source
object
-
AnnualContribution: string
Annual deductible amount of the employee.
-
AnnualLimit: number
Annual limit of the HSA.
-
AnnualMedicalExpense: string
Annual medical expenses of the employee.
-
ContributionPeriodYears: string
Contribution period for the health savings account.
-
Currency: string
Maximum Length:
80
Symbol of the currency. -
CurrentBalance: string
Current balance amount of the employee.
-
EstimatedEarnings: string
Estimated earnings of the employee.
-
EstimatedFutureValue: string
Estimated future value of the HSA.
-
EstimatedTaxRate: string
Estimated tax rate applicable for the employee.
-
EstimatedTaxSavings: string
Estimated tax savings of the employee.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanTypeCode: string
Maximum Length:
255
Plan type of the HSA. -
PlanTypeMeaning: string
Maximum Length:
80
Meaning of the plan type. -
RateOfReturn: string
Expected rate of return of the HSA.
-
TaxYear: string
Maximum Length:
80
Start year for taxes.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.