Payroll

Payment

Read payroll and contractor related payments by the company.

get/employer/payment

Query parameters

start_datestring date required

Example:2021-01-01

The start date to retrieve payments by a company (inclusive) in YYYY-MM-DD format.

end_datestring date required

Example:2021-01-01

The end date to retrieve payments by a company (inclusive) in YYYY-MM-DD format.

Finch-API-Versionstring date required

Header used to specify the version for a given API request. Current version is 2020-09-17.

Payment data

idstring uuid

The unique id for the payment.

pay_datestring nullable

debit_datestring nullable

individual_idsstring[] nullable

Array of every individual on this payment.

pay_group_idsstring[] nullable

Array of the Finch id (uuidv4) of every pay group associated with this payment.

pay_frequenciesPayFrequency[] nullable

List of pay frequencies associated with this payment.