Skip to main content
Documentation

Domain

Invoices capabilities

13 capabilities, all acting on a invoice. A reference to one from another domain is spelled invoice_id — never a bare id — and every one of those fields names the capability that produces it, so a model can chain calls without guessing.
CapabilityWhat it doesEffect
invoices.listPOST /api/v1/invoices/listList invoices by status, customer or how overdue they areread-only
invoices.getPOST /api/v1/invoices/getGet one whole invoice, its balance and its termsread-only
invoices.agingPOST /api/v1/invoices/agingTotal every unpaid invoice, split by how overdue it isread-only
invoices.statementPOST /api/v1/invoices/statementDraw one customer's account statement of invoices and paymentsread-only
invoices.create_from_jobPOST /api/v1/invoices/create_from_jobRaise a draft invoice for the work on one jobwrites
invoices.create_from_quotePOST /api/v1/invoices/create_from_quoteRaise an invoice from an accepted quote's agreed totalswrites
invoices.issuePOST /api/v1/invoices/issueIssue a draft invoice so the balance becomes owedwrites
invoices.sendPOST /api/v1/invoices/sendSend one invoice to the customer with a view-and-pay linkwrites · reaches the customer
invoices.record_paymentPOST /api/v1/invoices/record_paymentRecord money already received against one invoicewrites
invoices.voidPOST /api/v1/invoices/voidVoid an invoice that should never have been billedwrites
invoices.line_itemsPOST /api/v1/invoices/line_itemsList what one invoice actually charged for, line by lineread-only
invoices.recoveryPOST /api/v1/invoices/recoveryList the customer accounts holding an unpaid invoice balanceread-only
invoices.internal_notesPOST /api/v1/invoices/internal_notesRead the shop's private working notes on one invoiceread-only

← Every domain