- Changelog
- API Status
- GETGet All Deductions
- POSTRegister Deduction
- POSTCreate Deduction
- GETGet Deduction
- POSTUpdate Deduction
- GETGet Enrolled Individuals
- GETGet Deductions for Individuals
- POSTEnroll Individuals in Deductions
- DELUnenroll Individuals from Deductions
- POSTCreate Access Token
- GETProviders
- GETIntrospect
- POSTDisconnect
- POSTRequest Forwarding
- GETList All Automated Jobs
- POSTEnqueue a New Automated Job
- GETRetrieve an Automated Job
- GETRetrieve a Manual Job
- POSTCreate a new Sandbox Connection
- POSTCreate a new sandbox account
- PUTUpdate a sandbox account
- GETGet configurations for sandbox jobs
- PUTUpdate configurations for sandbox jobs
- POSTAdd a new sandbox payment
- PUTUpdate sandbox individual
- PUTUpdate sandbox employment
- POSTAdd new individuals to a sandbox company
- PUTUpdate a sandbox company's data
- POSTEnqueue a new sandbox job
Deductions
Management
Sandbox
Pay Statement
Read detailed pay statements for each individual.
Deduction and contribution types are supported by the payroll systems that supports Benefits.
Please use your Access Token
Header used to specify the version for a given API request. Current version is 2020-09-17.
Used to indicate the original media type of the resource
The array of batch requests.
curl --request POST \
--url https://api.tryfinch.com/employer/pay-statement \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: <content-type>' \
--header 'Finch-API-Version: <finch-api-version>'{
"responses": [
{
"payment_id": "fc8b024e-d373-4c9c-80fc-f1625383d142",
"code": 200,
"body": {
"paging": {
"count": 25,
"offset": 10
},
"pay_statements": [
{
"individual_id": "be7b048c-a6f3-4194-a017-2f537d4f3565",
"type": "regular",
"payment_method": "check",
"total_hours": 42.5,
"gross_pay": {
"amount": 230000,
"currency": "usd"
},
"net_pay": {
"amount": 180000,
"currency": "usd"
},
"earnings": [
{
"type": "salary",
"name": "Salary",
"amount": 230000,
"currency": "usd",
"hours": 42.5
}
],
"taxes": [
{
"type": "state",
"name": "State Withholding - OR",
"employer": false,
"amount": 0,
"currency": "usd"
}
],
"employee_deductions": [
{
"name": "Pre-Tax 401k",
"amount": 50000,
"currency": "usd",
"pre_tax": true,
"type": "401k"
}
],
"employer_contributions": [
{
"name": "Employee Medical Insurance",
"amount": 23272,
"currency": "usd"
}
]
}
]
}
}
]
}Authorizations
Please use your Access Token
Headers
Header used to specify the version for a given API request. Current version is 2020-09-17.
Used to indicate the original media type of the resource
Body
The array of batch requests.
A stable Finch id (UUID v4) for a payment.
Number of pay statements to return (defaults to all).
Index to start from.
Response
The total number of elements for the entire query (not just the given page)
The current start index of the returned list of elements
The array of pay statements for the current payment.
A stable Finch id (UUID v4) for an individual in the company
The type of the payment associated with the pay statement.
regular_payroll, off_cycle_payroll, one_time_payment, The payment method.
check, direct_deposit, The number of hours worked for this pay period
Amount for money object (in cents)
Amount for money object (in cents)
The array of earnings objects associated with this pay statement
The type of earning.
salary, wage, reimbursement, overtime, severance, double_overtime, pto, sick, bonus, commission, tips, 1099, other, The exact name of the deduction from the pay statement.
The earnings amount in cents.
The earnings currency code.
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).
The array of taxes objects associated with this pay statement.
The type of taxes.
state, federal, local, fica, The exact name of tax from the pay statement.
true if the amount is paid by the employers.
The tax amount in cents.
The currency code.
The array of deductions objects associated with this pay statement.
The deduction name from the pay statement.
The deduction amount in cents.
The deduction currency.
Boolean indicating if the deduction is pre-tax.
Type of benefit.
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, The contribution name from the pay statement.
The contribution amount in cents.
The contribution currency.
Type of benefit.
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, Was this page helpful?
curl --request POST \
--url https://api.tryfinch.com/employer/pay-statement \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: <content-type>' \
--header 'Finch-API-Version: <finch-api-version>'{
"responses": [
{
"payment_id": "fc8b024e-d373-4c9c-80fc-f1625383d142",
"code": 200,
"body": {
"paging": {
"count": 25,
"offset": 10
},
"pay_statements": [
{
"individual_id": "be7b048c-a6f3-4194-a017-2f537d4f3565",
"type": "regular",
"payment_method": "check",
"total_hours": 42.5,
"gross_pay": {
"amount": 230000,
"currency": "usd"
},
"net_pay": {
"amount": 180000,
"currency": "usd"
},
"earnings": [
{
"type": "salary",
"name": "Salary",
"amount": 230000,
"currency": "usd",
"hours": 42.5
}
],
"taxes": [
{
"type": "state",
"name": "State Withholding - OR",
"employer": false,
"amount": 0,
"currency": "usd"
}
],
"employee_deductions": [
{
"name": "Pre-Tax 401k",
"amount": 50000,
"currency": "usd",
"pre_tax": true,
"type": "401k"
}
],
"employer_contributions": [
{
"name": "Employee Medical Insurance",
"amount": 23272,
"currency": "usd"
}
]
}
]
}
}
]
}