
EmployerLink Employment Data
Learn about the employment data that powers Atomic's products. Employment data is delivered to you via webhooks, or you can pull the data via our API.
Be sure to check out our new Coverage Explorer to see coverage across our payroll integrations and what data fields we have to support your use case!
Deposit Accounts
accounts
[Account]- An array of deposit account objects.
Child Properties
Required Properties
accountNumber
string- Account number.
routingNumber
string- The ABA routing number.
type
string- Type of account. Possible values include
checking
,savings
, orpaycard
.
Optional Properties
bankName
stringThe name of the bank or financial institution providing the account.distributionType
stringThe type of distribution for the account. Possible values includetotal
,percent
, orfixed
.distributionAmount
numberThe amount being distributed to the account. WhendistributionType
ispercent
, the number represents a percentage of the total pay. WhendistributionType
isfixed
, this number represents a fixed dollar amount. This value is not set whendistributionType
istotal
.
Sample deposit account data
{
"accounts": [
{
"routingNumber": "123123123",
"accountNumber": "1122330000",
"type": "checking",
"bankName": "Molecular Bank",
"distributionType": "percent",
"distributionAmount": 80
},
{
"routingNumber": "456456456",
"accountNumber": "XXXX1111",
"type": "savings",
"bankName": "Molecular Bank",
"distributionType": "percent",
"distributionAmount": 20
}
]
}
Employee Deductions
employeeDeductions
[Employee Deductions]- An array of employee deduction objects, each containing information about the deductions on file for a specific employee.
Child Properties
Required Properties
_id
string- The
_id
of the deduction in Atomic's system. createdAt
string- The date the deduction was first fetched from the payroll system in ISO 8601 format.
updatedAt
string- The date the deduction was most recently fetched from the payroll system in ISO 8601 format.
employee
string- The
_id
of the employee the deduction belongs to. label
string- The label is a string stored in the payroll sytem to help identify a deduction. If you need to match on specific enumerated categories used by the payroll systems, use the category property instead.
amount
number- Amount of the deduction. Can be a percentage or a fixed dollar amount depending on the value of
calculation
calculation
string- One of
percent
orfixed
.
Sample employee deductions data
{
"employeeDeductions": [
{
"_id": "642703b666b8c0abb8c65cff",
"createdAt": "2023-08-14T20:04:17.459Z",
"updatedAt": "2023-08-14T20:29:45.917Z",
"employee": "642c9aa6f8fc90e0dbb4c92f",
"startDate": "2022-02-02T00:00:00.000Z",
"endDate": "2023-02-02T00:00:00.000Z",
"label": "401k",
"amount": 10,
"calculation": "percent",
"category": "401k",
"categoryType": "pre-tax"
},
{
"_id": "642703b666b8c0abb8c65d01",
"createdAt": "2023-08-14T20:04:17.459Z",
"updatedAt": "2023-08-14T20:29:45.917Z",
"employee": "642c9aa6f8fc90e0dbb4c92f",
"label": "Life Insurance",
"amount": 100,
"calculation": "fixed",
"category": "Other"
}
]
}
Employment
employeeType
string- Type of employment for the specified employee. Possible values are
contract
,fulltime
,intern
,parttime
,seasonal
,student
, andtemporary
. employmentStatus
string- Status of employment for specified employee. Possible values are
active
andterminated
. jobTitle
string- Employee's job title.
startDate
string- Employee's hire date.
weeklyHours
number- Number of hours worked per week.
classCode
string- The class code of the employee.
terminationDate
string- Optional. Date employee's employment was terminated.
Sample employment data
{
"employeeType": "fulltime",
"employmentStatus": "active",
"jobTitle": "Product Manager",
"startDate": "2017-04-19T12:00:00.000Z",
"weeklyHours": 40,
"classCode": 8810,
"terminationDate": "2019-09-01T12:00:00.000Z"
}
Identity
firstName
string- First name.
lastName
string- Last name.
dateOfBirth
string- Date of birth in ISO 8601 format.
email
string- Email address.
phone
string- Phone number.
ssn
string- Social security number.
homeAddress
object- Object containing all fields for an employees home address.
Child Properties
Sample identity data
{
"firstName": "Jane",
"lastName": "Appleseed",
"dateOfBirth": "1984-04-12T12:00:00.000Z",
"email": "janeappleseed@example.com",
"phone": "5558881111",
"ssn": "111223333",
"homeAddress": {
"line1": "123 Example St.",
"line2": "Apt. 345",
"city": "Salt Lake City",
"state": "UT",
"zipcode": "84111",
"country": "USA"
}
}
Income
income
number- Employee's income, represented as a number.
incomeType
string- Employee's income type. Possible values are
yearly
,monthly
,weekly
,daily
, andhourly
. payCycle
string- How frequently the end user gets paid. Possible values are
monthly
,semimonthly
,biweekly
, andweekly
.
Sample income data
{
"income": 45000,
"incomeType": "yearly",
"payCycle": "weekly"
}
Statements
statements
[Statement]- An array of statement objects. For date fields, we will return whichever of
date
,payPeriodStartDate
, andpayPeriodEndDate
are available, depending on the statement provider.Child Properties
Optional Properties
_id
stringTheid
of the statement in Atomic's system.createdAt
stringThe date the statement was first fetched from the payroll system in ISO 8601 format.updatedAt
stringThe date the statement was most recently fetched from the payroll system in ISO 8601 format.employee
stringThe_id
of the employee the statement belongs to.date
stringDate of the deposit in ISO 8601 format.payPeriodStartDate
stringStarting date of the pay period in ISO 8601 format.payPeriodEndDate
stringEnding date of the pay period in ISO 8601 format.grossAmount
numberGross dollar amount of the deposit.ytdGrossAmount
numberYear to date gross dollar amount of the deposit.netAmount
numberNet dollar amount of the deposit.ytdNetAmount
numberYear to date net dollar amount of the deposit.paymentMethod
stringMethod used for the payment. Possible values includedeposit
orcheck
.hours
numberHours worked within the pay period.deductions
[Deduction]An array ofDeduction
objects, describing paycheck deductions such as taxes and benefits. Not all deductions will have bothamount
andytdAmount
available. We will extract all values available to us in the payroll system.Child Properties
Required Properties
category
string- Category of the deduction such as
taxes
,benefits
, orretirement
. rawLabel
string- The label for the deduction, exactly as given by the payroll provider.
label
string- A derived label for the deduction, if we think it matches a common deduction such as
Federal Income Tax
,Medicare
, orSocial Security
. The same asrawLabel
if we are unable to match a common deduction.
earnings
[Earnings]An array ofEarnings
objects, describing paycheck earnings such as bonuses and reimbursements. Not all earnings will have bothamount
andytdAmount
available. We will extract all values available to us in the payroll system.Child Properties
Required Properties
category
string- Category of the earning such as
benefit
,bereavement
,bonus
,commission
,disability
,holiday
,other
,overtime
,per diem
,reimbursement
,retropay
,sick
,tip
,vacation
, orwage
. rawLabel
string- The label for the earning, exactly as given by the payroll provider.
Optional Properties
amount
numberThe amount of the earning, in dollars, if provided by the payroll system.ytdAmount
numberThe year to date amount of the earning, in dollars, if provided by the payroll system.hours
numberThe number of hours used to calculate the total amount of the earning in this statement.rate
numberThe hourly rate of the earning, in dollars.netAmountAdjustments
[NetAmountAdjustment]
Sample statements data
{
"statements": [
{
"_id": "642c9aa7f8fc90e0dbb4ca71",
"createdAt": "2023-04-04T21:46:15.762Z",
"updatedAt": "2023-08-14T20:29:45.419Z",
"employee": "64b820a19cba026a0245feeb",
"date": "2020-06-15T12:00:00.000Z",
"payPeriodStartDate": "2020-05-27T12:00:00.000Z",
"payPeriodEndDate": "2020-06-12T12:00:00.000Z",
"grossAmount": 1000,
"ytdGrossAmount": 10000,
"netAmount": 800,
"ytdNetAmount": 8000,
"paymentMethod": "deposit",
"hours": 39,
"deductions": [
{
"category": "taxes",
"label": "Federal Income Tax",
"rawLabel": "Federal Income Tax",
"amount": 200,
"ytdAmount": 2000
},
{
"category": "taxes",
"label": "State Income Tax",
"rawLabel": "Utah State Tax",
"amount": 50,
"ytdAmount": 500
},
{
"category": "other",
"label": "Abc corp dd",
"rawLabel": "Abc corp dd",
"amount": 5,
"ytdAmount": 50
}
],
"earnings": [
{
"category": "benefit",
"rawLabel": "Social Security (Disability)",
"amount": 1000
},
{
"category": "bonus",
"rawLabel": "Quarterly Bonus",
"amount": 2000,
"ytdAmount": 6000
},
{
"category": "overtime",
"rawLabel": "Overtime Pay",
"amount": 100,
"ytdAmount": 1000,
"hours": 10,
"rate": 15
},
{
"category": "reimbursement",
"rawLabel": "Gas Card",
"amount": 25.47,
"ytdAmount": 85.74
}
],
"netAmountAdjustments": [
{
"label": "Mileage Reimbursement",
"amount": 25
}
]
},
{
"_id": "64b820a19cba026a0245feed",
"createdAt": "2023-08-07T22:01:28.305Z",
"updatedAt": "2023-08-14T20:29:45.419Z",
"employee": "64b820a19cba026a0245feeb",
"date": "2020-06-30T12:00:00.000Z",
"payPeriodStartDate": "2020-05-27T12:00:00.000Z",
"payPeriodEndDate": "2020-06-12T12:00:00.000Z",
"grossAmount": 1000,
"paymentMethod": "check",
"hours": 37,
"deductions": [
{
"category": "taxes",
"label": "Federal Income Tax",
"rawLabel": "Federal Income Tax",
"amount": 200
},
{
"category": "taxes",
"label": "State Income Tax",
"rawLabel": "Utah State Tax",
"amount": 50
},
{
"category": "other",
"label": "Abc corp dd",
"rawLabel": "Abc corp dd",
"amount": 5
}
]
}
]
}