Introduction
Benefits
Employees
Enrollments
Member Benefits
Benefit Eligibility
Payroll Integration
Quoting
curl --request GET \
--url https://api.vitablehealth.com/v1/companies/{company_id}/payroll-deduction-statements \
--header 'X-Partner-API-Key: <api-key>'{
"data": [
{
"payroll_deduction_statement_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"company_name": "<string>",
"company_legal_name": "<string>",
"group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"payroll_deductions_change_file_url": "<string>",
"statement_date": "2023-12-25",
"period_start_date": "2023-12-25",
"period_end_date": "2023-12-25",
"total_deduction_amount_in_cents": 123,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"superseded_by": {
"payroll_deduction_statement_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"payroll_deductions_change_file_url": "<string>",
"statement_date": "2023-12-25",
"period_start_date": "2023-12-25",
"period_end_date": "2023-12-25",
"total_deduction_amount_in_cents": 123,
"created": "2023-11-07T05:31:56Z"
}
}
],
"pagination": {
"page": 123,
"limit": 123,
"total_count": 123,
"total_pages": 123
}
}List payroll deduction statements for a company
Retrieve payroll deduction statements for a company across all payroll periods. These statements contain detailed deduction amounts and downloadable files for payroll processing. Essential for payroll providers to access historical deduction data and change files.
curl --request GET \
--url https://api.vitablehealth.com/v1/companies/{company_id}/payroll-deduction-statements \
--header 'X-Partner-API-Key: <api-key>'{
"data": [
{
"payroll_deduction_statement_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"company_name": "<string>",
"company_legal_name": "<string>",
"group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"payroll_deductions_change_file_url": "<string>",
"statement_date": "2023-12-25",
"period_start_date": "2023-12-25",
"period_end_date": "2023-12-25",
"total_deduction_amount_in_cents": 123,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"superseded_by": {
"payroll_deduction_statement_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"payroll_deductions_change_file_url": "<string>",
"statement_date": "2023-12-25",
"period_start_date": "2023-12-25",
"period_end_date": "2023-12-25",
"total_deduction_amount_in_cents": 123,
"created": "2023-11-07T05:31:56Z"
}
}
],
"pagination": {
"page": 123,
"limit": 123,
"total_count": 123,
"total_pages": 123
}
}Authorizations
Partner API key for external integrations
Path Parameters
Unique identifier for the company
Query Parameters
Number of results to return per page
Page number for pagination
Response
List of payroll deduction statements
Show child attributes
Show child attributes
Unique identifier for the statement
Company identifier
Company display name
Legal company name
Benefit group identifier
URL to download the payroll deductions change file
Date the statement was generated
Start date of the payroll period
End date of the payroll period
Total deduction amount for the period in cents
Statement creation timestamp
Statement last update timestamp
Information about the statement that superseded this one, if any
Show child attributes
Show child attributes
Unique identifier for the superseding statement
URL to download the superseding statement's change file
Date the superseding statement was generated
Start date of the superseding statement's payroll period
End date of the superseding statement's payroll period
Total deduction amount in the superseding statement in cents
Superseding statement creation timestamp