Get Deduction

JavaScript

import Finch from '@tryfinch/finch-api';

const client = new Finch({
  accessToken: 'My Access Token',
});

const companyBenefit = await client.hris.benefits.retrieve('benefit_id');

console.log(companyBenefit.benefit_id);

package main

import (
	"context"
	"fmt"

	"github.com/Finch-API/finch-api-go/v2"
	"github.com/Finch-API/finch-api-go/v2/option"
)

func main() {
	client := finchgo.NewClient(
		option.WithAccessToken("My Access Token"),
	)
	companyBenefit, err := client.HRIS.Benefits.Get(
		context.TODO(),
		"benefit_id",
		finchgo.HRISBenefitGetParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", companyBenefit.BenefitID)
}

package com.tryfinch.api.example;

import com.tryfinch.api.client.FinchClient;
import com.tryfinch.api.client.okhttp.FinchOkHttpClient;
import com.tryfinch.api.models.CompanyBenefit;
import com.tryfinch.api.models.HrisBenefitRetrieveParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        FinchClient client = FinchOkHttpClient.builder()
            .fromEnv()
            .accessToken("My Access Token")
            .build();

        CompanyBenefit companyBenefit = client.hris().benefits().retrieve("benefit_id");
    }
}

package com.tryfinch.api.example

import com.tryfinch.api.client.FinchClient
import com.tryfinch.api.client.okhttp.FinchOkHttpClient
import com.tryfinch.api.models.CompanyBenefit
import com.tryfinch.api.models.HrisBenefitRetrieveParams

fun main() {
    val client: FinchClient = FinchOkHttpClient.builder()
        .fromEnv()
        .accessToken("My Access Token")
        .build()

    val companyBenefit: CompanyBenefit = client.hris().benefits().retrieve("benefit_id")
}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.tryfinch.com/employer/benefits/{benefit_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Finch-API-Version: <finch-api-version>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "benefit_id": "6547e3aa-d887-4a77-bd41-17221e17cce3",
  "type": "401k",
  "description": "Example 401k",
  "frequency": "every_paycheck"
}

GET

employer

benefits

{benefit_id}

JavaScript

import Finch from '@tryfinch/finch-api';

const client = new Finch({
  accessToken: 'My Access Token',
});

const companyBenefit = await client.hris.benefits.retrieve('benefit_id');

console.log(companyBenefit.benefit_id);

package main

import (
	"context"
	"fmt"

	"github.com/Finch-API/finch-api-go/v2"
	"github.com/Finch-API/finch-api-go/v2/option"
)

func main() {
	client := finchgo.NewClient(
		option.WithAccessToken("My Access Token"),
	)
	companyBenefit, err := client.HRIS.Benefits.Get(
		context.TODO(),
		"benefit_id",
		finchgo.HRISBenefitGetParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", companyBenefit.BenefitID)
}

package com.tryfinch.api.example;

import com.tryfinch.api.client.FinchClient;
import com.tryfinch.api.client.okhttp.FinchOkHttpClient;
import com.tryfinch.api.models.CompanyBenefit;
import com.tryfinch.api.models.HrisBenefitRetrieveParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        FinchClient client = FinchOkHttpClient.builder()
            .fromEnv()
            .accessToken("My Access Token")
            .build();

        CompanyBenefit companyBenefit = client.hris().benefits().retrieve("benefit_id");
    }
}

package com.tryfinch.api.example

import com.tryfinch.api.client.FinchClient
import com.tryfinch.api.client.okhttp.FinchOkHttpClient
import com.tryfinch.api.models.CompanyBenefit
import com.tryfinch.api.models.HrisBenefitRetrieveParams

fun main() {
    val client: FinchClient = FinchOkHttpClient.builder()
        .fromEnv()
        .accessToken("My Access Token")
        .build()

    val companyBenefit: CompanyBenefit = client.hris().benefits().retrieve("benefit_id")
}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.tryfinch.com/employer/benefits/{benefit_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Finch-API-Version: <finch-api-version>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "benefit_id": "6547e3aa-d887-4a77-bd41-17221e17cce3",
  "type": "401k",
  "description": "Example 401k",
  "frequency": "every_paycheck"
}

Availability: Automated providers only. Employer Match capabilities are currently in Beta. Please reach out if you are interested in gaining early access. This is a live request to the provider. Latencies may vary from seconds to minutes depending on the provider.

Authorizations

Authorization

string

header

required

Please use your Access Token

Headers

Finch-API-Version

string<date>

default:2020-09-17

required

Header used to specify the version for a given API request. Current version is 2020-09-17.

Path Parameters

benefit_id

string

required

Query Parameters

entity_ids

string<uuid>[]

The entity IDs to specify which entities' data to access. Provide exactly one entity ID per request; a maximum of one is accepted. Required when the connection has more than one entity — omitting it returns a 400 invalid_request_error. Optional for single-entity connections.

Required array length: 1 element

Example:

["550e8400-e29b-41d4-a716-446655440000"]

Response

benefit_id

string<uuid>

required

The id of the benefit.

type

enum<string> | null

required

Type of benefit.

Available options:

457,

401k,

401k_roth,

401k_loan,

403b,

403b_roth,

457_roth,

commuter,

custom_post_tax,

custom_pre_tax,

fsa_dependent_care,

fsa_medical,

hsa_post,

hsa_pre,

s125_dental,

s125_medical,

s125_vision,

simple,

simple_ira,

null

description

string | null

required

frequency

enum<string> | null

required

The frequency of the benefit deduction/contribution.

Available options:

every_paycheck,

monthly,

one_time,

null

company_contribution

BenefitCompanyMatchContribution · object | null

The company match for this benefit.

Show child attributes

Organization

Payroll

Deductions

Benefits

Documents

Connect

Management

Sandbox

Development Guides

Get Deduction

Authorizations

Headers

Path Parameters

Query Parameters

Response