What is a holding ID?

A holding ID is an identifier for a holding in a transaction portfolio that is:

  • Unique across portfolios. For example, a Microsoft holding in a portfolio does not share an ID with any other holding in a different portfolio, even another Microsoft holding.

  • Unique across sub-holding keys (SHKs) in a portfolio. For example, a Microsoft holding tagged by one SHK does not share an ID with a Microsoft holding tagged by a different SHK.

  • Shared across tax lots in a portfolio. For example, a Microsoft holding purchased in one tax lot does share an ID with a Microsoft holding purchased in a different tax lot.

  • Shared across unsettled and settled cash holdings in a portfolio. For example, a temporary USD balance of holding type A does share an ID with a settled USD balance of holding type B.

Consider a portfolio with a tax lot accounting method of FirstInFirstOut and a SHK that divides holdings into Growth and Income strategies. The following transactions are recorded for that portfolio:

Transaction type

Instrument

Currency

Trade date

Settlement date

Units

Total consideration

Strategy

Notes

FundsIn

USD

USD

1 July 2023

3 July 2023

15000

15000

Income

 

Buy

BP

GBP

2 July 2023

4 July 2023

500

-5000

Growth

 

Buy

Microsoft

USD

3 July 2023

5 July 2023

300

-3000

Income

Tax lot #1

Buy

Microsoft

USD

4 July 2023

6 July 2023

100

-1100

Income

Tax lot #2

Dividend

Microsoft

USD

5 July 2023

7 July 2023

400

 40

Income

10% of units held

Calling the GetHoldings API on 6 July 2023 returns the following five holdings. Note the ID of the settled USD balance and the unsettled accrual for the cash dividend transaction is the same:

Calling the GetHoldings API with byTaxlots set to True for 6 July 2023 returns the following six holdings. Note the ID of Microsoft in different tax lots is the same:


You can call the GetHoldingContributors API with a particular holding ID to audit the transactions that have contributed to that position. For example, the following three transactions contributed to the Microsoft holding with ID 67940167:

The following four transactions contributed to the USD holding with ID 67940164:

.