-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtree_node.json
More file actions
151 lines (151 loc) · 6.7 KB
/
tree_node.json
File metadata and controls
151 lines (151 loc) · 6.7 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
{
"title": "Tree Node",
"category": "ancillary",
"docpath": "trees/node",
"introduction": [
"A Tree Node is a specialised view of an <a class=\"link\" href=\"/documentation/accounts\">Account</a>. It provides a recursive and individual balance for an Account. You will never interact with Tree Nodes' directly, instead you will receive lists of Tree Nodes as components of requests for <a class=\"link\" href=\"/documentation/trees\">Trees</a>, <a class=\"link\" href=\"/documentation/positions\">Positions</a>, and <a class=\"link\" href=\"/documentation/performances\">Performances</a>.",
"Tree Nodes are recursive objects that may contain other Tree Nodes, depending on whether the Account in question has any children.",
"Trees, Positions, and Performances describe entire <a class=\"link\" href=\"/documentation/entities\">Entities</a>. The <a class=\"link\" href=\"/documentation/users\">User</a> from whose perspective you retrieve a Tree, Position, or Performance may not have read access to every Account in the Entity. In such cases, Tree Nodes describing Accounts to which a User does not have read access will be returned with <span class=\"monospace\">null</span> in their balance fields, and a generic <a class=\"link\" href=\"/documentation/constants/types\">Type</a> in place of the actual Account name."
],
"object": {
"name": "Tree Node",
"exposition": "The Amatino API returns Tree Node objects with the following structure",
"form": {
"root": "object",
"components": [
{
"key": {
"value": "\"account_id\"",
"mono": true
},
"type": {
"value": "JSON Number",
"mono": false
},
"description": {
"value": "Integer identifier of the <a class=\"link\" href=\"/documentation/accounts\">Account</a> this Tree Node describes",
"mono": false
},
"example": {
"value": 42,
"mono": true
}
},
{
"key": {
"value": "\"depth\"",
"mono": true
},
"type": {
"value": "JSON Number",
"mono": false
},
"description": {
"value": "The number of levels into the hierarchy this account sits. Top level accounts are 1.",
"mono": false
},
"example": {
"value": "2",
"mono": true
}
},
{
"key": {
"value": "\"account_balance\"",
"mono": true
},
"type": {
"value": "JSON String",
"mono": false
},
"description": {
"value": "The magnitude of the balance of the described Account, or <span class=\"monospace\">null</span> if the retrieving User lacks read privileges.",
"mono": false
},
"example": {
"value": "\"400.30\"",
"mono": true
}
},
{
"key": {
"value": "\"name\"",
"mono": true
},
"type": {
"value": "JSON String",
"mono": false
},
"description": {
"value": "The name of the Account this Tree Node describes, or the Type name if the retrieving User lacks read privileges.",
"mono": false
},
"example": {
"value": false,
"mono": true
}
},
{
"key": {
"value": "\"recursive_balance\"",
"mono": true
},
"type": {
"value": "JSON String or JSON Null",
"mono": false
},
"description": {
"value": "The magnitude of the recursive balance of the described Account, or <span class=\"monospace\">null</span> if the retrieving User lacks read privileges.",
"mono": false
},
"example": {
"value": "600.01",
"mono": true
}
},
{
"key": {
"value": "\"type\"",
"mono": true
},
"description": {
"value": "The id of the <a class=\"link\" href=\"/documentation/constants/types\">Type</a> of the Account this Tree Node describes",
"mono": false
},
"type": {
"value": "JSON Number",
"mono": false
},
"example": {
"value": "1",
"mono": true
}
},
{
"key" :{
"value": "\"children\"",
"mono": true
},
"description": {
"value": "A list of <a class=\"link\" href=\"/documentation/trees/node\">Tree Node</a> objects for each child of the Account this Tree Node describes",
"mono": false
},
"type": {
"value": "JSON Array",
"mono": false
},
"list objects": {
"value": "Tree Node",
"mono": false,
"link": "/documentation/trees/node"
},
"example": {
"value": "See <a href=\"/documentation/trees/node\" class=\"link\">Tree Nodes</a>",
"mono": false
}
}
]
}
},
"actions": null
}