All fields are optional. If you don’t provide a start and end date, the default start_date is one business day after the end_date of the most recently created payment, and the default end_date is start_date + 14 business days. The default pay_date is the end_date and the default debit_date is one business day after the pay_date.
You may override any fields in the pay statements you would like. By default, no taxes, earnings or deductions are created (unless an individual is enrolled in deductions via the /benefits endpoints).
Authorizations bearerAuth basicAuth
Please use your Access Token
Fields to configure the payment. Takes all fields from the /payment endpoint. All fields are optional.
The array of earnings objects associated with this pay statement
pay_statements.earnings. amount
The earnings amount in cents.
pay_statements.earnings. currency
The earnings currency code.
pay_statements.earnings. hours
The number of hours associated with this earning. (For salaried employees, this could be hours per pay period, 0 or null, depending on the provider).
pay_statements.earnings. name
The exact name of the deduction from the pay statement.
pay_statements.earnings. type
Available options:
salary,
wage,
reimbursement,
overtime,
severance,
double_overtime,
pto,
sick,
bonus,
commission,
tips,
1099,
other
pay_statements. employee_deductions
The array of deductions objects associated with this pay statement.
pay_statements.employee_deductions. amount
The deduction amount in cents.
pay_statements.employee_deductions. currency
pay_statements.employee_deductions. name
The deduction name from the pay statement.
pay_statements.employee_deductions. pre_tax
Boolean indicating if the deduction is pre-tax.
pay_statements.employee_deductions. type
Available options:
401k,
401k_roth,
401k_loan,
403b,
403b_roth,
457,
457_roth,
s125_medical,
s125_dental,
s125_vision,
hsa_pre,
hsa_post,
fsa_medical,
fsa_dependent_care,
simple_ira,
simple,
commuter,
custom_post_tax,
custom_pre_tax
pay_statements. employer_contributions
pay_statements.employer_contributions. amount
The contribution amount in cents.
pay_statements.employer_contributions. currency
The contribution currency.
pay_statements.employer_contributions. name
The contribution name from the pay statement.
pay_statements.employer_contributions. type
Available options:
401k,
401k_roth,
401k_loan,
403b,
403b_roth,
457,
457_roth,
s125_medical,
s125_dental,
s125_vision,
hsa_pre,
hsa_post,
fsa_medical,
fsa_dependent_care,
simple_ira,
simple,
commuter,
custom_post_tax,
custom_pre_tax
pay_statements.gross_pay. amount
Amount for money object (in cents)
pay_statements.gross_pay. currency
pay_statements. individual_id
A stable Finch id (UUID v4) for an individual in the company
pay_statements.net_pay. amount
Amount for money object (in cents)
pay_statements.net_pay. currency
pay_statements. payment_method
Available options:
check,
direct_deposit
The array of taxes objects associated with this pay statement.
pay_statements.taxes. amount
pay_statements.taxes. currency
pay_statements.taxes. employer
true if the amount is paid by the employers.
pay_statements.taxes. name
The exact name of tax from the pay statement.
pay_statements.taxes. type
Available options:
state,
federal,
local,
fica
pay_statements. total_hours
The number of hours worked for this pay period
The type of the payment associated with the pay statement.
Available options:
regular_payroll,
off_cycle_payroll,
one_time_payment
