File: eqz_file_format

package info (click to toggle)
eqonomize 1.5.1-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, sid
  • size: 16,956 kB
  • sloc: cpp: 49,180; xml: 495; makefile: 10; sh: 6
file content (295 lines) | stat: -rw-r--r-- 7,794 bytes parent folder | download | duplicates (3)
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
The Eqonomize! accounting file format (EQZ)

The file is an xml file encoded in UTF-8 with doctype EqonomizeDoc.
It should begin with
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE EqonomizeDoc>

The top element is EqonomizeDoc with attributes version (Eqonomize! version), revision (integer, last revision of file), 
and lastid (64-bit unsigned integer, the highest id in the file).

Subelements:
synchronization
budget_period
currency
category
account
security
schedule
transaction

Schedules and transactions should be listed last.

Common properties
-----------------------------------

revisions:
The revisions attribute specifies the file revision when the transaction was created (before ':') and last modified (after ':', if differs). 
The revisions attributes is optional.

id:
The id of each new transaction must be unique and higher than the 'lastid' specified by the loaded file.

timestamp:
Unix time when the transaction was created. The time stamp is specified in microseconds in Eqonomize! <= 1.3.2, but changes to seconds in 
later versions.

Synchronization
-----------------------------------
attributes: 
type (text string, ignored)
autosync (boolean integer)
revision (integer, synchronized revision)

elements: 
url
download (command)
upload (command)

Budget period
-----------------------------------
elements: 
first_day_of_month (default: 1)
first_month_of_year (default: 1)

Currency
-----------------------------------
Specifies the default currency for the file. Defaults to local currency.

attributes: 
code (three letter ISO 4217 currency code)

Category
-----------------------------------
attributes:
id
name (text string)
type (text string)
description (text string, optional)
revisions (optional)

types: 
expenses
incomes

elements: 
budget
category (only one level of subcategories is supported in Eqonomize!)

budget attributes: 
value (floating point)
date (a full date in ISO 8601 format)

Budget values are specified monthly using the first day of the month. Months without a specified budget uses the budget value of the previous 
month. A negative value (-1.0) unsets the budget.

Account
-----------------------------------
attributes:
id
name (text string)
type (text string, optional)
group (text string, optional)
lender/issuer/bank (text string, optional)
currency (three letter ISO 4217 currency code, otional)
initialbalance (floating point, optional)
budgetaccount (boolean integer, optional)
closed (boolean integer, optional)
revisions (optional)
description (text string, optional)

types: 
current
savings
credit card
liabilities
securities
cash
other (default)

If type is not set, then type is 'other'. 
If type is 'securities', initialbalance and budgetaccount is not allowed. budgetaccount can only be set to true for one account.

If group is empty automatic grouping based on type is assumed. Use "-" to specify no group.

Security
-----------------------------------
attributes:
name (text string)
type (optional)
account (account id of a securities account)
initialshares (floating point, optional)
decimals (integer, optional)
quotationdecimals (integer, optional)
desciption (text string, optional)

types: 
bond
stock
mutual fund
other (default)

elements: 
quotation

quotation attributes: 
date (a full date in ISO 8601 format)
value (floating point)
auto (boolean integer, optional)

Transaction
-----------------------------------
common attributes:
id (64-bit unsigned integer, optional)
type (text string)
revisions (integer, optional)
timestamp (integer, optional)
date (a full date in ISO 8601 format)
comment (text string, optional)
file (a file location, optional)
tags (comma separated text strings)
links (comma separated 64-bit unsigned integers)

types: 
expense/refund
income/repayment/dividend
transfer
balancing
reinvested_dividend
security_buy
security_sell
security_trade
multiitem (or deprecated 'split')
multiaccount
debtpayment

attributes for expense: 
description (text string, optional)
cost (floating point)
income (negated alternative to cost)
quantity (floating point, optional, default 1.0)
category (expense category id)
from (account id)
payee (text string, optional)
reconciled (boolean integer, optional)

attributes for income: 
description (text string, optional)
income (floating point)
cost (negated alternative to income)
quantity (floating point, optional, default 1.0)
category (income category id)
to (account id)
payer (text string, optional)
security (security id, optional, used for dividends)
reconciled (boolean integer, optional)

attributes for transfer: 
description (text string, optional)
amount (floating point)
withdrawal (used instead of amount if accounts uses different currencies)
deposit (used instead of amount if accounts uses different currencies)
from (account id)
to (account id)
reconciled (boolean integer, optional)

attributes for balancing: 
description (text string, optional)
amount (floating point)
account (account id)

attributes for reinvested_dividend:
category (income category id)
security (security id)
value (floating point)
shares (floating point)
sharevalue (floating point) 

Two of value, shares and sharevalue are required.

attributes for security_buy: 
account (account id)
security (security id)
cost (floating point)
shares (floating point)
reconciled (boolean integer, optional)

attributes for security_sell: 
account (account id)
security (security id)
income (floating point)
shares (floating point)
reconciled (boolean integer, optional)

attributes for security_trade (common attributes does not apply): 
date (a full date in ISO 8601 format)
from_security (security id)
to_security (security id)
from_shares (floating point)
to_shares (floating point)
timestamp (integer, optional)

attributes for multiitem: 
description (text string, optional)
account (account id)
payee (text string, optional)

elements for multiitem: 
transaction (date, from/to, payee/payer is set from multiitem attributes)

attributes for multiaccount: 
description (text string, optional)
quantity (floating point, optional, default 1.0)
category (category id)

elements for multiaccount: 
transaction (only incomes and expenses allowed; category and description is set from multiaccount attributes)

attributes for debtpayment: 
debt (account id) 
from (account id)
payment (floating point, used when currencies of accounts differ)
interestpaid (boolean integer, optional, default true, 'interestpayed' occurs in Eqonomize! < 1.3.2)
expensecategory (expense category id, optional)
reduction (floating point, optional)
interest (floating point, optional)
fee (floating point, optional)

In Eqonomize! > 1.3.2 type is not strictly required for expenses, incomes and transfers, value can be used instead of income/cost/amount, 
and to/from can be used instead of category.

Schedule
-----------------------------------
attributes: 
id (optional)
revisions (optional)

elements: 
transaction (mandatory)
recurrence (optional)

recurrence attributes: 
type (daily, weekly, monthly, or yearly)
startdate (a full date in ISO 8601 format)
enddate (a full date in ISO 8601 format, optional)
frequency (integer, optional)

attributes for weekly recurrence: 
days (a list of days of week numbers beginning at 1 with no whitespace or other characters inbetween)

attributes for monthly reccurence: 
week (week of month, can be negative to count from end) and dayofweek;
day (day of month, can be negative to count from end) and weekendhandling (0=none, 1=before, 2=after, 3=nearest, optional);

attributes for yearly reccurence: 
dayofyear and weekendhandling (optional); 
month, dayofweek and week (can be negative); 
month, dayofmonth and weekendhandling (optional);

recurrence elements: 
exception

exception attributes: 
date (a full date in ISO 8601 format)