WorkFerret: Difference between revisions

From Woozle Writes Code
Jump to navigation Jump to search
(link to main docs)
(→‎Links: updates)
Line 1: Line 1:
[[File:2019-12-17.screenshot.Greenmine.Project 2 - Sage Swift.redacted.png|thumb|Screenshot of WorkFerret's project page for an example client]]
<hide>
[[WorkFerret]] is a web application I use for tracking billable hours, generating invoices, and recording payments against outstanding balances. It is written as a plug-in module running under [[Ferreteria]], my web application framework currently under development.
[[page type::article]]
 
[[thing type::software]]
The screenshot at right shows the main menu on the left (which includes other applications besides WorkFerret), with the project information taking up the rest of the page (from top to bottom):
[[license::open source]]
* project ID, name, settings
[[category:software]]
* current un-invoiced work sessions
</hide>
* existing charges (invoices) and payments, and the final balance due
==About==
* past invoices
[[WorkFerret]] (WF) is an application for tracking billable work done for different clients, generating invoices, and recording payments. It is essentially a special-purpose [[accounts receivable]].
 
==History==
Each work-session can track date, starting/finishing time, hourly rate, and/or flat dollar amount. The user enters starting and stopping times and the rate being charged, and WorkFerret will automatically convert to dollars. (There is also a provision for flat dollar amounts, e.g. for fixed bids or billable purchases made for the client.)
WF was originally written in [[MS Access 97]], and ported to PHP as a [[MediaWiki extension]] sometime around 2005-2010. The code was first posted on [[GitHub]] in May 2015 (see [[#Links]]). As of 2017 I am porting it as a [[Ferreteria]] drop-in module.
 
===Features===
Invoices are available in both HTML and {{l/wp|.odt}} format, using complex templates. The .odt format was especially tricky, as it actually consists of a collection of files that have been {{l/wp|gzip}}ped together -- but in a certain particular order, so you have to use the right options with the <code>gzip</code> command.
* Ways of entering work done:
 
** Stopwatch for timing a work session
The main documentation is on [[htyp:WorkFerret|HTYP]].
** Manually correct start/stop times
** Manually enter adjustments to work session total (add or subtract)
*** e.g. to allow for distractions (minus), or forgetting to start the clock at first (plus)
** Manually enter start or stop times
** Manually enter total time in session
** Manually enter flat amount to charge
* Allows different hourly rates
** Keeps track of which rates are used for which clients (with client-specific description)
** Global rates also listed for all clients
* Invoice generation
** keeps track of which sessions have been invoiced to prevent double-billing for a session
** automatically totals session costs, doing whatever math is needed
** formats as HTML table (copy/paste into word processor document with letterhead)
===Future===
* Generate complete invoice (currently requires existing document to use as a template, copy/paste data from browser into doc)
* Sync with payments in [[FinanceFerret]] (using a pre-designated category or equity account)
==Technical==
* [[/tables]]
==Links==
* '''Repository''': WorkFerret is now part of the '''{{l/wooz|Greenmine}}''' project
* [[wooz:WorkFerret|portfolio page]]
* [http://rm.vbz.net/projects/workferret project on VBZ Redmine] ([http://bugs.hypertwins.org/projects/work-ferret old])

Revision as of 12:26, 10 March 2020

<hide> page type::article thing type::software license::open source </hide>

About

WorkFerret (WF) is an application for tracking billable work done for different clients, generating invoices, and recording payments. It is essentially a special-purpose accounts receivable.

History

WF was originally written in MS Access 97, and ported to PHP as a MediaWiki extension sometime around 2005-2010. The code was first posted on GitHub in May 2015 (see #Links). As of 2017 I am porting it as a Ferreteria drop-in module.

Features

  • Ways of entering work done:
    • Stopwatch for timing a work session
    • Manually correct start/stop times
    • Manually enter adjustments to work session total (add or subtract)
      • e.g. to allow for distractions (minus), or forgetting to start the clock at first (plus)
    • Manually enter start or stop times
    • Manually enter total time in session
    • Manually enter flat amount to charge
  • Allows different hourly rates
    • Keeps track of which rates are used for which clients (with client-specific description)
    • Global rates also listed for all clients
  • Invoice generation
    • keeps track of which sessions have been invoiced to prevent double-billing for a session
    • automatically totals session costs, doing whatever math is needed
    • formats as HTML table (copy/paste into word processor document with letterhead)

Future

  • Generate complete invoice (currently requires existing document to use as a template, copy/paste data from browser into doc)
  • Sync with payments in FinanceFerret (using a pre-designated category or equity account)

Technical

Links

Retrieved from "https://wooz.dev/mw/index.php?title=WorkFerret&oldid=1361"