Get Employee Activity
Get Employee Activity - Includes card transactions, claims, expenses, TC and FX claims, HSA Deposits, HSA Transactions, HSA BillPay, Interest
-
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.
-
participantId string Required
Participant Id
-
decrypt integer <int32>
Indicate if the URI parameters are encrypted or not. 1: encrypted, 0: decrypted, default to 0.
-
includereceipts integer <int32>
Indicate if the receipt should be included in the response. 1 = include receipt Any other value will result in the receipt not being included.
-
opt integer <int32>
If a returned claim is for a dependent, this flag indicates whether to mask certain information on the claim or not. 0: do not mask 1: mask provider information on dependent claim. PRIVATE will be returned for the claim description, claim provider descriptin, claim provder ID, service category code, service category code description, and merchant name. 2: mask provider information on dependent claim only if Dependency Privacy is enabled. PRIVATE will be returned for the claim description, claim provider description, claim provder ID, service category code, service category code description, and merchant name.
-
year integer <int32>
If sent, only transactions with service start dates in that calendar year will be included. This should be a 4-digit year (I.e., 2022). If 0 is sent, transactions from all applicable years will be sent.
-
flexAcctKey integer <int32>
A unique identifier representing the flex account that was created by WCA when the account was first inserted.
-
onlybalduetxns integer <int32>
Indicate to return only transactions which have a balance due or all transactions. 0 = return all transactions 1 = return only transactions with a balance due
-
recordCount integer <int32>
Indicate how many records should be returned. Default to 2000
-
getReassocTxn integer <int32>
Indicate if reassociated accounts' transaction should be included in the response instead of current accounts' transaction. Default is 0. 1: include reassociated transactions 0: current transactions only The following request fields are required if this is set to 1: getReassocTxn, reassocTpaId, reassocEmployerId, reassocParticipantId, reassocFlexAcctId
-
reassocTpaId string
The system generated unique identifier used to represent the admin instance that the reassociated account is under. This information can be obtained with the Get Reassociated HSA Account details API.
-
reassocEmployerId string
A unique identifier representing the employer that owns the reassociated HSA account. This information can be obtained with the Get Reassociated HSA Account details API.
-
reassocParticipantId string
The employee ID of the participant for the reassociated account (I.e., the employee ID under the reassociated employer). This information can be obtained with the Get Reassociated HSA Account details API.
-
reassocFlexAcctId string
A unique identifier representing the flex account of the reassociated HSA account (this is the flex account key of the reassociated account). If leading zeroes are sent on this vaule, they will be trimmed. This information can be obtained with the Get Reassociated HSA Account details API.
-
array <object>
-
DepositDetails object
Deposit Details
Bruce Caliri May 03, 2022 WC 22.08.00 -
AppliedAmount number <double>
For future use only.
-
ForfeitedAmount number <double>
For future use only.
-
-
ReimbursementDetails array <object>
Reimbursement Details
-
CheckClearedDate string
Check Cleared Date
-
Amount number <double>
Amount of the reimbursement
-
Date string <date-time>
Date the transaction was reimbursed
-
ClaimLineNumber integer <int32>
Claim Line Number for FX and TC claims
-
PrevPaidAmount number <double>
Previous Paid Amount – amount that was previously paid for this claim. This occurs when an account receives more funds or a claim is reprocessed to make additional payment
-
CheckNumber string
Check Number or Trace Number for ACH reimbursements
-
Method string
Method of reimbursement. Valid values are None, Check, Direct Deposit, External Check, External Direct Deposit, Card, Payroll.
-
PaidTo string
Indicates who the reimbursement was paid to. Valid values are Provider and Member
-
AccountType string
The type of the account
-
Reversed boolean
Reversed 1=Yes 0=No
-
ReversalDate string <date-time>
If applicable, this is the date the reimbursement was reversed. Will be null if not populated.
-
FlexAcctKey integer <int32>
A system generated unique identifer for the flex account
-
Reimbursed boolean
Reimbursed 1=Yes 0=No
-
CustomDescription string
Custom Plan Description
-
-
Amount number <double>
The purpose of this field varies, depending on the Type Code. TC Claim (5) or Member Expense (4): Total Patient Responsibility Amount. Manual Claim (3): Original claim amount. If Denied or (pended and has pended comment): EligibleAmt + TxnAmtPended + TxnAmtDenied HSA Bill Pay (10): Txn Amount. FX Claims (1): Total Reimbursed Amount
-
Status string
See Status code for string provided
-
Type string
See Type Code for Types provided and the enumeration.
-
TypeCode integer <int32>
Indicates the type of activity. A numeric code that corresponds to the transaction type returned in the Type field. 1- FX CLAIM, 2- CARD TRANSACTION, 3- MANUAL CLAIM, 4- MEMBER EXPENSE, 5- TC CLAIM, 7- MEMBER CLAIM, 8- DEPOSIT, 9- HSA TRANSACTION, 10- HSA BILLPAY
-
ClaimId string
For FX and TC claims, this is the claim number assigned by the system originally adjudicating the insurance claim; for other claims, this is the ID assigned by WCA to uniquely identify the claim.
-
Actions integer <int32>
This code identifies actions the participant can make when presented with this item: 1: Add Receipt, 2: Submit Claim, 4: Pay It Back and 8: Mark as Paid.
-
ServiceStartDate string <date-time>
Service Start Date
-
ServiceEndDate string <date-time>
Service End Date
-
Description string
For claims, the SCC description + the Merchant name (Note: a
tag is included to separate the two fields). For Card transactions, the Merchant Name. For other transactions, the type of transaction -
Claimant string
The family member for whom the claim applies
-
ReimbursementDate string <date-time>
Date the claim was reimbursed
-
ReimbursementMethod string
The method of reimbursement.
-
PaidToProvider boolean
1= Yes, paid to provider 0= No. Claims is not paid to provider
-
CheckNumber string
The Check Number or Trace Number (Direct Deposit) assigned to the reimbursement. If this is a multi-line claim (FX or TC) the reimbursement details are provided in the ReimbursemntInfo collection
-
HasReceipts boolean
Indicates whether the transaction has any receipts attached to it. 1= Yes 0= No
-
Provider string
For Pay Provider HSA Transactions, this will be the full provider name
-
BilledAmount number <double>
On an FX or TC claim or a participant added expense, this is the amount the provided billed to insurance. It is for information purposes only and is not used for adjudication. It is intended to help a participant match-up to the full billed amount for a service. For TC/FX Claims this is the summation of all claim lines.
-
AllowedAmount number <double>
On an FX or TC claim or a participant “save expense” for later, this is the amount allowed by insurance. It is for information purposes only and is not used for adjudication. For TC/FX Claims this is the summation of all claim lines.
-
CoveredAmount number <double>
On an FX or TC claim or a participant added expense, this is the amount the insurance carrier paid (aka amount “covered” by insurance. It is intended to help a participant match-up to the amount paid by the carrier for a service. For TC/FX Claims this is the summation of all claim lines.
-
ResponsibilityAmount number <double>
The amount the participant is responsible to pay for the claim.
-
OutOfPocketAmount number <double>
Amount the participant designated as paid Out Of Pocket for the claim and therefore the participant is not seeking reimbursements for this portion.
-
AccountsPaidAmount number <double>
Amount approved for payment from the account. This amount is not necessariy the amount that has been paid out.
-
OffsetAmount number <double>
The amount of the transaction that was eligible to be applied to a participant’s account but was used to offset a participant’s balance due for that account.
-
RemainingResponsibilityAmount number <double>
The amount the participant still owes for an FX or TC claim
-
ServiceCategoryCode string
-
ServiceCategoryName string
-
RenderingProvider string
The provider who provided the service to the participant (this may be different than the billing provider name). It is recommended to use this field as the Provider Name to display.
-
PatientName string
Patient Name – received on TC or FX claims.
-
PatientAccountNumber string
Patient Account Number provided on a provider pay claim.
-
TrackingNumber string
Tracking Number assigned by the system importing the transaction to WCA
-
Date string <date-time>
Expense (not a transaction yet) --> Service Start Date Claims not yet adjudicated (not a transaction yet) --> Insert Date HSA BillPay --> Payment Date Deposits, Adjudicated Claims and Card transactions (i.e. transactions) --> Transaction Date
-
StatusCode integer <int32>
1 = Paid 2 = Approved 4 = Not Eligible for Reimbursement 5 = Eligible for Reimbursement 7 = Claim Adjusted – Overpaid 8 = Partially Paid 9 = Partially Approved 10 = Paid Out-Of-Pocket 11 = Submitted-Under Review 12 = Needs Receipt 13 = Denied 15 = Ineligible Purchase Resolved 16 = Ineligible Purchase 17 = Matched to Card Transaction 18 = Pending
-
TransactionKey string
Unique identifier applied to the Transaction in WCA.
-
SeqNumber integer <int32>
Unique number assigned to transactions in WCA.
-
SettlementDate string
Settlement Date – date the transaction posted to an account – transactions posted after 4:45 PM ET receive tomorrow’s settlement date.
-
DeductibleAmount number <double>
The amount applied to the deductible for deductible manager claims.
-
ProviderKey integer <int32>
Unique identifier for the provider that is system generated by Alegeus.
-
ProviderId string
For Pay Provider HSA Transactions, this will be the provider Id
-
ClaimKey integer <int64>
A unique identifier key for the claim, generated by WCA when the claim was created
-
ExpenseKey integer <int64>
Unique WCA generated identifier key for the FX, TC or “save expense for later” Expense
-
DenialReason string
The Denial Reason, which is intended to be displayed to the participant.
-
ExcludedReason string
The reason for the excluded amount on a claim. An excluded amount is due to a system business rule that reduces what is eligible for reimbursement such as an amount paid by a higher priority account or a max transaction amount.
-
PendedReason string
Pended Reason added when as adjudicated with a pending amount. Additional information is needed for the claim to be approved or denied and the pended reason instructs the participant as to why the claim is pending.
-
PendedComment string
Pended Comment – comment added by the adjudicator which used in conjunction with pended reason helps the participant know what additional information is needed or the claim.
-
StatusWithAmount string
Displays the status with an amount approved/paid for partial approvals/payments.
-
DisplayStatus string
The transaction to display for the participant which indicates whether Action Required Paid Approved Pending Denied No Action
-
ExpensesDetails array <object>
Expenses Details
-
ClaimKey integer <int32>
A unique identifier key for the claim, generated by WCA when the claim was created
-
TxnKey string
Unique identifier key for the Transaction
-
SetlDte string
Date the Transaction was finalized in WCA- Settlement Date
-
ETxnSeqNum integer <int32>
Sequence Number of the FX, TC or “save expense for later” Expense
-
OffsetAmt number <double>
Amount of the claim line that was eligible for reimbursement but offset or reduced the balance due on one or more claims
-
AppliedToDeductible number <double>
For TC and FX claims, this is the amount that was applied to Deductible Manager or the amount applied to the DTR.
-
ExpenseStatus string
Status for the FX or TC Claim line.
-
CarrierId string
On an FX or TC claim, a unique identifier for the Carrier, as submitted on the FX or TC claim
-
ClaimId string
On an FX claim, a unique identifier for the claim, as submitted on the FX record
-
ClaimLineNum integer <int32>
The claim line number submitted with the claim by the insurance carrier.
-
ClaimTypeCde enum<string>
Unique identifier for type of Claims : None = 0, Pharmacy = 1, Medical = 2,Dental = 4, Vision = 8, OTC = 16
Possible values:None
Pharmacy
Medical
Dental
Vision
OTC
-
BenefitMaxMetAmount number <double>
On an FX or TC, this is the amount that is being denied by the insurance company due to the benefit being maxed out in number of visits or limit (such as a limit of 20 Physical Therapy visits per year). WCA can be configured to reimburse this amount since it would otherwise be covered by insurance were it not for the limit.
-
RbbExcessAmount number <double>
The amount the insurance carrier deemed as “Excess Amount” by insurance. It can be used in adjudication as a participant reimbursable liability amount.
-
NotCoveredAmount number <double>
The amount the insurance carrier deemed as “not covered” by insurance. It can be used in adjudication as a participant reimbursable liability amount.
-
AboveRcAmount number <double>
On an FX or TC claim or a participant “save expense” for later, this is the amount above the usual and customary rate – for an out of network claim, it’s the amount the provider billed minus the insurance allowed amount. WCA can be configured to reimburse this amount by service category tier.
-
RenderingProvider string
The provider who provided the service to the participant (this may be different than the billing provider name). It is recommended to use this field as the Provider Name to display.
-
BillingProviderTaxId string
On a TC claim, a unique identifier for the Billing Provider, as submitted on the TC claim
-
ServiceCategoryTierId string
The Service Categoriy Tier associated with the claim line.
-
DependentId string
When the activity is for a dependent, this will be populated with an identifier for the dependent, as submitted on the TC or FX claim
-
ServiceCategoryCode string
The Serive Category Code associated with the claim line
-
TotalPatientRespAmt number <double>
Total of all the participant liability amount fields for the claim line Deductible, Coinsurance, Copay, Not Covered Amount, Benefit Max Met, Amount RBB Excess Amount
-
RenderingProviderId string
Provider ID for the provider who performed the service for the participant.
-
FirstName string
First Name of participant associated with the expense
-
LastName string
Last Name of participant associated with the transaction
-
PayProviderKey integer <int32>
Unique identifier key for the Provider, generated by WCA when the provider was first created in the system
-
ProviderAddress1 string
Address line 1 associated with the provider’s mailing address
-
ProviderAddress2 string
Address line 2 associated with the provider’s mailing address
-
ProviderCity string
City associated with the provider’s mailing address
-
ProviderState string
State associated with the provider’s mailing address
-
ProviderCountryCde string
Country Code associated with the provider’s mailing address
-
ProviderZip string
Zip Code associated with the provider’s mailing address
-
ProviderPhone string
Phone associated with the provider’s mailing address
-
ProviderId string
Identifier for the Provider, as entered into WCA when the provider was created
-
TpaId string
A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.
-
ExpenseKey integer <int64>
Unique WCA generated identifier key for the FX, TC or “save expense for later” Expense
-
EmpeKey integer <int32>
Unique identifier key for Employee, generated by WCA when the employee was created in the system
-
DepKey integer <int32>
When the activity is for a dependent, this will be populated with a unique identifier for the dependent generated by WCA when the dependent was first entered into the system. This will be null if the activity was not linked to a dependent.
-
ServiceStartDte string <date-time>
Beginning date of service for the claim line received by the participant.
-
ServiceEndDte string <date-time>
Ending date of the service for the claim line provided to the participant
-
ProviderName string
Name of the Provider
-
DescOfService string
For a TC claim, this will be the description of service as submitted on the TC claim.
-
BilledAmt number <double>
See prior definition in the Employee Activity section. This is the billed amount specific to the claim line.
-
InsAmtAllowed number <double>
The amount the insurance carrier deemed eligible for the claim line service. It is not used in adjudication; only the participant’s responsibility fields are used in adjudication (Deductible, Coinsurance, Copay, etc.)
-
InsAmtPaid number <double>
The amount the insurance carrier paid for the claim line service. It is not used in adjudication as this amount has already been paid to the provider; only the participant’s responsibility fields are used in adjudication (Deductible, Coinsurance, Copay, etc.)
-
EmpePaidAmt number <double>
Employee Out-of-Pocket Paid Amount. The amount the participant has indicated as paid by other means and they are not seeking reimbursement for the amount. This amount reduces the remaining participant responsibility.
-
Notes string
Notes entered by user related to the transaction
-
FileKey integer <int32>
Unique identifier key for document attached to this claim line, generated by WCA when the document was first submitted
-
eClaimOptions integer <int64>
Indicates whether this claim is a save expense for later submitted by the participant or a TC claim. 1 = participant submitted expense for later 0 = TC claim
-
DeductibleAmt number <double>
The deductible amount as adjudicated by the insurance carrier on the FX or TC claim submitted to WCA. Note: WCA can be configured to reimburse this amount by service category code or not.
-
CoinsAmt number <double>
The coinsurance amount as adjudicated by the insurance carrier on the FX or TC claim submitted to WCA. Note: WCA can be configured to reimburse this amount by service category code or not.
-
CoPayAmt number <double>
The copay amount as adjudicated by the insurance carrier on the FX or TC claim submitted to WCA. Note: WCA can be configured to reimburse this amount by service category code or not.
-
TotalReimbAmt number <double>
Total Amount of transaction which got reimbursed
-
OriginCde enum<string>
Origin Code indicates which way claims initiated : None = 0,POSCardSwipe = 1,POSKeyedIn = 2,POSPhonedIn = 3,POSMbiSubmitted = 4,ManualScreen = 50,ManualEFT = 51, ManualAgent = 52, ParticipantManualScreen = 53,ParticipantMobileScreen = 54, HZDirect = 55, eClaimManagerManual = 56, eClaimManagerTPS = 57, WebServiceClaim = 58
Possible values:None
POSCardSwipe
POSKeyedIn
POSPhonedIn
POSMbiSubmitted
ManualScreen
ManualEFT
ManualAgent
ParticipantManualScreen
ParticipantMobileScreen
HZDirect
eClaimManagerManual
eClaimManagerTPS
WebServiceClaim
-
eClaimUIStatus enum<string>
Current status of the eClaim : None = 0, New = 1, (New claim posted to portal but not yet submitted for reimbursement) Matched = 2 (Matched to card transaction) Reimbursed = 3, (Claim was approved but not in full) Not Allow Participant Claim Entry = 4 (Participant claim entry is not allowed. Note: in WCA, WCP, and WCM, an eclaim with this status will display as “not eligible for reimbursement”). Miss Participant Claim Entry UI Template = 5 (Claim can not be submitted as there is no claim entry template in WCA) In_Process = 6 (Claim has been submitted for adjudication, but has not yet been adjudicated) Fully_Paid = 7 (claim is fully approved)
Possible values:None
New
Matched
Reimbursed
NotAllowParticipantClaimEntry
MissParticipantClaimEntryUITemplate
In_Process
Fully_Paid
-
-
ReceiptsDetails array <object>
Receipt Info
-
TpaId string
A unique identifier used to identify your admin instance. This value was system generated with the admin instance was created.
-
FileKey integer <int32>
A system generated ID used to identify the receipt file.
-
DocId string
A system generated ID created when a file is submitted through a document queue instead of by a participant.
-
DocDisplayName string
Document Display Name
-
OriginalFileName string
Original File Name
-
UploadDate string <date-time>
The date the receipt file was uploaded.
-
-
CardTransactionDetails object
-
CustomDescription string
Custom Plan Description
-
AccountTypeCode string
Account Type Code
-
MerchantName string
Merchant Name
-
MerchantType string
Merchant Type Code
-
ApprovedAmount number <double>
Approved Amount
-
IneligibleAmount number <double>
Ineligible Amount
-
IneligibleReason string
Ineligible Reason
-
PostedAmount number <double>
Posted Amount
-
BalanceDueAmount number <double>
Balance Due Amount
-
DenialReason string
Denial Reason
-
-
ClaimAdjudicationDetails object
Claim Adjudication Details
-
PendedAmount number <double>
Pended Amount
-
DeniedAmount number <double>
Denied Amount
-
ExcludedAmount number <double>
Excluded Amount
-
EligibleAmount number <double>
Eligible Amount
-
DeductibleAmount number <double>
Deductible Amount
-
OffsetAmount number <double>
Offset Amount
-
OnHoldAmount number <double>
On Hold Amount
-
LowFundsAmount number <double>
Low Funds Amount
-
ApprovedAmount number <double>
Approved Amount
-
-
CustomDescription string
Custom Plan Description
-
TaxYear string
Tax Year
-
PreTaxAmt number <double>
Pre Tax Amtount
-
PostTaxAmt number <double>
Post Tax Amtount
-
RepaymentStatus enum<string>
Repayment Status
Possible values:NotApplicable
NotPaid
Pending
Failed
Approved
-
BalanceDue number <double>
Transaction balance due Amount
-
RepaymentInitiatedDate string <date-time>
The date repayment was made.
-
AcctTypeCode string
Account Type Code
-
FlexAcctKey integer <int32>
Flex Account Key
-
HSATransactionDetail object
HSA Transaction Detail
Bobson Samuel Nov 30, 2021 WC 22.02.00 -
HSAProcessingStatus string
Displays Processing / Posted status.
-
CanUploadReceipt boolean
Indicates whether a transaction requires receipt.
-
DisplayName string
Name associated with Cardholder.
-
HSATransactionType string
Refers to transaction type associated with HSA account transactions.
-
MerchantName string
Name of merchant associated with Transaction.
-
OriginCde enum<string>
Number field Explains orgin of transaction.
Possible values:None
POSCardSwipe
POSKeyedIn
POSPhonedIn
POSMbiSubmitted
ManualScreen
ManualEFT
ManualAgent
ParticipantManualScreen
ParticipantMobileScreen
HZDirect
eClaimManagerManual
eClaimManagerTPS
WebServiceClaim
-
ShowGreenColorFlag boolean
This field returns true when RealTime Employer Funding is enabled. Otherwise returns false.
-
ShowHoverHelpFlag boolean
This field returns true when RealTime Employer Funding is enabled and transaction is not Posted. Otherwise returns false.
-
TransactionAdjudCde enum<string>
Refers to status code associated with each HSA transaction.
Possible values:Approved
Reversed
Ineligible
Pending
ResolvedEmployeePay
ResolvedPayrollDeduction
New
Denied
Unknown
ResolvedNoRefund
IneligiblePartiallyOffset
ResolvedOffsetbyManualClaim
InsufficientDocumentation
EnteredNotReviewed
ClaimReversal
Overpayment
OverpaymentPartiallyResolved
OverpaymentResolved
NonPost
Returned
Resubmitted
-
TransactionAdjudDetailCde string
Refers to adjudicated details code associated with each transaction.
-
TransactionCde integer <int32>
Code to identify the nature/type of transaction.
-
TransactionEligibleAmt number <double>
Amount eligible for transaction.
-
TransactionType string
Text field display type of transaction to Participants.
-
-
SetlSeqNum integer <int32>
Settlement sequence number of the transaction
-
TxnOverDistAmt number <double>
The over distributed amount on the transaction
-
HSABillPayInfo object
HSA Bill Pay Info
Bobson Samuel Feb 08, 2022 WC 22.05.00 -
HSATransactionType string
Refers to transaction type associated with HSA account transactions.
-
AccountDescription string
Product partner name
-
ErrorCode integer <int32>
Refers to the error code of the transaction.
-
ErrorDescription string
Refers to the error description of the transaction.
-
HSABillPayStatus string
HSA BillPay Status { Planned = 0, Failed = 1, Completed = 2 }
-
Memo string
Notes entered during the transaction.
-
NextPaymentDate string <date-time>
Date of next payment
-
PayeeAddress string
Refers to the address of Pay Provider/Payee.
-
PayeeName string
Name of the Pay Provider/Payee.
-
PaymentDate string <date-time>
Service start date
-
PaymentType integer <int32>
Method for reimbursing an employee or provider for this transaction { Check = 1, DirectDeposit = 2 }
-
PayProvider string
Refers to the EIN number of Pay Provider.
-
RecurrenceFrequency enum<string>
Claims Recurrence Frequency
Possible values:All
None
Daily
Weekly
BiMonthly
Monthly
Quarterly
Yearly
SemiMonthly
BiWeekly
Once
-
TaskSchEndDate string <date-time>
The end date for the recurrence
-
TaskSchKey integer <int32>
Unique key identifier for task scheduling
-
TaskSchStartDate string <date-time>
The start date for the first recurrence of the claim
-
TotalRecurrence integer <int32>
Number of payments that are to be made.
-
-