JavaScript
import Finch from '@tryfinch/finch-api';
const client = new Finch({
accessToken: 'My Access Token',
});
const unenrolledIndividualBenefitResponse = await client.hris.benefits.individuals.unenrollMany(
'benefit_id',
);
console.log(unenrolledIndividualBenefitResponse.job_id);from finch import Finch
client = Finch(
access_token="My Access Token",
)
unenrolled_individual_benefit_response = client.hris.benefits.individuals.unenroll_many(
benefit_id="benefit_id",
)
print(unenrolled_individual_benefit_response.job_id)package main
import (
"context"
"fmt"
"github.com/Finch-API/finch-api-go"
"github.com/Finch-API/finch-api-go/option"
)
func main() {
client := finchgo.NewClient(
option.WithAccessToken("My Access Token"),
)
unenrolledIndividualBenefitResponse, err := client.HRIS.Benefits.Individuals.UnenrollMany(
context.TODO(),
"benefit_id",
finchgo.HRISBenefitIndividualUnenrollManyParams{},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", unenrolledIndividualBenefitResponse.JobID)
}package com.tryfinch.api.example;
import com.tryfinch.api.client.FinchClient;
import com.tryfinch.api.client.okhttp.FinchOkHttpClient;
import com.tryfinch.api.models.HrisBenefitIndividualUnenrollManyParams;
import com.tryfinch.api.models.UnenrolledIndividualBenefitResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
FinchClient client = FinchOkHttpClient.builder()
.fromEnv()
.accessToken("My Access Token")
.build();
UnenrolledIndividualBenefitResponse unenrolledIndividualBenefitResponse = client.hris().benefits().individuals().unenrollMany("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.HrisBenefitIndividualUnenrollManyParams
import com.tryfinch.api.models.UnenrolledIndividualBenefitResponse
fun main() {
val client: FinchClient = FinchOkHttpClient.builder()
.fromEnv()
.accessToken("My Access Token")
.build()
val unenrolledIndividualBenefitResponse: UnenrolledIndividualBenefitResponse = client.hris().benefits().individuals().unenrollMany("benefit_id")
}require "finch_api"
finch = FinchAPI::Client.new(access_token: "My Access Token")
unenrolled_individual_benefit_response = finch.hris.benefits.individuals.unenroll_many("benefit_id")
puts(unenrolled_individual_benefit_response)curl --request DELETE \
--url https://api.tryfinch.com/employer/benefits/{benefit_id}/individuals \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: <content-type>' \
--header 'Finch-API-Version: <finch-api-version>' \
--data '
{
"individual_ids": [
"<string>"
]
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.tryfinch.com/employer/benefits/{benefit_id}/individuals",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_POSTFIELDS => json_encode([
'individual_ids' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: <content-type>",
"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;
}{
"job_id": "be1b3351-a88e-46c2-96e4-c2cf38e529a7"
}{
"code": 404,
"name": "not_found_error",
"finch_code": "benefit_not_found",
"message": "Benefit not found"
}Deductions
Unenroll Individuals from Deductions
Unenroll individuals from a deduction or contribution
DELETE
/
employer
/
benefits
/
{benefit_id}
/
individuals
JavaScript
import Finch from '@tryfinch/finch-api';
const client = new Finch({
accessToken: 'My Access Token',
});
const unenrolledIndividualBenefitResponse = await client.hris.benefits.individuals.unenrollMany(
'benefit_id',
);
console.log(unenrolledIndividualBenefitResponse.job_id);from finch import Finch
client = Finch(
access_token="My Access Token",
)
unenrolled_individual_benefit_response = client.hris.benefits.individuals.unenroll_many(
benefit_id="benefit_id",
)
print(unenrolled_individual_benefit_response.job_id)package main
import (
"context"
"fmt"
"github.com/Finch-API/finch-api-go"
"github.com/Finch-API/finch-api-go/option"
)
func main() {
client := finchgo.NewClient(
option.WithAccessToken("My Access Token"),
)
unenrolledIndividualBenefitResponse, err := client.HRIS.Benefits.Individuals.UnenrollMany(
context.TODO(),
"benefit_id",
finchgo.HRISBenefitIndividualUnenrollManyParams{},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", unenrolledIndividualBenefitResponse.JobID)
}package com.tryfinch.api.example;
import com.tryfinch.api.client.FinchClient;
import com.tryfinch.api.client.okhttp.FinchOkHttpClient;
import com.tryfinch.api.models.HrisBenefitIndividualUnenrollManyParams;
import com.tryfinch.api.models.UnenrolledIndividualBenefitResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
FinchClient client = FinchOkHttpClient.builder()
.fromEnv()
.accessToken("My Access Token")
.build();
UnenrolledIndividualBenefitResponse unenrolledIndividualBenefitResponse = client.hris().benefits().individuals().unenrollMany("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.HrisBenefitIndividualUnenrollManyParams
import com.tryfinch.api.models.UnenrolledIndividualBenefitResponse
fun main() {
val client: FinchClient = FinchOkHttpClient.builder()
.fromEnv()
.accessToken("My Access Token")
.build()
val unenrolledIndividualBenefitResponse: UnenrolledIndividualBenefitResponse = client.hris().benefits().individuals().unenrollMany("benefit_id")
}require "finch_api"
finch = FinchAPI::Client.new(access_token: "My Access Token")
unenrolled_individual_benefit_response = finch.hris.benefits.individuals.unenroll_many("benefit_id")
puts(unenrolled_individual_benefit_response)curl --request DELETE \
--url https://api.tryfinch.com/employer/benefits/{benefit_id}/individuals \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: <content-type>' \
--header 'Finch-API-Version: <finch-api-version>' \
--data '
{
"individual_ids": [
"<string>"
]
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.tryfinch.com/employer/benefits/{benefit_id}/individuals",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_POSTFIELDS => json_encode([
'individual_ids' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: <content-type>",
"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;
}{
"job_id": "be1b3351-a88e-46c2-96e4-c2cf38e529a7"
}{
"code": 404,
"name": "not_found_error",
"finch_code": "benefit_not_found",
"message": "Benefit not found"
}Availability: Automated and Assisted providers
This is a live request to the provider. Latencies may vary from seconds to minutes depending on the provider.
Authorizations
Please use your Access Token
Headers
Header used to specify the version for a given API request. Current version is 2020-09-17.
Pattern:
([12]\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01]))Used to indicate the original media type of the resource
Path Parameters
Query Parameters
The entity IDs to specify which entities' data to access. Provide exactly one entity ID per request; a maximum of one is accepted.
Required array length:
1 elementExample:
["550e8400-e29b-41d4-a716-446655440000"]
Body
application/json
Array of individual_ids to unenroll.
Response
Successfully enqueued job to unenroll individuals from the benefit
Was this page helpful?
⌘I