## List an employer's payroll-deduction statements **get** `/v1/employers/{employer_id}/payroll-deduction-statements` Returns a paginated list of the employer's payroll-deduction statements, newest period first, each with its period, generation date, distinct employee count, total deduction, change-file link, and deduction frequency. Statements superseded by a later correction are excluded. The caller must be authorized for the employer; an unknown or unauthorized employer returns 404. ### Path Parameters - `employer_id: string` Unique employer identifier (empr_*) ### Query Parameters - `limit: optional number` Maximum number of statements per page - `page: optional number` Page number to retrieve (starts at 1) ### Returns - `data: array of { csv_file_url, deduction_frequency, deduction_frequency_label, 6 more }` - `csv_file_url: string` Download link for the change CSV, or null. - `deduction_frequency: "weekly" or "bi_weekly" or "semi_monthly" or "monthly"` * `weekly` - Weekly * `bi_weekly` - Bi Weekly * `semi_monthly` - Semi Monthly * `monthly` - Monthly - `"weekly"` - `"bi_weekly"` - `"semi_monthly"` - `"monthly"` - `deduction_frequency_label: string` Human-readable deduction frequency (e.g. `Monthly`). - `employee_count: number` Distinct employees covered by the statement's entries. - `period_end: string` Deduction period end date. - `period_start: string` Deduction period start date. - `run_date: string` When the statement was generated. - `statement_id: string` Prefixed payroll-deduction-statement identifier (`pstmt_`). - `total_deduction_cents: number` Total payroll deduction for the period, in cents. - `pagination: Pagination` Pagination metadata for list responses. - `limit: number` Items per page - `page: number` Current page number - `total: number` Total number of items - `total_pages: number` Total number of pages ### Example ```http curl https://api.vitablehealth.com/v1/employers/$EMPLOYER_ID/payroll-deduction-statements \ -H "Authorization: Bearer $VITABLE_CONNECT_API_KEY" ``` #### Response ```json { "data": [ { "statement_id": "pstmt_abc123def456", "period_start": "2026-05-01", "period_end": "2026-05-31", "run_date": "2026-06-01T00:00:00Z", "employee_count": 12, "total_deduction_cents": 345600, "csv_file_url": "https://files.example/pds-1.csv", "deduction_frequency": "monthly", "deduction_frequency_label": "Monthly" } ], "pagination": { "page": 1, "limit": 20, "total": 1, "total_pages": 1 } } ```