-
Notifications
You must be signed in to change notification settings - Fork 0
/
ledgers.json
399 lines (399 loc) · 15.9 KB
/
ledgers.json
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
{
"title": "Ledger",
"category": "derived",
"docpath": "accounts/ledger",
"introduction": [
"A Ledger is a list of <a class=\"link\" href=\"/documentation/transactions\">Transactions</a> from the perspective of a particular <a class=\"link\" href=\"/documentation/accounts\">Account</a>. Ledgers are ordered by Transaction time, and include a running Account Balance for every line.",
"You can request Ledgers in arbitrary Global or Custom Units, not just the native unit of the target Account. If you request a Ledger in a unit other than the target Account native unit, Amatino will compute and return unrealised gains and losses.",
"Amatino will return a maximum total of 1,000 Ledger Rows per retrieval request. If the Ledger you define spans more than 1,000 rows, it will be broken into pages you can retrieve seperately."
],
"object": {
"name": "Ledger",
"exposition": "The Amatino API returns Ledger objects with the following structure",
"form": {
"root": "object",
"components": [
{
"key": {
"value": "\"account_id\"",
"mono": true
},
"type": {
"value": "JSON Number",
"mono": false
},
"description": {
"value": "An integer identifier of the <a class=\"link\" href=\"/documentation/accounts\">Account</a> this Ledger describes",
"mono": false
},
"example": {
"value": 42,
"mono": true
}
},
{
"key": {
"value": "\"start_time\"",
"mono": true
},
"type": {
"value": "JSON String",
"mono": false
},
"description": {
"value": "Time at which the ledger window starts, in the format YYYY-MM-DD_HH24:MI:SS.US",
"mono": false
},
"example": {
"value": "\"2017-01-01_17:22:16.00000\"",
"mono": true
}
},
{
"key": {
"value": "\"end_time\"",
"mono": true
},
"type": {
"value": "JSON String",
"mono": false
},
"description": {
"value": "Time at which the ledger window ends, in the format YYYY-MM-DD_HH24:MI:SS.US",
"mono": false
},
"example": {
"value": "\"2018-02-07_17:22:16.51245\"",
"mono": true
}
},
{
"key": {
"value": "\"recursive\"",
"mono": true
},
"type": {
"value": "JSON Boolean",
"mono": false
},
"description": {
"value": "A bool asserting that this is not a <a href=\"/documentation/recursive_ledger\">Recursive Ledger</a>. Always <span class=\"monospace\">false</span>",
"mono": false
},
"example": {
"value": false,
"mono": true
}
},
{
"key": {
"value": "\"generated_time\"",
"mono": true
},
"type": {
"value": "JSON String",
"mono": false
},
"description": {
"value": "Time that this Ledger was computed, in the format YYYY-MM-DD_HH24:MI:SS.US",
"mono": false
},
"example": {
"value": "\"2018-05-02_05:01:54.72941\"",
"mono": true
}
},
{
"key": {
"value": "\"global_unit_denomination\"",
"mono": true
},
"description": {
"value": "The id of the global unit in which this Ledger is denominated, if applicable",
"mono": false
},
"type": {
"value": "JSON Number or JSON Null",
"mono": false
},
"example": {
"value": "5",
"mono": true
}
},
{
"key": {
"value": "\"custom_unit_denomination\"",
"mono": true
},
"description": {
"value": "The id of the custom unit in which this Ledger is denominated, if applicable.",
"mono": false
},
"type": {
"value": "JSON Number or JSON Null",
"mono": false
},
"example": {
"value": "null",
"mono": true
}
},
{
"key": {
"value": "\"page\"",
"mono": true
},
"description": {
"value": "The page number covered by this ledger object",
"mono": false
},
"type": {
"value": "JSON Number",
"mono": false
},
"example": {
"value": 2,
"mono": true
}
},
{
"key": {
"value": "\"number_of_pages\"",
"mono": true
},
"description": {
"value": "The number of pages this Ledger covers, in total",
"mono": false
},
"type": {
"value": "JSON Number",
"mono": false
},
"example": {
"value": 3,
"mono": true
}
},
{
"key": {
"value": "\"ordered_oldest_first\"",
"mono": true
},
"description": {
"value": "True of the ledger presents oldest transactions first, false if newest first",
"mono": false
},
"type": {
"value": "JSON Bool",
"mono": false
},
"example": {
"value": "true",
"mono": true
}
},
{
"key": {
"value": "\"ledger_rows\"",
"mono": true
},
"description": {
"value": "A list of <a href=\"/documentation/ledger_row\" class=\"link\">Ledger Row</a> objects",
"mono": false
},
"type": {
"value": "JSON Array",
"mono": false
},
"list objects": {
"value": "Ledger Row",
"mono": false,
"link": "/documentation/ledger_row"
},
"example": {
"value": "See <a href=\"/documentation/ledger_row\" class=\"link\">Ledger Rows</a>",
"mono": false
}
}
]
}
},
"actions": [
{
"name": "Retrieve",
"method": "GET",
"path": "/accounts/ledger",
"description": "Retrieve a Ledger for an account or accounts",
"return_root_type": "JSON Array",
"required_json_data": {
"root": "object",
"components": [
{
"key": {
"value": "\"account_id\"",
"mono": true
},
"description": {
"value": "The unique integer identifier of the Account for which you would like to retrieve a Ledger",
"mono": false
},
"type": {
"value": "JSON Number",
"mono": false
},
"example": {
"value": 42,
"mono": true
}
},
{
"key": {
"value": "\"start_time\"",
"mono": true
},
"description": {
"value": "The time at which the Ledger will start. Specify JSON Null to start at request time",
"mono": false
},
"type": {
"value": "JSON String or JSON Null",
"mono": false
},
"example": {
"value": "\"2018-01-01_00:00:00.00000\"",
"mono": true
}
},
{
"key": {
"value": "\"end_time\"",
"mono": true
},
"description": {
"value": "The time at which the Ledger will end. Specify JSON Null to end at start time less one year",
"mono": false
},
"type": {
"value": "JSON String or JSON Null",
"mono": false
},
"example": {
"value": "\"2018-12-31_00:00:00.00000\"",
"mono": true
}
},
{
"key": {
"value": "\"page\"",
"mono": true
},
"description": {
"value": "The page to retrieve. Specify JSON Null to retrieve the first page.",
"mono": false
},
"type": {
"value": "JSON Number or JSON Null",
"mono": false
},
"example": {
"value": 2,
"mono": true
}
},
{
"key": {
"value": "\"global_unit_denomination\"",
"mono": true
},
"description": {
"value": "The id of the global unit denomination in which you would like to view the Ledger, if desired. Specify JSON Null both here and in the custom unit to retrieve the transaction in the target Account's native unit.",
"mono": false
},
"type": {
"value": "JSON Number or JSON Null",
"mono": false
},
"example": {
"value": "5",
"mono": true
},
"source": {
"value": "/units/list",
"mono": false,
"link": "/documentation/unit_list"
}
},
{
"key": {
"value": "\"custom_unit_denomination\"",
"mono": true
},
"description": {
"value": "The id of the custom unit in which you would like to view the Ledger, if desired. Specify JSON Null both here and in the custom unit to retrieve the transaction in the target Account's native unit.",
"mono": false
},
"type": {
"value": "JSON Number or JSON Null",
"mono": false
},
"example": {
"value": "null",
"mono": true
},
"source": {
"value": "/custom_units/list",
"mono": false,
"link": "/documentation/custom_unit_list"
}
},
{
"key": {
"value": "\"order_oldest_first\"",
"mono": true
},
"description": {
"value": "Specify true to order the ledger oldest first, false to reverse.",
"mono": false
},
"type": {
"value": "JSON Bool",
"mono": false
},
"example": {
"value": "false",
"mono": true
}
}
]
},
"required_headers": [
{
"key": "X-Signature",
"content": "Your <a class=\"link\" href=\"/documentation/sessions\">Session</a> signature",
"example": "\"yxATCPRKAAXHNiPctNQPHEGGVJF\"..."
},
{
"key": "X-Session-ID",
"content": "An an integer <a class=\"link\" href=\"/documentation/sessions\">Session</a> ID",
"example": 7449059267091272858
}
],
"required_url_parameters": [
{
"key": "entity_id",
"type": "string",
"description": "The entity id of the entity from which you wish to retrieve a Ledger",
"example": "oB3cjSNKXklkJ4Tb",
"repeatable": false
}
],
"returns": {
"root": "object",
"components": {
"object": "ledger"
}
}
}
]
}