NPO-Accounting/conservancy_beancount
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
388 commits 1 branch 0 tags 995 KiB
Commit graph

327 commits

Author SHA1 Message Date
Brett Smith
0f7a154ff4 reports: Balance cells try to retain currency on zero balance. 2020-06-18 10:07:10 -04:00
Brett Smith
daf7e12752 ledger: Remove obsoleted hack. 
This is no longer necessary now that the plugin enforces proper project
metadata on Equity accounts.
 2020-06-18 10:05:37 -04:00
Brett Smith
7441f4ef0c ledger: Correct period totals. RT#11661. 
The period totals were reporting the balance of all the loaded postings, not
just the ones in the reporting date range.

Like the accrual report, introduce a RelatedPostings subclass that records
and saves all the information we need at group definition time, to help us
get it consistently right rather than redoing the same math over and over.
 2020-06-17 18:25:47 -04:00
Brett Smith
5e295f1024 accrual: Change args.since default. 
This default makes more since with the way we're going to stop having
opening balances in open books.
 2020-06-17 15:32:08 -04:00
Brett Smith
0caf78436f accrual: Generate an aging report in more cases. 
Default to generating an aging report unless the user searched for a
specific RT ticket or invoice.
 2020-06-17 15:32:08 -04:00
Brett Smith
d7e2ab34b9 meta_project: Force the default project on Equity accounts. 
See rationale in comments.
 2020-06-17 04:29:17 -04:00
Brett Smith
8b8bdc0225 reports: Add BaseODS.column_style() method. 
Use this to provide more consistent column styles throughout the reports.
 2020-06-16 22:41:13 -04:00
Brett Smith
cf2833ee20 plugin: Load user configuration file. 2020-06-16 15:10:19 -04:00
Brett Smith
b1f82badf7 config: Get repository directory from config file. 
One less thing users have to fiddle with to get set up.
 2020-06-16 14:42:09 -04:00
Brett Smith
efe9bd8855 ledger: Change default report dates. 
The old defaults were optimized for the audit report.
The new defaults provide more helpful ad hoc reports.
The latter will be run more often and more quickly, so it's
worth optimizing the defaults for them.
 2020-06-16 13:31:46 -04:00
Brett Smith
9782e7203a ledger: New reporting module. 2020-06-16 10:18:18 -04:00
Brett Smith
7660700e6c cliutil: Add date_arg() function. 
Meant to be used as an argument type.
 2020-06-15 18:11:39 -04:00
Brett Smith
4a28596db2 data: bank-statement and tax-statement are link metadata. 
Not including them earlier was an oversight.
 2020-06-15 18:08:18 -04:00
Brett Smith
582316ae85 data: Add Metadata.report_links() method. 
This is just a variant of get_links() that eats TypeError.
Higher-level reporting code often wants it.
 2020-06-15 14:19:10 -04:00
Brett Smith
72f58d80d7 reports: BaseODS.currency_cell() sets default style. 
It'll be rare we don't want this.
 2020-06-15 14:09:42 -04:00
Brett Smith
8333ed8876 reports: Add RelatedPostings.group_by_account() classmethod. 2020-06-15 11:20:30 -04:00
Brett Smith
ccc3a829da reports: Add RelatedPostings.balance_at_cost_by_date() method. 2020-06-15 10:38:26 -04:00
Brett Smith
b2e35d098a reports: Add Balance subtraction methods. 2020-06-15 10:16:34 -04:00
Brett Smith
f21ac740f2 data: Add Posting.at_cost() method. 2020-06-15 10:16:34 -04:00
Brett Smith
a2ee9c73fe ranges: Start module. 
The ledger report wants to use this functionality, so make it available in a
higher-level module.

I took the opportunity to clean up a lot of the surrounding type
declarations. It is less flexible, since it relies on the static list of
types in RangeT, but I don't think the other method actually worked at all
except by cheating with generic Any.
 2020-06-15 09:14:42 -04:00
Brett Smith
760e0a8cd9 reports: Add column width styles to BaseODS. 2020-06-14 08:53:27 -04:00
Brett Smith
71d671e493 data: Add Metadata.human_name() classmethod. 2020-06-14 08:53:27 -04:00
Brett Smith
aff1fc537d reports: Add BaseODS.meta_links_cell() method. 2020-06-12 17:10:25 -04:00
Brett Smith
17c5468a7d reports: ODS links default to using URL as link text. 2020-06-12 16:42:54 -04:00
Brett Smith
44946a061d accrual: Aging report is written to repository path by default. 
Opening it here is necessary for repository links to work anyway.
 2020-06-12 15:56:29 -04:00
Brett Smith
d6559b572f accrual: Aging report uses RT short links for all RT link text. 
Per user request. This is better than saying "Display.html" everywhere.
 2020-06-12 15:54:50 -04:00
Brett Smith
4ca188611f rtutil: Add RT.unparse() classmethod. 2020-06-12 15:54:38 -04:00
Brett Smith
cd578289c4 cliutil: Add make_entry_point() function. 
This provides better logging setup, reduces the amount of boilerplate in
main, and replaces is_main_script().
 2020-06-12 15:08:08 -04:00
Brett Smith
2a33e17892 accrual: Clean up comments. 2020-06-12 14:34:41 -04:00
Brett Smith
5706273bbe accrual: Clean up types and imports. 
Mostly I wanted to write the documentation about groups, and then
I kept pulling the thread.
 2020-06-12 13:24:25 -04:00
Brett Smith
3330c834b2 accrual: Only try to generate an outgoing report for accruals with rt-id. 2020-06-12 10:51:29 -04:00
Brett Smith
1124842ea7 accrual: Actually use RT caching as intended. 
Basically none of the reports were reading or writing the RT link cache
because they didn't instantiate an rtutil.RT properly to do that.
 2020-06-11 16:29:18 -04:00
Brett Smith
175ac3bd7a accrual: Outgoing report groups by rt-id. RT#11594. 2020-06-11 15:27:36 -04:00
Brett Smith
8d7a2b1eea accrual: Add AccrualPostings.rt_id property. 
This is like the existing attributes, but it only supports the outgoings
report, so don't build it at __init__ time.
 2020-06-11 14:22:11 -04:00
Brett Smith
52fc0d1b5f reports: Add RelatedPostings.group_by_first_meta_link() method. 2020-06-11 14:01:19 -04:00
Brett Smith
f52ad4fbc1 reports: Add RelatedPostings.first_meta_links() method. 
Basically moving this from AccrualPostings into the superclass.
 2020-06-11 13:07:14 -04:00
Brett Smith
f76fa35fad reports: RelatedPostings.all_meta_links() returns an iterator. 
This preserves order.
 2020-06-11 10:46:06 -04:00
Brett Smith
e3dceb601c filters: Add iter_unique() function. 2020-06-11 10:46:06 -04:00
Brett Smith
9c33517583 data: Add Metadata.first_link() method. 2020-06-11 10:44:05 -04:00
Brett Smith
4b6a27496d accrual: Clean unused imports. 2020-06-10 16:14:07 -04:00
Brett Smith
5859421a15 accrual: Remove the consistency checker. 
Everything it said was a problem has been done legitimately in our books at
one point or another.

* Variation in contract can happen in different line items of an invoice or
  "group of contractor" situations.

* Variation in cost can happen because one invoice spans a period of time,
  like donation matching programs. There is probably still value in a tool
  that checks to make sure we use consistent rates each day, but that
  affects all kinds of transactions, not just accruals, so it would be
  done better in a separate tool.

* Variation in account happens because invoices legitimately span accrual
  accounts, like donation matching programs with fees payable.

So: it's gone, good riddance.
 2020-06-10 16:03:08 -04:00
Brett Smith
8250f0a8ef filters: Add audit_date() function. 2020-06-10 15:59:56 -04:00
Brett Smith
944c19da8d books: Add date-fetching methods to FiscalYear. 2020-06-10 15:59:56 -04:00
Brett Smith
6e9a612bb7 accrual: Aging report filters out too-recent accruals. RT#11600. 2020-06-09 17:05:36 -04:00
Brett Smith
948d3a2d14 accrual: Add columns to the aging report. RT#11439. 
This adds almost all the metadata that's relevant to accruals.
I considered adding statement, but that cuased rows to get spaced out a lot,
and statement's kind of a low-value column, so I decided against it.

Ultimately I would like to make this configurable but that's for the
future.
 2020-06-09 15:59:09 -04:00
Brett Smith
f192d250e7 accrual: More detailed text for "total aged" lines in aging report. 
Per bkuhn's request.
 2020-06-09 15:04:41 -04:00
Brett Smith
ba8aaaa988 accrual: Aging report uses group since last nonzero. RT#11600. 
This makes it consistent with our other reports. The fact that it wasn't
already was basically an oversight.
 2020-06-09 14:52:55 -04:00
Brett Smith
581046f988 reports: Balance.format() respects tolerance. 2020-06-09 09:04:27 -04:00
Brett Smith
cd1766adcf reports: Balance.__eq__ respects tolerance. 2020-06-09 09:04:27 -04:00
Brett Smith
110e5038e1 reports: Balance.__init__ better handles multiple amounts of same currency. 
This is something that should've happened with 3d704e286
but I didn't think of it at the time.
 2020-06-09 09:04:27 -04:00
Brett Smith
a23d075add books: Add Loader.load_none() method. 2020-06-09 09:04:27 -04:00
Brett Smith
8d3d7e7ce4 data: Add part slicing methods to Account. 2020-06-09 09:04:27 -04:00
Brett Smith
2b5cb0eca6 cliutil: Add bytes_output() and text_output() functions. 2020-06-09 09:04:27 -04:00
Brett Smith
04c804a506 books: Remove unused workdir() function. 2020-06-09 09:04:27 -04:00
Brett Smith
0581525c98 reports: Add Balance.__pos__() method. 
I did this while I was working on normalize_amount_func.
It turns out it's not immediately needed, but it's still nice to have.
 2020-06-09 09:04:27 -04:00
Brett Smith
e26dffa214 reports: Add normalize_amount_func() function. 2020-06-09 09:04:27 -04:00
Brett Smith
cd1b28ae3e cliutil: Add generalized SearchTerm class. 
This makes the same filtering easily available to other reporting tools for
consistency.
 2020-06-09 09:04:27 -04:00
Brett Smith
8dc6894ce7 accrual: Outgoing report uses first rt-id as primary ticket number. 
This makes it consistent with the reporting and our general rule
that the first link is primary.
 2020-06-08 16:38:42 -04:00
Brett Smith
e22e63dcca accrual: Make accruals consistent by entity on the accrual side. 
It is more common than I realized that we split an invoice by
entity on the accrual side, so this supports that better.

It still disregards inconsistency between accrual entity and payment entity
for reporting purposes, to help keep reporting clean around automatic
imports.

The changes to BaseReport._report shook out because at this point, the group
key is effectively arbitrary and shouldn't be used for any reporting
purposes.
 2020-06-05 10:54:35 -04:00
Brett Smith
87760f6aea accrual: Clean up typing after recent bugfix. 2020-06-05 10:01:36 -04:00
Brett Smith
0b3eb1d1d3 accrual: Inconsistent entity is not an error. 2020-06-05 09:10:48 -04:00
Brett Smith
39fa977f71 reports: Balance.le/ge_zero returns False when exactly at tolerance. 2020-06-04 10:49:55 -04:00
Brett Smith
95ba1638d2 filters: remove_opening_balance_txn does replacement instead of del. 2020-06-04 09:49:39 -04:00
Brett Smith
38cea37715 accrual: Load all books since args.since. 
This lets the tool find and report accruals in the future.
 2020-06-04 09:03:37 -04:00
Brett Smith
2bd3e8b462 books: Loader.from_all() accepts a start FY argument. 2020-06-04 09:03:10 -04:00
Brett Smith
4cba2b2681 reports: Balance has built-in tolerance for zero comparisons. 2020-06-03 22:20:37 -04:00
Brett Smith
f8f57428aa accrual: Introduce aging report. RT#10694. 2020-06-03 22:20:37 -04:00
Brett Smith
70057fe383 reports: Start BaseODS class. 2020-06-03 21:24:47 -04:00
Brett Smith
d920c5842a reports: Start BaseSpreadsheet class. 2020-06-03 21:24:47 -04:00
Brett Smith
c88c5ef3b0 accruals: AccrualPostings only reports inconsistent cost per currency. 
Of course if an accrual has multiple currencies, it'll probably have
different costs, and that's fine.
 2020-06-03 21:24:47 -04:00
Brett Smith
3d704e2865 reports: Balance is initialized with just amounts. 
This works fine with how we're currently using it, makes transformation
methods easier to implement, and avoids potential bugs where a balance is
initialized with a bad mapping.
 2020-06-03 18:54:12 -04:00
Brett Smith
069939b2d3 reports: Balance classes support addition. 2020-06-03 18:53:17 -04:00
Brett Smith
cc0656dde9 reports: Add Balance.__abs__() method. 2020-06-03 18:52:44 -04:00
Brett Smith
58b02b6f33 accrual: Move more functionality into AccrualPostings. 2020-06-03 18:51:48 -04:00
Brett Smith
677c99b565 accrual: Filter opening balance txn before main reporting. 
So far we've been implicitly relying on this by the user passing search
terms that filter out the opening balance transaction. That will stop
happening with the aging report, so we need to do it ourselves.
 2020-06-03 18:51:48 -04:00
Brett Smith
39c9c0d83a reports: Add RelatedPostings.__repr__() method. 2020-06-03 18:51:44 -04:00
Brett Smith
7301bfc099 accrual: Add AccrualPostings.make_consistent() method. 
This will help the aging report better render dirty data.
 2020-06-03 18:51:44 -04:00
Brett Smith
b37d7a3024 reports: Make RelatedPostings an immutable data structure. 
This was an early mistake, it makes data consistency mistakes too
easy, and I only used it once so far in actual code. Going to fix
this now so I can more safely build on top of this data structure.
 2020-06-03 18:51:38 -04:00
Brett Smith
dd949a4866 reports: Define RelatedPostings.__slots__. 2020-05-30 10:40:24 -04:00
Brett Smith
aef00ce83f accrual: Check the consistency of accruals' cost. 2020-05-30 10:35:29 -04:00
Brett Smith
a008a09477 filters: Add remove_opening_balance_txn. 2020-05-30 08:30:07 -04:00
Brett Smith
32b62df540 cliutil: Better implementation of is_main_script. 
The old one could return True if you called accrual.main()
directly from one-off test scripts.
 2020-05-29 23:39:27 -04:00
Brett Smith
e07a47ec8f accrual: Use cliutil for better logging and error reporting. 2020-05-29 22:05:26 -04:00
Brett Smith
3fbd05d553 cliutil: Add is_main_script function. 2020-05-29 22:05:26 -04:00
Brett Smith
2b550a2037 cliutil: Start module. 
We're probably going to have a small handful of reporting tools.
This module has all the stuff I end up putting in all of them.
 2020-05-29 22:05:26 -04:00
Brett Smith
d3e0a38073 accrual: Introduce logging infrastructure. 2020-05-28 16:42:36 -04:00
Brett Smith
8b2683d962 accrual: Refactor reports into classes. 
Preparation for introducing the aging report. This helps us
distinguish each report's setup requirements (different __init__ arguments).
 2020-05-28 15:52:10 -04:00
Brett Smith
f66460f343 accrual: Outgoing report includes total at cost. 2020-05-28 09:05:18 -04:00
Brett Smith
d8df34ebaf reports: Balance.format() accepts None as a format. 2020-05-28 09:03:23 -04:00
Brett Smith
2c44cc8f50 reports: Add Balance.format() method. 2020-05-28 09:03:19 -04:00
Brett Smith
3780c31c59 reports: Add Balance.__eq__() method. 
It turns out the provided implementation gets us most of the way there,
we just needed to add handling for the special case of zero balances.
Now it's confirmed with tests.
 2020-05-28 09:01:00 -04:00
Brett Smith
81d216f282 reports: Add RelatedPostings.balance_at_cost() method. 
This makes it easy to get results similar to `ledger -V`.
 2020-05-28 09:01:00 -04:00
Brett Smith
52fa66bba1 data: Specify the type of Posting.cost. 
The rationale is the same as it was for Posting.amount.
 2020-05-28 09:01:00 -04:00
Brett Smith
fea306b278 books.Loader: Ensure load_all properly sorts in chronological order. 
The test changes make them order-sensitive, which they should be.
It's important that our loader methods return date-sorted entries
just like Beancount itself would.
 2020-05-25 11:16:17 -04:00
Brett Smith
9595d3334d books: Add Loader.load_all method. 2020-05-25 10:38:02 -04:00
Brett Smith
b7aae7b3c0 reports.accrual: Exclude payments from default output. RT#11294. 
This makes the output more useful for broad searches like on an
entity. Invoices that cross FY boundaries will appear to be paid
without being accrued, and so would appear when we were just
filtering zeroed-out invoices.

If we integrate the aging report into this module in the future,
that'll need to follow different logic, and just filter out
zeroed-out invoices. But the basic balance report and outgoing
report are more workaday tools, where more filtering makes them
more useful.
 2020-05-23 10:13:17 -04:00
Brett Smith
68c2c1e6f8 reports.accrual: Sort imports. 2020-05-23 10:13:02 -04:00
Brett Smith
396173b55d reports.Balance: Add eq_zero, ge_zero, and le_zero methods. 
Support for RT#11294.
 2020-05-21 23:10:03 -04:00
Brett Smith
552ef45f47 plugin: Be more selective about when ! skips validation. 
It makes sense to let the bookkeeper skip validations in situations
where the metadata requires information that might not be available
when entered. It does not make sense to skip validations that *must*
be available and affect the structure of the books, like project and
entity.

This commit ensures every plugin hook has a test for flagged
transactions, even for hooks that currently have the desired
behavior where no code changes were required for the test to
pass.
 2020-05-21 21:58:48 -04:00
Brett Smith
b296fb0207 accrual: Add docstring with program overview. 2020-05-20 10:52:08 -04:00