Tax lots
Gains and losses at tax-lot level, with cost and value in both local and reporting currency and the exchange rates used.
Common parameters
Both endpoints take the same parameters.
| Name | In | Type | Description | |
|---|---|---|---|---|
id | path | integer | required | Client id. 0 returns all clients you can access. |
yearMonth | query | integer | required | End of the period, YYYYMM. |
period | query | integer | optional | 0 MTD (default), 1 YTD, 2 3 months, 3 6 months, 4 12 months. |
ccy | query | string | optional | Reporting currency. Default USD. |
tenantId | query | string | optional | Tenant to query, from /Tenants. Default: your user's main tenant. |
Unrealized gain/loss
GET/TaxLot/UnrealizedGL/{id}
REST onlyFull license only
Returns open tax lots with their cost basis, current market value and unrealized gain or loss.
Example request
Response
Response fields
| Field | Type | Description |
|---|---|---|
clientID, clientAlias | string | Client ID and alias. |
invVehicle, invVehicleCode | string | Investment vehicle name and code. |
parentNodeId, nodeId | string | Position in the GWM. |
bankBroker, accountNumber | string | null | Account details. |
assetName | string | null | Asset or security name. |
securityId | integer | Masttro security id. |
assetClass, securityType | string | null | Classification from your Asset Master. |
localCCY | string | Local currency of the asset. |
taxLot | number | null | Tax lot number. |
acquisitionDate | string | null | Acquisition date of the lot. |
unitCostLocalCCY | number | null | Unit cost, local currency. |
units | string | null | Units in the lot. |
totalCostLocalCCY | number | null | Total cost, local currency. |
exchangeRateCost | number | null | Exchange rate at acquisition. |
totalCostRepCCY | number | null | Total cost, reporting currency. |
lastPriceLocalCCY | number | null | Last price, local currency. |
marketValueLocalCCY | number | null | Market value, local currency. |
exchangeRateLastPrice | number | null | Exchange rate at the last price date. |
marketValueRepCCY | number | null | Market value, reporting currency. |
unrealizedGainLossRepCCY | number | null | Unrealized gain or loss, reporting currency. |
initialDate | string | null | Start of the selected period. |
date | string | null | Date selected in the request. |
Realized gain/loss
GET/TaxLot/RealizedGL/{id}
REST onlyFull license only
Returns lots sold during the period with their cost basis, sale proceeds and realized gain or loss.
Example request
Response
The identity, classification and cost fields are the same as Unrealized gain/loss, from clientID through totalCostRepCCY. Instead of market value fields, each row has:
| Field | Type | Description |
|---|---|---|
saleDate | string | null | Date of the sale. |
salePriceLocalCCY | number | null | Sale price, local currency. |
tradeAmountLocalCCY | number | null | Value of the units sold, local currency. |
exchangeRateSellDate | number | null | Exchange rate on the sale date. |
tradeAmountRepCCY | number | null | Value of the units sold, reporting currency. |
realizedGainLossRepCCY | number | null | Realized gain or loss, reporting currency. |
initialDate | string | null | Start of the selected period. |
date | string | null | Date selected in the request. |
Errors
| Status | Body |
|---|---|
400 | "The user does not have access to this client or the client does not exist." |
400 | Validation problem when yearMonth is missing or not a number. |
400 | "The user does not have access to this tenant or the tenant does not exist." |
Plus the common 401 and 429 responses. See Errors.