Invoice Operations
Invoice operations cover everything that happens after an invoice is generated: review, delivery, payment tracking, correction, and reconciliation.
Invoice lifecycle
| Status | Meaning | Typical action |
|---|---|---|
DRAFT |
Invoice is being prepared. | Review details before posting or sending. |
POSTED |
Invoice has been issued. | Send to the customer and collect payment. |
PARTIALLY_PAID |
Some payment has been recorded. | Continue collection or reconcile remaining balance. |
PAID |
Balance is zero. | No collection action required. |
REFUNDED |
Payment was returned through refund or credit workflow. | Review transaction history. |
WITHDRAWN |
Invoice should no longer be collected. | Keep the audit trail and document the reason. |
Review an invoice
Before sending a production invoice, confirm:
- Customer name, billing contact, and billing address.
- Invoice number, issue date, due date, and service period.
- Product descriptions, quantities, unit prices, and usage amounts.
- Tax lines and tax-exempt treatment.
- Discounts, coupons, credits, and prior payments.
- Payment instructions and invoice branding.
Download and share invoice documents
Invoices can be reviewed in the console and exposed to external systems through the Public API:
- HTML document:
GET /api/public/v1/invoices/{invoice_id}/html - PDF document:
GET /api/public/v1/invoices/{invoice_id}/pdf - Transaction timeline:
GET /api/public/v1/invoices/{invoice_id}/transactions
Use the PDF endpoint for customer portals, CRM attachments, and finance exports. Use the transaction endpoint when another system needs to explain how the invoice balance was calculated.
Correct an invoice
For draft invoices, correct the source data if possible: product price, customer address, discount, usage, or subscription dates.
For posted invoices, prefer auditable corrections:
- Use a credit memo to reduce or reverse a posted invoice.
- Record a refund when money is returned.
- Add a note describing the reason for the correction.
- Avoid deleting financial records that have already been sent to customers.