fetch_employee_paystatement_details
Retrieve detailed pay statement information for a specific employee, year, and check date from the Paylocity system.
Instructions
Fetch pay statement details for a specific employee, year and check date.
Args: company_id: Optional company ID (string or integer). If not provided, uses the first company ID from configuration. employee_id: Employee ID (string or integer) to get pay statement details for. year: The year to get pay statement details for. check_date: The check date to get pay statement details for (format: MM/DD/YYYY).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| company_id | No | ||
| employee_id | No | ||
| year | No | ||
| check_date | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Implementation Reference
- src/mcppaylocity/__init__.py:307-330 (handler)The main handler function for the 'fetch_employee_paystatement_details' tool. It is decorated with @mcp.tool() which registers it, includes input schema via type hints and docstring, validates parameters, and delegates to the Paylocity client.
@mcp.tool() def fetch_employee_paystatement_details( company_id: Optional[Union[str, int]] = None, employee_id: Union[str, int] = None, year: Union[str, int] = None, check_date: str = None ) -> Dict[str, Any]: """ Fetch pay statement details for a specific employee, year and check date. Args: company_id: Optional company ID (string or integer). If not provided, uses the first company ID from configuration. employee_id: Employee ID (string or integer) to get pay statement details for. year: The year to get pay statement details for. check_date: The check date to get pay statement details for (format: MM/DD/YYYY). """ if any(param is None for param in [employee_id, year, check_date]): raise ValueError("employee_id, year, and check_date are all required") company_id_str = str(company_id) if company_id is not None else company_ids[0] employee_id_str = str(employee_id) year_str = str(year) return client.get_employee_paystatement_details(company_id_str, employee_id_str, year_str, check_date)