Jump to

• Request
• Response

Collection GET action not supported.

get

/hcmRestApi/resources/11.13.18.05/healthSavingsAccountCalculator

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey
    Finder Variables:
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • 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; 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; Plan type of the HSA.
  • PlanTypeMeaning; string; Meaning of the plan type.
  • RateOfReturn; string; Expected rate of return of the HSA.
  • TaxYear; string; Start year for taxes.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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 : healthSavingsAccountCalculator

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/healthSavingsAccountCalculator-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object healthSavingsAccountCalculator-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/healthSavingsAccountCalculator-item-response"
    }
}

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 : healthSavingsAccountCalculator-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "EstimatedFutureValue":{
            "type":"string",
            "description":"Estimated future value of the HSA.",
            "nullable":true,
            "x-queryable":true
        },
        "AnnualLimit":{
            "type":"number",
            "description":"Annual limit of the HSA.",
            "nullable":true,
            "x-queryable":true
        },
        "RateOfReturn":{
            "type":"string",
            "description":"Expected rate of return of the HSA.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrentBalance":{
            "type":"string",
            "description":"Current balance amount of the employee.",
            "nullable":true,
            "x-queryable":true
        },
        "AnnualMedicalExpense":{
            "type":"string",
            "description":"Annual medical expenses of the employee.",
            "nullable":true,
            "x-queryable":true
        },
        "ContributionPeriodYears":{
            "type":"string",
            "description":"Contribution period for the health savings account.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanTypeCode":{
            "maxLength":255,
            "type":"string",
            "description":"Plan type of the HSA.",
            "nullable":false,
            "x-queryable":true
        },
        "PlanTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the plan type.",
            "nullable":true,
            "x-queryable":true
        },
        "AnnualContribution":{
            "type":"string",
            "description":"Annual deductible amount of the employee.",
            "nullable":true,
            "x-queryable":true
        },
        "EstimatedTaxRate":{
            "type":"string",
            "description":"Estimated tax rate applicable for the employee.",
            "nullable":true,
            "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"
            }
        },
        "EstimatedTaxSavings":{
            "type":"string",
            "description":"Estimated tax savings of the employee.",
            "nullable":true,
            "x-queryable":true
        },
        "EstimatedEarnings":{
            "type":"string",
            "description":"Estimated earnings of the employee.",
            "nullable":true,
            "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."
        }
    }
}

Links

calculateHsaProjections

Operation: /hcmRestApi/resources/11.13.18.05/healthSavingsAccountCalculator/action/calculateHsaProjections

Calculates the projections of health savings by using the values of the custom action elements.

Back to Top