List an employer's 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.
Request
- Base URL: https://api.vitablehealth.com
- URL: https://api.vitablehealth.com/v1/employers/{employer_id}/payroll-deduction-statements
- Auth: HTTP bearer
Path parameters
Unique employer identifier (empr_*)
Query parameters
Items per page (default: 20, max: 100)
Maximum number of statements per page
Page number (default: 1)
Page number to retrieve (starts at 1)
Headers
Organization to act as for this request (e.g. org_SGVsbG8gV29ybGQ). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 organization_required. A malformed value returns 400 invalid_organization_header, and naming an organization you do not have access to returns 403 organization_access_denied.
Response
Changes
No recorded changes to this operation across all 1 revision of this API.