Management

Enqueue a New Automated Job

Enqueue an automated job.

data_sync_all: Enqueue a job to re-sync all data for a connection. data_sync_all has a concurrency limit of 1 job at a time per connection. This means that if this endpoint is called while a job is already in progress for this connection, Finch will return the job_id of the job that is currently in progress. Finch allows a fixed window rate limit of 1 forced refresh per hour per connection.

w4_form_employee_sync: Enqueues a job for sync W-4 data for a particular individual, identified by individual_id. This feature is currently in beta.

This endpoint is available for Scale tier customers as an add-on. To request access to this endpoint, please contact your Finch account manager.

POST

jobs

automated

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

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

async function main() {
  const automated = await client.jobs.automated.create({ type: 'data_sync_all' });

  console.log(automated.job_id);
}

main();

{
  "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
  "job_url": "https://api.tryfinch.com/jobs/automated/453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
  "allowed_refreshes": 2,
  "remaining_refreshes": 1
}

Authorizations

Authorization

string

header

required

Please use your Access Token

Headers

Finch-API-Version

string

default:2020-09-17

required

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

Content-Type

string

default:application/json

required

Used to indicate the original media type of the resource

Body

type

enum<string>

required

The type of job to start.

Available options:

data_sync_all

Response

201

application/json

Created

job_id

string

The id of the job that has been created.

job_url

string

The url that can be used to retrieve the job status

allowed_refreshes

integer

The number of allowed refreshes per hour (per hour, fixed window)

remaining_refreshes

integer

The number of remaining refreshes available (per hour, fixed window)

Was this page helpful?

List All Automated Jobs Retrieve an Automated Job

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

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

async function main() {
  const automated = await client.jobs.automated.create({ type: 'data_sync_all' });

  console.log(automated.job_id);
}

main();

{
  "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
  "job_url": "https://api.tryfinch.com/jobs/automated/453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
  "allowed_refreshes": 2,
  "remaining_refreshes": 1
}

Organization

Payroll

Deductions

Documents

Connect

Management

Sandbox

Development Guides

Enqueue a New Automated Job

Authorizations

Headers

Body

Response