TC Rate Market Indices
Calculation overview
When making changes to a TC Rate Market Index - by adding or editing a MarketIndexValue - the following related objects will be recalculated:
MarketIndex (validation only)
Any custom market index that have the market index you are editing of adding a market index value to will be recalculated if all other market indices in the custom market index has been updated today
Recalculation is triggered by a POST or PUT request on the MarketIndexValue endpoint. The scope of objects being recalculated is limited by the validFrom date on the MarketIndexValue; such that, for instance, a voyage that ends before the validFrom date is not recalculated.
DELETE requests do not trigger a recalculation at this time. Validation will still run when deleting, and deleting a market index value for a market index that is part of a custom market index is not allowed.
Workflow
Step 1: Bulk Updating Forward Estimates/Rates
In order to update multiple index values at once, it is recommended to use the BulkUpdateIncrement feature.
While it is possible to trigger all recalculations at once, it is highly recommended to add the header disablebl with value set to true when using the BulkUpdateIncrement feature on MarketIndexValues. This is in order to mitigate calculation costs, and concurrency problems for objects with overlapping.
Example:
Step 2: Updating todays MarketIndexValue
We can now update todays MarketIndexValue, and trigger a recalculation of all related objects.
Option A: PUT on existing MarketIndexValue
Option B: POST a new MarketIndexValue
Posting a market index value without:
marketIndexValueType :
Will default to SPOT if either
ValidFromDate is null
validToDate is null
ValidFromDate == ValidToDate
Else it will get FORWARD
ValidFromDate
If market index value is SPOT
Will use ValidToDate
Else will fail at validation since valid from date is required
ValidToDate
If market index value is SPOT
Will use ValidFromDate
Else will fail at validation since validToDate is required
PublishedDate
If market index value is SPOT
Sets PublishedDate = ValidFromDate
Else
Todays date at 00:00 UTC+0
Was this helpful?