> ## Documentation Index
> Fetch the complete documentation index at: https://beta-docs.vitablehealth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.




## OpenAPI

````yaml external-api-schema.yml get /v1/companies/{company_id}/payroll-deduction-statements
openapi: 3.0.3
info:
  title: Vitable External Partner API
  version: 1.0.0
  description: >
    External API for Payroll Providers and PEO platforms to integrate with
    Vitable health plan products 

    for benefit administration. This API enables partner systems to manage
    benefit enrollment, 

    employee data, and plan information for their clients.


    Common integration scenarios:

    - Retrieve active benefit plans for employers

    - List enrolled employees for benefit periods  

    - Create and update employee records

    - Manage benefit enrollments and elections

    - Access enrollment status and eligibility information
servers:
  - url: https://api.vitablehealth.com
    description: Production server
  - url: https://api-staging.vitablehealth.com
    description: Staging server
security:
  - partnerApiKey: []
tags:
  - name: Company Benefits
    description: Benefit plans available to companies (plan years)
  - name: Company Members
    description: Employee management and information
  - name: Benefit Enrollments
    description: Employee benefit enrollment status and management
  - name: Member Benefits
    description: Individual employee benefit information
  - name: Benefit Eligibility
    description: Employee benefit eligibility information
  - name: Payroll Integration
    description: Payroll deduction and contribution calculations
  - name: Quoting
    description: Marketplace plan searches and insurance quotes
paths:
  /v1/companies/{company_id}/payroll-deduction-statements:
    get:
      tags:
        - Payroll Integration
      summary: List payroll deduction statements for a company
      description: >
        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.
      operationId: list_payroll_deduction_statements
      parameters:
        - in: path
          name: company_id
          schema:
            type: string
            format: uuid
          required: true
          description: Unique identifier for the company
        - in: query
          name: limit
          schema:
            type: integer
            default: 20
          description: Number of results to return per page
        - in: query
          name: page
          schema:
            type: integer
            default: 1
          description: Page number for pagination
      responses:
        '200':
          description: List of payroll deduction statements
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ListPayrollDeductionStatementsForCompanyResponse
      security:
        - partnerApiKey: []
components:
  schemas:
    ListPayrollDeductionStatementsForCompanyResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PayrollDeductionStatement'
        pagination:
          $ref: '#/components/schemas/PaginationInfo'
    PayrollDeductionStatement:
      type: object
      description: >-
        Payroll deduction statement containing deduction amounts and
        downloadable files
      properties:
        payroll_deduction_statement_id:
          type: string
          format: uuid
          description: Unique identifier for the statement
        company_id:
          type: string
          format: uuid
          description: Company identifier
        company_name:
          type: string
          description: Company display name
        company_legal_name:
          type: string
          description: Legal company name
        group_id:
          type: string
          format: uuid
          description: Benefit group identifier
        payroll_deductions_change_file_url:
          type: string
          format: uri
          description: URL to download the payroll deductions change file
        statement_date:
          type: string
          format: date
          description: Date the statement was generated
        period_start_date:
          type: string
          format: date
          description: Start date of the payroll period
        period_end_date:
          type: string
          format: date
          description: End date of the payroll period
        total_deduction_amount_in_cents:
          type: integer
          description: Total deduction amount for the period in cents
        superseded_by:
          allOf:
            - $ref: '#/components/schemas/SupersededPayrollDeductionStatement'
          description: Information about the statement that superseded this one, if any
        created:
          type: string
          format: date-time
          description: Statement creation timestamp
        updated:
          type: string
          format: date-time
          description: Statement last update timestamp
      required:
        - payroll_deduction_statement_id
        - company_id
        - company_name
        - company_legal_name
        - group_id
        - payroll_deductions_change_file_url
        - statement_date
        - period_start_date
        - period_end_date
        - total_deduction_amount_in_cents
        - created
        - updated
    PaginationInfo:
      type: object
      properties:
        page:
          type: integer
          description: Current page number
        limit:
          type: integer
          description: Number of items per page
        total_count:
          type: integer
          description: Total number of items
        total_pages:
          type: integer
          description: Total number of pages
    SupersededPayrollDeductionStatement:
      type: object
      description: Information about a statement that superseded another statement
      properties:
        payroll_deduction_statement_id:
          type: string
          format: uuid
          description: Unique identifier for the superseding statement
        payroll_deductions_change_file_url:
          type: string
          format: uri
          description: URL to download the superseding statement's change file
        statement_date:
          type: string
          format: date
          description: Date the superseding statement was generated
        period_start_date:
          type: string
          format: date
          description: Start date of the superseding statement's payroll period
        period_end_date:
          type: string
          format: date
          description: End date of the superseding statement's payroll period
        total_deduction_amount_in_cents:
          type: integer
          description: Total deduction amount in the superseding statement in cents
        created:
          type: string
          format: date-time
          description: Superseding statement creation timestamp
      required:
        - payroll_deduction_statement_id
        - payroll_deductions_change_file_url
        - statement_date
        - period_start_date
        - period_end_date
        - total_deduction_amount_in_cents
        - created
  securitySchemes:
    partnerApiKey:
      type: apiKey
      in: header
      name: X-Partner-API-Key
      description: Partner API key for external integrations

````