Rhythm 2.0 Specifications

Appearance

CAP-ACC-BKS-003Set a unit’s accounting and tender-fee policies

Markdown

CAP-ACC-BKS-003

Set a unit’s accounting and tender-fee policies

Markdown
  • DocumentDraft
  • Product intentConfirmed
  • ImplementationPartially observed

Planning

Feature
FEAT-ACC-BKS-01
Exercised by
FAS-ACC-BKS-01-01, FAS-ACC-BKS-01-04, FAS-ACC-BKS-01-05, FAS-ACC-BKS-04-02
Key concepts
CON-ACC-BKS-001
Actors
ACT-ACC-001, ACT-ACC-004
Depends on
CAP-ACC-BKS-001
Related
CAP-ACC-BKS-006
Open questions
OQ-ACC-BKS-002
Proved by
ATS-ACC-BKS-003

Implementation

Executable suites
TST-ACC-BKS-002, TST-ACC-BKS-003, TST-ACC-BKS-074, TST-ACC-BKS-171

KindCapabilityProduct areaAccountingModuleBooks, Business Units and Chart of AccountsRevision1

Read atservices-accounting f47cb263react-console baf6dae3

Set a unit’s accounting and tender-fee policies ​

Purpose ​

Controllers choose how the unit recognizes activity, treats write-offs and charges tender fees.

How It Works ​

The controller edits the accounting choices on a business unit. These choices supply policy to later transaction and posting work. A write-off uses the policy at the point its batch posts. A fee rule names the product used to represent the charge and the amounts used to calculate it. The payment method’s behaviour determines whether that rule applies. A change can be refused when accounting activity has already fixed the current period’s treatment. Invalid fee configuration is refused before the unit is saved.

Relationships ​

Posting uses the write-off choices, while transaction workflows use tender behaviour and fee policy.

The Formal Contract

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

Outcomes
Current-period posted activity prevents accounting-method changes.Posting uses the write-off policy currently in force.Each tender receives one consistently calculated unit fee.
Surfaces
consoleapi
Intent sources
services-accounting:docs/milestones/ACCT-M1-books-and-invoices.md#D12services-accounting:docs/architecture/accounting-2.0/02-decisions.md#A-2services-accounting:docs/architecture/accounting-2.0/02-decisions.md#A-17

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-005 TC-AZ-006 TC-TEN-001 TC-TEN-002 TC-TEN-003 TC-TEN-004 TC-DAT-001 TC-DAT-002 TC-DAT-005 TC-LOG-001 TC-LOG-002 TC-LOG-003 TC-LOG-004 TC-LOG-005 TC-PI-001 TC-PI-003 TC-PI-005

Permissions

KeyChecked atScope
accounting.business-units.updateapitenant

Business Rules

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

IdRuleKindEnforced atProvenance
01must prove
Confirmed
Accounting defaults to accrual and may be changed to cash or back unless the current open period has posted or downloaded batches, when the refusal names the period and count; no open period permits the change.
origin: services-accounting:docs/milestones/ACCT-M1-books-and-invoices.md#D12
proved by ATS-ACC-BKS-003-01, TST-ACC-BKS-074
lifecycleservicetest
services-accounting:modules/books/tests/integration/services/persistence/business-units.integration.spec.js#refuses the change 409 naming the period and the count when a batch of the open period is posted, leaving the method
02must prove
Confirmed
The unit defaults to direct write-offs and bad-debt expense, permits allowance or revenue-reversal choices, and supplies the policy effective at posting rather than at write-off creation.
origin: services-accounting:docs/architecture/accounting-2.0/02-decisions.md#A-2
proved by ATS-ACC-BKS-001-15, ATS-ACC-BKS-003-02, ATS-ACC-BKS-003-11, ATS-ACC-BKS-003-12, ATS-ACC-BKS-006-08, TST-ACC-BKS-002, TST-ACC-BKS-003, TST-ACC-BKS-074
policyservice, databasetest
services-accounting:modules/books/tests/integration/services/persistence/business-units.integration.spec.js#takes bad_debt_expense on a create that leaves the treatment out
03must prove
Confirmed
A card-fee rule requires a product and a percentage, fixed amount or both, with an optional minimum; percentages range from 0 to 100 with four decimal places and base-currency minor-unit amounts are nonnegative.
origin: services-accounting:docs/architecture/accounting-2.0/02-decisions.md#A-17
proved by ATS-ACC-BKS-003-03, ATS-ACC-BKS-003-09, TST-ACC-BKS-074
validationapi, service, databasetest
services-accounting:modules/books/tests/integration/services/persistence/business-units.integration.spec.js#refuses a rule that is not whole (a percent without a product, a product without an amount, a minimum alone) by the database’s rule
04must prove
Confirmed
The fee product must be active and belong to the same unit.
origin: services-accounting:docs/architecture/accounting-2.0/02-decisions.md#A-17
proved by ATS-ACC-BKS-003-04, TST-ACC-BKS-074
validationservicetest
services-accounting:modules/books/tests/integration/services/persistence/business-units.integration.spec.js#refuses a fee product of another unit, an inactive one and one the tenant does not have, naming card_fee_product_id
05must prove
Confirmed
The tender fee combines the half-up-rounded percentage with a fixed amount and minimum in base currency, uses only the percentage for other currencies, and is calculated once then distributed across the invoices.
✓ A valid configuration completes the stated operation.
origin: services-accounting:docs/architecture/accounting-2.0/02-decisions.md#A-17
proved by ATS-ACC-BKS-003-05, TST-ACC-BKS-171
calculationservicetest
services-accounting:modules/books/tests/unit/rules/card-fee-rules.spec.js#adds the fixed amount in the base currency: 2.9% + 30 on 10000 is 320
06must prove
Confirmed
A configured fee applies to cards, applies to bank debits only when electronic-check charging is enabled, and never applies to offline methods.
origin: services-accounting:docs/architecture/accounting-2.0/02-decisions.md#A-17
proved by ATS-ACC-BKS-003-06, ATS-ACC-BKS-012-10, TST-ACC-BKS-171
policyservicetest
services-accounting:modules/books/tests/unit/rules/card-fee-rules.spec.js#charges a card behaviour always, a bank debit only when the rule says so, and never an offline method or without a rule
07
Confirmed
A new invoice takes the unit’s default fee policy when no policy is supplied, choosing none, required or optional with none as the default.
origin: services-accounting:docs/architecture/accounting-2.0/02-decisions.md#A-17
policyservicedocumented
services-accounting:docs/accounting/configuration-api.md#Business units
08
Confirmed
The unit stores download detail, financial-software choice and receivable project inheritance for posting and exports to read.
policyservice, databaseobserved
services-accounting:modules/books/db/business-units.table.ts:businessUnits
09must prove
Confirmed
Zero and negative tender amounts calculate a zero fee even when fixed or minimum charges are configured.
proved by ATS-ACC-BKS-003-07
calculationserviceobserved
services-accounting:modules/books/services/rules/card-fee-rules.ts:cardFeeAmountOf

Scenarios

IdGivenWhenThenProvenance
01The configured tender rule charges 2.9 percent plus 30 cents, with a dollar minimum.A single card tender settles two invoices.The total fee is calculated once and allocated between the invoices.test
react-console:acceptance/accounting/playwright/journeys/configuration/ACT-ACC-0048.spec.ts#ACT-ACC-0048
02A pending write-off was entered under bad-debt-expense treatment.The controller selects revenue reversal before posting its batch.Posting uses the revenue account rather than the creation-time treatment.test
react-console:acceptance/accounting/playwright/journeys/configuration/ACT-ACC-0003.spec.ts#ACT-ACC-0003

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