forked from multrees/api
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
538 lines (532 loc) · 141 KB
/
index.html
File metadata and controls
538 lines (532 loc) · 141 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
<!DOCTYPE HTML><html><head><title>Multrees WebAPI API documentation</title><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta name="generator" content="https://github.com/raml2html/raml2html 7.2.2"><link rel="stylesheet" href="https://netdna.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"><script type="text/javascript" src="https://code.jquery.com/jquery-1.11.0.min.js"></script><script type="text/javascript" src="https://netdna.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script><script type="text/javascript">
$(document).ready(function() {
$('[data-toggle]').click(function() {
var selector = $(this).data('target') + ' pre code';
$(selector).each(function(i, block) {
hljs.highlightBlock(block);
});
});
// open modal on hashes like #_action_get
$(window).bind('hashchange', function(e) {
var anchor_id = document.location.hash.substr(1); //strip #
var element = $('#' + anchor_id);
// do we have such element + is it a modal? --> show it
if (element.length && element.hasClass('modal')) {
element.modal('show');
}
});
// execute hashchange on first page load
$(window).trigger('hashchange');
// remove url fragment on modal hide
$('.modal').on('hidden.bs.modal', function() {
try {
if (history && history.replaceState) {
history.replaceState({}, '', '#');
}
} catch(e) {}
});
});
</script><style>
.hljs {
background: transparent;
}
.parent {
color: #999;
}
.list-group-item > .badge {
float: none;
margin-right: 6px;
}
.panel-title > .methods {
float: right;
}
.badge {
border-radius: 0;
text-transform: uppercase;
width: 70px;
font-weight: normal;
color: #f3f3f6;
line-height: normal;
}
.badge_get {
background-color: #63a8e2;
}
.badge_post {
background-color: #6cbd7d;
}
.badge_put {
background-color: #22bac4;
}
.badge_delete {
background-color: #d26460;
}
.badge_patch {
background-color: #ccc444;
}
.list-group,
.panel-group {
margin-bottom: 0;
}
.panel-group .panel+.panel-white {
margin-top: 0;
}
.panel-group .panel-white {
border-bottom: 1px solid #F5F5F5;
border-radius: 0;
}
.panel-white:last-child {
border-bottom-color: white;
-webkit-box-shadow: none;
box-shadow: none;
}
.panel-white .panel-heading {
background: white;
}
.tab-pane ul {
padding-left: 2em;
}
.tab-pane h1 {
font-size: 1.3em;
}
.tab-pane h2 {
font-size: 1.2em;
padding-bottom: 4px;
border-bottom: 1px solid #ddd;
}
.tab-pane h3 {
font-size: 1.1em;
}
.tab-content {
border-left: 1px solid #ddd;
border-right: 1px solid #ddd;
border-bottom: 1px solid #ddd;
padding: 10px;
}
#sidebar {
margin-top: 30px;
padding-right: 5px;
overflow: auto;
height: 90%;
}
.top-resource-description {
border-bottom: 1px solid #ddd;
background: #fcfcfc;
padding: 15px 15px 0 15px;
margin: -15px -15px 10px -15px;
}
.resource-description {
border-bottom: 1px solid #fcfcfc;
background: #fcfcfc;
padding: 15px 15px 0 15px;
margin: -15px -15px 10px -15px;
}
.resource-description p:last-child {
margin: 0;
}
.list-group .badge {
float: left;
}
.method_description {
margin-left: 85px;
}
.method_description p:last-child {
margin: 0;
}
.list-group-item {
cursor: pointer;
}
.list-group-item:hover {
background-color: #f5f5f5;
}
pre code {
overflow: auto;
word-wrap: normal;
white-space: pre;
}
.items {
background: #f5f5f5;
color: #333;
border: 1px solid #ccc;
border-radius: 4px;
padding: 9.5px;
margin: 0 0 10px;
font-size: 13px;
line-height: 1.42857143;
}
.examples {
margin-left: 0.5em;
}
.resource-modal li > ul {
margin-bottom: 1em;
}
.required {
color: #f00;
}
</style></head><body data-spy="scroll" data-target="#sidebar"><div class="container"><div class="row"><div class="col-md-9" role="main"><div class="page-header"><h1>Multrees WebAPI API documentation <small>version 1.2</small></h1><p>https://api-live.multrees.com:8443/{subfi}/{fi}</p><p>The Multrees Web API provides secure, programmatic access into the core elements of Multrees' services and data. Version 1 focusses on exposing out 'GET' functionality for integration into Digital and Reporting Tools. Version 2 will focus on POST/PUT for integration into CRM and platform technologies. Version 3 will integrate Corporate Action notifications and elections.</p><ul><li><strong>subfi</strong>: <em>(string)</em><p>An optional parameter to define an area within the Financial Institution.</p></li><li><strong>fi</strong>: <em><span class="required">required</span>(string)</em><p>The Financial Institution's short-code, supplied by Multrees.</p></li></ul></div><div class="panel panel-default"><div class="panel-heading"><h3 id="assetallocation" class="panel-title">Asset Allocations</h3></div><div class="panel-body"><div class="top-resource-description"><p>The Asset Allocations for a specified entity.</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_assetallocation"><span class="parent"></span>/AssetAllocation</a> <span class="methods"><a href="#assetallocation_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_assetallocation" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#assetallocation_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Retrieve all asset allocations for the specified entity. Allocations are returned in client base currency, USD, GBP, EUR and percentage weightings.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="assetallocation_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent"></span>/AssetAllocation</h4></div><div class="modal-body"><div class="alert alert-info"><p>Retrieve all asset allocations for the specified entity. Allocations are returned in client base currency, USD, GBP, EUR and percentage weightings.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#assetallocation_get_request" data-toggle="tab">Request</a></li><li><a href="#assetallocation_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="assetallocation_get_request"><h3>Query Parameters</h3><ul><li><strong>LEVEL</strong>: <em><span class="required">required</span>(one of ACCOUNT, GROUP, CUSTOMER)</em><p>Defines which level the request is being made at.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>GROUP</code></pre></div></li><li><strong>filter</strong>: <em><span class="required">required</span>(string)</em><p>The ID of the entity you are looking for.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>12345</code></pre></div></li></ul></div><div class="tab-pane" id="assetallocation_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: array of AssetAllocation</p><p><strong>Items</strong>: Asset Allocation</p><div class="items"><ul><li><strong>extractDate</strong>: <em><span class="required">required</span>(datetime)</em><p>The day the data was last updated. Normally this will be close of business of the previous day.</p></li><li><strong>EntityType</strong>: <em><span class="required">required</span>(string)</em><p>The type of entity returned (ACCOUNT, GROUP or CUSTOMER)</p></li><li><strong>EntityId</strong>: <em><span class="required">required</span>(string)</em><p>The ID of the entity</p></li><li><strong>EntityName</strong>: <em><span class="required">required</span>(string)</em><p>The name of the entity that has been returned (e.g. account name, client name or group name).</p></li><li><strong>classification1</strong>: <em><span class="required">required</span>(string)</em><p>The name of the Classification.</p></li><li><strong>baseCurrency</strong>: <em><span class="required">required</span>(string)</em><p>The base reporting currency of entity.</p></li><li><strong>marketValueBase</strong>: <em><span class="required">required</span>(number)</em><p>The market value in base currency</p></li><li><strong>marketValueGBP</strong>: <em><span class="required">required</span>(number)</em><p>The market value in GBP</p></li><li><strong>marketValueEUR</strong>: <em><span class="required">required</span>(number)</em><p>The market value in EUR</p></li><li><strong>marketValueUSD</strong>: <em><span class="required">required</span>(number)</em><p>The market value in USD</p></li><li><strong>weighting</strong>: <em><span class="required">required</span>(number)</em><p>The weighting of asset from over all call.</p></li><li><strong>order</strong>: <em><span class="required">required</span>(integer)</em><p>The sort order used in client reporting based of the classification.</p></li></ul></div><p><strong>Example</strong>:</p><div class="examples"><pre><code>[
{
"extractDate": "2019-02-25T00:00:00.0000000+00:00",
"EntityType": "GROUP",
"EntityId": "12345",
"EntityName": "Paul Smith",
"classification1": "Fixed Income",
"baseCurrency": "GBP",
"marketValueBase": 880620.027147,
"marketValueGBP": 880620.027147,
"marketValueEUR": 1026243.757937,
"marketValueUSD": 1166733.473967,
"weighting": 12.012057159573683,
"order": 1
},
{
"extractDate": "2019-02-25T00:00:00.0000000+00:00",
"EntityType": "GROUP",
"EntityId": "12345",
"EntityName": "Paul Smith",
"classification1": "Cash",
"baseCurrency": "GBP",
"marketValueBase": 586366.738077,
"marketValueGBP": 586366.738077,
"marketValueEUR": 683331.273719,
"marketValueUSD": 776877.291278,
"weighting": 7.9983086429147754,
"order": 3
}
]
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_assetallocation_classifications"><span class="parent">/AssetAllocation</span>/Classifications</a> <span class="methods"><a href="#assetallocation_classifications_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_assetallocation_classifications" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Returns all possible values for the classification</p></div><div class="list-group"><div onclick="window.location.href = '#assetallocation_classifications_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Retrieve all categories in a classification</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="assetallocation_classifications_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/AssetAllocation</span>/Classifications</h4></div><div class="modal-body"><div class="alert alert-info"><p>Retrieve all categories in a classification</p></div><ul class="nav nav-tabs"><li class="active"><a href="#assetallocation_classifications_get_request" data-toggle="tab">Request</a></li><li><a href="#assetallocation_classifications_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="assetallocation_classifications_get_request"><h3>Query Parameters</h3><ul><li><strong>ClassificationType</strong>: <em><span class="required">required</span>(string)</em><p>The name of classification.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Asset Type</code></pre></div></li></ul></div><div class="tab-pane" id="assetallocation_classifications_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: array of Classification</p><p><strong>Items</strong>: Classification</p><div class="items"><ul><li><strong>ClassificationType</strong>: <em><span class="required">required</span>(string)</em><p>The type of classifcation</p></li><li><strong>ClassificationLabel</strong>: <em><span class="required">required</span>(string)</em><p>The name of classification</p></li><li><strong>ClassificationValue</strong>: <em><span class="required">required</span>(string)</em><p>The Multrees platform ID for that classification</p></li></ul></div><p><strong>Example</strong>:</p><div class="examples"><pre><code>[
{
"ClassificationType": "Asset Type",
"ClassificationLabel": "Cash",
"ClassificationValue": "ABC_CASH"
},
{
"ClassificationType": "Asset Type",
"ClassificationLabel": "Commodities",
"ClassificationValue": "ABC_COMMOD"
}
]
</code></pre></div></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="aum" class="panel-title">Assets Under Management</h3></div><div class="panel-body"><div class="top-resource-description"><p>The total value assets under a specified entity.</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_aum"><span class="parent"></span>/AUM</a> <span class="methods"><a href="#aum_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_aum" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#aum_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Retrieves the total assets under management for the specified entity. Values are returned in client base currency, USD, GBP, EUR and perctentage weightings.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="aum_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent"></span>/AUM</h4></div><div class="modal-body"><div class="alert alert-info"><p>Retrieves the total assets under management for the specified entity. Values are returned in client base currency, USD, GBP, EUR and perctentage weightings.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#aum_get_request" data-toggle="tab">Request</a></li><li><a href="#aum_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="aum_get_request"><h3>Query Parameters</h3><ul><li><strong>LEVEL</strong>: <em><span class="required">required</span>(one of ACCOUNT, GROUP, CUSTOMER)</em><p>Defines which level the request is being made at</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>GROUP</code></pre></div></li><li><strong>filter</strong>: <em><span class="required">required</span>(string)</em><p>The ID of the entity you are looking for.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>12345</code></pre></div></li></ul></div><div class="tab-pane" id="aum_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: array of AUM</p><p><strong>Items</strong>: Assets Under Management</p><div class="items"><ul><li><strong>ExtractDate</strong>: <em><span class="required">required</span>(datetime)</em><p>The day the data was last updated. Normally this will be close of business of the previous day.</p></li><li><strong>EntityType</strong>: <em><span class="required">required</span>(string)</em><p>The type of entity returned (ACCOUNT, GROUP or CUSTOMER).</p></li><li><strong>EntityId</strong>: <em><span class="required">required</span>(string)</em><p>The Id of the entity returned.</p></li><li><strong>EntityName</strong>: <em><span class="required">required</span>(string)</em><p>The name of the entity returned.</p></li><li><strong>BaseCurrency</strong>: <em><span class="required">required</span>(string)</em><p>The base reporting currency of entity.</p></li><li><strong>BookCostBase</strong>: <em><span class="required">required</span>(number)</em><p>The Bookcost in base currency.</p></li><li><strong>BookCostGBP</strong>: <em><span class="required">required</span>(number)</em><p>The Bookcost in GBP.</p></li><li><strong>BookCostEUR</strong>: <em><span class="required">required</span>(number)</em><p>The Bookcost in EUR.</p></li><li><strong>BookCostUSD</strong>: <em><span class="required">required</span>(number)</em><p>The Bookcost in USD.</p></li><li><strong>MarketValueBase</strong>: <em><span class="required">required</span>(number)</em><p>The Market Value in base currency.</p></li><li><strong>MarketValueGBP</strong>: <em><span class="required">required</span>(number)</em><p>The Market Value in GBP.</p></li><li><strong>MarketValueEUR</strong>: <em><span class="required">required</span>(number)</em><p>The Market Value in EUR.</p></li><li><strong>MarketValueUSD</strong>: <em><span class="required">required</span>(number)</em><p>The Market Value in USD.</p></li></ul></div><p><strong>Example</strong>:</p><div class="examples"><pre><code>[
{
"ExtractDate": "2019-02-25T00:00:00.0000000+00:00",
"EntityType": "GROUP",
"EntityId": "12345",
"EntityName": "The Paul Smith Trust",
"BaseCurrency": "GBP",
"BookCostBase": 6638633.98,
"BookCostGBP": 6638633.98,
"BookCostEUR": 7736431.6881027,
"BookCostUSD": 8795526.160102,
"MarketValueBase": 224118102.96866599,
"MarketValueGBP": 224118102.96866599,
"MarketValueEUR": 261179393.06607944,
"MarketValueUSD": 296934074.62318563
}
]
</code></pre></div></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="cash" class="panel-title">Cash</h3></div><div class="panel-body"><div class="top-resource-description"><p>All calls relating to cash accounts</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_cash_accounts"><span class="parent">/Cash</span>/Accounts</a> <span class="methods"><a href="#cash_accounts_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_cash_accounts" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Search for cash accounts by name</p></div><div class="list-group"><div onclick="window.location.href = '#cash_accounts_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Search for cash accounts by name</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="cash_accounts_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Cash</span>/Accounts</h4></div><div class="modal-body"><div class="alert alert-info"><p>Search for cash accounts by name</p></div><ul class="nav nav-tabs"><li class="active"><a href="#cash_accounts_get_request" data-toggle="tab">Request</a></li><li><a href="#cash_accounts_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="cash_accounts_get_request"><h3>Query Parameters</h3><ul><li><strong>searchTerm</strong>: <em><span class="required">required</span>(string)</em><p>Search the account name for this text.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Paul Smith</code></pre></div></li></ul></div><div class="tab-pane" id="cash_accounts_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: array of CashAccount</p><p><strong>Items</strong>: Cash Account</p><div class="items"><ul><li><strong>accountId</strong>: <em><span class="required">required</span>(integer)</em><p>The cash account's internal Id</p></li><li><strong>accountNumber</strong>: <em><span class="required">required</span>(string)</em><p>The cash account's number.</p></li><li><strong>accountName</strong>: <em><span class="required">required</span>(string)</em><p>The display name given to the account</p></li><li><strong>accountCurrency</strong>: <em><span class="required">required</span>(string)</em><p>The Cash Account's currency</p></li><li><strong>accountStatus</strong>: <em><span class="required">required</span>(string)</em><p>The status of the account</p></li></ul></div><p><strong>Example</strong>:</p><div class="examples"><pre><code>[
{
"accountId": 185046,
"accountNumber": "1185046",
"accountName": Paul Smith - ADV CAP",
"accountCurrency": "EUR",
"accountStatus": "ACTIVE"
},
{
"accountId": 193461,
"accountNumber": "1193461",
"accountName": "Paul Smith - ADV INC",
"accountCurrency": "USD",
"accountStatus": "ACTIVE"
}
]
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_cash_accounts__id_"><span class="parent">/Cash</span>/Accounts/{id}</a> <span class="methods"><a href="#cash_accounts__id__get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_cash_accounts__id_" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Search for a single cash account by its Id.</p></div><div class="list-group"><div onclick="window.location.href = '#cash_accounts__id__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Retrieve a single cash account</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="cash_accounts__id__get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Cash</span>/Accounts/{id}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Retrieve a single cash account</p></div><ul class="nav nav-tabs"><li class="active"><a href="#cash_accounts__id__get_request" data-toggle="tab">Request</a></li><li><a href="#cash_accounts__id__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="cash_accounts__id__get_request"><h3>URI Parameters</h3><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em><p>The cash account ID you are trying to retrieve</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>12345</code></pre></div></li></ul></div><div class="tab-pane" id="cash_accounts__id__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: array of CashAccount</p><p><strong>Items</strong>: Cash Account</p><div class="items"><ul><li><strong>accountId</strong>: <em><span class="required">required</span>(integer)</em><p>The cash account's internal Id</p></li><li><strong>accountNumber</strong>: <em><span class="required">required</span>(string)</em><p>The cash account's number.</p></li><li><strong>accountName</strong>: <em><span class="required">required</span>(string)</em><p>The display name given to the account</p></li><li><strong>accountCurrency</strong>: <em><span class="required">required</span>(string)</em><p>The Cash Account's currency</p></li><li><strong>accountStatus</strong>: <em><span class="required">required</span>(string)</em><p>The status of the account</p></li></ul></div><p><strong>Example</strong>:</p><div class="examples"><pre><code>[
{
"accountId": 12345,
"accountNumber": "1012345",
"accountName": "Paul Smith GBP Income account",
"accountCurrency": "GBP",
"accountStatus": "ACTIVE"
}
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_cash_transactions"><span class="parent">/Cash</span>/Transactions</a> <span class="methods"><a href="#cash_transactions_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_cash_transactions" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Collection of all cash transactions linked to an entity. Defaults to 30 days worth of transactions without from and to parameters populated.</p></div><div class="list-group"><div onclick="window.location.href = '#cash_transactions_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Retrieve all cash transactions</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="cash_transactions_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Cash</span>/Transactions</h4></div><div class="modal-body"><div class="alert alert-info"><p>Retrieve all cash transactions</p></div><ul class="nav nav-tabs"><li class="active"><a href="#cash_transactions_get_request" data-toggle="tab">Request</a></li><li><a href="#cash_transactions_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="cash_transactions_get_request"><h3>Query Parameters</h3><ul><li><strong>LEVEL</strong>: <em><span class="required">required</span>(one of ACCOUNT, GROUP, CUSTOMER)</em><p>Defines which level the request is being made at</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>GROUP</code></pre></div></li><li><strong>filter</strong>: <em><span class="required">required</span>(integer)</em><p>The ID of the entity you are looking for</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>12345</code></pre></div></li><li><strong>from</strong>: <em>(datetime)</em><p>Optionally pass the start date</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>2018-09-01</code></pre></div></li><li><strong>to</strong>: <em>(datetime)</em><p>Optionally pass the end date</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>2018-09-30</code></pre></div></li></ul></div><div class="tab-pane" id="cash_transactions_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: array of CashTransaction</p><p><strong>Items</strong>: Cash Transactions</p><div class="items"><ul><li><strong>entityType</strong>: <em><span class="required">required</span>(string)</em><p>The type of parent entity searched for.</p></li><li><strong>entityId</strong>: <em><span class="required">required</span>(string)</em><p>The ID of the entity you searched for.</p></li><li><strong>entityName</strong>: <em><span class="required">required</span>(string)</em><p>The name of the parent entity.</p></li><li><strong>investmentAccountNumber</strong>: <em><span class="required">required</span>(string)</em><p>The parent Investment Account number that the cash transaction is linked to.</p></li><li><strong>investmentAccountName</strong>: <em><span class="required">required</span>(string)</em><p>Name of the parent Investment Account the cash transaction is linked to</p></li><li><strong>cashAccountName</strong>: <em><span class="required">required</span>(string)</em><p>Name of the Cash Account.</p></li><li><strong>cashAccountNumber</strong>: <em><span class="required">required</span>(string)</em><p>The Cash Account Number.</p></li><li><strong>cashAccountType</strong>: <em><span class="required">required</span>(string)</em><p>The type of the account (e.g. Income\Capital).</p></li><li><strong>transactionId</strong>: <em><span class="required">required</span>(integer)</em><p>Unique Transaction ID</p></li><li><strong>valueDate</strong>: <em><span class="required">required</span>(datetime)</em><p>Value Date of transaction</p></li><li><strong>postedDate</strong>: <em><span class="required">required</span>(datetime)</em><p>Posted Date of the cash transaction</p></li><li><strong>transactionType</strong>: <em><span class="required">required</span>(string)</em><p>Transaction type</p></li><li><strong>creditDebit</strong>: <em><span class="required">required</span>(string)</em><p>Direction of transaction</p></li><li><strong>transactionCurrency</strong>: <em><span class="required">required</span>(string)</em><p>Currency of the transaction</p></li><li><strong>transactionAmount</strong>: <em><span class="required">required</span>(number)</em><p>Value of the transaction in trasnaction currency.</p></li><li><strong>cashTransactionStatus</strong>: <em><span class="required">required</span>(string)</em><p>Status of transaction</p></li><li><strong>transactionDescription</strong>: <em><span class="required">required</span>(string)</em><p>Narrative of the transaction</p></li><li><strong>quantity</strong>: <em><span class="required">required</span>(number)</em><p>Nominal of the related investment transaction</p></li><li><strong>settledQuantity</strong>: <em><span class="required">required</span>(number)</em><p>The settled nominal of the related investment transaction</p></li><li><strong>expectedSettlementDate</strong>: <em><span class="required">required</span>(datetime)</em><p>The expected settlement date of the related investment transaction</p></li><li><strong>investmentTransactionStatus</strong>: <em><span class="required">required</span>(string)</em><p>Status of the related investment transaction</p></li><li><strong>transDate</strong>: <em><span class="required">required</span>(datetime)</em><p>Trade date of the related investment transaction</p></li></ul></div><p><strong>Example</strong>:</p><div class="examples"><pre><code>[
{
"entityType": "CUSTOMER",
"entityId": "123456",
"entityName": "Smith, Paul",
"investmentAccountNumber": "1012345",
"investmentAccountName": "Paul Smith Trust",
"cashAccountName": "Paul Smith GBP INC",
"cashAccountNumber": "104568",
"cashAccountType": "Income",
"transactionId": 5472829,
"valueDate": "2018-12-20T00:00:00.0000000+00:00",
"postedDate": "2018-12-20T10:39:52.0000000+00:00",
"transactionType": "Corporate Action Income",
"creditDebit": "CREDIT",
"transactionCurrency": "GBP",
"transactionAmount": 443.44,
"cashTransactionStatus": "Posted",
"transactionDescription": "Cash dividend - LEGG MASON GLOBAL FUNDS WESTN ASSET MACRO OPPS BD HGD PREM INC",
"quantity": 0,
"settledQuantity": 0,
"expectedSettlementDate": "0001-01-01T00:00:00.0000000+00:00",
"investmentTransactionStatus": null,
"transDate": "0001-01-01T00:00:00.0000000+00:00"
},
{
"entityType": "CUSTOMER",
"entityId": "123456",
"entityName": "Smith, Paul",
"investmentAccountNumber": "1012345",
"investmentAccountName": "Paul Smith Trust",
"cashAccountName": "Paul Smith GBP CAP",
"cashAccountNumber": "1015019",
"cashAccountType": "Capital",
"transactionId": 5591916,
"valueDate": "2019-02-05T00:00:00.0000000+00:00",
"postedDate": "2019-02-05T09:38:56.0000000+00:00",
"transactionType": "Trade",
"creditDebit": "CREDIT",
"transactionCurrency": "GBP",
"transactionAmount": 110812.27,
"cashTransactionStatus": "Posted",
"transactionDescription": "Sell 943.324 INVESCO MANAGEMENT SA ZODIAC US SENIOR LOAN GH GBP",
"quantity": 943.324,
"settledQuantity": 943.324,
"expectedSettlementDate": "2019-02-05T00:00:00.0000000+00:00",
"investmentTransactionStatus": "Settled",
"transDate": "2019-01-29T00:00:00.0000000+00:00"
}
]
</code></pre></div></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="client" class="panel-title">Client</h3></div><div class="panel-body"><div class="top-resource-description"><p>The details of a client</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_client"><span class="parent"></span>/Client</a> <span class="methods"><a href="#client_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_client" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#client_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Retrieve the properties of a client</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="client_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent"></span>/Client</h4></div><div class="modal-body"><div class="alert alert-info"><p>Retrieve the properties of a client</p></div><ul class="nav nav-tabs"><li class="active"><a href="#client_get_request" data-toggle="tab">Request</a></li><li><a href="#client_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="client_get_request"><h3>Query Parameters</h3><ul><li><strong>searchTerm</strong>: <em><span class="required">required</span>(string)</em><p>Text to search for in the client's name</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Smith</code></pre></div></li></ul></div><div class="tab-pane" id="client_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: array of Client</p><p><strong>Items</strong>: The properties of a client</p><div class="items"><ul><li><strong>customerId</strong>: <em><span class="required">required</span>(integer)</em><p>Multrees' internal customer Id</p></li><li><strong>customerName</strong>: <em><span class="required">required</span>(string)</em><p>Name of the customer</p></li><li><strong>customerRef</strong>: <em><span class="required">required</span>(string)</em><p>The customer reference number.</p></li><li><strong>customerDomicile</strong>: <em><span class="required">required</span>(string)</em><p>The customer's country of domicile</p></li><li><strong>customerBaseCurrency</strong>: <em><span class="required">required</span>(string)</em><p>The customer's base reporting currency</p></li><li><strong>customerStatus</strong>: <em><span class="required">required</span>(string)</em><p>The status of the customer (e.g. Proven, Closed)</p></li></ul></div><p><strong>Example</strong>:</p><div class="examples"><pre><code>[
{
"customerId": 12345,
"customerName": "Smith, Paul",
"customerRef": "ABC12345",
"customerDomicile": "GB",
"customerBaseCurrency": "GBP",
"customerStatus": "PROVEN"
},
{
"customerId": 95106,
"customerName": "Smith, John",
"customerRef": "ABC1000",
"customerDomicile": "GB",
"customerBaseCurrency": "GBP",
"customerStatus": "PROVEN"
}
]
</code></pre></div></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="holdings" class="panel-title">Holdings</h3></div><div class="panel-body"><div class="top-resource-description"><p>The holdings for a specified entity. This shows a traded market value as at close of business yesterday.</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_holdings"><span class="parent"></span>/Holdings</a> <span class="methods"><a href="#holdings_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_holdings" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#holdings_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Retrieve all holdings for a specified entity. This shows a traded dirty market value as at close of business yesterday.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="holdings_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent"></span>/Holdings</h4></div><div class="modal-body"><div class="alert alert-info"><p>Retrieve all holdings for a specified entity. This shows a traded dirty market value as at close of business yesterday.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#holdings_get_request" data-toggle="tab">Request</a></li><li><a href="#holdings_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="holdings_get_request"><h3>Query Parameters</h3><ul><li><strong>LEVEL</strong>: <em><span class="required">required</span>(one of ACCOUNT, GROUP, CUSTOMER)</em><p>Defines which level the request is being made at</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>GROUP</code></pre></div></li><li><strong>filter</strong>: <em><span class="required">required</span>(string)</em><p>The Id of the entity being search for.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>12345</code></pre></div></li></ul></div><div class="tab-pane" id="holdings_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: array of Holding</p><p><strong>Items</strong>: Holding</p><div class="items"><ul><li><strong>extractDate</strong>: <em><span class="required">required</span>(datetime)</em><p>The day the data was last updated. Normally this will be close of business of the previous day.</p></li><li><strong>EntityType</strong>: <em><span class="required">required</span>(string)</em><p>The type of entity searched for.</p></li><li><strong>EntityId</strong>: <em><span class="required">required</span>(string)</em><p>The ID of the entity searched for.</p></li><li><strong>EntityName</strong>: <em><span class="required">required</span>(string)</em><p>The name of the entity searched for.</p></li><li><strong>baseCurrency</strong>: <em><span class="required">required</span>(string)</em><p>Base currency of the holding</p></li><li><strong>accountNumber</strong>: <em><span class="required">required</span>(string)</em><p>Account Number</p></li><li><strong>accountName</strong>: <em><span class="required">required</span>(string)</em><p>Account Name</p></li><li><strong>accountType</strong>: <em><span class="required">required</span>(string)</em><p>Account Type</p></li><li><strong>securityId</strong>: <em><span class="required">required</span>(integer)</em><p>The security's unique identifier</p></li><li><strong>securityName</strong>: <em><span class="required">required</span>(string)</em><p>Name of security</p></li><li><strong>securityCCY</strong>: <em><span class="required">required</span>(string)</em><p>The local price currency of the security</p></li><li><strong>ISIN</strong>: <em><span class="required">required</span>(string)</em><p>The Security's ISIN</p></li><li><strong>SEDOL</strong>: <em><span class="required">required</span>(string)</em><p>The Security's SEDOL</p></li><li><strong>quantity</strong>: <em><span class="required">required</span>(number)</em><p>The traded nominal of the position</p></li><li><strong>bookCostBase</strong>: <em><span class="required">required</span>(number)</em><p>Book cost of security in base currency</p></li><li><strong>bookCostGBP</strong>: <em><span class="required">required</span>(number)</em><p>Book cost of security in GBP</p></li><li><strong>bookCostEUR</strong>: <em><span class="required">required</span>(number)</em><p>Book cost of security in EUR</p></li><li><strong>bookCostUSD</strong>: <em><span class="required">required</span>(number)</em><p>Book cost of security in USD</p></li><li><strong>bookCostSec</strong>: <em><span class="required">required</span>(number)</em><p>Book cost of security in security currency</p></li><li><strong>marketPriceSec</strong>: <em><span class="required">required</span>(number)</em><p>Market price in security currency</p></li><li><strong>marketValueSec</strong>: <em><span class="required">required</span>(number)</em><p>The dirty market value in security currency</p></li><li><strong>marketValueGBP</strong>: <em><span class="required">required</span>(number)</em><p>The dirty market value in GBP</p></li><li><strong>marketValueUSD</strong>: <em><span class="required">required</span>(number)</em><p>The dirty market value in USD</p></li><li><strong>marketValueEUR</strong>: <em><span class="required">required</span>(number)</em><p>The dirty market value in EUR</p></li><li><strong>marketValueBase</strong>: <em><span class="required">required</span>(number)</em><p>The dirty market value in client base currency</p></li><li><strong>accruedInterestGBP</strong>: <em><span class="required">required</span>(number)</em><p>Accrued intrest in GBP</p></li><li><strong>accruedInterestUSD</strong>: <em><span class="required">required</span>(number)</em><p>Accrued intrest in USD</p></li><li><strong>accruedInterestEUR</strong>: <em><span class="required">required</span>(number)</em><p>Accrued intrest in EUR</p></li><li><strong>accruedInterestBase</strong>: <em><span class="required">required</span>(number)</em><p>Accrued intrest in clients base currency</p></li><li><strong>securityType</strong>: <em><span class="required">required</span>(string)</em><p>Security type</p></li><li><strong>instrumentType</strong>: <em><span class="required">required</span>(string)</em><p>Instrument type</p></li><li><strong>classification1</strong>: <em><span class="required">required</span>(string)</em><p>First level of client specific security classifications</p></li><li><strong>classification2</strong>: <em>(union of string or nil)</em><p>Second level of client specific security classifications</p></li><li><strong>classification3</strong>: <em>(union of string or nil)</em><p>Thrid level of client specific security classifications</p></li><li><strong>custodyAccountNumber</strong>: <em><span class="required">required</span>(string)</em><p>Custody account ID or unique identifier</p></li><li><strong>custodyAccountName</strong>: <em><span class="required">required</span>(string)</em><p>Custody account name</p></li><li><strong>yield</strong>: <em><span class="required">required</span>(number)</em><p>Yeild of the security</p></li><li><strong>estimatedAnnualIncome</strong>: <em><span class="required">required</span>(number)</em><p>Estimated annual income from the security</p></li><li><strong>fxRate</strong>: <em><span class="required">required</span>(number)</em><p>Current FX rate used to covert security to base currency</p></li></ul></div><p><strong>Example</strong>:</p><div class="examples"><pre><code>[
{
"extractDate": "2019-02-26T00:00:00.0000000+00:00",
"EntityType": "GROUP",
"EntityId": "12345",
"EntityName": "Paul Smith",
"baseCurrency": "GBP",
"accountNumber": "100100",
"accountName": "Paul Smith Trust",
"accountType": "Trust",
"securityId": 42185,
"securityName": "ISHARES III PLC UK GILTS 0-5YR UCITS ETF GBP DIST",
"securityCCY": "GBP",
"ISIN": "IE00B4WXJK79",
"SEDOL": "B4WXJK7",
"quantity": 3074,
"bookCostBase": 409492.57,
"bookCostGBP": 409492.57,
"bookCostEUR": 542536.705993,
"bookCostUSD": 477208.30883805,
"bookCostSec": 409492.57,
"marketPriceSec": 132.575,
"marketValueSec": 407535.55,
"marketValueGBP": 407535.55,
"marketValueUSD": 539943.850195,
"marketValueEUR": 474927.66622575,
"marketValueBase": 407535.55,
"accruedInterestGBP": 0,
"accruedInterestUSD": 0,
"accruedInterestEUR": 0,
"accruedInterestBase": 0,
"securityType": "OEIC 0dp",
"instrumentType": "Fund",
"classification1": "Fixed Income",
"classification2": "United Kingdom",
"classification3": null,
"custodyAccountNumber": "98765432",
"custodyAccountName": "MIS CUST ABC BNY",
"yield": 0.88,
"estimatedAnnualIncome": 3603.021798,
"fxRate": 1
},
{
"extractDate": "2019-02-26T00:00:00.0000000+00:00",
"EntityType": "GROUP",
"EntityId": "12345",
"EntityName": "Paul Smith",
"baseCurrency": "GBP",
"accountNumber": "1002746",
"accountName": "Paul Smith Trust",
"accountType": "Trust",
"securityId": 3044,
"securityName": "SMITH CAPITAL FUND II LP",
"securityCCY": "GBP",
"ISIN": "PAS000007199",
"SEDOL": "IMW0071",
"quantity": 90000,
"bookCostBase": 9246.45,
"bookCostGBP": 9246.45,
"bookCostEUR": 12250.621605,
"bookCostUSD": 10775.489204250001,
"bookCostSec": 9246.45,
"marketPriceSec": 0.468276,
"marketValueSec": 42144.84,
"marketValueGBP": 42144.84,
"marketValueUSD": 55837.698516,
"marketValueEUR": 49114.121466599994,
"marketValueBase": 42144.84,
"accruedInterestGBP": 0,
"accruedInterestUSD": 0,
"accruedInterestEUR": 0,
"accruedInterestBase": 0,
"securityType": "Equity",
"instrumentType": "Equity",
"classification1": "Real Estate",
"classification2": "United Kingdom",
"classification3": null,
"custodyAccountNumber": "112233",
"custodyAccountName": "ABC Record Keeping Only",
"yield": 0,
"estimatedAnnualIncome": 0,
"fxRate": 1
}
]
</code></pre></div></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="investment" class="panel-title">Investment</h3></div><div class="panel-body"><div class="top-resource-description"><p>All calls relating to investment accounts</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_investment_account"><span class="parent">/Investment</span>/Account</a> <span class="methods"><a href="#investment_account_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_investment_account" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Search for investment accounts by name</p></div><div class="list-group"><div onclick="window.location.href = '#investment_account_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Search for investment accounts by name</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="investment_account_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Investment</span>/Account</h4></div><div class="modal-body"><div class="alert alert-info"><p>Search for investment accounts by name</p></div><ul class="nav nav-tabs"><li class="active"><a href="#investment_account_get_request" data-toggle="tab">Request</a></li><li><a href="#investment_account_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="investment_account_get_request"><h3>Query Parameters</h3><ul><li><strong>searchTerm</strong>: <em><span class="required">required</span>(string)</em><p>The text to look for in the account name.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Smith</code></pre></div></li></ul></div><div class="tab-pane" id="investment_account_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: array of InvestmentAccount</p><p><strong>Items</strong>: Investment Account</p><div class="items"><ul><li><strong>accountId</strong>: <em><span class="required">required</span>(integer)</em><p>The internal Multrees Investment account ID</p></li><li><strong>accountNumber</strong>: <em><span class="required">required</span>(string)</em><p>The Investment Account Number</p></li><li><strong>accountName</strong>: <em><span class="required">required</span>(string)</em><p>The investment account name.</p></li><li><strong>accountType</strong>: <em><span class="required">required</span>(string)</em><p>The account type</p></li><li><strong>accountStatus</strong>: <em><span class="required">required</span>(string)</em><p>The account Status (e.g. Active or closed)</p></li></ul></div><p><strong>Example</strong>:</p><div class="examples"><pre><code>[
{
"accountId": 111234,
"accountNumber": "111234",
"accountName": "Paul Smith ISA",
"accountType": "ISA",
"accountStatus": "ACTIVE"
},
{
"accountId": 12345,
"accountNumber": "1012345",
"accountName": "Paul Smith",
"accountType": "Individual",
"accountStatus": "ACTIVE"
}
]
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_investment_accounts__id_"><span class="parent">/Investment</span>/Accounts/{id}</a> <span class="methods"><a href="#investment_accounts__id__get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_investment_accounts__id_" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Search for a single investment account by its Id.</p></div><div class="list-group"><div onclick="window.location.href = '#investment_accounts__id__get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Search for a single investment account by its Id.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="investment_accounts__id__get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Investment</span>/Accounts/{id}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Search for a single investment account by its Id.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#investment_accounts__id__get_request" data-toggle="tab">Request</a></li><li><a href="#investment_accounts__id__get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="investment_accounts__id__get_request"><h3>URI Parameters</h3><ul><li><strong>id</strong>: <em><span class="required">required</span>(integer)</em><p>The invtesment account Id you are trying to retrieve</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>12345</code></pre></div></li></ul></div><div class="tab-pane" id="investment_accounts__id__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: array of InvestmentAccount</p><p><strong>Items</strong>: Investment Account</p><div class="items"><ul><li><strong>accountId</strong>: <em><span class="required">required</span>(integer)</em><p>The internal Multrees Investment account ID</p></li><li><strong>accountNumber</strong>: <em><span class="required">required</span>(string)</em><p>The Investment Account Number</p></li><li><strong>accountName</strong>: <em><span class="required">required</span>(string)</em><p>The investment account name.</p></li><li><strong>accountType</strong>: <em><span class="required">required</span>(string)</em><p>The account type</p></li><li><strong>accountStatus</strong>: <em><span class="required">required</span>(string)</em><p>The account Status (e.g. Active or closed)</p></li></ul></div><p><strong>Example</strong>:</p><div class="examples"><pre><code>[
{
"accountId": 12345,
"accountNumber": "1012345",
"accountName": "Paul Smith",
"accountType": "Individual",
"accountStatus": "ACTIVE"
}
</code></pre></div></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_investment_transaction"><span class="parent">/Investment</span>/Transaction</a> <span class="methods"><a href="#investment_transaction_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_investment_transaction" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Returns all investment transactions relating to an Entity. By default the last 30 days of transactions will be returned unless a to and from date are specified.</p></div><div class="list-group"><div onclick="window.location.href = '#investment_transaction_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Retrieve all investment transactions</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="investment_transaction_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent">/Investment</span>/Transaction</h4></div><div class="modal-body"><div class="alert alert-info"><p>Retrieve all investment transactions</p></div><ul class="nav nav-tabs"><li class="active"><a href="#investment_transaction_get_request" data-toggle="tab">Request</a></li><li><a href="#investment_transaction_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="investment_transaction_get_request"><h3>Query Parameters</h3><ul><li><strong>LEVEL</strong>: <em><span class="required">required</span>(one of ACCOUNT, GROUP, CUSTOMER)</em><p>Defines which level the request is being made at</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>GROUP</code></pre></div></li><li><strong>filter</strong>: <em><span class="required">required</span>(string)</em><p>The ID of the entity you are looking for</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>12345</code></pre></div></li><li><strong>from</strong>: <em>(datetime)</em><p>Optionally set the start date.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>2018-09-01</code></pre></div></li><li><strong>to</strong>: <em>(datetime)</em><p>Optionally set the end date.</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>2018-09-30</code></pre></div></li></ul></div><div class="tab-pane" id="investment_transaction_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: array of InvestmentTransaction</p><p><strong>Items</strong>: Investment Transactions</p><div class="items"><ul><li><strong>EntityType</strong>: <em><span class="required">required</span>(string)</em><p>The type of entity being searched for</p></li><li><strong>EntityId</strong>: <em><span class="required">required</span>(string)</em><p>The Id of the entity being searched for.</p></li><li><strong>EntityName</strong>: <em><span class="required">required</span>(string)</em><p>The name of the entity being searched for.</p></li><li><strong>investmentTransactionId</strong>: <em><span class="required">required</span>(integer)</em><p>The unique transaction ID.</p></li><li><strong>investmentAccountNumber</strong>: <em><span class="required">required</span>(string)</em><p>The investment account number</p></li><li><strong>investmentAccountName</strong>: <em><span class="required">required</span>(string)</em><p>The name of the investment account.</p></li><li><strong>securityId</strong>: <em><span class="required">required</span>(integer)</em><p>Security ID or unique identifier</p></li><li><strong>securityName</strong>: <em><span class="required">required</span>(string)</em><p>Security name</p></li><li><strong>ISIN</strong>: <em><span class="required">required</span>(string)</em><p>ISIN</p></li><li><strong>SEDOL</strong>: <em><span class="required">required</span>(string)</em><p>SEDOL</p></li><li><strong>transactionType</strong>: <em><span class="required">required</span>(string)</em><p>The type of transaction</p></li><li><strong>transactionDate</strong>: <em><span class="required">required</span>(datetime)</em><p>Date and time of transaction</p></li><li><strong>settlementDate</strong>: <em><span class="required">required</span>(datetime)</em><p>Date and time transaction was settled</p></li><li><strong>quantity</strong>: <em><span class="required">required</span>(number)</em><p>Nominal of transaction</p></li><li><strong>securityCurrency</strong>: <em><span class="required">required</span>(string)</em><p>The local security price currency</p></li><li><strong>priceSecCurrency</strong>: <em><span class="required">required</span>(number)</em><p>Price in security currency</p></li><li><strong>settlementCurrency</strong>: <em><span class="required">required</span>(string)</em><p>The settlement currency</p></li><li><strong>settlementAmount</strong>: <em><span class="required">required</span>(number)</em><p>Transaction amount in settlement currency.</p></li><li><strong>grossAmountInSettlementCurrency</strong>: <em><span class="required">required</span>(number)</em><p>Gross amount in settlement currency</p></li><li><strong>tradeCurrency</strong>: <em><span class="required">required</span>(string)</em><p>Currency of trasnaction</p></li><li><strong>settlementAmountInTradeCurrency</strong>: <em><span class="required">required</span>(number)</em><p>Settlement amount in traded currency</p></li><li><strong>grossAmountInTradeCurrency</strong>: <em><span class="required">required</span>(number)</em><p>Gross amount in traded currency</p></li><li><strong>baseCurrency</strong>: <em><span class="required">required</span>(string)</em><p>Base currency of transaction</p></li><li><strong>settlementAmountInBaseCurrency</strong>: <em><span class="required">required</span>(number)</em><p>Settlement amount in base currency</p></li><li><strong>grossAmountInBaseCurrency</strong>: <em><span class="required">required</span>(number)</em><p>Gross amount in base currency</p></li><li><strong>custodyAccountNumber</strong>: <em><span class="required">required</span>(string)</em><p>Custody account number</p></li><li><strong>tradeStatus</strong>: <em><span class="required">required</span>(string)</em><p>Status of the transaction</p></li></ul></div><p><strong>Example</strong>:</p><div class="examples"><pre><code>[
{
"EntityType": "GROUP",
"EntityId": "12345",
"EntityName": "Smith, Paul",
"investmentTransactionId": 1889752,
"investmentAccountNumber": "111000",
"investmentAccountName": "Paul Smith",
"securityId": 194283,
"securityName": "SERAPHIM SPACE LP",
"ISIN": "ZZ0000001058",
"SEDOL": "Z001058",
"transactionType": "BC Increase",
"transactionDate": "2019-01-09T00:00:00.0000000+00:00",
"settlementDate": "2019-01-09T00:00:00.0000000+00:00",
"quantity": 0,
"securityCurrency": "GBP",
"priceSecCurrency": 0,
"settlementCurrency": "GBP",
"settlementAmount": 0,
"grossAmountInSettlementCurrency": 0,
"tradeCurrency": "GBP",
"settlementAmountInTradeCurrency": 0,
"grossAmountInTradeCurrency": 0,
"baseCurrency": "GBP",
"settlementAmountInBaseCurrency": 0,
"grossAmountInBaseCurrency": 0,
"custodyAccountNumber": "MIS Nominees ABCOFFSHORE",
"tradeStatus": "Settled"
},
{
"EntityType": "GROUP",
"EntityId": "12345",
"EntityName": "Paul Smith",
"investmentTransactionId": 1910645,
"investmentAccountNumber": "1103203",
"investmentAccountName": "Paul Smith",
"securityId": 113894,
"securityName": "INVESCO MANAGEMENT SA SEN.LOAN FD-GH GBP",
"ISIN": "LU0769027045",
"SEDOL": "4JDP4P4",
"transactionType": "Sell",
"transactionDate": "2019-01-29T00:00:00.0000000+00:00",
"settlementDate": "2019-02-05T00:00:00.0000000+00:00",
"quantity": -174.856,
"securityCurrency": "GBP",
"priceSecCurrency": 130.02,
"settlementCurrency": "GBP",
"settlementAmount": 22734.78,
"grossAmountInSettlementCurrency": 22734.78,
"tradeCurrency": "GBP",
"settlementAmountInTradeCurrency": 22734.78,
"grossAmountInTradeCurrency": 22734.78,
"baseCurrency": "GBP",
"settlementAmountInBaseCurrency": 22734.78,
"grossAmountInBaseCurrency": 22734.78,
"custodyAccountNumber": "MIS Nominees ABCOFFSHORE",
"tradeStatus": "Settled"
}
]
</code></pre></div></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="performance" class="panel-title">Performance</h3></div><div class="panel-body"><div class="top-resource-description"><p>All calls relation to performance</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_performance"><span class="parent"></span>/Performance</a> <span class="methods"><a href="#performance_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_performance" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#performance_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>Retrieve all performance for a specific entity.</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="performance_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent"></span>/Performance</h4></div><div class="modal-body"><div class="alert alert-info"><p>Retrieve all performance for a specific entity.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#performance_get_request" data-toggle="tab">Request</a></li><li><a href="#performance_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="performance_get_request"><h3>Query Parameters</h3><ul><li><strong>LEVEL</strong>: <em><span class="required">required</span>(ACCOUNT - GROUP - CUSTOMER)</em><p>Defines which level the request is being made at</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>GROUP</code></pre></div></li><li><strong>filterId</strong>: <em><span class="required">required</span>(integer)</em><p>The Id of the entity to search for</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>12345</code></pre></div></li></ul></div><div class="tab-pane" id="performance_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: array of Performance</p><p><strong>Items</strong>:</p><div class="items"><ul><li><strong>BrandCD</strong>: <em><span class="required">required</span>(string)</em><p>Client's FI Code</p></li><li><strong>EntityType</strong>: <em><span class="required">required</span>(string)</em><p>The level the data is at (ACCOUNT, GROUP or CUSTOMER).</p></li><li><strong>EntityID</strong>: <em><span class="required">required</span>(string)</em><p>The ID of the entity.</p></li><li><strong>EntityName</strong>: <em><span class="required">required</span>(string)</em><p>The name of the entity that has been returned</p></li><li><strong>YTD</strong>: <em><span class="required">required</span>(number)</em><p>Year to date performance to close of business yesterday.</p></li><li><strong>ThreeMonths</strong>: <em><span class="required">required</span>(number)</em><p>3 month performance to the end of the last quarter</p></li><li><strong>SixMonths</strong>: <em><span class="required">required</span>(number)</em><p>6 month performance to the end of the last quarter</p></li><li><strong>OneYear</strong>: <em><span class="required">required</span>(number)</em><p>1 year performance to the end of the last quarter</p></li><li><strong>ThreeYears</strong>: <em><span class="required">required</span>(number)</em><p>3 year performance to the end of the last quarter</p></li><li><strong>FiveYears</strong>: <em><span class="required">required</span>(number)</em><p>5 year performance to the end of the last quarter</p></li><li><strong>SinceInception</strong>: <em><span class="required">required</span>(number)</em><p>Since Inception performance to close of business yesterday.</p></li><li><strong>AnnualisedReturn</strong>: <em><span class="required">required</span>(number)</em><p>Annualised return to close of business yesterday.</p></li><li><strong>InceptionDate</strong>: <em><span class="required">required</span>(datetime)</em><p>The inception date.</p></li><li><strong>Year1</strong>: <em><span class="required">required</span>(number)</em><p>1 year performance for previous year (e.g. 2018 performance in 2019)</p></li><li><strong>Year2</strong>: <em><span class="required">required</span>(number)</em><p>1 year performance for two years ago (e.g. 2017 performance in 2019)</p></li><li><strong>Year3</strong>: <em><span class="required">required</span>(number)</em><p>1 year performance for three years ago (e.g. 2016 performance in 2019)</p></li><li><strong>Year4</strong>: <em><span class="required">required</span>(number)</em><p>1 year performance for four years ago (e.g. 2015 performance in 2019)</p></li><li><strong>Year5</strong>: <em><span class="required">required</span>(number)</em><p>1 year performance for five years ago (e.g. 2014 performance in 2019)</p></li><li><strong>YTDQE</strong>: <em><span class="required">required</span>(number)</em><p>Year to Date peformance to end of last quarter</p></li><li><strong>SinceInceptionQE</strong>: <em><span class="required">required</span>(number)</em><p>Since Inception peformance to end of last quarter</p></li><li><strong>AnnualisedReturnQE</strong>: <em><span class="required">required</span>(number)</em><p>Annualised return to end of last quarter</p></li></ul></div><p><strong>Example</strong>:</p><div class="examples"><pre><code>[
{
"BrandCD": "ABC",
"EntityType": "ACCOUNT",
"EntityID": "12345",
"EntityName": "Paul Smith Trust",
"YTD": 6.56353076,
"ThreeMonths": -6.6052,
"SixMonths": -5.4471,
"OneYear": -4.788,
"ThreeYears": 2.4024,
"FiveYears": 22.6431,
"SinceInception": 501.40735544,
"AnnualisedReturn": 25.44127619,
"InceptionDate": "2011-02-01T00:00:00.0000000+00:00",
"Year1": 4.5544,
"Year2": 2.868,
"Year3": 8.3377,
"Year4": 10.5546,
"Year5": 6.3097,
"YTDQE": -4.788,
"SinceInceptionQE": 39.4281,
"AnnualisedReturnQE": 4.288704119964
},
{
"BrandCD": "ABC",
"EntityType": "GROUP",
"EntityID": "123456",
"EntityName": "Paul Smith",
"YTD": 6.56353076,
"ThreeMonths": -6.6052,
"SixMonths": -5.4471,
"OneYear": -4.788,
"ThreeYears": 2.4024,
"FiveYears": 22.6431,
"SinceInception": 501.40735544,
"AnnualisedReturn": 25.44127619,
"InceptionDate": "2011-02-01T00:00:00.0000000+00:00",
"Year1": 4.5544,
"Year2": 2.868,
"Year3": 8.3377,
"Year4": 10.5546,
"Year5": 6.3097,
"YTDQE": -4.788,
"SinceInceptionQE": 39.4281,
"AnnualisedReturnQE": 4.288704119964
}
]
</code></pre></div></div></div></div></div></div></div></div></div></div></div></div><div class="col-md-3"><div id="sidebar" class="hidden-print affix" role="complementary"><ul class="nav nav-pills nav-stacked"><li><a href="#assetallocation">Asset Allocations</a></li><li><a href="#aum">Assets Under Management</a></li><li><a href="#cash">Cash</a></li><li><a href="#client">Client</a></li><li><a href="#holdings">Holdings</a></li><li><a href="#investment">Investment</a></li><li><a href="#performance">Performance</a></li></ul></div></div></div></div></body></html>