Sign in

v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-2148120293.6 KB
Payroll

Payment

Read payroll and contractor related payments by the company.

get/employer/payment

Query parameters

entity_idsstring[]

The entity IDs to specify which entities' data to access. Provide exactly one entity ID per request; a maximum of one is accepted.

[
  "550e8400-e29b-41d4-a716-446655440000"
]
start_datestring date required
Example:2021-01-01

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

end_datestring date required
Example:2021-01-01

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

Headers

Finch-API-Versionstring date required

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

Response

Payment data

idstring uuid required

The unique id for the payment.

pay_datestring nullable required
debit_datestring nullable required
individual_idsstring[] nullable required

Array of every individual on this payment.

pay_group_idsstring[] nullable required

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

pay_frequenciesPayFrequency[] nullable required

List of pay frequencies associated with this payment.