Sign in
Payroll

Pay Statement Item

Beta: this endpoint currently serves employers onboarded after March 4th and historical support will be added soon Retrieve a list of detailed pay statement items for the access token's connection account.

get/employer/pay-statement-item

Query parameters

entity_idsstring[]

The entity IDs to specify which entities' data to access.

[
  "550e8400-e29b-41d4-a716-446655440000"
]
categoriesstring[]

Comma-delimited list of pay statement item categories to filter on. If empty, defaults to all categories.

namestring

Case-insensitive partial match search by pay statement item name.

typestring
Example:base_compensation

String search by pay statement item type.

start_datestring date
Example:2024-01-01

The start date to retrieve pay statement items by via their last seen pay date (inclusive) in YYYY-MM-DD format.

end_datestring date
Example:2024-07-01

The end date to retrieve pay statement items by via their last seen pay date in YYYY-MM-DD format.

Headers

Finch-API-Versionstring date required

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

Response

Pay statement item data

Changes