GET api/v2/advisor/investors/{investorId}/banktransactions?hideTransfers={hideTransfers}&startDate={startDate}&endDate={endDate}&ignoreOrion={ignoreOrion}

Returns a list of transactions for a given investor.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
investorId

Investor is specified by the investorId returned from the advisor/investors endpoint.

 integer

Required
hideTransfers

Optional: Filter out transfers. Defaults to true.

 boolean

Default value is True
startDate

Optional: Set the first date for the date range to filter transactions. Defaults to lowest possible value.

 date

None.
endDate

Optional: Set the last date for the date range to filter transactions. Defaults to today.

 date

None.
ignoreOrion

Optional: Allows endpoint to return all accounts except for Orion accounts.

 boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

InvestorBankTransactionsResponse
NameDescriptionTypeAdditional information
Records

Collection of InvestorBankTransactionModel

None.
TotalLength

integer

None.
TotalIncomeRecords

integer

None.
TotalExpenseRecords

integer

None.
TotalIncomeAmount

decimal number

None.
TotalExpenseAmount

decimal number

None.
NetWorth

decimal number

None.

Response Formats

application/json, text/json

Sample: 
{
  "Records": [
    {
      "WealthAccountTransactionId": 1,
      "WealthAccountId": 2,
      "Name": "sample string 3",
      "DisplayDescription": "sample string 4",
      "Amount": 5.0,
      "TransactionDate": "2025-01-02T15:23:27.7467148-06:00",
      "CategoryName": "sample string 7",
      "AlwaysChange": true,
      "OriginalDescription": "sample string 9",
      "BankTransactionCategoryId": 10,
      "CashflowGroup": "sample string 11",
      "IsCustomCategory": true,
      "ParentCategoryId": 13,
      "ParentCategoryName": "sample string 14",
      "TypeManuallyChanged": true,
      "TypeChangedByRule": true,
      "TransactionType": "sample string 17",
      "IsCashflow": true,
      "SecurityDescription": "sample string 18",
      "DescriptionCodeName": "sample string 19",
      "ExtraDescription": "sample string 20",
      "Symbol": "sample string 21",
      "CUSIP": "sample string 22",
      "Price": 1.0,
      "Quantity": 1.0,
      "AccountNumber": "sample string 23",
      "TradeDate": "2025-01-02T15:23:27.7467148-06:00",
      "ExDate": "2025-01-02T15:23:27.7467148-06:00",
      "TypeOfActivity": "sample string 24",
      "ISIN": "sample string 25"
    },
    {
      "WealthAccountTransactionId": 1,
      "WealthAccountId": 2,
      "Name": "sample string 3",
      "DisplayDescription": "sample string 4",
      "Amount": 5.0,
      "TransactionDate": "2025-01-02T15:23:27.7467148-06:00",
      "CategoryName": "sample string 7",
      "AlwaysChange": true,
      "OriginalDescription": "sample string 9",
      "BankTransactionCategoryId": 10,
      "CashflowGroup": "sample string 11",
      "IsCustomCategory": true,
      "ParentCategoryId": 13,
      "ParentCategoryName": "sample string 14",
      "TypeManuallyChanged": true,
      "TypeChangedByRule": true,
      "TransactionType": "sample string 17",
      "IsCashflow": true,
      "SecurityDescription": "sample string 18",
      "DescriptionCodeName": "sample string 19",
      "ExtraDescription": "sample string 20",
      "Symbol": "sample string 21",
      "CUSIP": "sample string 22",
      "Price": 1.0,
      "Quantity": 1.0,
      "AccountNumber": "sample string 23",
      "TradeDate": "2025-01-02T15:23:27.7467148-06:00",
      "ExDate": "2025-01-02T15:23:27.7467148-06:00",
      "TypeOfActivity": "sample string 24",
      "ISIN": "sample string 25"
    }
  ],
  "TotalLength": 1,
  "TotalIncomeRecords": 2,
  "TotalExpenseRecords": 3,
  "TotalIncomeAmount": 4.0,
  "TotalExpenseAmount": 5.0,
  "NetWorth": 6.0
}

application/xml, text/xml

Sample: 
<InvestorBankTransactionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WealthAccessDataModels.Investors.Responses">
  <NetWorth>6</NetWorth>
  <Records xmlns:d2p1="http://schemas.datacontract.org/2004/07/WealthAccessDataModels.Investors.Models">
    <d2p1:InvestorBankTransactionModel>
      <d2p1:AccountNumber>sample string 23</d2p1:AccountNumber>
      <d2p1:AlwaysChange>true</d2p1:AlwaysChange>
      <d2p1:Amount>5</d2p1:Amount>
      <d2p1:BankTransactionCategoryId>10</d2p1:BankTransactionCategoryId>
      <d2p1:CUSIP>sample string 22</d2p1:CUSIP>
      <d2p1:CashflowGroup>sample string 11</d2p1:CashflowGroup>
      <d2p1:CategoryName>sample string 7</d2p1:CategoryName>
      <d2p1:DescriptionCodeName>sample string 19</d2p1:DescriptionCodeName>
      <d2p1:DisplayDescription>sample string 4</d2p1:DisplayDescription>
      <d2p1:ExDate>2025-01-02T15:23:27.7467148-06:00</d2p1:ExDate>
      <d2p1:ExtraDescription>sample string 20</d2p1:ExtraDescription>
      <d2p1:ISIN>sample string 25</d2p1:ISIN>
      <d2p1:IsCashflow>true</d2p1:IsCashflow>
      <d2p1:IsCustomCategory>true</d2p1:IsCustomCategory>
      <d2p1:Name>sample string 3</d2p1:Name>
      <d2p1:OriginalDescription>sample string 9</d2p1:OriginalDescription>
      <d2p1:ParentCategoryId>13</d2p1:ParentCategoryId>
      <d2p1:ParentCategoryName>sample string 14</d2p1:ParentCategoryName>
      <d2p1:Price>1</d2p1:Price>
      <d2p1:Quantity>1</d2p1:Quantity>
      <d2p1:SecurityDescription>sample string 18</d2p1:SecurityDescription>
      <d2p1:Symbol>sample string 21</d2p1:Symbol>
      <d2p1:TradeDate>2025-01-02T15:23:27.7467148-06:00</d2p1:TradeDate>
      <d2p1:TransactionDate>2025-01-02T15:23:27.7467148-06:00</d2p1:TransactionDate>
      <d2p1:TransactionType>sample string 17</d2p1:TransactionType>
      <d2p1:TypeChangedByRule>true</d2p1:TypeChangedByRule>
      <d2p1:TypeManuallyChanged>true</d2p1:TypeManuallyChanged>
      <d2p1:TypeOfActivity>sample string 24</d2p1:TypeOfActivity>
      <d2p1:WealthAccountId>2</d2p1:WealthAccountId>
      <d2p1:WealthAccountTransactionId>1</d2p1:WealthAccountTransactionId>
    </d2p1:InvestorBankTransactionModel>
    <d2p1:InvestorBankTransactionModel>
      <d2p1:AccountNumber>sample string 23</d2p1:AccountNumber>
      <d2p1:AlwaysChange>true</d2p1:AlwaysChange>
      <d2p1:Amount>5</d2p1:Amount>
      <d2p1:BankTransactionCategoryId>10</d2p1:BankTransactionCategoryId>
      <d2p1:CUSIP>sample string 22</d2p1:CUSIP>
      <d2p1:CashflowGroup>sample string 11</d2p1:CashflowGroup>
      <d2p1:CategoryName>sample string 7</d2p1:CategoryName>
      <d2p1:DescriptionCodeName>sample string 19</d2p1:DescriptionCodeName>
      <d2p1:DisplayDescription>sample string 4</d2p1:DisplayDescription>
      <d2p1:ExDate>2025-01-02T15:23:27.7467148-06:00</d2p1:ExDate>
      <d2p1:ExtraDescription>sample string 20</d2p1:ExtraDescription>
      <d2p1:ISIN>sample string 25</d2p1:ISIN>
      <d2p1:IsCashflow>true</d2p1:IsCashflow>
      <d2p1:IsCustomCategory>true</d2p1:IsCustomCategory>
      <d2p1:Name>sample string 3</d2p1:Name>
      <d2p1:OriginalDescription>sample string 9</d2p1:OriginalDescription>
      <d2p1:ParentCategoryId>13</d2p1:ParentCategoryId>
      <d2p1:ParentCategoryName>sample string 14</d2p1:ParentCategoryName>
      <d2p1:Price>1</d2p1:Price>
      <d2p1:Quantity>1</d2p1:Quantity>
      <d2p1:SecurityDescription>sample string 18</d2p1:SecurityDescription>
      <d2p1:Symbol>sample string 21</d2p1:Symbol>
      <d2p1:TradeDate>2025-01-02T15:23:27.7467148-06:00</d2p1:TradeDate>
      <d2p1:TransactionDate>2025-01-02T15:23:27.7467148-06:00</d2p1:TransactionDate>
      <d2p1:TransactionType>sample string 17</d2p1:TransactionType>
      <d2p1:TypeChangedByRule>true</d2p1:TypeChangedByRule>
      <d2p1:TypeManuallyChanged>true</d2p1:TypeManuallyChanged>
      <d2p1:TypeOfActivity>sample string 24</d2p1:TypeOfActivity>
      <d2p1:WealthAccountId>2</d2p1:WealthAccountId>
      <d2p1:WealthAccountTransactionId>1</d2p1:WealthAccountTransactionId>
    </d2p1:InvestorBankTransactionModel>
  </Records>
  <TotalExpenseAmount>5</TotalExpenseAmount>
  <TotalExpenseRecords>3</TotalExpenseRecords>
  <TotalIncomeAmount>4</TotalIncomeAmount>
  <TotalIncomeRecords>2</TotalIncomeRecords>
  <TotalLength>1</TotalLength>
</InvestorBankTransactionsResponse>