invoice-fs
Version:
Nostalgic command-line invoicing application producing plain text invoices and JSON data structures. Uses the file system as a database
121 lines (89 loc) • 3.32 kB
Markdown
# invoice-fs
[](https://travis-ci.org/any-code/invoice-fs)
> Nostalgic command-line (bill) invoicing application producing plain text invoices and JSON data structures. Uses the file system as a database.
## Getting Started
### 1. Installation
``` bash
npm install invoice-fs
bill
```
### 2. Setup Invoice Issuer
``` bash
bill edit issuer
```
### 3. Create/Edit Customers
``` bash
bill edit customer [{customer_code}]
```
### 4. Create an Invoice
``` bash
bill new invoice {customer_code}
bill add item
```
### 5. Open an Invoice
``` bash
bill list invoices
bill show invoice [{invoice_number}/last open invoice]
```
### 6. Finish an Invoice
``` bash
bill finish invoice [{invoice_number}/last open invoice]
```
_______ _ ______
(_______) | | | ___ \
_____ ____ | | _ ____ | | | | ____ ____ ____
| ___)/ _ || | / )/ _ )| | | | / _ || \ / _ )
| | ( ( | || |< (( (/ / | | | |( ( | || | | |( (/ /
|_| \_||_||_| \_)\____)|_| |_| \_||_||_|_|_| \____)
Fake Name
ABN 00 000 000 000
Telephone (+61) 000 000 000
P.O. Box 1 Suburb State, Postcode
Email human@example.com
Web example.com
** PAID ** TAX INVOICE #L001T
------------------------------------------------------------
To:
[TEST]
Test Company
123 Debugger Parade
Makefile ASM 0000
Date: Tue Aug 11 2015
Order Number: N/A
A.B.N.: 00 000 000 01
Payment Terms: 30 Days
Due Date: Fri Sep 11 2015
Payment Method: A/C 000000000
BSB 000-000 (REF L001T)
------------------------------------------------------------
Something
5 @ $300.00 $1500.00*
------------------------------------------------------------
TOTAL AMOUNT: $1500.00
Total includes GST of: $136.36
* indicates taxable supply
To play, npm install and run 'bill' for a list of commands
> This is a tinker-toy hope someone else finds it as much fun as I do.
## Commands
Commands
============================================================
-> bill show issuer
-> bill show customer
-> bill show invoice
-> bill edit issuer
-> bill edit customer
-> bill list customers
-> bill list invoices
-> bill new customer
-> bill new invoice
-> bill add item
-> bill mark paid
-> bill finish invoice
-> bill unlock finished invoice
-> bill open invoice
============================================================
## Copyright and license
Copyright (c) 2015, Any Code <lee@anycode.io>
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.