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
- TpaIdStringrequiredA 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 - EmployerIdStringrequiredUnique 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 - PlanIDStringrequiredUnique Identifier to distinguish this plan from others within the administrator.
First Available Version: GetEmployerPlanMetricsRequest Max Length: 18 - AccountTypeCodeStringrequiredThree character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc.)
First Available Version: GetEmployerPlanMetricsRequest - PlanYearStartDateStringrequired(YYYMMDD)Date that funds are available for services.
First Available Version: GetEmployerPlanMetricsRequest Max Length: 9 - PlanYearEndDateEnumerationrequired(YYYMMDD)Date after which services are not eligible for payment, unless there is an extension in the field.
First Available Version: GetEmployerPlanMetricsRequest - VerboseModeEnumerationOptional, if set to true, the response may return more details as to why a request was not successful
First Available Version: GetEmployerPlanMetricsRequest
Response message:
- TpaIdStringA unique identifer for your administrator instance, generated by WCA when the instance was first set up.
First Available Version: GetEmployerPlanMetricsResponse - EmployerIdStringUnique 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 - PlanIdStringUnique Identifier to distinguish this plan from others within the administrator.
First Available Version: GetEmployerPlanMetricsResponse - AccountTypeCodeStringThree character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc.)
First Available Version: GetEmployerPlanMetricsResponse - PlanYearStartDateString(YYYMMDD)Date that funds are available for services.
First Available Version: GetEmployerPlanMetricsResponse - PlanYearEndDateEnumeration(YYYMMDD)Date after which services are not eligible for payment, unless there is an extension in the field.
First Available Version: GetEmployerPlanMetricsResponse - TotalEnrolleesCountIntegerTotal number of flex accounts on this plan that are in a new, active, temporarily inactive, or terminated status.
First Available Version: GetEmployerPlanMetricsResponse - TotalAnnualElectionNumberSum 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 - TotalEmpeContribYtdNumberSum of all employee contributions made this calendar year for accounts on this plan.
First Available Version: GetEmployerPlanMetricsResponse - TotalEmprContribYtdNumberSum of all employer contributions made this calendar year for accounts on this plan.
First Available Version: GetEmployerPlanMetricsResponse - TotalOtherDepositYtdNumberSum of all "other deposit" category deposits made this calendar year for accounts on this plan.
First Available Version: GetEmployerPlanMetricsResponse - TotalDisbursedYtdNumberSum of all disbursed amounts made this calendar year for accounts on this plan.
First Available Version: GetEmployerPlanMetricsResponse - TotalForefeitureBalNumberTotal 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 - TotalClaimsDisbursedNumberSum of the transaction amounts for all disbursed claims on accounts under this plan.
First Available Version: GetEmployerPlanMetricsResponse - TotalPosDisbursedNumberSum 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
Coming Soon!
Example of a GetEmployerPlanMetrics response message
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 GetEmployerPlanMetrics method.
Coming Soon!
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
- TpaIdStringrequiredA 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 - EmployerIdStringrequiredUnique 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 - VerboseModeEnumerationOptional, if set to true, the response may return more details as to why a request was not successful
First Available Version: GetEmployerMetricsAllRequest
Response message:
- TpaIdStringA unique identifer for your administrator instance, generated by WCA when the instance was first set up.
First Available Version: GetEmployerMetricsAllResponse - EmployerIdStringUnique 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 - TotalNumberOfNewEmployeesLongNumber of employees in a 'new' status under this employer
First Available Version: GetEmployerMetricsAllResponse - TotalNumberOfTemporaryInactiveEmployeesLongNumber of employees in a 'temporary inactive' status under this employer
First Available Version: GetEmployerMetricsAllResponse - TotalNumberOfActiveEmployeesLongNumber of employees in a 'active' status under this employer
First Available Version: GetEmployerMetricsAllResponse - TotalNumberOfTerminateEmployeesLongNumber of employees in a 'terminated' status under this employer
First Available Version: GetEmployerMetricsAllResponse - TotalNumberOfPermanentInactiveEmployeesLongNumber of employees in a 'permanent inactive' status under this employer
First Available Version: GetEmployerMetricsAllResponse - TotalEmployeesLongTotal number of employees under this employer
First Available Version: GetEmployerMetricsAllResponse - TotalNumberOfNewCardsLongNumber of cards in a 'new' status under this employer
First Available Version: GetEmployerMetricsAllResponse - TotalNumberOfActiveCardsLongNumber of cards in a 'active' status under this employer
First Available Version: GetEmployerMetricsAllResponse - TotalNumberOfLostORStolenCardsLongNumber of cards or a 'lost or stolen' status under this employer
First Available Version: GetEmployerMetricsAllResponse - TotalNumberOfTemporaryInactiveCardsLongNumber of cards in a 'temporary inactive' status under this employer
First Available Version: GetEmployerMetricsAllResponse - TotalCardsLongTotal number of cards issued under this employer
First Available Version: GetEmployerMetricsAllResponse - TotalNumberOfManualApprovedCardTransactionsLongTotal number of manually approved card transactions under this employer
First Available Version: GetEmployerMetricsAllResponse - TotalNumberOfAutoApprovedCardTransactionsLongTotal number of auto approved card transactions under this employer
First Available Version: GetEmployerMetricsAllResponse - TotalNumberOfPOSTransactionsLongTotal number of POS transactions under this employer
First Available Version: GetEmployerMetricsAllResponse - TotalNumberOfDeniedCardSwipesLongTotal number of denied card transactions under this employer
First Available Version: GetEmployerMetricsAllResponse - TotalApprovedAmountForCardTransactionsdecimalSum of all approved amounts on card transactions under this employer
First Available Version: GetEmployerMetricsAllResponse - AveragePOSTransactionValuedecimalAverage amount of all POS transactions under this employer
First Available Version: GetEmployerMetricsAllResponse - TotalNumberOfManualClaimslongThe total number of manual claims under this employer
First Available Version: GetEmployerMetricsAllResponse - TotalApprovedAmountForManualClaimsdecimalTotal approved amount on all manual claims under this employer
First Available Version: GetEmployerMetricsAllResponse - AverageManualClaimApprovedAmountdecimalThe average amount of all approved amounts on manual claims under this employer
First Available Version: GetEmployerMetricsAllResponse - TotalDeniedAmountForManualClaimsdecimalThe total amount that has been denied on manual claims under this employer
First Available Version: GetEmployerMetricsAllResponse - TotalNumberOfParticipantEnteredClaimsWeblongThe number of claims entered by participants via WCP
First Available Version: GetEmployerMetricsAllResponse - TotalNumberOfParticipantEnteredClaimsMobilelongThe number of claims entered by participants via WCM
First Available Version: GetEmployerMetricsAllResponse - TotalNumberOfPendingCardTransactionslongThe total number of card transactions in a pending status under this employer
First Available Version: GetEmployerMetricsAllResponse - TotalNumberOfInsufficientDocumentationCardTransactionslongThe total number of card transactions in an "insufficient documentation" status under this employer
First Available Version: GetEmployerMetricsAllResponse - TotalNumberOfIneligibleCardTransactionslongThe total number of card transactions in an ineligible status under this employer
First Available Version: GetEmployerMetricsAllResponse - TotalIneligibleAmountForCardTransactionsdecimalThe total ineligible amount for all card transactions under this employer
First Available Version: GetEmployerMetricsAllResponse - NumberOfManualClaimsWithImagesAttachedlongThe total number of manual claims with one or more documents attached to it under this employer
First Available Version: GetEmployerMetricsAllResponse - TotalNumberOfPOSTransactionsWithImagesAttachedlongThe total number of POS transactions with one or more documents attached to it under this employer
First Available Version: GetEmployerMetricsAllResponse - CurrentNumberOfNewDebitCardTransactionslongCurrent number of card transactions in a "new" status under this employer
First Available Version: GetEmployerMetricsAllResponse - CurrentNumberOfParticipantClaimsWeblongNumber 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 - CurrentNumberOfParticipantClaimsMobilelongNumber 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 - CurrentNumberOfPendedClaimslongNumber 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 - TotalPendedAmountForManualClaimsdecimalThe total amount currently pended on manual claims under this employer
First Available Version: GetEmployerMetricsAllResponse - TotalNumberOfChecksYTDlongThe total number of checks that have been issued this year under this employer
First Available Version: GetEmployerMetricsAllResponse - TotalDollarAmountOfChecksYTDdecimalThe total dollar amount accounted for on checks this year under this employer
First Available Version: GetEmployerMetricsAllResponse - TotalNumberOfDirectDepositsYTDlongThe total number of direct deposit reimbursements that have been completed this year under this employer
First Available Version: GetEmployerMetricsAllResponse - TotalDollarAmountOfDirectDepositsYTDdecimalThe total dollar amount reimbursed with direct deposits this year under this employer
First Available Version: GetEmployerMetricsAllResponse - EmployerMetricsWereLastUpdatedOnStringThe date which these employer metrics were last updated within WCA.
First Available Version: GetEmployerMetricsAllResponse
Example of a GetEmployerMetricsAll SOAP request message
Coming Soon!
Example of a GetEmployerMetricsAll response message
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.
Coming Soon!