Provider Data Compatibility

Finch APIs try to maintain parity between all providers. However, every now and then, a provider may not support a specific data field (for example: job titles). This section outlines the compatibility of each data field per Automated API Provider and any other miscellaneous information that's important to know.

Search Data Fields

Run Powered by ADP

Automated API

BambooHR

Automated API

BambooHR (API)

Automated API

bob

Automated API

Gusto

Automated API

Humaans

Automated API

Insperity

Automated API

Justworks

Automated API

Namely

Automated API

Paychex Flex

Automated API

Paychex Flex (API)

Automated API

Paycom

Automated API

Paycom (API)

Automated API

Paylocity

Automated API

Paylocity (API)

Automated API

Personio

Automated API

Quickbooks

Automated API

Rippling

Automated API

Sage HR

Automated API

Sapling

Automated API

Sequoia One

Automated API

Square Payroll

Automated API

TriNet

Automated API

TriNet (API)

Automated API

UltiPro

Automated API

Wave

Automated API

Workday

Automated API

Zenefits

Automated API

Zenefits (API)

Automated API

Active Filter 
[]

Valid Providers 
[
  "Run Powered by ADP",
  "BambooHR",
  "BambooHR (API)",
  "bob",
  "Gusto",
  "Humaans",
  "Insperity",
  "Justworks",
  "Namely",
  "Paychex Flex",
  "Paychex Flex (API)",
  "Paycom",
  "Paycom (API)",
  "Paylocity",
  "Paylocity (API)",
  "Personio",
  "Quickbooks",
  "Rippling",
  "Sage HR",
  "Sapling",
  "Sequoia One",
  "Square Payroll",
  "TriNet",
  "TriNet (API)",
  "UltiPro",
  "Wave",
  "Workday",
  "Zenefits",
  "Zenefits (API)"
]

Query Fields 
[
  {
    "name": "legal_name",
    "description": "The legal name of the company.",
    "product": "company"
  },
  {
    "name": "entity",
    "description": "The entity type object.",
    "product": "company"
  },
  {
    "name": "entity.type",
    "description": "The tax payer type of the company.",
    "allowed_value": [
      "llc",
      "corporation",
      "sole_proprietor",
      "non_profit",
      "partnership",
      "cooperative",
      "null"
    ],
    "product": "company"
  },
  {
    "name": "entity.subtype",
    "description": "The tax payer subtype of the company.",
    "allowed_value": [
      "s_corporation",
      "c_corporation",
      "b_corporation",
      "null"
    ],
    "product": "company"
  },
  {
    "name": "primary_email",
    "description": "The email of the main administrator on the account.",
    "product": "company"
  },
  {
    "name": "primary_phone_number",
    "description": "The phone number of the main administrator on the account. Format: XXXXXXXXXX",
    "product": "company"
  },
  {
    "name": "departments",
    "description": "An array of company departments.",
    "product": "company"
  },
  {
    "name": "departments[].name",
    "description": "The department name.",
    "product": "company"
  },
  {
    "name": "departments[].parent",
    "description": "The parent department, if present.",
    "product": "company"
  },
  {
    "name": "departments[].parent.name",
    "description": "The parent department's name.",
    "product": "company"
  },
  {
    "name": "ein",
    "description": "The employer identification number.",
    "product": "company"
  },
  {
    "name": "locations",
    "description": "The array of company locations.",
    "product": "company"
  },
  {
    "name": "locations[].line1",
    "description": "Street address or PO box.",
    "product": "company"
  },
  {
    "name": "locations[].line2",
    "description": "Apartment, suite, unit, or building.",
    "product": "company"
  },
  {
    "name": "locations[].city",
    "description": "City, district, suburb, town, or village.",
    "product": "company"
  },
  {
    "name": "locations[].state",
    "description": "The state code.",
    "product": "company"
  },
  {
    "name": "locations[].postal_code",
    "description": "The postal code or zip code.",
    "product": "company"
  },
  {
    "name": "locations[].country",
    "description": "The 2-letter ISO 3166 country code.",
    "product": "company"
  },
  {
    "name": "accounts",
    "description": "An array of bank account objects associated with the payroll or HRIS system.",
    "product": "company"
  },
  {
    "name": "accounts[].routing_number",
    "description": "A nine-digit code that's based on the U.S. Bank location where your account was opened.",
    "product": "company"
  },
  {
    "name": "accounts[].account_name",
    "description": "The name of the bank associated in the payroll or HRIS system.",
    "product": "company"
  },
  {
    "name": "accounts[].institution_name",
    "description": "The name of the banking institution.",
    "product": "company"
  },
  {
    "name": "accounts[].account_type",
    "description": "The type of bank account.",
    "allowed_value": [
      "checking",
      "savings",
      "null"
    ],
    "product": "company"
  },
  {
    "name": "accounts[].account_number",
    "description": "A 10-12 digit number to specify the bank account.",
    "product": "company"
  },
  {
    "name": "individuals[].first_name",
    "description": "The legal first name of the individual.",
    "product": "directory"
  },
  {
    "name": "individuals[].middle_name",
    "description": "The legal middle name of the individual.",
    "product": "directory"
  },
  {
    "name": "individuals[].last_name",
    "description": "The legal last name of the individual.",
    "product": "directory"
  },
  {
    "name": "individuals[].manager.id",
    "description": "A stable Finch Id (UUID v4) representing the manager of the individual within the organization.",
    "product": "directory"
  },
  {
    "name": "individuals[].department.name",
    "description": "The name of the individual's current department.",
    "product": "directory"
  },
  {
    "name": "individuals[].is_active",
    "description": "Returns 'true' if the individual is an active employee or contractor at the company.",
    "product": "directory"
  },
  {
    "name": "first_name",
    "description": "The legal first name of the individual.",
    "product": "individual"
  },
  {
    "name": "middle_name",
    "description": "The legal middle name of the individual.",
    "product": "individual"
  },
  {
    "name": "last_name",
    "description": "The legal last name of the individual.",
    "product": "individual"
  },
  {
    "name": "preferred_name",
    "description": "The preferred name of the individual.",
    "product": "individual"
  },
  {
    "name": "emails[].type",
    "description": "The type of email of the individual.",
    "product": "individual"
  },
  {
    "name": "emails[].data",
    "description": "An email of the individual.",
    "product": "individual"
  },
  {
    "name": "phone_numbers[].type",
    "description": "The type of phone number of the individual.",
    "product": "individual"
  },
  {
    "name": "phone_numbers[].data",
    "description": "A phone number of the individual.",
    "product": "individual"
  },
  {
    "name": "gender",
    "description": "The gender of the individual.",
    "product": "individual"
  },
  {
    "name": "dob",
    "description": "The date of birth of the individual.",
    "product": "individual"
  },
  {
    "name": "residence.line1",
    "description": "Street address or PO box.",
    "product": "individual"
  },
  {
    "name": "residence.line2",
    "description": "Apartment, suite, unit, or building.",
    "product": "individual"
  },
  {
    "name": "residence.city",
    "description": "City, district, suburb, town, or village.",
    "product": "individual"
  },
  {
    "name": "residence.state",
    "description": "The state code.",
    "product": "individual"
  },
  {
    "name": "residence.postal_code",
    "description": "The postal code or zip code.",
    "product": "individual"
  },
  {
    "name": "residence.country",
    "description": "The 2-letter ISO 3166 country code.",
    "product": "individual"
  },
  {
    "name": "first_name",
    "description": "The legal first name of the individual.",
    "product": "employment"
  },
  {
    "name": "middle_name",
    "description": "The legal middle name of the individual.",
    "product": "employment"
  },
  {
    "name": "last_name",
    "description": "The legal last name of the individual.",
    "product": "employment"
  },
  {
    "name": "title",
    "description": "The current title of the individual.",
    "product": "employment"
  },
  {
    "name": "manager.id",
    "description": "A stable Finch Id (UUID v4) representing the manager of the individual within the organization.",
    "product": "employment"
  },
  {
    "name": "department.name",
    "description": "The name of the department associated with the individual.",
    "product": "employment"
  },
  {
    "name": "employment.type",
    "description": "The main employment type of the individual.",
    "product": "employment"
  },
  {
    "name": "employment.subtype",
    "description": "The secondary employment type of the individual.",
    "product": "employment"
  },
  {
    "name": "start_date",
    "description": "The first date of employment of the individual.",
    "product": "employment"
  },
  {
    "name": "end_date",
    "description": "The last date of employment of the individual.",
    "product": "employment"
  },
  {
    "name": "is_active",
    "description": "Returns 'true' if the individual is an active employee or contractor at the company.",
    "product": "employment"
  },
  {
    "name": "class_code",
    "description": "Worker's compensation classification code for this employee",
    "product": "employment"
  },
  {
    "name": "location.line1",
    "description": "Street address or PO box.",
    "product": "employment"
  },
  {
    "name": "location.line2",
    "description": "Apartment, suite, unit, or building.",
    "product": "employment"
  },
  {
    "name": "location.city",
    "description": "City, district, suburb, town, or village.",
    "product": "employment"
  },
  {
    "name": "location.state",
    "description": "The state code.",
    "product": "employment"
  },
  {
    "name": "location.postal_code",
    "description": "The postal code or zip code.",
    "product": "employment"
  },
  {
    "name": "location.country",
    "description": "The 2-letter ISO 3166 country code.",
    "product": "employment"
  },
  {
    "name": "income.unit",
    "description": "The income unit of payment",
    "product": "employment"
  },
  {
    "name": "income.amount",
    "description": "The income amount in cents.",
    "product": "employment"
  },
  {
    "name": "income.currency",
    "description": "The currency code.",
    "product": "employment"
  },
  {
    "name": "income.effective_date",
    "description": "The date the income amount went into effect.",
    "product": "employment"
  },
  {
    "name": "income_history[].unit",
    "description": "The income unit of payment",
    "product": "employment"
  },
  {
    "name": "income_history[].amount",
    "description": "The income amount in cents.",
    "product": "employment"
  },
  {
    "name": "income_history[].currency",
    "description": "The currency code.",
    "product": "employment"
  },
  {
    "name": "income_history[].effective_date",
    "description": "The date the income amount went into effect.",
    "product": "employment"
  },
  {
    "name": "pay_period.start_date",
    "description": "The first day of the pay period.",
    "product": "payment"
  },
  {
    "name": "pay_period.end_date",
    "description": "The last day of the pay period.",
    "product": "payment"
  },
  {
    "name": "pay_date",
    "description": "The date on which employees are paid.",
    "product": "payment"
  },
  {
    "name": "debit_date",
    "description": "The date on which the payroll provider debits the payroll amount into the bank account of the employer.",
    "product": "payment"
  },
  {
    "name": "company_debit.amount",
    "description": "The company debit amount in cents.",
    "product": "payment"
  },
  {
    "name": "company_debit.currency",
    "description": "The currency code for company debit.",
    "product": "payment"
  },
  {
    "name": "gross_pay.amount",
    "description": "The company debit amount in cents.",
    "product": "payment"
  },
  {
    "name": "gross_pay.currency",
    "description": "The currency code for gross pay.",
    "product": "payment"
  },
  {
    "name": "net_pay.amount",
    "description": "The net pay amount in cents.",
    "product": "payment"
  },
  {
    "name": "net_pay.currency",
    "description": "The currency code for net pay.",
    "product": "payment"
  },
  {
    "name": "employer_taxes.amount",
    "description": "The employer taxes amount in cents.",
    "product": "payment"
  },
  {
    "name": "employer_taxes.currency",
    "description": "The currency code for employer taxes.",
    "product": "payment"
  },
  {
    "name": "employee_taxes.amount",
    "description": "The employee taxes amount in cents.",
    "product": "payment"
  },
  {
    "name": "employee_taxes.currency",
    "description": "The currency code for employee taxes.",
    "product": "payment"
  },
  {
    "name": "individual_ids[]",
    "description": "An array of stable Finch Ids (UUID v4) representing every individual on this payment.",
    "product": "payment"
  }
]

Product Filter 
{
  "company": false,
  "directory": false,
  "individual": false,
  "employment": false,
  "payment": false,
  "pay_statement": false
}

Supported Data Fields (HRIS & Payroll)

Company

Directory

etc...

Supported Data Fields (Applicant Tracking Systems)

tbd...