Depending on applicable regulations or business limitations, specific API requests may not be available for your use.
Get Cash Activity
This request returns the Cash activity of clients under an advisor.
Request URL
| Syntax |
GET /restapi/reports/cashactivity |
| Example URL |
https://api.uat.foliofn.com/restapi/reports/cashactivity?accounttype=I&transactionstatus=PEND&transactiontype=Dep&method=EFT&dateRange=2W |
Request Query Parameters
| Parameter |
Required? |
Description |
| accountnumber |
N |
Account number. The endpoint returns cash activity of only the given account number. |
| lastname |
N |
Last name of member(s). The endpoint returns cash activity of the member(s) with the given last name. |
| repcode |
N |
Rep code of an account/member. The endpoint returns cash activity of the account/member with the given rep code. |
| branchcode |
N |
Branch code of an account/member. The endpoint returns cash activity of the account/member with the given branch code. |
| accounttype |
N |
Account type. The endpoint returns cash activity of the accounts with the given account type. See Account Type Codes |
| transactionstatus |
N |
Transaction status. The endpoint returns cash activity with the given transaction status. See Transaction Status codes |
| transactiontype |
N |
Transaction type. The endpoint returns cash activity with the given transaction type. See Transaction Type codes |
| method |
N |
Transaction method. The endpoint returns cash activity with the given method type. See Method codes |
| daterange |
N |
Default to (+/-)one week i.e. one week before and one week after the current date. It can be a date range. The format of a date should be “MM-dd-yyyy”. The start date and the end date should be separated by a comma, (“,”). For example, “daterange=11-01-2013,09-01-2014”. In additional to a custom date range, the value of daterange parameter could also be a code. See the other valid codes in Date Range Codes table below. |
Account Type Codes
| Code |
Description |
| I |
Individual |
| R |
Traditional IRA |
| Q |
Rollover IRA |
| S |
Roth IRA |
| P |
SEP IRA |
| 9 |
Simple IRA |
| J |
Joint - Rights of Survivorship |
| K |
Joint - Tenants in Common |
| L |
Joint - Community Property |
| M |
Joint - Tenants by Entirety |
| UC |
Custodial (UGMA/UTMA) |
| X |
Revocable Trust |
| A |
Corporation |
| B |
General Partnership |
| E |
Limited Partnership |
| F |
Limited Liability Corporation |
| H |
Sole Proprietorship |
| C |
Investment Club |
| D |
Business Trust |
| G |
Qualified Retirement Plan |
| V |
Unincorporated Organization |
| AT |
All Taxable Accounts |
| AN |
All Non-Taxable Accounts |
Transaction Status codes
| Code |
Description |
| PEND |
Pending |
| HOLD |
On Hold |
| INPR |
In Progress |
| PSTD |
Posted |
| CNLD |
Canceled |
| REJD |
Rejected |
Transaction Type codes
| Code |
Description |
| Dep |
Deposit |
| With |
Withdrawal |
Method codes
| Code |
Description |
| CHEK |
Check |
| WIRE |
Wire |
| EFT |
Electronic Fund Transfer |
| DTDP |
Direct Deposit |
| BPAY |
Billpay |
| ATRN |
Transfer |
| CLCW |
Client Check Writing |
Date Range Codes
| Code |
Description |
| 1W |
(+/-)one week i.e. one week before and one week after the current date. |
| 2W |
(+/-)two weeks i.e. two weeks before and two weeks after the current date. |
| 1M |
(+/-)one month i.e. one month before and one month after the current date. |
Response Data Fields
| Field |
Values |
Description |
| clientName |
|
Name of the client. Format = "Last name, first name" |
| accountNumber |
|
Account number. |
| accountName |
|
Name of the account. |
| accountType |
|
Account type. |
| repCode |
|
Rep code. |
| branchCode |
|
Branch code. |
| transactionType |
See Transaction Type codes |
The type of the transaction. |
| transactionAmount |
|
Transaction amount in dollars. |
| method |
See Method codes |
Transaction method. |
| requestDate |
|
The requested date of the transaction. Format = "mm/dd/yyyy" |
| processDate |
|
The processed date of the transaction. Format = "mm/dd/yyyy hh:mm a" |
| status |
|
Status of the transaction. |
| repeating |
|
Specifies if the transaction is a repeating transaction. |
| totalPostedDepositsAmount |
|
Total amount of the posted deposits in dollars. |
| totalPostedWithdrawalsAmount |
|
Total amount of the posted withdrawals in dollars. |
| totalPendingDepositsAmount |
|
Total amount of the pending deposits in dollars. |
| totalPendingWithdrawalsAmount |
|
Total amount of the pending withdrawals in dollars. |
Response Example
HTTP/1.1 200 OK
Date: Wed, 10 Apr 2019 17:40:04 GMT
Transfer-Encoding: chunked
Location: https://api.uat.foliofn.com/restapi/cashactivity?accountnumber=RB18938005&method=CHEK
Content-Type: application/json
[
{
"cashActivityList": [
{
"accountName": "AccountName-RB18938005",
"accountNumber": "RB18938005",
"accountType": "Individual",
"branchCode": "Charlotte",
"clientName": "LN-watanabecli, FN-watanabecli",
"method": "CHECK",
"processDate": "04/08/2019",
"repCode": "12345",
"repeating": false,
"requestDate": "04/09/2019 04:47 AM",
"status": "Posted",
"transactionAmount": "100.00000",
"transactionType": "Dep"
},
{
"accountName": "AccountName-RB18938005",
"accountNumber": "RB18938005",
"accountType": "Individual",
"branchCode": "Charlotte",
"clientName": "LN-watanabecli, FN-watanabecli",
"method": "CHECK",
"processDate": "04/10/2019",
"repCode": "12345",
"repeating": false,
"requestDate": "04/10/2019 04:47 AM",
"status": "Posted",
"transactionAmount": "100.00000",
"transactionType": "Dep"
}
],
"totalPendingDepositsAmount": "0.00000",
"totalPendingWithdrawalsAmount": "0.00000",
"totalPostedDepositsAmount": "200.00000",
"totalPostedWithdrawalsAmount": "0.00000"
}
]
Change Log
03/12/2020
- Remove extra spaces
06/18/2019
- Initial version created!
