Invoice schema for PhoenixKit Billing system.
Invoices are generated from orders and sent to customers for payment. They include receipt functionality once payment is confirmed.
user_id: Foreign key to the userorder_id: Foreign key to the source order (optional)invoice_number: Unique invoice identifier (e.g., "INV-2024-0001")status: Invoice status workflowsubtotal, tax_amount, tax_rate, total: Financial amountscurrency: ISO 4217 currency codedue_date: Payment due datebilling_details: Full snapshot of billing profileline_items: Copy of order line itemspayment_terms: Payment terms textbank_details: Bank account for paymentreceipt_number: Receipt identifier (generated after payment)receipt_generated_at: When receipt was generatedreceipt_data: Additional receipt data (PDF URL, etc.)draft → sent → paid
↘
overdue → paid
↘
void# Generate invoice from order
{:ok, invoice} = Billing.create_invoice_from_order(order)
# Send invoice
{:ok, invoice} = Billing.send_invoice(invoice)
# Mark as paid (generates receipt)
{:ok, invoice} = Billing.mark_invoice_paid(invoice)
# Get receipt
receipt = Billing.get_receipt(invoice)Returns the billing name from billing_details snapshot.
Creates a changeset for invoice creation.
Checks if invoice can be edited.
Creates an invoice from an order.
Checks if invoice is fully paid (paid_amount >= total).
Checks if invoice has any payments (paid_amount > 0).
Checks if invoice has a receipt.
Checks if invoice is overdue.
Changeset for updating paid_amount.
Changeset for marking invoice as paid and generating receipt.
Checks if invoice can be marked as paid.
Returns all unique payment methods used in transactions for this invoice. Requires transactions to be preloaded.
Returns the primary payment method (most used in positive transactions). Useful for display when there are multiple payment methods. Requires transactions to be preloaded.
Checks if invoice can receive a refund (has payments).
Returns the remaining amount to be paid.
Checks if invoice can be resent (already sent, paid, or overdue).
Checks if invoice can be sent (first time - changes status to sent).
Changeset for status transitions.
Returns status badge color class.
Returns human-readable status label.
Checks if invoice can be voided.
Returns the billing name from billing_details snapshot.
Creates a changeset for invoice creation.
Checks if invoice can be edited.
Creates an invoice from an order.
Checks if invoice is fully paid (paid_amount >= total).
Checks if invoice has any payments (paid_amount > 0).
Checks if invoice has a receipt.
Checks if invoice is overdue.
Changeset for updating paid_amount.
Changeset for marking invoice as paid and generating receipt.
Checks if invoice can be marked as paid.
Returns all unique payment methods used in transactions for this invoice. Requires transactions to be preloaded.
iex> Invoice.payment_methods(invoice_with_transactions)
["bank", "stripe"]
iex> Invoice.payment_methods(invoice_without_transactions)
[]Returns the primary payment method (most used in positive transactions). Useful for display when there are multiple payment methods. Requires transactions to be preloaded.
iex> Invoice.primary_payment_method(invoice)
"stripe"
iex> Invoice.primary_payment_method(invoice_without_transactions)
nilChecks if invoice can receive a refund (has payments).
Returns the remaining amount to be paid.
Checks if invoice can be resent (already sent, paid, or overdue).
Checks if invoice can be sent (first time - changes status to sent).
Changeset for status transitions.
Returns status badge color class.
Returns human-readable status label.
Checks if invoice can be voided.