TKTS-INVOICE(1)

🧾 tkts-invoice 💖 (that's TKTS-INVOICE(1) bestie, welcome to the invoice era)

okay so. you opened the invoice corner of tkts and honestly? this is where the money happens 💸 we're talking generate and manage invoices for tickets and projects. group-chat energy, but the flags are real. let's go 🫶

---

✨ NAME ✨

tkts-invoice — invoice generation commands for tkts 🧾🌸

---

🌈 SYNOPSIS 🌈

here's the short version first (yes, there are two, and yes, i'm showing you both because i refuse to leave anything out 💅):

tkts invoice:create [-t|--tkt number] [--start " date"] [--end " date"]
[--update " id"]
tkts invoice:list [-c|--client name] [-t|--tkt " number"]
tkts invoice:prepare [-t|--tkt number] [--client " name"]

and here's the full one with all the extra sauce 🍓 — --tax_rate, --payment_terms, --template, the whole glow-up:

tkts invoice:create [-t|--tkt number] [--start " date"] [--end " date"]
[--update " id"] [--tax_rate " rate"] [--payment_terms " days"]
[--template " name"]
tkts invoice:list [-c|--client name] [-t|--tkt " number"]
tkts invoice:prepare [-t|--tkt number] [--client " name"]

(psst — yes, the quotes and spaces in there are exactly how the page shows them. copy them as-is, don't "fix" the vibe ✨)

---

💜 DESCRIPTION 💜

Generate and manage invoices for tickets and projects. that's the whole job and she ate 🔥

🎀 Invoice Types 🎀

• Ticket Invoices — generated from individual ticket time entries. one ticket, one invoice, no chaos 🌸
• Project Invoices — consolidated invoices for all tickets in a project. the group project that actually works 👑

🦋 Invoice Components 🦋

• Line Items — time entries grouped by tag and company. so organized it's giving main character energy 💅
• Rate Calculations — based on configured hourly rate. math but make it cute 🧮
• Tax Handling — configurable tax rates. the tax girlies get options ✨
• Payment Terms — customizable payment period. pay me in 30 days or catch these vibes 😭

🌸 Prerequisites for Ticket Invoicing 🌸

okay bestie, before you generate a ticket invoice you gotta do these in order. no skipping, it's a whole routine 🎀:

1. User Configuration — configure tkts.conf with:
   • Valid user name
   • Company name
   • Hourly rate (the rate setting)
2. User's Company Setup — create your company record:

tkts company:create -n "Your Company" --abv YC --addr "Your Address"

3. User as Client — add yourself as a client:

tkts client:create -n "$USER" -c YC

4. Client's Company Setup — create the client's company:

tkts company:create -n "Client Company" --abv CC --addr "Client Address"

5. Client Setup — add the client to their company:

tkts client:create -n "Client Name" -c CC

6. Ticket Client Assignment — pick one, you don't need both:
   • Create ticket with client: tkts create -i "Issue" --client "Client Name"
   • Or update existing ticket: tkts edit -t NUMBER
7. Time Logging — record time on the ticket:

tkts time -t NUMBER [--tag TAG]

🧚 Prerequisites for Project Invoicing 🧚

for a project invoice you do all the ticket invoice prerequisites first, then these extras on top. yes, all of them. i don't make the rules 🫶

1. Project Creation — create project with client and company:

tkts project:create -n "Project Name" -c CC --client "Client Name"

2. Ticket Association — add tickets to the project:

tkts project:add-tkt -p PROJECT_ID -t TICKET_ID

3. Project Status — ensure project is in appropriate state:
   • Should be "Active" or "Completed"
   • Use tkts project:status -p PROJECT_ID to verify

⚠️ fr fr do the steps in order. skipping steps is how you end up with a sad empty invoice and a broken heart 💀

---

💅 OPTIONS 💅

• -t, --tkt — Ticket number 🎫
• -c, --client — Client name 👤
• --start — Start date for invoice period (YYYY-MM-DD) 📅
• --end — End date for invoice period (YYYY-MM-DD) 📅
• --update — Invoice ID to update 🔄
• --tax_rate — Tax rate percentage (default: 0.0) 💸
• --payment_terms — Payment period in days (default: 30) ⏳
• --template — Invoice template name (default: default) 🎀

---

🎨 TEMPLATES 🎨

invoice templates live in ~/.config/tkts/invoice.tf and use groff formatting. iconic combo, no notes 👑

available template variables include:

Basic Information — full_name, address, cell_number

Company Details — company, company_addr, company_zip

Client Information — client_email, client_cellphone

Invoice Details — invoice_number, issued_date, due_date, period

Financial Information — line_items, tax_rate, total_cost, tax_amount, final_amount

---

⭐ EXAMPLES ⭐

generate invoice for a ticket:

tkts invoice:create -t 123 --start "2025-01-01" --end "2025-01-31"

list invoices for a client:

tkts invoice:list -c "ACME Corp"

prepare ticket for invoicing:

tkts invoice:prepare -t 123 --client "John Doe"

generate invoice with custom tax rate:

tkts invoice:create -t 123 --tax_rate 7.5 --payment_terms 45

---

🫶 AUTHOR 🫶

Will Sinatra <tkts@lambdacreate.com> — absolute legend 🌟

---

🔗 SEE ALSO 🔗

tkts(1), tkts-ticket(1), tkts-project(1) — go read the whole family, they all slay 💖

---

and that's the page!! 💜 this is tkts version 3.0, dated February 2025, mwah 😘 go invoice somebody, bestie 🧾✨