How do I create a bookmark?

You can create a bookmark for a NAV type in a particular fund in order to strike an ad-hoc NAV or generate other financial reports.

A bookmark is similar to a valuation point (VP) but does not close a period and persist associated data. Rather, it can be used as a convenient way of referencing an ad hoc datetime.

Methods

curl -X POST 'https://<your-domain>.lusid.com/api/api/funds/MyFunds/Growth/bookmarks?navTypeCode=OFFICIAL'
  -H 'Content-Type: application/json-patch+json'
  -H 'Authorization: Bearer <your-API-access-token>'
  -d '{
  "bookmarkCode": "27Jan2025",
  "displayName": "27 January 2025",
  "effectiveAt": "2025-01-27T17:00:00.0000000+00:00",
  "queryAsAt": "2025-01-27T19:59:59.0000000+00:00"
  "holdingsAsAtOverride": "2025-01-27T21:59:59.0000000+00:00"
  "valuationAsAtOverride": "2025-01-27T23:59:59.0000000+00:00"
}'

Data fields and properties

This section supplements the API documentation and on-screen help text in the LUSID web app.

Fields

A bookmark is identified by a bookmarkCode that must be unique within the parent NAV type.

For more information on the effectiveAt, queryAsAt, holdingsAsAtOverride and valuationsAsAtOverride timestamps, see the NAV documentation.

Properties

You can optionally extend the data model of a bookmark by adding custom properties from the ClosedPeriod domain.

Subsequent updates

You cannot update a bookmark. You must call DeleteBookmark API and start over.

Working with multiple bookmarks and VPs

Since a bookmark represents an ad hoc datetime, you can create one with any effectiveAt that is later than the creation date of the fund.

If you have also created VPs, note that the queryAsAt, holdingsAsAtOverride and valuationsAsAtOverride timestamps of the bookmark must all be later than those of the most recent finalised VP (with a status of Final, signifying the last closed period).

Note: A VP can also have a status of Estimate. Bookmarks ignore Estimate VPs, and include all data since the last closed period.