Depending on applicable regulations or business limitations, specific API requests may not be available for your use.
Get an Open Tax Lot
This request returns the information for an open tax lot for an account. An open tax lot is the set of shares of the same security purchased in one transaction, but that has not been sold yet. Every time a client buys shares, an open tax lot is created to track the date and price of the purchase. Learn more about open tax lot.
Request URL
| Syntax |
GET /restapi/accounts/{accountnumber}/opentaxlots/{originatingtransactionid} |
| Example URL |
https://api.uat.foliofn.com/restapi/accounts/RA1234ABCD/opentaxlots/92896207 |
Error Codes
| HTTP Code Status |
Field |
Code |
Message |
Description |
| 404 |
- |
- |
- |
Tax data is currently not available. |
Response Data Fields
| Field |
Description |
| accountNumber |
The account number whose open tax lot was requested. |
| shareQuantity |
The number of the shares in the tax lot. |
| giftDate |
The date that the lot was gifted in the case that this is a gifted lot (as specified by getGiftedInheritedInd). Otherwise, the value of this field is null. |
| transferDate |
The date that this lot was received in, if it was transferred from other accounts. Otherwise, the value of this field is null. |
| costBasisKnown |
A Boolean indicator of whether cost basis is known. A cost basis may not be known if this is an uncovered lot that is transferred in from other financial institution. “true” or “false”. |
| covered |
A Boolean indicator of whether the security is covered. “true” or “false”. Each security has a covered start data associated with it. Purchases prior to that security’s covered date or ones where we do not know the acquisition date will be uncovered. See What are covered and noncovered securities? for more information. |
| gainLossTerm |
An indicator of whether the gainloss for the tax lot is long term or short term if the shares are sold today. The available options are “SHORT_TERM”, “LONG_TERM”, and “UNKNOWN”. |
| security.ticker |
The ticker of the security transacted in this open tax lot. Please note that ticker can occasionally change. To trace the history of changes of a ticker, use GET /security/{ticker} |
| security.cusip |
The CUSIP of the security. |
| security.id |
The ID of the security. |
| originatingTransactionId |
The transaction ID of the transaction that created the tax lot. |
| originalSharePrice |
The original unit price of the open tax lot. |
| adjustedCostBasis |
The adjusted cost basis of the open tax lot, adjusted to account for various events such as stock splits, exchanges, return of capital transactions, and wash sales. |
| giftedFairMarketValue |
The fair market value of the tax lot as of the date of gift, represented as the total cost. |
| adjustedAcquisitionDate |
The acquisition date of the open lot, adjusted for wash sales. |
| giftedInheritedIndicator |
An indicator whether the shares are gifted or inherited. The available options are “NONE”, “GIFTED”, “INHERITED”, “INHERITED_THEN_GIFTED”. |
| washSaleIndicator |
A Boolean indicator of whether this lot has been adjusted due to a wash sale. The value is either “true” or “false”. |
| purchaseReinvestmentIndicator |
An indicator of whether the shares were acquired by purchase or by reinvestment of dividend. The available options are “PURCHASE” and “DIVIDEND_REINVESTMENT”. |
| originalAcquisitionDate |
The original acquisition date. If there were wash sales, the adjusted acquisition date will be in adjustedAcquisitionDate. This field can be null. |
| originalCostBasis |
The cost of the lot at the time of purchase. If there were wash sales, the adjusted cost basis will be in adjustedCostBasis. |
Response Example
Status Code: 200 OK
Content-Type: application/json
Date: Wed, 18 Dec 2013 18:53:22 GMT
Server: Sun GlassFish Enterprise Server v2.1.1
Transfer-Encoding: chunked
X-Powered-By: Servlet/2.5
{
"accountNumber": "RA1234ABCD",
"shareQuantity": "8.97145",
"giftDate": null,
"transferDate": null,
"lastTradeDate": "2013-01-25T05:00:00.000+0000",
"costBasisKnown": true,
"covered": true,
"gainLossTerm": "SHORT_TERM",
"security": {
"ticker": "AAPL",
"cusip": "037833100",
"id": null
},
"originatingTransactionId": "92896207",
"originalSharePrice": "445.85881",
"adjustedCostBasis": "4000.00",
"giftedFairMarketValue": null,
"adjustedAcquisitionDate": "2013-01-25T05:00:00.000+0000",
"giftedInheritedIndicator": "NONE",
"washSaleIndicator": false,
"purchaseReinvestmentIndicator": "PURCHASE",
"originalAcquisitionDate": "2013-01-25T05:00:00.000+0000",
"originalCostBasis": "4000.00"
}
Change Log
07/22/2016
- Updated text.
02/22/2016
- Add error codes information.
