Getting Started

Introduction

When employees choose and enroll in a Wellhub plan, they will be responsible for paying the monthly plan subscription fee. This amount may be paid using a Credit Card or through Payroll deductions. For payroll deductions, there is an additional integration process required between Wellhub and the company related to managing the deduction data (i.e. creating, exchanging, and processing the deduction data). This is a monthly process, and Wellhub will provide a file that provides specific information for each charge the employee is responsible for covering for that month.

CIA - Integrations Guidebook (SFTP and API) (4).png

As indicated in the diagram, the company will generate an Eligibility File (EF) and provide it to Wellhub using either (1) a manual upload function available in the Wellhub for Companies Portal, or (2) SFTP for a more automated transfer. More details on using SFTP for exchanging information with Wellhub can be found HERE.

File Characteristics

  • The CSV delimiter will be semicolons ( ; )
  • The headers will be in English
  • The file headers will follow the Eligibility file specifications shared by the client (in case the content hasn’t been shared, it will be blank)
  • The currency will follow the client’s location (in case there are entities within the structure with different location/currencies, currencies will be returned accordingly)
  • Only employees who have payroll enabled (as determined by the Eligibility File) will appear on the deduction file
  • Only employees who have payroll enabled (as determined by the Eligibility File), and have subscribed to a plan and then were removed from the company during the given billing cycle will appear on the deduction file for leavers

File Exchange Frequency

Deduction Files (DFs) are generated and available at the same time the company invoice is issued. You will find in the Payroll SFTP folder the deduction file referring to the latest billing cycle (at the same time the company invoice will be issued). On a monthly basis, it will be replaced by the most recent file.

File Naming Convention

Single Entity

Deduction file

File name: YYYYMM_wellhub_payroll_deduction.csv

Example: 202507_wellhub_payroll_deduction.csv

If there is more than one file issued, there will be versioning. Ex: YYYYMM_wellhub_payroll_deduction_1.csv, YYYYMM_wellhub_payroll_deduction_2.csv

Deduction file for leavers

File name: YYYYMM_wellhub_partial_payroll_deduction.csv

Example: 202507_wellhub_partial_payroll_deduction.csv

Multi Entity

Deduction file

File name: Client name (single entity) + YYYYMM + wellhub_payroll_deduction.csv

Example: Clientname1_202507_wellhub_payroll_deduction.csv

Deduction file for leavers

File name: Client name (single entity) + YYYYMM + wellhub_partial_payroll_deduction.csv

Example: Clientname1_202507_wellhub_partial_payroll_deduction.csv

File Contents Overview

Deduction Files (DFs) contain fields that identify the employee that the charge belongs to. Because of the flexibility provided to make changes to plans, there may be more than one charge for the employee baked into the total amount owed on the DF.