Deductions
Documents
Management
Sandbox
- POSTCreate a new Sandbox Connection
- POSTCreate a new sandbox account
- PUTUpdate a sandbox account
- GETGet configurations for sandbox jobs
- PUTUpdate configurations for sandbox jobs
- POSTAdd a new sandbox payment
- PUTUpdate sandbox individual
- PUTUpdate sandbox employment
- POSTAdd new individuals to a sandbox company
- PUTUpdate a sandbox company's data
- POSTEnqueue a new sandbox job
Development Guides
Organization
Employment
Read individual employment and income data
POST
/
employer
/
employment
import Finch from '@tryfinch/finch-api';
const client = new Finch({
accessToken: 'My Access Token',
});
async function main() {
// Automatically fetches more pages as needed.
for await (const employmentDataResponse of client.hris.employments.retrieveMany({
requests: [{ individual_id: 'individual_id' }],
})) {
console.log(employmentDataResponse.individual_id);
}
}
main();
{
"responses": [
{
"individual_id": "5d0b10a1-a09a-430f-81f1-20be735dc5e9",
"code": 200,
"body": {
"id": "5d0b10a1-a09a-430f-81f1-20be735dc5e9",
"first_name": "Jane",
"middle_name": null,
"last_name": "Doe",
"title": "Customer Support",
"manager": {
"id": "c205b3fa-b626-4346-bf0f-ca065ab88d31"
},
"department": {
"name": "Product"
},
"employment": {
"type": "employee",
"subtype": "full_time"
},
"start_date": "2017-06-30",
"end_date": null,
"latest_rehire_date": null,
"is_active": true,
"employment_status": "onboarding",
"class_code": "8810",
"location": {
"line1": "12 Bird Drive",
"line2": null,
"city": "Palo Alto",
"state": "CA",
"postal_code": "94301",
"country": "US"
},
"income": {
"unit": "yearly",
"amount": 10000000,
"currency": "usd",
"effective_date": "2019-03-01"
},
"income_history": [
{
"unit": "yearly",
"amount": 9000000,
"currency": "usd",
"effective_date": "2018-05-15"
},
{
"unit": "yearly",
"amount": 8000000,
"currency": "usd",
"effective_date": "2017-06-30"
}
],
"custom_fields": [
{
"name": "tShirtSize",
"value": "L"
}
]
}
}
]
}
Note: Income information is returned as reported by the provider. This may not always be annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc, depending on what information the provider returns.
Authorizations
Please use your Access Token
Headers
Header used to specify the version for a given API request. Current version is 2020-09-17.
Used to indicate the original media type of the resource
Body
application/json
Individual Ids Request Body
Response
200
application/json
Employment data
The response is of type object
.
Was this page helpful?
import Finch from '@tryfinch/finch-api';
const client = new Finch({
accessToken: 'My Access Token',
});
async function main() {
// Automatically fetches more pages as needed.
for await (const employmentDataResponse of client.hris.employments.retrieveMany({
requests: [{ individual_id: 'individual_id' }],
})) {
console.log(employmentDataResponse.individual_id);
}
}
main();
{
"responses": [
{
"individual_id": "5d0b10a1-a09a-430f-81f1-20be735dc5e9",
"code": 200,
"body": {
"id": "5d0b10a1-a09a-430f-81f1-20be735dc5e9",
"first_name": "Jane",
"middle_name": null,
"last_name": "Doe",
"title": "Customer Support",
"manager": {
"id": "c205b3fa-b626-4346-bf0f-ca065ab88d31"
},
"department": {
"name": "Product"
},
"employment": {
"type": "employee",
"subtype": "full_time"
},
"start_date": "2017-06-30",
"end_date": null,
"latest_rehire_date": null,
"is_active": true,
"employment_status": "onboarding",
"class_code": "8810",
"location": {
"line1": "12 Bird Drive",
"line2": null,
"city": "Palo Alto",
"state": "CA",
"postal_code": "94301",
"country": "US"
},
"income": {
"unit": "yearly",
"amount": 10000000,
"currency": "usd",
"effective_date": "2019-03-01"
},
"income_history": [
{
"unit": "yearly",
"amount": 9000000,
"currency": "usd",
"effective_date": "2018-05-15"
},
{
"unit": "yearly",
"amount": 8000000,
"currency": "usd",
"effective_date": "2017-06-30"
}
],
"custom_fields": [
{
"name": "tShirtSize",
"value": "L"
}
]
}
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.