Get companyRead the employer's own record: legal name, EIN, entity type and subtype, departments, work locations, and the bank accounts payroll is funded from.
List directoryList everyone in the employer's directory - name, department, manager and whether they are currently active - a page at a time.
Get individualsRead personal profiles for the individuals named - preferred name, date of birth, home address, emails and phone numbers.
Get employmentsRead employment records for the individuals named - job title, employment type and status, start and end dates, manager, department, work location, and current and historical pay rates.
List paymentsList the employer's payroll runs whose pay date falls in a date range, with gross and net pay, employee and employer taxes, the company debit, and the pay period each covers.
Get pay statementsRead the per-employee pay statements behind one or more payroll runs: every earning, tax, employee deduction and employer contribution, with the employer's own name for each line alongside Finch's normalised type.
List pay groupsList the employer's pay groups and how often each is paid.
Get pay groupRead one pay group, with the IDs of everyone in it and how often it is paid.
List pay statement itemsList the distinct earnings, taxes, deductions and employer contributions this employer's payroll actually uses - the catalogue of line items, not any one person's amounts.
List benefitsList every benefit the employer offers, with its normalised type, the employer's own description of it, how often it is deducted, and the company's contribution rule.
Get benefitRead one company benefit, with its contribution rule - a fixed amount, a percentage, or a tiered schedule.
List supported benefitsList which benefit types this employer's payroll provider supports through Finch, and what may be set on each - the frequencies allowed, the deduction and contribution styles, and whether annual maximums and catch-up contributions apply.
List enrolled individualsList the IDs of everyone enrolled in one benefit.
Get benefit enrollmentsRead each person's own settings for one benefit - how much they contribute, the company's match, any annual maximum, and whether catch-up contributions apply.
Get connection detailsRead what this connection actually is: which employer and payroll provider it points at, and which products it was authorised for.
List providersList every payroll and HR system Finch can connect to, with the products each supports and how it authenticates.
List data sync jobsList the data-sync jobs Finch has run for this connection, most recent first, with the status of each.
Get data sync jobRead one data-sync job: whether it is pending, running, complete or failed, and when it ran.
