Skip to main content
GET
/
v1
/
companies
/
{company_id}
/
payroll-deduction-statements
List payroll deduction statements for a company
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

​
X-Partner-API-Key
string
header
required

Partner API key for external integrations

Path Parameters

​
company_id
string<uuid>
required

Unique identifier for the company

Query Parameters

​
limit
integer
default:20

Number of results to return per page

​
page
integer
default:1

Page number for pagination

Response

200 - application/json

List of payroll deduction statements

​
data
object[]
​
pagination
object