GET
/
employer
/
pay-statement-item
curl --request GET \
  --url https://api.tryfinch.com/employer/pay-statement-item \
  --header 'Authorization: Bearer <token>' \
  --header 'Finch-API-Version: <finch-api-version>'
{
  "responses": [
    {
      "name": "Employer_Social_Security",
      "category": "taxes",
      "attributes": [
        {
          "employer": true,
          "type": "social_security",
          "metadata": null
        }
      ]
    },
    {
      "name": "Medical_HMO",
      "category": "employee_deductions",
      "attributes": [
        {
          "type": null,
          "metadata": [
            {
              "_PENSION_PRO_COLUMN": "Pre-Tax Health/125"
            }
          ]
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Please use your Access Token

Headers

​
Finch-API-Version
string
default:
2020-09-17
required

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

Query Parameters

​
categories
enum<string>[]

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

Available options:
earnings,
taxes,
employee_deductions,
employer_contributions
​
name
string

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

​
type
string

String search by pay statement item type.

Example:

"base_compensation"

​
start_date
string

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

Example:

"2024-01-01"

​
end_date
string

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

Example:

"2024-07-01"

Response

200 - application/json
Pay statement item data
​
responses
object[]

Was this page helpful?

Get Pay GroupCreate Rule