All Implemented Interfaces:

com.tryfinch.api.core.Params
```
public final class HrisBenefitCreateParams
 implements Params
                    
```
Creates a new company-wide deduction or contribution. Please use the /providers endpoint to view available types for each provider.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`HrisBenefitCreateParams.Builder`	A builder for HrisBenefitCreateParams.
`public final class`	`HrisBenefitCreateParams.Body`
`public final class`	`HrisBenefitCreateParams.BenefitCompanyMatchContribution`	The company match for this benefit.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Optional<List<String>>`	`entityIds()`	The entity IDs to specify which entities' data to access.
`final Optional<HrisBenefitCreateParams.BenefitCompanyMatchContribution>`	`companyContribution()`	The company match for this benefit.
`final Optional<String>`	`description()`	Name of the benefit as it appears in the provider and pay statements.
`final Optional<BenefitFrequency>`	`frequency()`	The frequency of the benefit deduction/contribution.
`final Optional<BenefitType>`	`type()`	Type of benefit.
`final JsonField<HrisBenefitCreateParams.BenefitCompanyMatchContribution>`	`_companyContribution()`	Returns the raw JSON value of companyContribution.
`final JsonField<String>`	`_description()`	Returns the raw JSON value of description.
`final JsonField<BenefitFrequency>`	`_frequency()`	Returns the raw JSON value of frequency.
`final JsonField<BenefitType>`	`_type()`	Returns the raw JSON value of type.
`final Map<String, JsonValue>`	`_additionalBodyProperties()`
`final Headers`	`_additionalHeaders()`	Additional headers to send with the request.
`final QueryParams`	`_additionalQueryParams()`	Additional query param to send with the request.
`final HrisBenefitCreateParams.Builder`	`toBuilder()`
`final HrisBenefitCreateParams.Body`	`_body()`
`Headers`	`_headers()`	The full set of headers in the parameters, including both fixed and additional headers.
`QueryParams`	`_queryParams()`	The full set of query params in the parameters, including both fixed and additional query params.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static HrisBenefitCreateParams`	`none()`
`final static HrisBenefitCreateParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of HrisBenefitCreateParams.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - entityIds
```
 final Optional<List<String>> entityIds()
```
    The entity IDs to specify which entities' data to access.
  - companyContribution
```
 final Optional<HrisBenefitCreateParams.BenefitCompanyMatchContribution> companyContribution()
```
    The company match for this benefit.
  - description
```
 final Optional<String> description()
```
    Name of the benefit as it appears in the provider and pay statements. Recommend limiting this to <30 characters due to limitations in specific providers (e.g. Justworks).
  - frequency
```
 final Optional<BenefitFrequency> frequency()
```
    The frequency of the benefit deduction/contribution.
  - type
```
 final Optional<BenefitType> type()
```
    Type of benefit.
  - _companyContribution
```
 final JsonField<HrisBenefitCreateParams.BenefitCompanyMatchContribution> _companyContribution()
```
    Returns the raw JSON value of companyContribution.
    Unlike companyContribution, this method doesn't throw if the JSON field has an unexpected type.
  - _description
```
 final JsonField<String> _description()
```
    Returns the raw JSON value of description.
    Unlike description, this method doesn't throw if the JSON field has an unexpected type.
  - _frequency
```
 final JsonField<BenefitFrequency> _frequency()
```
    Returns the raw JSON value of frequency.
    Unlike frequency, this method doesn't throw if the JSON field has an unexpected type.
  - _type
```
 final JsonField<BenefitType> _type()
```
    Returns the raw JSON value of type.
    Unlike type, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalBodyProperties
```
 final Map<String, JsonValue> _additionalBodyProperties()
```
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
    Additional headers to send with the request.
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
    Additional query param to send with the request.
  - toBuilder
```
 final HrisBenefitCreateParams.Builder toBuilder()
```
  - _body
```
 final HrisBenefitCreateParams.Body _body()
```
  - _headers
```
 Headers _headers()
```
    The full set of headers in the parameters, including both fixed and additional headers.
  - _queryParams
```
 QueryParams _queryParams()
```
    The full set of query params in the parameters, including both fixed and additional query params.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - none
```
 final static HrisBenefitCreateParams none()
```
  - builder
```
 final static HrisBenefitCreateParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of HrisBenefitCreateParams.

Class HrisBenefitCreateParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

entityIds

companyContribution

description

frequency

type

_companyContribution

_description

_frequency

_type

_additionalBodyProperties

_additionalHeaders

_additionalQueryParams

toBuilder

_body

_headers

_queryParams

equals

hashCode

toString

none

builder