Forecasted transfers
A forecasted transfer is a cash deposit, a cash withdrawal or another transfer that you expect in an account, once or on a schedule. The console shows the approved ones as Approved Transfers on the Recurring Cash Predictions tab of the Cash page.
AdviceCloud adds the forecasted transfers it predicts with the status proposed. A forecasted transfer you create has the status approved. To approve or reject forecasted transfers, call Update the status of forecasted transfers. To remove a forecasted transfer, set its status to rejected, as the console does.
To list your firm's forecasted transfers, call List forecasted transfers. To list the approved forecasted transfers of one account, call List the forecasted transfers of an account.
List forecasted transfers
Returns your firm's forecasted transfers, ordered by ID. Send `status` for only the forecasted transfers with that status.
Create a forecasted transfer
Creates a forecasted transfer in the account with the given `accountId`, with the status `approved`, and returns it. If your firm has no account with that `accountId`, nothing is created and the response is `404`.
Update the status of forecasted transfers
Sets the status in the request body on each forecasted transfer in `transferIds`, and returns them, ordered by ID. If your firm has no forecasted transfer with one of the IDs, no status changes and the response is `404`.
Get a forecasted transfer
Returns the forecasted transfer with the given ID. If your firm has no forecasted transfer with that ID, the response is `404`.
Update a forecasted transfer
Replaces the direction, amount, frequency, start date, description and status of the forecasted transfer with the given ID with the ones in the request body, and returns it. The account does not change. If your firm has no forecasted transfer with that ID, nothing changes and the response is `404`.
List the forecasted transfers of an account
Returns the approved forecasted transfers of the account with the given ID, ordered by ID. Each item has six of the fields of a forecasted transfer: `id`, `startDate`, `description`, `amount`, `frequency` and `direction`. For an archived account, the list is empty. If your firm has no account with that ID, the response is `404`.