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
Sandbox
Update sandbox employment
PUT
/
sandbox
/
employment
/
{individual_id}
import Finch from '@tryfinch/finch-api';
const client = new Finch({
accessToken: 'My Access Token',
});
async function main() {
const employment = await client.sandbox.employment.update('individual_id');
console.log(employment.id);
}
main();
{
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>",
"title": "<string>",
"manager": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"department": {
"name": "<string>"
},
"employment": {
"type": "employee",
"subtype": "full_time"
},
"start_date": "<string>",
"end_date": "<string>",
"latest_rehire_date": "<string>",
"is_active": true,
"employment_status": "active",
"class_code": "<string>",
"location": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"name": "<string>",
"source_id": "<string>"
},
"income": {
"unit": "yearly",
"amount": 123,
"currency": "<string>",
"effective_date": "<string>"
},
"income_history": [
{
"unit": "yearly",
"amount": 123,
"currency": "<string>",
"effective_date": "<string>"
}
],
"custom_fields": [
{
"name": "<string>",
"value": "<any>"
}
],
"source_id": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
Authorizations
Please use your Access Token
Path Parameters
Body
application/json
Response
200 - application/json
OK
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() {
const employment = await client.sandbox.employment.update('individual_id');
console.log(employment.id);
}
main();
{
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>",
"title": "<string>",
"manager": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"department": {
"name": "<string>"
},
"employment": {
"type": "employee",
"subtype": "full_time"
},
"start_date": "<string>",
"end_date": "<string>",
"latest_rehire_date": "<string>",
"is_active": true,
"employment_status": "active",
"class_code": "<string>",
"location": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"postal_code": "<string>",
"country": "<string>",
"name": "<string>",
"source_id": "<string>"
},
"income": {
"unit": "yearly",
"amount": 123,
"currency": "<string>",
"effective_date": "<string>"
},
"income_history": [
{
"unit": "yearly",
"amount": 123,
"currency": "<string>",
"effective_date": "<string>"
}
],
"custom_fields": [
{
"name": "<string>",
"value": "<any>"
}
],
"source_id": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
Assistant
Responses are generated using AI and may contain mistakes.