...
Key Principles
Principle | Decision / Discussion |
---|
Status |
---|
Figures | the number and types of figures to be reported should be flexible (MarketValue, Duration, etc.) while some figures can be aggregated by simple summing up, other figures have a specific "aggregation weight" to be used when aggregating for details see Cinnamon Data Interface - Figures
|
(Breakdown) Segments | should be included in a flexible manner translations to be done in reporting via the translation dictionary breakdown hierarchies are delivered by the separate interface Cinnamon Data Interface - Segmentations
|
Aggregation | |
Status |
---|
colour | Green |
---|
title | Specified |
---|
|
| Status |
---|
colour | Green |
---|
title | Specified |
---|
|
| Unbundling / Legs | All unbundling positions have to be provided with all figures (e.g. weights) prepared to be directly included in the overall analysis (replacing the figures of the originating position). Unbundling support three different concepts Constituents: a constituent (like a position of a fund held in the portfolio) is assumed to be a different financial instrument and therefore should provide all needed segments and details for the position. The original position is completely replaced. Legs: derivative instruments (e.g. FX forwards) can be unbundled into two or more legs that can have differing segments and details from the original position. Currently they are handeled identically to constituents. Lots: a position considered a lot, is assumed to stem from the same financial instrument as the original position so only detailing the position with some respect. Therefore the segments as well as details are inherited from the original position but can be overwritten in the lot.
When unbundling positions, the following precedence is taken 1. Constituents 2. Legs 3. Lots
|
Will always be interpreted → should be replaced with a full position concept Status |
---|
colour | Green |
---|
title | Specified |
---|
|
| even Status |
---|
colour | Green |
---|
title | Specified |
---|
|
| Breakdown Segments | should be included in a flexible mannertranslations to be done in the translation dictionary
breakdown hierarchies are delivered by the separate interface CSAM Data Hub - Segmentations
Status |
---|
colour | Green |
---|
title | Specified |
---|
|
| Figures | the number and types of figures to be reported should be flexible (MarketValue, Duration, etc.) while some figures can be aggregated by simple summing up, other figures have a specific "aggregation weight" to be used when aggregating for details see CSAM Data Hub - Figures
| Status |
---|
colour | Green |
---|
title | Specified |
---|
|
|
Interface "PortfolioValuation"
...
Status
...
Green | title | implemented |
---|
Usage & Contents | used to produce Asset Breakdowns (e.g. AB001-AB007) Asset Structures (e.g. AS003, AS004) Position Lists (e.g. PL001, PL002)
contains |
---|
Path | /portfolio/valuation |
---|
Parameters | portfolioId* | string | The id of the portfolio (or consolidation) in the data source |
---|
reportingDate* | string (date) | The business date the valuations are queried for. |
segmentationDate | string (date) | Date as of the instruments are segmented and the segmentation definition is valid (equals reportingDate if omitted) |
Example call | /portfolio/valuation?portfolioId=E0002&reporting=2019-03-31&segmentationDate=2019-06-30 |
---|
Response structure | If the API can fulfill the request (response status code 200 = OK) the response must follow the below json-schema.
Schema | https://bitbucket.org/banknotes/ngr/src/df61b39d18a16581cd95aed9694991bbe39c5fb1/ngr-csamsolution/src/Model/schema/PortfolioValuation.schema.json?at=release%2Fcurrent |
---|
Error handling | If the request can't be fulfilled an appropriate response status code (4xx or 5xx) must be used. Possible errors could be The body of the response should contain information about the reason of the error in plain text or as json object. |
---|
Reporting Business Logic | aggregation from position to sector/portfolio level of simple and weighted figures top n / bottom n, filtering, sorting build hierarchical view from segment data translation of segment labels
|
---|
Consistency Rules | The following rules should be adhered to by any response and will eventually be checked when consuming a response: Consistency Rules |
---|
code |
* declaration
* All figures having an aggregationMethod <> none have to match the top level figure value when aggregating up the positions
* [P02] All segmentationIds referenced within positions must be defined in the Segmentations call
* [P03] All segmentIds referenced within positions must be defined under the corresponding segmentation in the Segmentations call
* All segmentIds referenced within positions must be "leaf-level" segments within the segmentation (no more child segments)Reporting Business Logic | aggregation from position to sector/portfolio level of simple and weighted figures top n / bottom n, filtering, sorting build hierarchical view from segment data translation of segment labels
|
---|
Interface "BenchmarkValuation"
Status | Status |
---|
colour | Green |
---|
title | implemented |
---|
|
|
---|
Usage & Contents | used to produce contains |
---|
Path | /benchmark/valuation |
---|
Parameters | benchmarkIddeclaration [P02] All figures having an aggregationMethod <> none have to match the top level figure value when aggregating up the positions [P03] All segmentationIds referenced within positions must be defined in the Segmentations call [P04] All segmentIds referenced within positions must be defined under the corresponding segmentation in the Segmentations call [P05] All segmentIds referenced within positions must be "leaf-level" segments within the segmentation (no more child segments)
|
Path | /portfolio/valuation
|
---|
Parameters | portfolioId *
| string | The id of the |
---|
benchmark portfolio (or consolidation) in the data source |
reportingDate *
| string (date) | The business date the valuations are queried for. |
---|
segmentationDate
| string (date) | Date as of the instruments are segmented and the segmentation definition is valid (equals reportingDate if omitted) |
---|
Example call | /
|
---|
benchmarkbenchmarkIdB0002E0002&reportingDate=2019-03-31&segmentationDate=2019-06-30
|
Response structure | If the API can fulfill the request (response status code 200 = OK) the responst must follow the below json-schema.
Note |
---|
The request part of the response has to match the path and parameters used in the API call/request
The json schema currently excludes the schema for dataVersioning (should be designed by CSAM)
Schema | https://bitbucket.org/banknotes/ngr/src/df61b39d18a16581cd95aed9694991bbe39c5fb1/ngr-csamsolution/src/Model/schema/BenchmarkValuation.schema.json?at=release%2Fcurrent |
---|
Error handling | If the request can't be fulfilled an appropriate response status code (4xx or 5xx) must be used. Possible errors could be
The body of the response should contain information about the reason of the error in plain text or as json object.Interface "BenchmarkValuation"
Usage & Contents | used to produce contains |
---|
Reporting Business Logic | |
---|
Consistency Rules | The following rules should be adhered to by any response and will |
---|
eventually be checked when consuming a response: |
Consistency Rules
Code Block |
---|
|
*
*
*
*
* segments)Reporting Business Logic | for comparison with portfolio all same logic needed as stated under PortfolioValuation |
Path | /benchmark/valuation
|
---|
Parameters | benchmarkId *
| string | The id of the benchmark in the data source |
---|
reportingDate *
| string (date) |
|
---|
segmentationDate
| string (date) |
|
---|
Example call | /benchmark/valuation?benchmarkId=B0002&reportingDate=2019-03-31&segmentationDate=2019-06-30
|
---|
Schema | |
---|
Response | |
---|