]> Dogcows Code - chaz/homebank/blob - doc/misc-csvformat.html
Merge branch 'upstream'
[chaz/homebank] / doc / misc-csvformat.html
1 <!DOCTYPE html>
2 <html>
3 <head>
4 <meta content="text/html; charset=utf-8" http-equiv="CONTENT-TYPE">
5 <meta content="noindex" name="robots">
6 <title>CSV file format</title>
7 <link href="help.css" rel="stylesheet" type="text/css">
8 </head>
9 <body id="top">
10 <div class="dochead">
11 HomeBank User manual
12 </div>
13 <div class="title">
14 <h1>CSV file format</h1>
15 <p>With HomeBank you can import/export some of the internal data's in the most common file format that is CSV.</p>
16 <p>Notice: meanwhile CSV should uses comma as separator, HomeBank uses semi-colon as separator (this is most common than comma)</p>
17 <p>The format used for the different files is specific to HomeBank, so don't expect to import files your bank should offers you directly, you will need to arrange it a little in a spreadsheet like Gnumeric before.</p>
18 <p>Below is a description with example of the CSV format that HomeBank uses.</p><!-- separator -->
19 <ul class="toc">
20 <li><a href="#txn">Transaction</a></li>
21 <li><a href="#bud">Budget</a></li>
22 <li><a href="#cat">Category</a></li>
23 <li><a href="#pay">Payee</a></li>
24 </ul>
25 </div>
26 <div class="rounded content">
27 <h2><a id="txn" name="txn"></a>Transaction</h2>
28 <table class="widgetinfo">
29 <tr>
30 <th>date</th>
31 <td>the date format can be:
32 <ul>
33 <li>y-m-d
34 <li>m-d-y
35 <li>d-m-y
36 </ul>
37 <p>year can be 2 or 4 digits<br>
38 separators can be / . or -</td>
39 </tr>
40 <tr>
41 <th>payment</th>
42 <td>
43 <img src="images/d-warn.png">&nbsp;<span class="warning">You cannot import transaction with payment type=5 (internal xfer)</span><br>
44 from 0=none to 10=FI fee (in the same order of the list)<br>
45 </td>
46 </tr>
47 <tr>
48 <th>info</th>
49 <td>a string</td>
50 </tr>
51 <tr>
52 <th>payee</th>
53 <td>a payee name</td>
54 </tr>
55 <tr>
56 <th>memo</th>
57 <td>a string</td>
58 </tr>
59 <tr>
60 <th>amount</th>
61 <td>a number with a '.' or ',' as decimal separator, ex: -24.12 or 36,75</td>
62 </tr>
63 <tr>
64 <th>category</th>
65 <td>a full category name (category, or category:subcategory)</td>
66 </tr>
67 <tr>
68 <th>tags</th>
69 <td>tags separated by space<br>
70 tag is mandatory since v4.5</td>
71 </tr>
72 </table>
73 <p>Example:</p>
74 <pre class="csvexample">
75 15-02-04;0;;;Some cash;-40,00;Bill:Withdrawal of cash;tag1 tag2
76 15-02-04;1;;;Internet DSL;-45,00;Inline service/Internet;tag2 my-tag3
77 ...
78 </pre>
79 <p class="top"><a href="#top">↑ Back to Top</a></p>
80 </div><!-- separator -->
81 <div class="rounded content">
82 <h2><a id="bud" name="bud"></a>Budget</h2>
83 <table class="widgetinfo">
84 <tr>
85 <th>type</th>
86 <td>* = monthly<br>
87 <em>blank</em> = month value</td>
88 </tr>
89 <tr>
90 <th>category</th>
91 <td>the category name</td>
92 </tr>
93 <tr>
94 <th>value(s)</th>
95 <td>1 amount : if the type is monthly<br>
96 12 amounts, separated by ';' : if type month value</td>
97 </tr>
98 </table>
99 <p>Example:</p>
100 <pre class="csvexample">
101 *;Fuel;45.00
102 ;Domestic animals;1.00;2.00;3.00;4.00;...
103 *;Food;17.00
104 ...
105 </pre>
106 <p class="top"><a href="#top">↑ Back to Top</a></p>
107 </div><!-- separator -->
108 <div class="rounded content">
109 <h2><a id="cat" name="cat"></a>Category</h2>
110 <table class="widgetinfo">
111 <tr>
112 <th>level</th>
113 <td>1 = category<br>
114 2 = subcategory</td>
115 </tr>
116 <tr>
117 <th>type</th>
118 <td>- = expense<br>
119 + = income</td>
120 </tr>
121 <tr>
122 <th>category name</th>
123 <td>the category name</td>
124 </tr>
125 </table>
126 <p>Example:</p>
127 <pre class="csvexample">
128 1;-;Food
129 2; ;Grocer
130 2; ;Restaurant
131 1;+;Wage
132 ...
133 </pre>
134 <p class="top"><a href="#top">↑ Back to Top</a></p>
135 </div>
136 <div class="rounded content">
137 <h2><a id="pay" name="pay"></a>Payee</h2>
138 <table class="widgetinfo">
139 <tr>
140 <th>payee name</th>
141 <td>the name of the payee</td>
142 </tr>
143 <tr>
144 <th>full category name</th>
145 <td>optional: since 5.1.3<br>the full name of the category</td>
146 </tr>
147 </table>
148 <p>Example:</p>
149 <pre class="csvexample">
150 payee_name1;cat1:subcat1
151 payee_name2;
152 ...
153 </pre>
154 <p class="top"><a href="#top">↑ Back to Top</a></p>
155 </div><!-- separator -->
156 </body>
157 </html>
This page took 0.037195 seconds and 4 git commands to generate.