Rhythm 2.0 Specifications

Appearance

DOM-ACC-TRX-001Invoice

Markdown

DOM-ACC-TRX-001

Invoice

Markdown
  • DocumentDraft
  • ImplementationObserved

Planning

Specified by
CON-ACC-TRX-001

Design

Owned by
SVC-ACC-TRX-transactions

KindDomain objectProduct areaAccountingModuleTransactionsRevision1

Read atservices-accounting f47cb263react-console baf6dae3

Invoice ​

What It Models ​

Invoice covers customer billing and the documents that adjust that billing. Credit and debit memos, write-offs and billing reversals remain distinct records within this concept. A pro forma represents a quotation before receivable recognition.

Identity and Attributes ​

The attributes describe the billed party, commercial terms, charges and financial position. Recognition separates editable preparation from protected commercial content; posting account selection belongs to batch management.

Relationships ​

Allocations and credit applications connect receipts and customer credit to invoice lines. CRM supplies customer context, Books supplies configuration, and batch management supplies the posting boundary.

Invariants ​

The invariant rows distinguish database protections from command eligibility checks. Their cited evidence identifies which conditions are tested and which are read from implementation or recorded architecture.

How It Is Stored and Shared ​

Transactions owns billing and correction storage. Authorized console reads, service-function calls and dataset queries provide distinct access surfaces. Receivable change events provide the financial integration surface for Commerce.

Open Design Questions ​

Staff billing without an order still needs a tax-ownership decision. The approved amendment direction lacks a working console connection, and memo editors assume draft behavior that the commands do not implement. Recognition-based protection also requires clearer treatment of issued pro formas.

Relationships

ToCardinalityOwnershipCrosses a serviceOn archive or delete
DOM-ACC-TRX-003many-to-many through allocationsAllocation records belong to the payment and contribute to the invoice line's paid amount.no
DOM-ACC-TRX-004many-to-many through credit applicationsApplication records belong to the credit and also contribute to the line's paid amount.no
DOM-ACC-TRX-005many-to-oneThe account reads the invoice's financial effects without owning the bill.no
DOM-ACC-TRX-006one-to-oneThe invoice and its correction documents share the transaction-record shape for identity, batching and history.no

Invariants

InvariantProtectsEnforced atProvenance
INV-DOM-ACC-TRX-001-01
Replacing a draft requires its current version and rejects stale replacements without effects.
api, servicetest
services-accounting:modules/transactions/tests/integration/services/invoices/update-draft.integration.spec.js#it refuses an update at a version the draft has moved past (stale)
INV-DOM-ACC-TRX-001-02
Draft replacement preserves the existing business unit and currency.
servicetest
services-accounting:modules/transactions/tests/integration/services/invoices/update-draft.integration.spec.js#it refuses a change of business unit: a draft keeps its unit (business_unit_mismatch)
INV-DOM-ACC-TRX-001-03
Each extension rounds half away from zero to minor units before the invoice sums the resulting line amounts.
api, service, databasetest
services-accounting:modules/transactions/tests/integration/services/invoices/rounding.integration.spec.js#it totals the rounded lines (3422), not a rounding of the unrounded sum (3421)
INV-DOM-ACC-TRX-001-04
A real invoice needs lines, an open period and an eligible batch, while a pro forma needs lines without a batch; failures before numbering leave the sequence unchanged.
service, databasetest
services-accounting:modules/transactions/tests/integration/services/invoices/issue.integration.spec.js#it refuses the issue when the unit has no assignment rules (batch_required), the draft unchanged
INV-DOM-ACC-TRX-001-05
The workspace invoice sequence begins at one million and permits skipped numbers without duplicates.
service, databasetest
services-accounting:modules/transactions/tests/integration/services/invoices/issue.integration.spec.js#it numbers the tenant’s first invoice 1,000,000
INV-DOM-ACC-TRX-001-06
Once recognised, ordinary database writes preserve commercial content while allowing designated lifecycle, description and maintained-amount changes.
databasetest
services-accounting:modules/transactions/tests/integration/db/invoices.table.integration.spec.js#it refuses a change of an issued line’s amounts (RHA04)
INV-DOM-ACC-TRX-001-07
Maintained amounts determine invoice status, including paid for a newly issued zero-value invoice.
databasetest
services-accounting:modules/transactions/tests/integration/services/invoices/issue.integration.spec.js#it is paid at once, its line with it
INV-DOM-ACC-TRX-001-08
An unconverted pro forma has no batch, receivable facts or allocations and supports complete deletion.
service, databasetest
services-accounting:modules/transactions/tests/integration/services/invoices/issue.integration.spec.js#it gives it no batch, no accounting date and no recognition (FC-06)
INV-DOM-ACC-TRX-001-09
Line debt is total plus debits minus payments, credits and write-offs, bounded from zero to total plus debits, with header amounts summing the lines.
databasedocumented
services-accounting:docs/architecture/accounting-2.0/06-integrity-model.md#2. Generated balances with CHECK bounds
INV-DOM-ACC-TRX-001-10
Amendment increments revision and preserves any line carrying an application or adjustment.
servicetest
services-accounting:modules/transactions/tests/integration/services/document-edits/reassign-and-edit.integration.spec.js#it removes a line with nothing applied at the next revision, and refuses removing or repricing the paid line
INV-DOM-ACC-TRX-001-11
A posting, posted or downloaded batch prevents amendment, document or accounting date correction and voiding, while terms, due dates and descriptions use separate edit guards.
serviceobserved
services-accounting:modules/transactions/services/invoices/invoice-changes.ts:changeHeader
INV-DOM-ACC-TRX-001-12
Void requires a reason and an invoice without applications or adjustments, retaining amounts while cancelling a recognised receivable on the void date.
service, databasetest
services-accounting:modules/transactions/tests/integration/services/invoices/void.integration.spec.js#it is refused invoice_has_money_applied, the invoice unchanged
INV-DOM-ACC-TRX-001-13
A credit memo is limited to outstanding debt plus releasable paid value and leaves no effects when it exceeds that limit.
service, databasetest
services-accounting:modules/transactions/tests/integration/services/change-memos/credit-memos.integration.spec.js#it writes nothing: no memo, no ledger line, no fact, no event
INV-DOM-ACC-TRX-001-14
Voiding a memo appends dated opposite lines once and retains the original document.
service, databasetest
services-accounting:modules/transactions/tests/integration/services/change-memos/credit-memos.integration.spec.js#it returns the invoice’s balances to what they were before the memo
INV-DOM-ACC-TRX-001-15
Restoring a write-off creates a separately numbered opposite document and neither member of that pair supports another reversal.
service, databasetest
services-accounting:modules/transactions/tests/integration/services/write-offs/write-offs.integration.spec.js#it answers the reversal: a second write-off, numbered next, its lines negating the first’s
INV-DOM-ACC-TRX-001-16
Issue retains tax lines by rate without posting accounts and later reductions use that recorded determination.
service, databasetest
services-accounting:modules/transactions/tests/integration/services/invoices/issue-tax.integration.spec.js#it writes one tax line per rate on the dues line, naming the zone and the rate and no account
INV-DOM-ACC-TRX-001-17
Creation selects the card-fee policy and receivable recognition protects it from ordinary changes; pro forma issue alone does not activate that freeze.
api, service, databaseobserved
services-accounting:db/migrations/20261019013149_invoice_ship_to_address.sql:refuse_frozen_invoice_changes; services-accounting:modules/transactions/services/invoices/invoice-drafts.ts
INV-DOM-ACC-TRX-001-18
Billing-reversal preparation commits its financial steps together or rolls them all back.
servicetest
services-accounting:modules/transactions/tests/integration/services/reversals/reversals.integration.spec.js#it refuses a reversal dated in no open period (period_not_open), writing nothing
INV-DOM-ACC-TRX-001-19
Invoice and correction records contain no custom-field storage and the module registration supplies no custom-field capability declaration.
api, servicedocumented
services-accounting:docs/milestones/plans/ACCT-M2-plan.md#7a. Entity capabilities (R2-ARCH-001)

The Markdown files under specs/ in rhythmsoftware/rhythm-v2-docs are the canonical source of truth. This reader is a generated, read-only projection of them.

Rhythm Software