Constructor Detail

Method Detail

• withRawResponse

   abstract BenefitService.WithRawResponse withRawResponse()

  Returns a view of this service that provides access to raw HTTP responses for each method.

• withOptions

   abstract BenefitService withOptions(Consumer<ClientOptions.Builder> modifier)

  Returns a view of this service with the given option modifications applied.

  The original service is not modified.

• individuals

   abstract IndividualService individuals()

• create

   CreateCompanyBenefitsResponse create()

  Creates a new company-wide deduction or contribution. Please use the /providers endpoint to view available types for each provider.

• create

   abstract CreateCompanyBenefitsResponse create(HrisBenefitCreateParams params, RequestOptions requestOptions)

• create

   CreateCompanyBenefitsResponse create(HrisBenefitCreateParams params)

• create

   CreateCompanyBenefitsResponse create(RequestOptions requestOptions)

• retrieve

   CompanyBenefit retrieve(String benefitId)

  Lists deductions and contributions information for a given item

• retrieve

   CompanyBenefit retrieve(String benefitId, HrisBenefitRetrieveParams params, RequestOptions requestOptions)

• retrieve

   CompanyBenefit retrieve(String benefitId, HrisBenefitRetrieveParams params)

• retrieve

   abstract CompanyBenefit retrieve(HrisBenefitRetrieveParams params, RequestOptions requestOptions)

• retrieve

   CompanyBenefit retrieve(HrisBenefitRetrieveParams params)

• retrieve

   CompanyBenefit retrieve(String benefitId, RequestOptions requestOptions)

• update

   UpdateCompanyBenefitResponse update(String benefitId)

  Updates an existing company-wide deduction or contribution

• update

   UpdateCompanyBenefitResponse update(String benefitId, HrisBenefitUpdateParams params, RequestOptions requestOptions)

• update

   UpdateCompanyBenefitResponse update(String benefitId, HrisBenefitUpdateParams params)

• update

   abstract UpdateCompanyBenefitResponse update(HrisBenefitUpdateParams params, RequestOptions requestOptions)

• update

   UpdateCompanyBenefitResponse update(HrisBenefitUpdateParams params)

• update

   UpdateCompanyBenefitResponse update(String benefitId, RequestOptions requestOptions)

• list

   HrisBenefitListPage list()

  List all company-wide deductions and contributions.

• list

   abstract HrisBenefitListPage list(HrisBenefitListParams params, RequestOptions requestOptions)

• list

   HrisBenefitListPage list(HrisBenefitListParams params)

• list

   HrisBenefitListPage list(RequestOptions requestOptions)

• listSupportedBenefits

   HrisBenefitListSupportedBenefitsPage listSupportedBenefits()

  Get deductions metadata

• listSupportedBenefits

   abstract HrisBenefitListSupportedBenefitsPage listSupportedBenefits(HrisBenefitListSupportedBenefitsParams params, RequestOptions requestOptions)

• listSupportedBenefits

   HrisBenefitListSupportedBenefitsPage listSupportedBenefits(HrisBenefitListSupportedBenefitsParams params)

• listSupportedBenefits

   HrisBenefitListSupportedBenefitsPage listSupportedBenefits(RequestOptions requestOptions)

• register

   RegisterCompanyBenefitResponse register()

  Register existing benefits from the customer on the provider, on Finch's end. Please use the /provider endpoint to view available types for each provider.

• register

   abstract RegisterCompanyBenefitResponse register(HrisBenefitRegisterParams params, RequestOptions requestOptions)

• register

   RegisterCompanyBenefitResponse register(HrisBenefitRegisterParams params)

• register

   RegisterCompanyBenefitResponse register(RequestOptions requestOptions)