Manually Excluding a Portfolio from Dashboard

To exclude/include portfolios from Tax Loss Harvesting (TLH), Out Of Tolerance (OOT) and Cash Needs dashboards until a set date, the below endpoint can be used. The corresponding Trade Tools can be used for the portfolio, however while the portfolio is excluded, it will not show on the dashboard list.

Update exclusions for list of portfolios

PUT https://baseurl/v1/excludefilter/

BODY

Sample Request

property	description	required	datatype
<portfolioIds>	List of portfolio ids	Yes	Integer
<exclude>	specify whether to exclude	Yes	Boolean
<excludeDate>	Date till exclusion applies. If exclude is true and excludeDate is null, portfolio is excluded until manually re added. If exclude is false excludeDate is ignored, and the portfolio is excluded indefinitely or until the exclusion is removed.	No	Date

{
     "filters":{
          "outOfTolerance":{
               "exclude":true,
               "excludeDate":"2024-03-30"
           },
           "cashNeeds":{
               "exclude":true,
               "excludeDate":null
          },
          "taxLossHarvest":{
               "exclude":false,
               "excludeDate":null
         }
     },
     "portfolioIds":[
          69036
     ]
}

Response

{
     "message": "Data saved successfully",
}

Get current exclusions of a single portfolio

GET https://baseurl/v1/excludefilter/?portfolioId=<portfolioId>

property	description	required	datatype
<portfolioId>	Portfolio Id	Yes	Integer

Sample Request

https://baseurl/v1/excludefilter/?portfolioId=69036

Sample Response

{
     "portfolioId": 69036,
     "outOfTolerance": 1,
     "outOfToleranceDate": "11/30/2023",
     "cashNeeds": 1,
     "cashNeedsDate": null,
     "taxLossHarvest": 1,
     "taxLossHarvestDate": "03/30/2024"
}