JavaScript
import Finch from '@tryfinch/finch-api';
const client = new Finch();
// Automatically fetches more pages as needed.
for await (const providerListResponse of client.providers.list()) {
console.log(providerListResponse.id);
}from finch import Finch
client = Finch()
page = client.providers.list()
page = page.items[0]
print(page.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"),
option.WithClientID("4ab15e51-11ad-49f4-acae-f343b7794375"),
option.WithClientSecret("My Client Secret"),
)
page, err := client.Providers.List(context.TODO())
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", page)
}
package com.tryfinch.api.example;
import com.tryfinch.api.client.FinchClient;
import com.tryfinch.api.client.okhttp.FinchOkHttpClient;
import com.tryfinch.api.models.ProviderListPage;
import com.tryfinch.api.models.ProviderListParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
FinchClient client = FinchOkHttpClient.builder()
.fromEnv()
.accessToken("My Access Token")
.build();
ProviderListPage page = client.providers().list();
}
}package com.tryfinch.api.example
import com.tryfinch.api.client.FinchClient
import com.tryfinch.api.client.okhttp.FinchOkHttpClient
import com.tryfinch.api.models.ProviderListPage
import com.tryfinch.api.models.ProviderListParams
fun main() {
val client: FinchClient = FinchOkHttpClient.builder()
.fromEnv()
.accessToken("My Access Token")
.build()
val page: ProviderListPage = client.providers().list()
}require "finch_api"
finch = FinchAPI::Client.new(
access_token: "My Access Token",
client_id: "4ab15e51-11ad-49f4-acae-f343b7794375",
client_secret: "My Client Secret"
)
page = finch.providers.list
puts(page)curl --request GET \
--url https://api.tryfinch.com/providers \
--header 'Finch-API-Version: <finch-api-version>'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.tryfinch.com/providers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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;
}[
{
"id": "<string>",
"display_name": "<string>",
"products": [
"<string>"
],
"icon": "<string>",
"logo": "<string>",
"mfa_required": true,
"primary_color": "<string>",
"manual": true,
"beta": true,
"authentication_methods": [
{
"type": "assisted",
"benefits_support": {},
"supported_fields": {
"company": {
"id": true,
"legal_name": true,
"entity": {
"type": true,
"subtype": true
},
"primary_email": true,
"primary_phone_number": true,
"ein": true,
"accounts": {
"routing_number": true,
"account_name": true,
"institution_name": true,
"account_type": true,
"account_number": true
},
"departments": {
"name": true,
"parent": {
"name": true
}
},
"locations": {
"line1": true,
"line2": true,
"city": true,
"state": true,
"postal_code": true,
"country": true
}
},
"directory": {
"paging": {
"count": true,
"offset": true
},
"individuals": {
"id": true,
"first_name": true,
"middle_name": true,
"last_name": true,
"is_active": true,
"department": true,
"manager": {
"id": true
}
}
},
"individual": {
"id": true,
"first_name": true,
"middle_name": true,
"last_name": true,
"preferred_name": true,
"dob": true,
"gender": true,
"ethnicity": true,
"ssn": true,
"encrypted_ssn": true,
"emails": {
"data": true,
"type": true
},
"phone_numbers": {
"data": true,
"type": true
},
"residence": {
"line1": true,
"line2": true,
"city": true,
"state": true,
"postal_code": true,
"country": true
}
},
"employment": {
"id": true,
"first_name": true,
"middle_name": true,
"last_name": true,
"title": true,
"start_date": true,
"end_date": true,
"is_active": true,
"employment_status": true,
"income_history": true,
"class_code": true,
"custom_fields": true,
"department": {
"name": true
},
"employment": {
"type": true,
"subtype": true
},
"income": {
"amount": true,
"currency": true,
"unit": true
},
"location": {
"line1": true,
"line2": true,
"city": true,
"state": true,
"postal_code": true,
"country": true
},
"manager": {
"id": true
}
},
"payment": {
"id": true,
"pay_date": true,
"debit_date": true,
"company_debit": true,
"gross_pay": true,
"net_pay": true,
"employer_taxes": true,
"employee_taxes": true,
"individual_ids": true,
"pay_period": {
"start_date": true,
"end_date": true
},
"pay_group_ids": true,
"pay_frequencies": true
},
"pay_statement": {
"paging": {
"count": true,
"offset": true
},
"pay_statements": {
"individual_id": true,
"type": true,
"payment_method": true,
"total_hours": true,
"gross_pay": true,
"net_pay": true,
"earnings": {
"type": true,
"name": true,
"amount": true,
"currency": true
},
"employee_deductions": {
"name": true,
"amount": true,
"type": true,
"pre_tax": true,
"currency": true
},
"employer_contributions": {
"name": true,
"amount": true,
"currency": true
},
"taxes": {
"type": true,
"name": true,
"employer": true,
"amount": true,
"currency": true
}
}
},
"pay_group": {
"id": true,
"name": true,
"pay_frequencies": true,
"individual_ids": true
},
"plans": {
"id": true,
"name": true,
"start_date": true,
"type": true,
"description": true,
"network_type": true,
"deduction_codes": true,
"carrier": {
"id": true,
"name": true
},
"end_date": true,
"coverage_tiers": true
},
"plan_enrollments": {
"id": true,
"individual_id": true,
"plan_id": true,
"status": true,
"coverage_tier": true,
"coverage_start_date": true,
"coverage_end_date": true,
"contributions": {
"frequency": true,
"employee_contribution": {
"amount": true,
"currency": true
},
"employer_contribution": {
"amount": true,
"currency": true
}
},
"dependent_ids": true
},
"plan_dependents": {
"dependent_id": true,
"first_name": true,
"last_name": true,
"middle_name": true,
"date_of_birth": true,
"gender": true,
"ssn": true,
"coverage": {
"relationship_to_individual": true,
"individual_id": true,
"enrollments": {
"id": true,
"type": true
}
}
}
}
}
]
}
]Management
Providers
Return details on all available payroll and HR systems.
GET
/
providers
JavaScript
import Finch from '@tryfinch/finch-api';
const client = new Finch();
// Automatically fetches more pages as needed.
for await (const providerListResponse of client.providers.list()) {
console.log(providerListResponse.id);
}from finch import Finch
client = Finch()
page = client.providers.list()
page = page.items[0]
print(page.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"),
option.WithClientID("4ab15e51-11ad-49f4-acae-f343b7794375"),
option.WithClientSecret("My Client Secret"),
)
page, err := client.Providers.List(context.TODO())
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", page)
}
package com.tryfinch.api.example;
import com.tryfinch.api.client.FinchClient;
import com.tryfinch.api.client.okhttp.FinchOkHttpClient;
import com.tryfinch.api.models.ProviderListPage;
import com.tryfinch.api.models.ProviderListParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
FinchClient client = FinchOkHttpClient.builder()
.fromEnv()
.accessToken("My Access Token")
.build();
ProviderListPage page = client.providers().list();
}
}package com.tryfinch.api.example
import com.tryfinch.api.client.FinchClient
import com.tryfinch.api.client.okhttp.FinchOkHttpClient
import com.tryfinch.api.models.ProviderListPage
import com.tryfinch.api.models.ProviderListParams
fun main() {
val client: FinchClient = FinchOkHttpClient.builder()
.fromEnv()
.accessToken("My Access Token")
.build()
val page: ProviderListPage = client.providers().list()
}require "finch_api"
finch = FinchAPI::Client.new(
access_token: "My Access Token",
client_id: "4ab15e51-11ad-49f4-acae-f343b7794375",
client_secret: "My Client Secret"
)
page = finch.providers.list
puts(page)curl --request GET \
--url https://api.tryfinch.com/providers \
--header 'Finch-API-Version: <finch-api-version>'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.tryfinch.com/providers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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;
}[
{
"id": "<string>",
"display_name": "<string>",
"products": [
"<string>"
],
"icon": "<string>",
"logo": "<string>",
"mfa_required": true,
"primary_color": "<string>",
"manual": true,
"beta": true,
"authentication_methods": [
{
"type": "assisted",
"benefits_support": {},
"supported_fields": {
"company": {
"id": true,
"legal_name": true,
"entity": {
"type": true,
"subtype": true
},
"primary_email": true,
"primary_phone_number": true,
"ein": true,
"accounts": {
"routing_number": true,
"account_name": true,
"institution_name": true,
"account_type": true,
"account_number": true
},
"departments": {
"name": true,
"parent": {
"name": true
}
},
"locations": {
"line1": true,
"line2": true,
"city": true,
"state": true,
"postal_code": true,
"country": true
}
},
"directory": {
"paging": {
"count": true,
"offset": true
},
"individuals": {
"id": true,
"first_name": true,
"middle_name": true,
"last_name": true,
"is_active": true,
"department": true,
"manager": {
"id": true
}
}
},
"individual": {
"id": true,
"first_name": true,
"middle_name": true,
"last_name": true,
"preferred_name": true,
"dob": true,
"gender": true,
"ethnicity": true,
"ssn": true,
"encrypted_ssn": true,
"emails": {
"data": true,
"type": true
},
"phone_numbers": {
"data": true,
"type": true
},
"residence": {
"line1": true,
"line2": true,
"city": true,
"state": true,
"postal_code": true,
"country": true
}
},
"employment": {
"id": true,
"first_name": true,
"middle_name": true,
"last_name": true,
"title": true,
"start_date": true,
"end_date": true,
"is_active": true,
"employment_status": true,
"income_history": true,
"class_code": true,
"custom_fields": true,
"department": {
"name": true
},
"employment": {
"type": true,
"subtype": true
},
"income": {
"amount": true,
"currency": true,
"unit": true
},
"location": {
"line1": true,
"line2": true,
"city": true,
"state": true,
"postal_code": true,
"country": true
},
"manager": {
"id": true
}
},
"payment": {
"id": true,
"pay_date": true,
"debit_date": true,
"company_debit": true,
"gross_pay": true,
"net_pay": true,
"employer_taxes": true,
"employee_taxes": true,
"individual_ids": true,
"pay_period": {
"start_date": true,
"end_date": true
},
"pay_group_ids": true,
"pay_frequencies": true
},
"pay_statement": {
"paging": {
"count": true,
"offset": true
},
"pay_statements": {
"individual_id": true,
"type": true,
"payment_method": true,
"total_hours": true,
"gross_pay": true,
"net_pay": true,
"earnings": {
"type": true,
"name": true,
"amount": true,
"currency": true
},
"employee_deductions": {
"name": true,
"amount": true,
"type": true,
"pre_tax": true,
"currency": true
},
"employer_contributions": {
"name": true,
"amount": true,
"currency": true
},
"taxes": {
"type": true,
"name": true,
"employer": true,
"amount": true,
"currency": true
}
}
},
"pay_group": {
"id": true,
"name": true,
"pay_frequencies": true,
"individual_ids": true
},
"plans": {
"id": true,
"name": true,
"start_date": true,
"type": true,
"description": true,
"network_type": true,
"deduction_codes": true,
"carrier": {
"id": true,
"name": true
},
"end_date": true,
"coverage_tiers": true
},
"plan_enrollments": {
"id": true,
"individual_id": true,
"plan_id": true,
"status": true,
"coverage_tier": true,
"coverage_start_date": true,
"coverage_end_date": true,
"contributions": {
"frequency": true,
"employee_contribution": {
"amount": true,
"currency": true
},
"employer_contribution": {
"amount": true,
"currency": true
}
},
"dependent_ids": true
},
"plan_dependents": {
"dependent_id": true,
"first_name": true,
"last_name": true,
"middle_name": true,
"date_of_birth": true,
"gender": true,
"ssn": true,
"coverage": {
"relationship_to_individual": true,
"individual_id": true,
"enrollments": {
"id": true,
"type": true
}
}
}
}
}
]
}
]Headers
Response
200 - application/json
OK
Was this page helpful?