# docker-finance | modern accounting for the power-user
#
# Copyright (C) 2021-2025 Aaron Fiore (Founder, Evergreen Crypto LLC)
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.

fields timestamp,description_,type,status_,currency_,amount_,fees,total,exchange_rate,code_,balance_,txid,title,direction,subaccount,in_value,in_ticker,out_value,out_ticker,tx_fee_value,tx_fee_ticker,fiat_value

date-format %Y-%m-%d %H:%M:%S %z
date %timestamp

description %timestamp

account1 assets:paypal:%subaccount:%currency_
amount %amount_ %currency_

comment type:%type, status:%status_, direction:%direction

if %description_ ([0-9]|[a-z])
  comment description:%description_, type:%type, status:%status_, direction:%direction

if %description_ ([0-9]|[a-z])
& %title ([0-9]|[a-z])
  comment description:%description_, title:%title, type:%type, status:%status_, direction:%direction

if %description_ ([0-9]|[a-z])
& %txid ([0-9]|[a-z])
  comment description:%description_, type:%type, txid:%txid, status:%status_, direction:%direction

if %description_ ([0-9]|[a-z])
& %txid ([0-9]|[a-z])
& %title ([0-9]|[a-z])
  comment description:%description_, title:%title, type:%type, txid:%txid, status:%status_, direction:%direction

if %description_ ([0-9]|[a-z])
& %txid ([0-9]|[a-z])
& %title ([0-9]|[a-z])
& %code ([0-9]|[a-z])
  comment description:%description_, title:%title, type:%type, txid:%txid, status:%status_, code:%code_, direction:%direction

# ---------------------------------------------------------------------------- #
#                                     IN                                       #
# ---------------------------------------------------------------------------- #

if %direction ^IN$
  account2 income:paypal:%subaccount:%currency_

if %direction ^IN$
& %type (^General Card Deposit$|^Bank Deposit to PP Account$|^Reversal of General Account Hold$)
  account2 equity:paypal:%subaccount:withdrawal:%currency_

# ---------------------------------------------------------------------------- #
#                                     OUT                                      #
# ---------------------------------------------------------------------------- #

if %direction ^OUT$
  amount -%amount_ %currency_

if %direction ^OUT$
  account2 expenses:paypal:%subaccount:%currency_

if %direction ^OUT$
& %description_ [0-9a-z]
  account2 expenses:paypal:platform:%description_:%currency_

if %direction ^OUT$
& %fees [1-9]
  account3 assets:paypal:%subaccount:%currency_
  amount3 -%fees %currency_
  account4 expenses:paypal:%subaccount:fees:%currency_
  amount4 %fees %currency_

if %direction ^OUT$
& %description_ ^PayPal$
& %type ^Account Hold for Open Authorization$
  account2 equity:paypal:%subaccount:deposit:%currency_

# Bank withdrawal
if %direction ^OUT$
& %description_ ^$
& %type (^General Withdrawal$|^User Initiated Withdrawal$)
  account2 equity:paypal:%subaccount:deposit:%currency_

# Non-balancing-only reports
if %status_ Reversed
  amount -%amount_ %currency_

# ---------------------------------------------------------------------------- #
#                                   Crypto                                     #
# ---------------------------------------------------------------------------- #

# NOTE: at this time, despite `%type Cryptocurrency`, PayPal offers absolutely
# no usable information for buys/sells *UNTIL* end of the year tax statements
# are provided. However, `preprocess` *will* process the 'crypto transactions'
# CSV provided at that time but *NOT* the 'tax statements' CSV (and not any
# crypto-related reports entries). This type of periodic release on PayPal's
# behalf makes development on real verifiable data a patient task.

if %type ^Cryptocurrency$
  skip

# TODO: only tested against PYUSD (which has no trading fees), need more data for verification

if %in_ticker [a-z]
  comment description:%description_, type:%type, taxed_as:%type

if %in_ticker [a-z]
& %type ^BUY$
  account1 assets:paypal:%subaccount:%in_ticker
  amount %in_value %in_ticker @@ %out_value %out_ticker
  account2 assets:paypal:%subaccount:%out_ticker
  comment2 %timestamp,%type,paypal:%subaccount,%in_ticker,%in_value,%out_ticker,%out_value,,

if %in_ticker [a-z]
& %type ^SELL$
  account1 assets:paypal:%subaccount:%out_ticker
  amount -%out_value %out_ticker @@ %in_value %in_ticker
  account2 assets:paypal:%subaccount:%in_ticker
  comment2 %timestamp,%type,paypal:%subaccount,%out_ticker,%out_value,%in_ticker,%in_value,,

# w/ fees

if %in_ticker [a-z]
& %tx_fee_value [1-9]
  account3 assets:paypal:%subaccount:%tx_fee_ticker
  amount3 -%tx_fee_value %tx_fee_ticker
  account4 expenses:paypal:%subaccount:fees:%tx_fee_ticker
  amount4 %tx_fee_value %tx_fee_ticker

if %in_ticker [a-z]
& %type ^BUY$
& %tx_fee_value [1-9]
  comment2 %timestamp,%type,paypal:%subaccount,%in_ticker,%in_value,%out_ticker,%out_value,%tx_fee_ticker,%tx_fee_value

if %in_ticker [a-z]
& %type ^SELL$
& %tx_fee_value [1-9]
  comment2 %timestamp,%type,paypal:%subaccount,%out_ticker,%out_value,%in_ticker,%in_value,%tx_fee_ticker,%tx_fee_value

# vim: sw=2 sts=2 si ai et