Payroll
Payment
Read payroll and contractor related payments by the company.
GET
/
employer
/
payment
Authorizations
Authorization
string
headerrequiredPlease use your Access Token
Headers
Finch-API-Version
string
default: 2020-09-17requiredHeader used to specify the version for a given API request. Current version is 2020-09-17.
Query Parameters
start_date
string
requiredThe start date to retrieve payments by a company (inclusive) in YYYY-MM-DD
format.
end_date
string
requiredThe end date to retrieve payments by a company (inclusive) in YYYY-MM-DD
format.
Response
200 - application/json
id
string
The unique id for the payment.
pay_period
object | null
The pay period object.
pay_date
string | null
debit_date
string | null
company_debit
object | null
gross_pay
object | null
net_pay
object | null
employer_taxes
object | null
employee_taxes
object | null
individual_ids
string[] | null
Array of every individual on this payment.
pay_group_ids
string[] | null
Array of the Finch id (uuidv4) of every pay group associated with this payment.
pay_frequencies
enum<string>[] | null
List of pay frequencies associated with this payment.
Available options:
annually
, semi_annually
, quarterly
, monthly
, semi_monthly
, bi_weekly
, weekly
, daily
, other
Was this page helpful?