Periods

Periods in Cinnamon are specified as startDate to endDate, using the following convention:

startDate is the first day where performance (return and risk) is measured.
endDate is the last day where performance is measured.

Hence, the start values used in performance calculations are from the day before startDate. For instance, with a startDate: "2025-01-01", start values are from 2024-12-31

http://localhost:8000/ui2/context/structure/00001%2F02%2FCH0008038389%2F1/position?startDate=2025-01-01&endDate=2025-06-30&returnTypeId=net&consolidationId=00001

Request and Performance Periods

When requesting performance data, the request period may be longer than the performance period of the consolidation, i.e. the performance period may start after and end before the request period.

This allows for instance to query KPIs of a consolidation for the first two quarters of 2025, even though the consolidation’s only portfolio was incepted with first receipts and credits on Jan 27, 2025, and client and bank agreed to start performance measurement and benchmarking of the portfolio on Feb 1, 2025.

A request period of fromDate: "2025-01-01", toDate: "2025-06-30" therefore returns performance data for a performance period of startDate: “2025-02-01”, endDate: "2025-06-30":

GET /reporting/consolidation/00001/performanceperiod?fromDate=2025-01-01&toDate=2025-06-30

CODE

{
  "startDate": "2025-02-01",
  "endDate": "2025-06-30"
}

By convention, the Cinnamon REST API names the request period parameters fromDate (for startDate) and toDate (for endDate).
Most REST API calls requesting performance data return the performance period as part of the result.

Performance Period Calculation

The performancePeriod is determined from the requestPeriod as follows:

performancePeriod.startDate = later of requestPeriod.startDate and consolidation.performanceStartDate
performancePeriod.endDate = earlier of requestPeriod.endDate and consolidation.closingDate, or requestPeriod.endDate if the consolidation has no closing date.

The performanceStartDate of a consolidation is the earliest performanceStartDate of all its portfolios. If a portfolio has no explicit performanceStartDate set, its performanceStartDate corresponds to the first booking on any of its targets.

More precisely: consolidation.performanceStartDate is the earliest of:

the performanceStartDate of all portfolios in the consolidation which have a performanceStartDate
and the dates of the first bookings of all targets in the consolidation whose portfolio doesn't have a performanceStartDate

Going beyond the Performance Period

If your use case needs to calculate performance figures for periods longer than the performance period, obtain the raw return figures from the return APIs, and calculate the figures yourself using ReturnCalculator and RiskCalculator. Raw return figures will always honor the request period.