=================================================================== RCS file: /cvs/pta/pta_import.1,v retrieving revision 1.12 retrieving revision 1.13 diff -u -p -r1.12 -r1.13 --- pta/pta_import.1 2020/12/03 14:17:39 1.12 +++ pta/pta_import.1 2020/12/03 14:46:44 1.13 @@ -1,4 +1,4 @@ -.\" $Id: pta_import.1,v 1.12 2020/12/03 14:17:39 freda Exp $ +.\" $Id: pta_import.1,v 1.13 2020/12/03 14:46:44 freda Exp $ .\" .\" Copyright (c) 2020 Freda Bundchen .\" @@ -169,159 +169,18 @@ Example CSV files: .Ex -std .Sh EXAMPLES Add journal entries to a journal file using a CSV file generated by -a financial institution: +a financial institution, and a configuration file +.Pa ./import/my_bank.txt : .Pp -.Dl "$ pta_import -I chase_credit chasedownload.csv >> journal.txt" -.Ss Account numbers in the configuration file -The line +.Dl "$ pta_import -I my_bank downloaded.csv >> journal.txt" .Pp -.Dl ACCOUNT 3235 -.Pp -in the configuration file corresponds to a line such as -.Pp -.Dl 3235 L Capital One credit card -.Pp -in -.Pa ./accounts.txt . -.Pp -The description -.Qq Capital One credit card -may vary, but in this example, the account numbers -.Qq 3235 -match, and the account type is -.Qq L -to indicate that it is a liability account. -.Ss Patterns in the configuration file -Suppose -.Pp -.Dl ,,,Automotive,,, 1111 AUTO -.Pp -is a sample entry in the -.Pa ./import/chase_credit.txt -file which uses headers of the form -.Pp -.Dl Transaction Date,Post Date,Description,Category,Type,Amount -.Pp -Then this -.Ar selector -ignores the transaction date, post date, description, type, and amount. -It matches the -.Qq Automotive -category and maps transactions to account -.Qq 1111 -defined in -.Pa ./accounts.txt -with the -.Qq Auto -booking identifier. -.Ss A sample credit card purchase -If -.Pa chasedownload.csv -file contains -.Pp -.Dl "10/26/2020,10/26/2020,example.com*asldfkj,Shopping,Sale,-17.07" -.Pp -and -.Pa ./import/chase_credit.txt -contains -.Bd -literal -offset Ds -ACCOUNT 3234 -,,,Shopping,,, 9996 SHOP -.Ed -.Pp -and -.Pa ./accounts.txt -contains -.Bd -literal -offset Ds -3234 L Chase credit card -9996 X shopping -.Ed -.Pp -then the -.Qq Shopping -category defined by Chase is mapped to the user's -.Qq SHOP -booking identifier, the user's account for shopping -expenses is defined as -.Qq 9996 -in their -.Pa ./accounts.txt , -the user's account for the credit card is 3234 in their -.Pa ./accounts.txt , -and -.Nm -prints -.Pp -.Dl "20201026 SHOP 9996 3234 17.07 example.com*asldfkj" -.Ss A complete example -Suppose -.Pa ./accounts.txt -is given by -.Bd -literal -1700 A My Bank -3234 L My Chase Credit Card -5102 X Physician expenses -5103 X Dental expenses -5203 X Shopping -.Ed -.Pp -and -.Pa chasedownload.csv -is given by -.Bd -literal -Transaction Date,Post Date,Description,Category,Type,Amount,Memo -11/06/2020,11/09/2020,Dr. Joseph Schmoe,Health & Wellness,Sale,-100.00, -11/06/2020,11/09/2020,Dr. Sally Sue,Health & Wellness,Sale,-183.00, -11/08/2020,11/08/2020,example.com,Shopping,Sale,-53.83, -11/04/2020,11/04/2020,Payment Thank You - Web,,Payment,75.43, -.Ed -.Pp -and -.Pa ./import/chase_credit.txt -is given by -.Bd -literal -# Chase credit card header is -# Transaction Date,Post Date,Description,Category,Type,Amount -# The format of this file is -# selector account_number booking_identifier -# selector is a comma-separated list of regular expressions which -# matches corresponding fields in the CSV file -ACCOUNT 3234 -,,,Automotive,,, 1111 AUTO -,,,Bills & Utilities,,, 2222 BILLS -,,,Fees & Adjustments,,, 3333 FEES -,,,Food & Drink,,, 4444 FOOD -,,,Gas,,, 5555 GAS -,,,Gifts & Donations,,, 6666 GIFTS -,,,Groceries,,, 7777 GROCERIES -,,Dr. Sally Sue,,,, 5103 DENTAL -,,,Health & Wellness,,, 5102 PHYSICIAN -,,,Home,,, 9999 HOME -,,,Personal,,, 9998 PERSONAL -,,,Professional Services,,, 9997 PRO -,,,Shopping,,, 5203 SHOP -,,,,Payment,, 1700 PAY -.Ed -.Pp -Then -.Pp -.Dl pta_import -I chase_credit chasedownload.csv -.Pp -outputs -.Bd -literal -20201109 PHYSICIAN 5102 3234 100.00 Dr. Joseph Schmoe -20201109 DENTAL 5103 3234 183.00 Dr. Sally Sue -20201108 SHOP 5203 3234 53.83 example.com -20201104 PAY 3234 1700 75.43 Payment Thank You - Web -.Ed -.Pp -Note that the selector for Dr\&. Sally Sue -in the example configuration file comes before the -Health & Wellness selector. -Since the first match wins, transactions for Dr\&. Sally Sue -can be classified with the DENTAL booking identifier, -even though the bank's CSV file classifies -these transactions as Health & Wellness. +The result of applying a configuration file +of the form +.Pa ./import/accountname.txt +to the corresponding CSV file +.Pa ./csv/accountname.csv +may be seen in +.Pa ./regress/import/expected/accountname.out . .Sh SEE ALSO .Xr pta-accounts 5 , .Xr pta-journal 5 ,