Jump to

• Request
• Response

Create an estimate

post

/hcmRestApi/resources/11.13.18.05/healthCareFsaCalculator

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AnnualDeductible: string
  Medical annual deductible of the employee.
• AnnualIncome: string
  Annual income of the employee.
• AnnualLimit: number
  Annual contribution limit for the employee's health care FSA.
• Copayment: string
  Copayment and coinsurance amount paid by the employee.
• Currency: string
  Maximum Length: 80

  Symbol of the currency.
• DentalExpense: string
  Dental expenses of the employee.
• EligibleOtcExpense: string
  Eligible over-the-counter items expenses of the employee.
• EstimatedTaxRate: string
  Estimated tax rate applicable for the employee.
• EyeExamExpense: string
  Expenses of the employee for eye examinations, contacts and glasses.
• HospitalizationExpense: string
  Hospitalization or surgery expenses of the employee.
• OtherMedicalExpenses: string
  Other medical expenses of the employee.
• PotentialTaxSavings: string
  Potential tax savings of the employee.
• PrescriptionDrugExpense: string
  Expenses of the employee for prescription drugs.
• RecommendedContribution: string
  Recommended contribution by the employee.
• SpecialtyCareExpense: string
  Specialty care expenses of the employee.
• TaxYear: string
  Maximum Length: 80

  Start year for taxes.

{
    "type":"object",
    "properties":{
        "EligibleOtcExpense":{
            "type":"string",
            "description":"Eligible over-the-counter items expenses of the employee.",
            "nullable":true
        },
        "PrescriptionDrugExpense":{
            "type":"string",
            "description":"Expenses of the employee for prescription drugs.",
            "nullable":true
        },
        "SpecialtyCareExpense":{
            "type":"string",
            "description":"Specialty care expenses of the employee.",
            "nullable":true
        },
        "AnnualLimit":{
            "type":"number",
            "description":"Annual contribution limit for the employee's health care FSA.",
            "nullable":true
        },
        "PotentialTaxSavings":{
            "type":"string",
            "description":"Potential tax savings of the employee.",
            "nullable":true
        },
        "AnnualDeductible":{
            "type":"string",
            "description":"Medical annual deductible of the employee.",
            "nullable":true
        },
        "HospitalizationExpense":{
            "type":"string",
            "description":"Hospitalization or surgery expenses of the employee.",
            "nullable":true
        },
        "DentalExpense":{
            "type":"string",
            "description":"Dental expenses of the employee.",
            "nullable":true
        },
        "OtherMedicalExpenses":{
            "type":"string",
            "description":"Other medical expenses of the employee.",
            "nullable":true
        },
        "RecommendedContribution":{
            "type":"string",
            "description":"Recommended contribution by the employee.",
            "nullable":true
        },
        "EyeExamExpense":{
            "type":"string",
            "description":"Expenses of the employee for eye examinations, contacts and glasses.",
            "nullable":true
        },
        "EstimatedTaxRate":{
            "type":"string",
            "description":"Estimated tax rate applicable for the employee.",
            "nullable":false
        },
        "Currency":{
            "maxLength":"80",
            "type":"string",
            "description":"Symbol of the currency.",
            "nullable":true
        },
        "Copayment":{
            "type":"string",
            "description":"Copayment and coinsurance amount paid by the employee.",
            "nullable":true
        },
        "AnnualIncome":{
            "type":"string",
            "description":"Annual income of the employee.",
            "nullable":false
        },
        "TaxYear":{
            "maxLength":"80",
            "type":"string",
            "description":"Start year for taxes.",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : healthCareFsaCalculator-item-response

Type: object

Show Source

• AnnualDeductible: string
  Medical annual deductible of the employee.
• AnnualIncome: string
  Annual income of the employee.
• AnnualLimit: number
  Annual contribution limit for the employee's health care FSA.
• Copayment: string
  Copayment and coinsurance amount paid by the employee.
• Currency: string
  Maximum Length: 80

  Symbol of the currency.
• DentalExpense: string
  Dental expenses of the employee.
• EligibleOtcExpense: string
  Eligible over-the-counter items expenses of the employee.
• EstimatedTaxRate: string
  Estimated tax rate applicable for the employee.
• EyeExamExpense: string
  Expenses of the employee for eye examinations, contacts and glasses.
• HospitalizationExpense: string
  Hospitalization or surgery expenses of the employee.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OtherMedicalExpenses: string
  Other medical expenses of the employee.
• PotentialTaxSavings: string
  Potential tax savings of the employee.
• PrescriptionDrugExpense: string
  Expenses of the employee for prescription drugs.
• RecommendedContribution: string
  Recommended contribution by the employee.
• SpecialtyCareExpense: string
  Specialty care expenses of the employee.
• TaxYear: string
  Maximum Length: 80

  Start year for taxes.

{
    "type":"object",
    "properties":{
        "EligibleOtcExpense":{
            "type":"string",
            "description":"Eligible over-the-counter items expenses of the employee.",
            "nullable":true,
            "x-queryable":true
        },
        "PrescriptionDrugExpense":{
            "type":"string",
            "description":"Expenses of the employee for prescription drugs.",
            "nullable":true,
            "x-queryable":true
        },
        "SpecialtyCareExpense":{
            "type":"string",
            "description":"Specialty care expenses of the employee.",
            "nullable":true,
            "x-queryable":true
        },
        "AnnualLimit":{
            "type":"number",
            "description":"Annual contribution limit for the employee's health care FSA.",
            "nullable":true,
            "x-queryable":true
        },
        "PotentialTaxSavings":{
            "type":"string",
            "description":"Potential tax savings of the employee.",
            "nullable":true,
            "x-queryable":true
        },
        "AnnualDeductible":{
            "type":"string",
            "description":"Medical annual deductible of the employee.",
            "nullable":true,
            "x-queryable":true
        },
        "HospitalizationExpense":{
            "type":"string",
            "description":"Hospitalization or surgery expenses of the employee.",
            "nullable":true,
            "x-queryable":true
        },
        "DentalExpense":{
            "type":"string",
            "description":"Dental expenses of the employee.",
            "nullable":true,
            "x-queryable":true
        },
        "OtherMedicalExpenses":{
            "type":"string",
            "description":"Other medical expenses of the employee.",
            "nullable":true,
            "x-queryable":true
        },
        "RecommendedContribution":{
            "type":"string",
            "description":"Recommended contribution by the employee.",
            "nullable":true,
            "x-queryable":true
        },
        "EyeExamExpense":{
            "type":"string",
            "description":"Expenses of the employee for eye examinations, contacts and glasses.",
            "nullable":true,
            "x-queryable":true
        },
        "EstimatedTaxRate":{
            "type":"string",
            "description":"Estimated tax rate applicable for the employee.",
            "nullable":false,
            "x-queryable":true
        },
        "Currency":{
            "maxLength":"80",
            "type":"string",
            "description":"Symbol of the currency.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Copayment":{
            "type":"string",
            "description":"Copayment and coinsurance amount paid by the employee.",
            "nullable":true,
            "x-queryable":true
        },
        "AnnualIncome":{
            "type":"string",
            "description":"Annual income of the employee.",
            "nullable":false,
            "x-queryable":true
        },
        "TaxYear":{
            "maxLength":"80",
            "type":"string",
            "description":"Start year for taxes.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top