Skip to main content
GET
/
employer
/
payment
JavaScript
import Finch from '@tryfinch/finch-api';

const client = new Finch({
  accessToken: 'My Access Token',
});

// Automatically fetches more pages as needed.
for await (const payment of client.hris.payments.list({
  end_date: '2021-01-01',
  start_date: '2021-01-01',
})) {
  console.log(payment.id);
}
[
  {
    "id": "20aa7cf2-949d-4d4e-9c01-499b59501ded",
    "pay_period": {
      "start_date": "2019-08-01",
      "end_date": "2019-08-15"
    },
    "pay_date": "2019-08-22",
    "debit_date": "2019-08-22",
    "company_debit": {
      "amount": 5300000,
      "currency": "usd"
    },
    "gross_pay": {
      "amount": 4000000,
      "currency": "usd"
    },
    "net_pay": {
      "amount": 3200000,
      "currency": "usd"
    },
    "employer_taxes": {
      "amount": 200000,
      "currency": "usd"
    },
    "employee_taxes": {
      "amount": 350000,
      "currency": "usd"
    },
    "individual_ids": [
      "54719e14-5ea7-4fda-9898-f4d9ccb83c1a",
      "0ab620fc-203e-44ad-916c-facc69250f6f"
    ],
    "pay_group_ids": [
      "5d0b10a1-a09a-430f-81f1-20be735dc5e9",
      "9349eed4-4064-4641-ba8e-9e1ad7e1d014"
    ],
    "pay_frequencies": [
      "monthly",
      "weekly"
    ]
  }
]

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.

Required array length: 1 element
Example:
["550e8400-e29b-41d4-a716-446655440000"]
​
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
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
required
​
gross_pay
Money · object
required
​
net_pay
Money · object
required
​
employer_taxes
Money · object
required
​
employee_taxes
Money · object
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