Rhythm 2.0 Specifications

Appearance

CAP-ACC-TRX-002Correct issued bills before posting

Markdown

CAP-ACC-TRX-002

Correct issued bills before posting

Markdown
  • DocumentDraft
  • Product intentProposed
  • ImplementationObserved

Planning

Feature
FEAT-ACC-TRX-01
Exercised by
FAS-ACC-TRX-01-01, FAS-ACC-TRX-01-02, FAS-ACC-TRX-01-03, FAS-ACC-TRX-01-04, FAS-ACC-TRX-01-05
Key concepts
CON-ACC-TRX-001, CON-ACC-TRX-006
Actors
ACT-ACC-012
Depends on
CAP-ACC-TRX-001
Related
CAP-ACC-TRX-003, CAP-ACC-TRX-015
Proved by
ATS-ACC-TRX-002

Implementation

Executable suites
TST-ACC-TRX-010, TST-ACC-TRX-039, TST-ACC-TRX-049, TST-ACC-TRX-050, TST-ACC-TRX-058, TST-ACC-TRX-066, TST-ACC-TRX-221, TST-ACC-TRX-224, TST-ACC-TRX-234

KindCapabilityProduct areaAccountingModuleTransactionsRevision1

Read atservices-accounting f47cb263react-console baf6dae3

Correct issued bills before posting ​

Purpose ​

Staff correct billing mistakes while preserving the customer’s document and financial trail.

How It Works ​

Staff start from the issued invoice and choose amendment, details or void according to the intended correction. Eligible unposted lines can change through amendment, which advances the visible revision. Money already applied protects a line from removal or repricing. Descriptive changes use the separate details path. Voiding removes an eligible bill’s debt while retaining the document and explanation. Posting closes the amendment path and directs staff toward correcting documents.

Relationships ​

  • Issue customer bills and numbered quotes supplies or continues the related financial work.
  • Adjust billed value with memos supplies or continues the related financial work.
  • Keep transaction batches and details correct supplies or continues the related financial work.

The Formal Contract

The narrative above explains; the sections below are authoritative — the rules, scenarios and tests this document binds.

Outcomes
Staff correct billing mistakes while preserving the customer’s document and financial trail.Voiding removes an eligible bill’s debt while retaining the document and explanation. Posting closes the amendment path and directs staff toward correcting documents.
Surfaces
consoleapi
Intent sources
services-accounting:docs/architecture/accounting-2.0/02-decisions.md#A-4services-accounting:docs/architecture/accounting-2.0/02-decisions.md#A-7services-accounting:docs/architecture/accounting-2.0/02-decisions.md#A-14services-accounting:docs/milestones/ACCT-M1-books-and-invoices.md#D9services-accounting:docs/milestones/ACCT-M1-books-and-invoices.md#D3

Controls

25 controls apply, from the corpus control catalogue.

TC-IAM-001 TC-IAM-002 TC-IAM-004 TC-IAM-005 TC-AZ-001 TC-AZ-002 TC-AZ-003 TC-AZ-004 TC-AZ-006 TC-TEN-001 TC-TEN-002 TC-TEN-003 TC-DAT-001 TC-DAT-002 TC-DAT-003 TC-DAT-004 TC-LOG-002 TC-LOG-003 TC-LOG-004 TC-LOG-005 TC-PI-001 TC-PI-003 TC-PI-005 TC-PRV-001 TC-PRV-002

Permissions

KeyChecked atScope
accounting.invoices.adjustapitenant
accounting.invoices.updateapitenant
accounting.invoices.voidapitenant

Business Rules

11 rules, 11 to be proved before approval. A rule's product intent is derived from its origin: 0 confirmed by a product decision, the rest inheriting this capability's proposed.

IdRuleKindEnforced atProvenance
01must prove
Proposed
Staff can amend a live issued invoice before posting by adding lines, changing unapplied lines and correcting its commercial details.
origin: services-accounting:docs/architecture/accounting-2.0/02-decisions.md#A-14
proved by ATS-ACC-TRX-001-17, ATS-ACC-TRX-002-01, ATS-ACC-TRX-002-11, ATS-ACC-TRX-005-07, TST-ACC-TRX-010, TST-ACC-TRX-039, TST-ACC-TRX-224
lifecycleservice, databasetest
services-accounting:modules/transactions/tests/integration/services/document-edits/reassign-and-edit.integration.spec.js#it answers the invoice at revision 2 with the line added after the last, the line repriced and the totals re-derived
02must prove
Proposed
A line carrying a payment, credit, memo or write-off cannot be removed or repriced through an amendment.
origin: services-accounting:docs/architecture/accounting-2.0/02-decisions.md#A-14
proved by ATS-ACC-TRX-002-02, TST-ACC-TRX-039
validationservicetest
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
03must prove
Proposed
Amendment advances the revision, records the receivable difference and change event, and recalculates tax only on added or repriced lines; rendered revisions appear from the second onward.
origin: services-accounting:docs/architecture/accounting-2.0/02-decisions.md#A-14
proved by ATS-ACC-TRX-001-17, ATS-ACC-TRX-002-01, ATS-ACC-TRX-005-07, TST-ACC-TRX-010, TST-ACC-TRX-039, TST-ACC-TRX-224
calculationservice, databasetest
services-accounting:modules/transactions/tests/integration/services/document-edits/reassign-and-edit.integration.spec.js#it writes the amended facts for the delta, the originals untouched, and the amend event with the delta
04must prove
Proposed
A posting, posted or downloaded batch prevents invoice amendment, date changes and voiding, leaving a correcting memo as the remedy.
origin: services-accounting:docs/architecture/accounting-2.0/02-decisions.md#A-4
proved by ATS-ACC-TRX-002-03, ATS-ACC-TRX-002-04, ATS-ACC-TRX-002-11, ATS-ACC-TRX-015-09, TST-ACC-TRX-039
lifecycleservicetest
services-accounting:modules/transactions/tests/integration/services/document-edits/reassign-and-edit.integration.spec.js#it is refused batch_not_open once the batch is posted
05must prove
Proposed
Changing terms derives a due date from the invoice date unless the request supplies one, and no permitted due date precedes the invoice date.
origin: services-accounting:docs/milestones/ACCT-M1-books-and-invoices.md#D3
proved by ATS-ACC-TRX-002-05, TST-ACC-TRX-049
calculationapi, servicetest
services-accounting:modules/transactions/tests/integration/services/invoices/details-terms-due-date.integration.spec.js#it answers the memo, the terms and the explicit due date, which wins over the terms’ own
06must prove
Proposed
Before voiding, descriptive details and terms can change together, with any invalid part rejecting the whole request.
origin: services-accounting:docs/architecture/accounting-2.0/02-decisions.md#A-7
proved by ATS-ACC-TRX-002-06, TST-ACC-TRX-049, TST-ACC-TRX-050
policyservicetest
services-accounting:modules/transactions/tests/integration/services/invoices/details-terms-due-date.integration.spec.js#it leaves the memo, the terms, the due date and the version as they were
07must prove
Proposed
An issued invoice can move its dates into an open period before posting, with correcting receivable entries; the console provides no date-change control.
origin: services-accounting:docs/milestones/ACCT-M1-books-and-invoices.md#D9
proved by ATS-ACC-TRX-002-07, TST-ACC-TRX-010, TST-ACC-TRX-039
lifecycleservicetest
services-accounting:modules/transactions/tests/integration/services/document-edits/reassign-and-edit.integration.spec.js#it moves the invoice date of an issued, unposted invoice, re-dating its facts; refuses a date after its due date
08must prove
Proposed
Voiding requires a reason and an invoice with no payment, credit, memo or write-off applied, whether draft or issued.
origin: services-accounting:docs/architecture/accounting-2.0/02-decisions.md#A-4
proved by ATS-ACC-TRX-002-08, TST-ACC-TRX-066, TST-ACC-TRX-221
validationservicetest
services-accounting:modules/transactions/tests/integration/services/invoices/void.integration.spec.js#it is refused invoice_has_money_applied, the invoice unchanged
09must prove
Proposed
An issued invoice’s void preserves its commercial amounts, voids its lines and offsets the remaining receivable on today’s date; the void cannot be undone.
origin: services-accounting:docs/milestones/ACCT-M1-books-and-invoices.md#D12
proved by ATS-ACC-TRX-002-08, TST-ACC-TRX-066, TST-ACC-TRX-221
lifecycleservice, databasetest
services-accounting:modules/transactions/tests/integration/services/invoices/void.integration.spec.js#it appends an invoice_voided fact per line for minus the line’s balance, dated today
10must prove
Proposed
An update lock prevents invoice mutations, while a deletion lock prevents removal alone.
origin: services-accounting:docs/milestones/ACCT-M1-books-and-invoices.md#D12
proved by ATS-ACC-TRX-002-09, TST-ACC-TRX-058
policyservicetest
services-accounting:modules/transactions/tests/integration/services/invoices/locked-invoice.integration.spec.js#it refuses the void of the issued invoice, which stays open
11must prove
Proposed
Issue and amendment require adjust authority, details and terms require update authority, and voiding requires the separate void authority.
origin: services-accounting:docs/milestones/ACCT-M1-books-and-invoices.md#D12
proved by ATS-ACC-TRX-002-10, TST-ACC-TRX-010, TST-ACC-TRX-234
permissionapitest
services-accounting:modules/transactions/tests/e2e/invoices.e2e.spec.js#it is refused POST /invoices/{tenantId}/{id}/void without accounting.invoices.void (403)

Scenarios

IdGivenWhenThenProvenance
01The issued invoice remains unposted.Add a missing charge and change an eligible line price.Revision two contains recalculated totals and its e-mail identifies the revision.test
react-console:acceptance/accounting/playwright/journeys/invoices/ACT-ACC-0190.spec.ts#ACT-ACC-0190
02No value has been applied to an issued invoice.Provide a reason and void the document.Void status and today’s offsetting receivable entries preserve the record.test
react-console:acceptance/accounting/playwright/journeys/invoices/ACT-ACC-0183.spec.ts#ACT-ACC-0183
03A check has settled part of the invoice.Attempt to void the invoice.Applied money prevents voiding and the invoice remains open.test
services-accounting:modules/transactions/tests/integration/services/invoices/void.integration.spec.js#it is refused invoice_has_money_applied, the invoice unchanged

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