Get Dependent Accounts
Request
-
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.
-
employeeId string Required
Unique identifier for the employee.
-
dependentSocialSecurityNumber string
Dependent’s social security number.
Min Length: 0 Max Length: 9 -
dependentId string
Required if this field is being used as the unique dependent identifier. Either this field or SSN may be used for this purpose.
Min Length: 0 Max Length: 30 -
planYearListType enum<string>
Optional, (ALL, Current, Previous, and Future)
Possible values:ALLCurrentPreviousFuture -
verboseMode boolean
Optional, if set to true, the method may return more details as to why a query did not return any records. For example, if an invalid employee social security number was sent.
-
planId string
Optional, Unique identifier for the plan.
Min Length: 0 Max Length: 18 -
employeeSocialSecurityNumber string
Employee’s social security number. Required if dependent IDs are not unique within an Employer.
Min Length: 0 Max Length: 9
-
dependentSocialSecurityNumber string
Dependent’s social security number.
Min Length: 0 Max Length: 9 -
dependentId string
Required if this field is being used as the unique dependent identifier. Either this field or SSN may be used for this purpose.
Min Length: 0 Max Length: 30 -
planYearListType enum<string>
Optional, (ALL, Current, Previous, and Future)
Possible values:ALLCurrentPreviousFuture -
verboseMode boolean
Optional, if set to true, the method may return more details as to why a query did not return any records. For example, if an invalid employee social security number was sent.
-
planId string
Optional, Unique identifier for the plan.
Min Length: 0 Max Length: 18 -
employeeSocialSecurityNumber string
Employee’s social security number. Required if dependent IDs are not unique within an Employer.
Min Length: 0 Max Length: 9
-
dependentSocialSecurityNumber string
Dependent’s social security number.
Min Length: 0 Max Length: 9 -
dependentId string
Required if this field is being used as the unique dependent identifier. Either this field or SSN may be used for this purpose.
Min Length: 0 Max Length: 30 -
planYearListType enum<string>
Optional, (ALL, Current, Previous, and Future)
Possible values:ALLCurrentPreviousFuture -
verboseMode boolean
Optional, if set to true, the method may return more details as to why a query did not return any records. For example, if an invalid employee social security number was sent.
-
planId string
Optional, Unique identifier for the plan.
Min Length: 0 Max Length: 18 -
employeeSocialSecurityNumber string
Employee’s social security number. Required if dependent IDs are not unique within an Employer.
Min Length: 0 Max Length: 9
-
dependentSocialSecurityNumber string
Dependent’s social security number.
Min Length: 0 Max Length: 9 -
dependentId string
Required if this field is being used as the unique dependent identifier. Either this field or SSN may be used for this purpose.
Min Length: 0 Max Length: 30 -
planYearListType enum<string>
Optional, (ALL, Current, Previous, and Future)
Possible values:ALLCurrentPreviousFuture -
verboseMode boolean
Optional, if set to true, the method may return more details as to why a query did not return any records. For example, if an invalid employee social security number was sent.
-
planId string
Optional, Unique identifier for the plan.
Min Length: 0 Max Length: 18 -
employeeSocialSecurityNumber string
Employee’s social security number. Required if dependent IDs are not unique within an Employer.
Min Length: 0 Max Length: 9
Response
-
array <object>
-
IsPlanLinked boolean
Returns false if plan is not linked
-
LinkedPlanId string
Returns plan ID of linked plan
-
LinkedAccountTypeCode string
Returns Account Type for linked plan
-
LinkedPlanYearStartDate string
Returns start date of linked plan
-
LinkedPlanYearEndDate string
Returns end date of linked plan
-
LastDayToSubmitClaims string
Returns the last day the participant is eligible to submit claims.
-
HidePlanFromPortal boolean
Returns if the plan is hidden from view on the participant portal.
-
AccountTypeCode string
Three character abbreviation that indicates the type of account (FSA, DCA, TRN, HRA, etc.)
-
DependentSocialSecurityNumber string
Dependent’s social security number.
-
DependentId string
Dependent’s unique identifier.
-
EmployeeSocialSecurityNumber string
Employee’s social security number.
-
EmployeeId string
Employee’s unique identifier.
-
EmployerId string
Unique identifier for the employer, generated when the employer was first set up. First 3 characters are the employers prefix, unique for each employer. Next 9 characters are created by the administrator for the employer.
-
EndDate string
-
PlanId string
Unique identifier for the plan.
-
PlanTypeCode string
Returns the plan type setup for the plan.
-
StartDate string
-
Status enum<string>
The current account status of the dependent account.
Possible values:NewActiveTempInactivePermInactiveTerminated -
TpaId string
A unique identifier for your administrator instance, generated by WCA when the instance was first set up. If a value is not sent, the TPA ID from the user making the request with be used.
-
HraAccount boolean
HRA account name.
-
IndividualAmount number <double>
Individual Amount
-
IndividualAvailableAmount number <double>
Amount available for the individual.
-
IndividualDisbursableBalance number <double>
Disbursable balance for individual.
-
IndividualPreAuthHold number <double>
PreAuth hold balance. Transactions that don’t have a matching force-post.
-
BalanceDue number <double>
Returns the balance due field from the Employee demographic page.
-
EligibilityDate string
YYYYMMDD. Date upon which the employee is eligible to elect benefits.
-
TerminationDate string
YYYYMMDD. Date upon which the employee’s account is no longer eligible for benefits. Date must be after employee Account Effective date.
-
RolloverDepositsPtd number <double>
Deposits made Year to Date INTO this account via Fund Rollover. For an Individual/Family HRA plan, this is the Individual Fund information– If a Dependent ID is provided, then this is the Dependent’s individual Fund information.
-
FundRolloverStatusCode integer <int32>
Determines current status of the process. For an Individual/Family HRA plan, this is the Individual Fund Rollover Status – If a Dependent ID is provided, then this is the Dependent’s individual Fund Rollover Status. 0 = No Status 1 = Not Completed 2 = In Process 4 = Completed 8 = Partial 16 = Account Created 32 = Primary Transaction Calculated 64 = Primary Transaction Pending 128 = Primary Completed 256 = Secondary Transaction Calculated(future) 512 = Secondary Transaction Pending(future) 1024 = Secondary Completed (future)
-
FundRolloverErrorCode integer <int32>
If the Carryover Status Code = 1 (Not Completed), then a value will exist in this field indicating the specific error. For an Individual/Family HRA plan, this is the Individual Fund Rollover Error Code – If a Dependent ID is provided, then this is the Dependent’s individual Fund Rollover Error Code.
-
FlexAcctId string
A unique identifier for the employee's account, generated by WCA when the account was first set up.
-
No response yet.No response yet.