Rhythm 2.0 Specifications

Appearance

CAP-ACC-PRD-016Allocate product revenue across dates and accounts

Markdown

CAP-ACC-PRD-016

Allocate product revenue across dates and accounts

Markdown
  • DocumentDraft
  • Product intentProposed
  • ImplementationObserved

Planning

Feature
FEAT-ACC-PRD-04
Exercised by
FAS-ACC-PRD-04-01, FAS-ACC-PRD-04-03
Key concepts
CON-ACC-PRD-004
Actors
ACT-ACC-006, ACT-ACC-008
Journeys
JNY-ACC-PRD-005
Depends on
CAP-ACC-PRD-015
Related
CAP-ACC-PRD-008, CAP-ACC-PRD-011
Proved by
ATS-ACC-PRD-016

Implementation

Executable suites
TST-ACC-PRD-010, TST-ACC-PRD-026, TST-ACC-PRD-036, TST-ACC-PRD-066

KindCapabilityProduct areaAccountingModuleProductsRevision4

Read atservices-accounting f47cb263react-console baf6dae3

Allocate product revenue across dates and accounts ​

Purpose ​

Finance chooses when revenue should be recognized and whether parts belong to other accounts.

How It Works ​

Finance chooses when revenue should be recognized and whether parts belong to other accounts. Deferred choices need a deferred revenue account and suitable product kind. Fixed dates allocate the whole amount across percentages. Relative rules group transaction months and must avoid overlapping coverage. Revenue splits allocate percentages or amounts within the product’s price limits. Inter-entity entries identify accounts for sales in other business units. The service keeps supplied split identities across replacements. The console currently regenerates them and refuses month ranges crossing December. Those editor differences need resolution before design treats the two paths as interchangeable.

Relationships ​

This outcome uses assign a product’s accounting treatment.

The Formal Contract

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

Outcomes
Revenue allocation retains valid dates, shares and account references.
Surfaces
consoleapi
Intent sources
services-accounting:docs/milestones/ACCT-M1-books-and-invoices.md#D3

Controls

21 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-DAT-001 TC-LOG-001 TC-LOG-002 TC-LOG-003 TC-LOG-004 TC-PI-001 TC-PI-002 TC-PI-003

Permissions

KeyChecked atScope
accounting.product-accounting.updateapitenant

Business Rules

10 rules, 8 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
Revenue treatment selects immediate, automatic, relative-date or fixed-date recognition, with deferred treatment requiring a capable kind and deferred revenue account.
origin: services-accounting:docs/milestones/ACCT-M1-books-and-invoices.md#D3
proved by ATS-ACC-PRD-015-17, ATS-ACC-PRD-016-01, TST-ACC-PRD-026, TST-ACC-PRD-036
validationservice, databasetest
services-accounting:modules/products/tests/e2e/product-accounting.e2e.spec.js#answers 400 to deferral without a deferred revenue GL account
02must prove
Proposed
Fixed-date treatment requires up to one hundred twenty distinct dates whose percentages sum to exactly one hundred.
✓ Allocations of 40.5 percent and 59.5 percent complete the required hundred percent.✗ Three allocations of 33.33 percent fall short at 99.99 percent and fail validation.
origin: services-accounting:docs/milestones/ACCT-M1-books-and-invoices.md#D3
proved by ATS-ACC-PRD-016-02, TST-ACC-PRD-010, TST-ACC-PRD-026, TST-ACC-PRD-036
calculationservicetest
services-accounting:modules/products/tests/integration/services/persistence/product-accounting-setups.integration.spec.js#refuses percentages that add up to less than 100, in Rhythm 1.0’s words
03must prove
Proposed
Relative-date treatment requires up to twelve inclusive transaction-month ranges with no shared month, permits ranges crossing December and stores them by starting month.
origin: services-accounting:docs/milestones/ACCT-M1-books-and-invoices.md#D3
proved by ATS-ACC-PRD-016-03, TST-ACC-PRD-026, TST-ACC-PRD-036
validationservicetest
services-accounting:modules/products/tests/integration/services/persistence/product-accounting-setups.integration.spec.js#REGRESSION — refuses 1-3 beside 11-2, the wrapping last rule overlapping the first, which Rhythm 1.0 accepted
04
Proposed
Relative-date fallback configuration selects immediate recognition or default deferral for transactions outside configured ranges.
policydatabaseobserved
services-accounting:modules/products/db/product-accounting-setups.table.ts:DEFERRAL_RELATIVE_DATE_FALLBACKS
05must prove
Proposed
Each revenue split names an income account in the product’s unit and supplies either a percentage or fixed amount.
origin: services-accounting:docs/milestones/ACCT-M1-books-and-invoices.md#D3
proved by ATS-ACC-PRD-016-04, TST-ACC-PRD-036, TST-ACC-PRD-066
validationservice, databasetest
services-accounting:modules/products/tests/integration/services/persistence/product-accounting-setups.integration.spec.js#refuses a percentage split that also states an amount
06must prove
Proposed
Percentage shares total at most one hundred; fixed shares fit the standard set base price from the always period when available, preferring undated then first matching dated rows.
origin: services-accounting:docs/milestones/ACCT-M1-books-and-invoices.md#D3
proved by ATS-ACC-PRD-008-11, ATS-ACC-PRD-011-09, ATS-ACC-PRD-016-05, ATS-ACC-PRD-016-09, ATS-ACC-PRD-017-07, TST-ACC-PRD-026, TST-ACC-PRD-036, TST-ACC-PRD-066
calculationserviceobserved
services-accounting:modules/products/services/rules/product-rules.ts:listPrice; services-accounting:modules/products/services/rules/product-rules.ts:revenueSplitsProblem
07must prove
Proposed
Revenue split identities are retained when supplied and generated when absent, with repeated identities rejected.
proved by ATS-ACC-PRD-016-06, TST-ACC-PRD-026, TST-ACC-PRD-036
invariantservicetest
services-accounting:modules/products/tests/integration/services/persistence/product-accounting-setups.integration.spec.js#keeps the id of a split sent back
08must prove
Proposed
Inter-entity entries appear once per other unit, exclude the product’s unit and name accounts belonging to that other unit.
proved by ATS-ACC-PRD-016-07, TST-ACC-PRD-026, TST-ACC-PRD-036
validationservice, databasetest
services-accounting:modules/products/tests/integration/services/persistence/product-accounting-setups.integration.spec.js#refuses a liability account of a third unit
09must prove
Proposed
Accounting setup accepts no more than fifty revenue splits and two hundred inter-entity entries.
proved by ATS-ACC-PRD-016-08
validationapi, serviceobserved
services-accounting:modules/products/services/persistence/product-accounting-setups.ts:replaceProductAccounting
10
Proposed
The console rejects transaction-month ranges crossing December and omits split identities from saves, causing identities to be generated again.
policyconsoleobserved
react-console:lib/accounting-config/product-accounting-rules.ts:accountingForSave

Scenarios

IdGivenWhenThenProvenance
01A priced course awaits accounting setup.Finance configures three dates totaling one hundred percent, a split and another unit’s accounts.All three collections read back from the saved setup.test
react-console:acceptance/accounting/playwright/journeys/products/ACT-ACC-0116.spec.ts#ACT-ACC-0116

Edge Cases

IdGivenWhenThenProvenance
02Relative coverage includes January–March and November–February.Finance attempts to save those ranges.Shared January and February coverage rejects the setup.test
services-accounting:modules/products/tests/integration/services/persistence/product-accounting-setups.integration.spec.js#REGRESSION — refuses 1-3 beside 11-2, the wrapping last rule overlapping the first, which Rhythm 1.0 accepted

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