Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

Please use your Access Token

Headers

Finch-API-Version
string<date>
default:2020-09-17
required

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

Pattern: ([12]\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01]))

Query Parameters

entity_ids
string<uuid>[]

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

Required array length: 1 element
Example:
start_date
string<date>
required

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

Example:

"2021-01-01"

end_date
string<date>
required

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

Example:

"2021-01-01"

Response

Payment data

id
string<uuid>
required

The unique id for the payment.

pay_period
object | null
required

The pay period object.

pay_date
string | null
required
Pattern: (\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01]))
debit_date
string | null
required
Pattern: (\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01]))
company_debit
Money · object | null
required
gross_pay
Money · object | null
required
net_pay
Money · object | null
required
employer_taxes
Money · object | null
required
employee_taxes
Money · object | null
required
individual_ids
string<uuid>[] | null
required

Array of every individual on this payment.

pay_group_ids
string<uuid>[] | null
required

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

pay_frequencies
enum<string>[] | null
required

List of pay frequencies associated with this payment.

Available options:
annually,
bi_weekly,
daily,
monthly,
other,
quarterly,
semi_annually,
semi_monthly,
weekly