Employer Metrics API | Administrative - SOAP

The Employer Metrics Service provides retrieving metrics for your employers or employer plans.

Service Web Methods

The following is a list of methods provided by the Employer Metrics Service.

  • GetEmployerPlanMetrics - used to retrieve metrics for a plan under an employer
  • GetEmployerMetricsAll - used to retrieve metrics for a specified employer

Service Assumptions and Business Rules

The Employer Metrics Service makes the following assumptions as well as enforce the following business rules.

  • Clients shall conform to the WS-I specifications unless otherwise agreed upon by Alegeus Technologies and the administrator
  • Clients shall format SOAP messages in a Document/Literal format over HTTPS
  • Clients shall have already created a valid user ID and password.
  • Clients shall have a valid session ID after being authenticated by the system. The session ID needs to be passed in the proper manner as described in the Account Manager Service Guide.
  • If the administrator uses the same user ID and password for all of their clients, the administrator is responsible for managing the security of the data.
  • Clients should validate data before submitting a request to this Service. This facilitates better performance and accurate processing on both systems.
  • Clients shall not attempt to use this service for batch processing of large amounts of data. The service is designed for synchronous calls that send or retrieve small chunks of data. If batch processing is required, then the EDI process should be used.
  • If any method fails, the service returns a SOAP fault describing the problem.
  • The Employer HRA Plan Service is intended to be used only by non-split plan administrators.

GetEmployerPlanMetrics

This method is used to retrieve metrics for a plan under an employer.

History

The GetEmployerPlanMetrics methods are listed below:

Request Message

  • GetEmployerPlanMetricsRequest

Response Message

  • GetEmployerPlanMetricsResponse

GetEmployerPlanMetrics Request/Response Messages

The GetEmployerPlanMetrics method requires the following request and response messages (input and output data).

The table below includes the following request messages:

  • GetEmployerPlanMetricsRequest

Request Body

  • TpaId String required
    A unique identifer for your administrator instance, generated by WCA when the instance was first set up. The API will use the TPA ID associated with the username making the call if not sent.
    First Available Version: GetEmployerPlanMetricsRequest
  • EmployerId String required
    Unique identifier for the employer for which you want to retrieve metrics. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.
    First Available Version: GetEmployerPlanMetricsRequest
    Max Length: 50
  • PlanID String required
    Unique Identifier to distinguish this plan from others within the administrator.
    First Available Version: GetEmployerPlanMetricsRequest
    Max Length: 18
  • AccountTypeCode String required
    Three character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc.)
    First Available Version: GetEmployerPlanMetricsRequest
  • PlanYearStartDate String required
    (YYYMMDD)Date that funds are available for services.
    First Available Version: GetEmployerPlanMetricsRequest
    Max Length: 9
  • PlanYearEndDate Enumeration required
    (YYYMMDD)Date after which services are not eligible for payment, unless there is an extension in the field.
    First Available Version: GetEmployerPlanMetricsRequest
  • VerboseMode Enumeration
    Optional, if set to true, the response may return more details as to why a request was not successful
    First Available Version: GetEmployerPlanMetricsRequest

Response message:

Response Body

  • TpaId String
    A unique identifer for your administrator instance, generated by WCA when the instance was first set up.
    First Available Version: GetEmployerPlanMetricsResponse
  • EmployerId String
    Unique identifier for the employer for which you want to retrieve metrics. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.
    First Available Version: GetEmployerPlanMetricsResponse
  • PlanId String
    Unique Identifier to distinguish this plan from others within the administrator.
    First Available Version: GetEmployerPlanMetricsResponse
  • AccountTypeCode String
    Three character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc.)
    First Available Version: GetEmployerPlanMetricsResponse
  • PlanYearStartDate String
    (YYYMMDD)Date that funds are available for services.
    First Available Version: GetEmployerPlanMetricsResponse
  • PlanYearEndDate Enumeration
    (YYYMMDD)Date after which services are not eligible for payment, unless there is an extension in the field.
    First Available Version: GetEmployerPlanMetricsResponse
  • TotalEnrolleesCount Integer
    Total number of flex accounts on this plan that are in a new, active, temporarily inactive, or terminated status.
    First Available Version: GetEmployerPlanMetricsResponse
  • TotalAnnualElection Number
    Sum of all annual election amounts for flex accounts on this plan that are in a new, active, temporarily inactive, or terminated status.
    First Available Version: GetEmployerPlanMetricsResponse
  • TotalEmpeContribYtd Number
    Sum of all employee contributions made this calendar year for accounts on this plan.
    First Available Version: GetEmployerPlanMetricsResponse
  • TotalEmprContribYtd Number
    Sum of all employer contributions made this calendar year for accounts on this plan.
    First Available Version: GetEmployerPlanMetricsResponse
  • TotalOtherDepositYtd Number
    Sum of all "other deposit" category deposits made this calendar year for accounts on this plan.
    First Available Version: GetEmployerPlanMetricsResponse
  • TotalDisbursedYtd Number
    Sum of all disbursed amounts made this calendar year for accounts on this plan.
    First Available Version: GetEmployerPlanMetricsResponse
  • TotalForefeitureBal Number
    Total amount forfeited for accounts under this plan. This is the sum of employee and employer contributions YTD less the total disbursed amount YTD.
    First Available Version: GetEmployerPlanMetricsResponse
  • TotalClaimsDisbursed Number
    Sum of the transaction amounts for all disbursed claims on accounts under this plan.
    First Available Version: GetEmployerPlanMetricsResponse
  • TotalPosDisbursed Number
    Sum of the transaction amounts for all disbursed POS transactions on accounts under this plan.
    First Available Version: GetEmployerPlanMetricsResponse

Example of a GetEmployerPlanMetrics SOAP request message

Example of a GetEmployerPlanMetrics response message

Example Client Code

The following is an example of the client code (using a .NET proxy class for the service) used when calling the GetEmployerPlanMetrics method.

GetEmployerMetricsAll

This method is used to retrieve metrics for a specified employer.

History

The GetEmployerMetricsAll methods are listed below:

Request Message

  • GetEmployerMetricsAllRequest

Response Message

  • GetEmployerMetricsAllResponse

GetEmployerMetricsAll Request/Response Messages

The GetEmployerMetricsAll method requires the following request and response messages (input and output data).

The table below includes the following request message:

  • GetEmployerMetricsAllRequest

Request Body

  • TpaId String required
    A unique identifer for your administrator instance, generated by WCA when the instance was first set up. The API will use the TPA ID associated with the username making the call if not sent.
    First Available Version: GetEmployerMetricsAllRequest
  • EmployerId String required
    Unique identifier for the employer for which you want to retrieve metrics. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.
    First Available Version: GetEmployerMetricsAllRequest
    Max Length: 18
  • VerboseMode Enumeration
    Optional, if set to true, the response may return more details as to why a request was not successful
    First Available Version: GetEmployerMetricsAllRequest

Response message:

Response Body

  • TpaId String
    A unique identifer for your administrator instance, generated by WCA when the instance was first set up.
    First Available Version: GetEmployerMetricsAllResponse
  • EmployerId String
    Unique identifier for the employer for which you want to retrieve metrics. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.
    First Available Version: GetEmployerMetricsAllResponse
  • TotalNumberOfNewEmployees Long
    Number of employees in a 'new' status under this employer
    First Available Version: GetEmployerMetricsAllResponse
  • TotalNumberOfTemporaryInactiveEmployees Long
    Number of employees in a 'temporary inactive' status under this employer
    First Available Version: GetEmployerMetricsAllResponse
  • TotalNumberOfActiveEmployees Long
    Number of employees in a 'active' status under this employer
    First Available Version: GetEmployerMetricsAllResponse
  • TotalNumberOfTerminateEmployees Long
    Number of employees in a 'terminated' status under this employer
    First Available Version: GetEmployerMetricsAllResponse
  • TotalNumberOfPermanentInactiveEmployees Long
    Number of employees in a 'permanent inactive' status under this employer
    First Available Version: GetEmployerMetricsAllResponse
  • TotalEmployees Long
    Total number of employees under this employer
    First Available Version: GetEmployerMetricsAllResponse
  • TotalNumberOfNewCards Long
    Number of cards in a 'new' status under this employer
    First Available Version: GetEmployerMetricsAllResponse
  • TotalNumberOfActiveCards Long
    Number of cards in a 'active' status under this employer
    First Available Version: GetEmployerMetricsAllResponse
  • TotalNumberOfLostORStolenCards Long
    Number of cards or a 'lost or stolen' status under this employer
    First Available Version: GetEmployerMetricsAllResponse
  • TotalNumberOfTemporaryInactiveCards Long
    Number of cards in a 'temporary inactive' status under this employer
    First Available Version: GetEmployerMetricsAllResponse
  • TotalCards Long
    Total number of cards issued under this employer
    First Available Version: GetEmployerMetricsAllResponse
  • TotalNumberOfManualApprovedCardTransactions Long
    Total number of manually approved card transactions under this employer
    First Available Version: GetEmployerMetricsAllResponse
  • TotalNumberOfAutoApprovedCardTransactions Long
    Total number of auto approved card transactions under this employer
    First Available Version: GetEmployerMetricsAllResponse
  • TotalNumberOfPOSTransactions Long
    Total number of POS transactions under this employer
    First Available Version: GetEmployerMetricsAllResponse
  • TotalNumberOfDeniedCardSwipes Long
    Total number of denied card transactions under this employer
    First Available Version: GetEmployerMetricsAllResponse
  • TotalApprovedAmountForCardTransactions decimal
    Sum of all approved amounts on card transactions under this employer
    First Available Version: GetEmployerMetricsAllResponse
  • AveragePOSTransactionValue decimal
    Average amount of all POS transactions under this employer
    First Available Version: GetEmployerMetricsAllResponse
  • TotalNumberOfManualClaims long
    The total number of manual claims under this employer
    First Available Version: GetEmployerMetricsAllResponse
  • TotalApprovedAmountForManualClaims decimal
    Total approved amount on all manual claims under this employer
    First Available Version: GetEmployerMetricsAllResponse
  • AverageManualClaimApprovedAmount decimal
    The average amount of all approved amounts on manual claims under this employer
    First Available Version: GetEmployerMetricsAllResponse
  • TotalDeniedAmountForManualClaims decimal
    The total amount that has been denied on manual claims under this employer
    First Available Version: GetEmployerMetricsAllResponse
  • TotalNumberOfParticipantEnteredClaimsWeb long
    The number of claims entered by participants via WCP
    First Available Version: GetEmployerMetricsAllResponse
  • TotalNumberOfParticipantEnteredClaimsMobile long
    The number of claims entered by participants via WCM
    First Available Version: GetEmployerMetricsAllResponse
  • TotalNumberOfPendingCardTransactions long
    The total number of card transactions in a pending status under this employer
    First Available Version: GetEmployerMetricsAllResponse
  • TotalNumberOfInsufficientDocumentationCardTransactions long
    The total number of card transactions in an "insufficient documentation" status under this employer
    First Available Version: GetEmployerMetricsAllResponse
  • TotalNumberOfIneligibleCardTransactions long
    The total number of card transactions in an ineligible status under this employer
    First Available Version: GetEmployerMetricsAllResponse
  • TotalIneligibleAmountForCardTransactions decimal
    The total ineligible amount for all card transactions under this employer
    First Available Version: GetEmployerMetricsAllResponse
  • NumberOfManualClaimsWithImagesAttached long
    The total number of manual claims with one or more documents attached to it under this employer
    First Available Version: GetEmployerMetricsAllResponse
  • TotalNumberOfPOSTransactionsWithImagesAttached long
    The total number of POS transactions with one or more documents attached to it under this employer
    First Available Version: GetEmployerMetricsAllResponse
  • CurrentNumberOfNewDebitCardTransactions long
    Current number of card transactions in a "new" status under this employer
    First Available Version: GetEmployerMetricsAllResponse
  • CurrentNumberOfParticipantClaimsWeb long
    Number of claims entered by participants on WCP with the status of 'Entered Not Reviewed', 'Reviewed Receipt Required', 'Reviewed Insufficient Documentation', or 'Reviewed Pending Approval' entered in the last 6 months under this employer
    First Available Version: GetEmployerMetricsAllResponse
  • CurrentNumberOfParticipantClaimsMobile long
    Number of claims entered by participants on WCM with the status of 'Entered Not Reviewed', 'Reviewed Receipt Required', 'Reviewed Insufficient Documentation', or 'Reviewed Pending Approval' entered in the last 6 months under this employer
    First Available Version: GetEmployerMetricsAllResponse
  • CurrentNumberOfPendedClaims long
    Number of Participant Entered Claims entered from WCM with the status of 'Entered Not Reviewed', 'Reviewed Receipt Required', 'Reviewed Insufficient Documentation', or 'Reviewed Pending Approval' entered in the last 6 months under this employer
    First Available Version: GetEmployerMetricsAllResponse
  • TotalPendedAmountForManualClaims decimal
    The total amount currently pended on manual claims under this employer
    First Available Version: GetEmployerMetricsAllResponse
  • TotalNumberOfChecksYTD long
    The total number of checks that have been issued this year under this employer
    First Available Version: GetEmployerMetricsAllResponse
  • TotalDollarAmountOfChecksYTD decimal
    The total dollar amount accounted for on checks this year under this employer
    First Available Version: GetEmployerMetricsAllResponse
  • TotalNumberOfDirectDepositsYTD long
    The total number of direct deposit reimbursements that have been completed this year under this employer
    First Available Version: GetEmployerMetricsAllResponse
  • TotalDollarAmountOfDirectDepositsYTD decimal
    The total dollar amount reimbursed with direct deposits this year under this employer
    First Available Version: GetEmployerMetricsAllResponse
  • EmployerMetricsWereLastUpdatedOn String
    The date which these employer metrics were last updated within WCA.
    First Available Version: GetEmployerMetricsAllResponse

Example of a GetEmployerMetricsAll SOAP request message

Example 
Coming Soon!

Example of a GetEmployerMetricsAll response message

Example 
Coming Soon!

Example Client Code

The following is an example of the client code (using a .NET proxy class for the service) used when calling the GetEmployerMetricsAll method.

Example 
Coming Soon!

Copyright © 2026 Alegeus Technologies, LLC. All rights reserved. Alegeus, Alegeus Technologies, WealthCare, WealthCare Saver are registered trademarks of Alegeus Technologies, LLC

AI Assistant Preview

Generating response...