Administrative APIs | REST

Version:
Download Open API Specification

https://api.wealthcare.com/system/Services/Employer/Metrics/{tpaId}/{employerId}/AllMetrics

This operation is used to retrieve metrics for a specified employer

  • tpaId string Required

    A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.

  • employerId string Required

    Unique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.

  • verboseMode boolean
  • TpaId string

    A unique identifer for your administrator instance, generated by WCA when the instance was first set up.

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

  • TotalNumberOfNewEmployees integer <int64>

    Number of employees in a 'new' status under this employer

  • TotalNumberOfTemporaryInactiveEmployees integer <int64>

    Number of employees in a 'temporary inactive' status under this employer

  • TotalNumberOfActiveEmployees integer <int64>

    Number of employees in a 'active' status under this employer

  • TotalNumberOfTerminatedEmployees integer <int64>

    Number of employees in a 'terminated' status under this employer

  • TotalNumberOfPermanentInactiveEmployees integer <int64>

    Number of employees in a 'permanent inactive' status under this employer

  • TotalEmployees integer <int64>

    Total number of employees under this employer

  • TotalNumberOfNewCards integer <int64>

    Number of cards in a 'new' status under this employer

  • TotalNumberOfActiveCards integer <int64>

    Number of cards in a 'active' status under this employer

  • TotalNumberOfLostORStolenCards integer <int64>

    Number of cards or a 'lost or stolen' status under this employer

  • TotalNumberOfTemporaryInactiveCards integer <int64>

    Number of cards in a 'temporary inactive' status under this employer

  • TotalNumberOfPermanentlyInactiveCards integer <int64>

    Number of cards in a 'permanently inactive' status under this employer

  • TotalCards integer <int64>

    Total number of cards issued under this employer

  • TotalNumberOfManualApprovedCardTransactions integer <int64>

    Total number of manually approved card transactions under this employer

  • TotalNumberOfAutoApprovedCardTransactions integer <int64>

    Total number of auto approved card transactions under this employer

  • TotalNumberOfPOSTransactions integer <int64>

    Total number of POS transactions under this employer

  • TotalNumberOfDeniedCardSwipes integer <int64>

    Total number of denied card transactions under this employer

  • TotalApprovedAmountForCardTransactions number <double>

    Sum of all approved amounts on card transactions under this employer

  • AveragePOSTransactionValue number <double>

    Average amount of all POS transactions under this employer

  • TotalNumberOfManualClaims integer <int64>

    The total number of manual claims under this employer

  • TotalApprovedAmountForManualClaims number <double>

    Total approved amount on all manual claims under this employer

  • AverageManualClaimApprovedAmount number <double>

    The average amount of all approved amounts on manual claims under this employer

  • TotalDeniedAmountForManualClaims number <double>

    The total amount that has been denied on manual claims under this employer

  • TotalNumberOfParticipantEnteredClaimsWeb integer <int64>

    The number of claims entered by participants via WCP

  • TotalNumberOfParticipantEnteredClaimsMobile integer <int64>

    The number of claims entered by participants via WCM

  • TotalNumberOfPendingCardTransactions integer <int64>

    The total number of card transactions in a pending status under this employer

  • TotalNumberOfInsufficientDocumentationCardTransactions integer <int64>

    The total number of card transactions in an "insufficient documentation" status under this employer

  • TotalNumberOfIneligibleCardTransactions integer <int64>

    The total number of card transactions in an ineligible status under this employer

  • TotalIneligibleAmountForCardTransactions number <double>

    The total ineligible amount for all card transactions under this employer

  • NumberOfManualClaimsWithImagesAttached integer <int64>

    The total number of manual claims with one or more documents attached to it under this employer

  • TotalNumberOfPOSTransactionsWithImagesAttached integer <int64>

    The total number of POS transactions with one or more documents attached to it under this employer

  • CurrentNumberOfNewDebitCardTransactions integer <int64>

    Current number of card transactions in a "new" status under this employer

  • CurrentNumberOfParticipantClaimsWeb integer <int64>

    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

  • CurrentNumberOfParticipantClaimsMobile integer <int64>

    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

  • CurrentNumberOfPendedClaims integer <int64>

    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

  • TotalPendedAmountForManualClaims number <double>

    The total amount currently pended on manual claims under this employer

  • TotalNumberOfChecksYTD integer <int64>

    The total number of checks that have been issued this year under this employer

  • TotalDollarAmountOfChecksYTD number <double>

    The total dollar amount accounted for on checks this year under this employer

  • TotalNumberOfDirectDepositsYTD integer <int64>

    The total number of direct deposit reimbursements that have been completed this year under this employer

  • TotalDollarAmountOfDirectDepositsYTD number <double>

    The total dollar amount reimbursed with direct deposits this year under this employer

  • EmployerMetricsWereLastUpdatedOn string

    The date which these employer metrics were last updated within WCA.