Administrative APIs | REST

Version:
Download Open API Specification

Save Employer Deposit

https://development.api.wealthcare.com/system/Services/Employer/LogicalBankAccount/{tpaId}/{employerId}/EmployerDeposit

Create a new employer deposit for a specified employer using their unique identifiers. This operation is typically used to record deposits such as ACH transactions, checks, or other types of contributions to the employer's logical bank account.

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.

  • bankAccountDisplayName string

    Display name associated with the logical bank account.

  • depositAmount number <double>

    Deposit amount, can be negative.

  • depositTypeCde enum<string>

    This field is used to define the type of deposit being made.

    ACH Check Other

    Possible values: ACH Check Other
  • checkNumber integer <int32>

    Use this field to enter a check numbers associated with the deposit.

  • notes string

    Optional, use to include deposit notes.

  • transactionDate string <date-time>

    Date of the transaction. Anytime a transaction date is entered, WCA assumes you are attempting to update an existing transaction. This should be left blank for new transactions.

  • planId string

    Used to specify the plan ID when updating the benefit plan associated with the deposit.

  • accountTypeCode string

    Used to specify the account type when updating the benefit plan associated with the deposit. Example: FSA, DCA, etc.

  • planYearStartDate string <date-time>

    Start date for the plan ID selected.

  • planYearEndDate string <date-time>

    End date for the plan ID selected.

  • fundsClearedDate string <date-time>

    Date the funds cleared.

  • rejectDate string <date-time>

    Funds reject date.

  • rejectNote string

    Add a reject note to an employer deposit.

  • hideFromReports boolean
    1. (No) – Will not hide this transaction from report
    2. (Yes) – Transaction will be hidden from report

Response

AI Assistant Preview

Generating response...