-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathledger_rows.json
More file actions
171 lines (171 loc) · 7.58 KB
/
ledger_rows.json
File metadata and controls
171 lines (171 loc) · 7.58 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
{
"title": "Ledger Row",
"category": "ancillary",
"docpath": "ledger_row",
"introduction": [
"A Ledger Row is a specialised view of a <a class=\"link\" href=\"/documentation/transactions\">Transaction</a>, delivered as part of a <a class=\"link\" href=\"/documentation/ledgers\">Ledger</a> or <a class=\"link\" href=\"/documentation/recursive_ledger\">Recursive Ledger</a>. The Ledger Row describes a Tranasction from the perspective of the <a class=\"link\" href=\"/documentation/accounts\">Account</a> targeted by the controlling Ledger or Recursive Ledger.",
"When consuming the Amatino API, you will never encounter a Ledger Row on its own. They are only ever delivered under the <span class=\"monospace\">ledger_rows</span> key as part of a Ledger or Recursive Ledger object."
],
"object": {
"name": "Ledger Row",
"exposition": "Amatino will deliver Ledger Rows with the following object structure",
"form": {
"root": "list",
"components": [
{
"key": {
"value": "\"transaction_id\"",
"mono": true
},
"type": {
"value": "JSON Number",
"mono": false
},
"description": {
"value": "The integer identifier of the <a class=\"link\" href=\"/documentation/transactions\">Transaction</a> this Ledger Row describes.",
"mono": false
},
"example": {
"value": 320932,
"mono": true
}
},
{
"key": {
"value": "\"transaction_time\"",
"mono": true
},
"description": {
"value": "Time at which the described <a class=\"link\" href=\"/documentation/transactions\">Transaction</a> occured, or is to occur, in the format YYYY-MM-DD_HH24:MI:SS.US, at UTC",
"mono": false
},
"type": {
"value": "JSON String",
"mono": false
},
"example": {
"value": "\"2017-01-07_17:22:16.51245\"",
"mono": true
}
},
{
"key": {
"value": "\"description\"",
"mono": true
},
"description": {
"value": "A friendly description of the <a class=\"link\" href=\"/documentation/transactions\">Transaction</a>",
"mono": false
},
"type": {
"value": "JSON String",
"mono": false
},
"example": {
"value": "Receipt of payment for exquisite accounting services",
"mono": false
}
},
{
"key": {
"value": "\"opposing_account_id\"",
"mono": true
},
"description": {
"value": "The unique integer id of the <a class=\"link\" href=\"/documentation/accounts\">Account</a> debited or credited in opposition to the target Account",
"mono": false
},
"type": {
"value": "JSON Number or JSON Null",
"mono": false
},
"example": {
"value": 42,
"mono": false
},
"note": {
"value": "If the <a class=\"link\" href=\"/documentation/transactions\">Transaction</a> described features more than two <a class=\"link\" href=\"/documentation/entries\">Entries</a>, <span class=\"monospace\">opposing_account_id</span> will return <span class=\"monospace\">null</span>." ,
"mono": false
}
},
{
"key": {
"value": "\"opposing_account_name\"",
"mono": true
},
"description": {
"value": "The name of the <a class=\"link\" href=\"/documentation/accounts\">Account</a> debited or credited in opposition to the target Account",
"mono": false
},
"type": {
"value": "JSON String",
"mono": false
},
"example": {
"value": "Accounts Receivable",
"mono": false
},
"note": {
"value": "If the Transaction described features more than two <a class=\"link\" href=\"/documentation/entries\">Entries</a>, <span class=\"monospace\">opposing_account_name</span> will return <span class=\"monospace\">\"[Split Transaction]\"</span>." ,
"mono": false
}
},
{
"key": {
"value": "\"debit\"",
"mono": true
},
"type": {
"value": "JSON String",
"mono": false
},
"description": {
"value": "The debit value of the described <a class=\"link\" href=\"/documentation/transactions\">Transaction</a>.",
"mono": false
},
"example": {
"value": "\"0.00\"",
"mono": true
}
},
{
"key": {
"value": "\"credit\"",
"mono": true
},
"type": {
"value": "JSON String",
"mono": false
},
"description": {
"value": "The credit value of the described <a class=\"link\" href=\"/documentation/transactions\">Transaction</a>.",
"mono": false
},
"example": {
"value": "\"23,125.95\"",
"mono": true
}
},
{
"key": {
"value": "\"balance\"",
"mono": true
},
"type": {
"value": "JSON String",
"mono": false
},
"description": {
"value": "The running total balance of the target <a class=\"link\" href=\"/documentation/accounts\">Account</a>, at the time of this <a class=\"link\" href=\"/documentation/transactions\">Transaction</a>",
"mono": false
},
"example": {
"value": "\"12,492,532.33\"",
"mono": true
}
}
]
}
},
"actions": null
}