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

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

// Automatically fetches more pages as needed.
for await (const payStatementItemListResponse of client.hris.company.payStatementItem.list()) {
  console.log(payStatementItemListResponse.attributes);
}
{
  "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<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"]
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<date>

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<date>

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[]
required