Rhythm 2.0 Specifications

Appearance

CAP-ACC-BKS-019Manage Accounting data through workspace lifecycle jobs

Markdown

CAP-ACC-BKS-019

Manage Accounting data through workspace lifecycle jobs

Markdown
  • DocumentDraft
  • Product intentProposed
  • ImplementationObserved

Planning

Feature
FEAT-ACC-BKS-06
Exercised by
FAS-ACC-BKS-04-03, FAS-ACC-BKS-06-01, FAS-ACC-BKS-06-03
Key concepts
CON-ACC-BKS-006
Actors
ACT-ACC-005
Depends on
CAP-ACC-BKS-012
Related
CAP-ACC-BKS-016
Proved by
ATS-ACC-BKS-019

Implementation

Executable suites
TST-ACC-BKS-093, TST-ACC-BKS-178, TST-ACC-BKS-180, TST-ACC-BKS-181, TST-ACC-BKS-183, TST-ACC-BKS-194, TST-ACC-BKS-195

KindCapabilityProduct areaAccountingModuleBooks, Business Units and Chart of AccountsRevision1

Read atservices-accounting f47cb263react-console baf6dae3

Manage Accounting data through workspace lifecycle jobs ​

Purpose ​

Accounting participates in Platform’s provisioning, availability, export and deletion workflows.

How It Works ​

Platform calls Accounting when it creates, exports or deletes a workspace. Accounting’s participants describe and process their own data. Provisioning supplies initial payment methods without constructing the customer’s units or chart. Availability checks govern whether ordinary work can proceed during lifecycle changes. Export follows the declared datasets and explains exclusions rather than treating every internal record as customer data. A detected secret stops the batch before it is staged. Deletion can continue from completed batches after an interruption.

Relationships ​

Platform owns lifecycle orchestration; payment configuration and other Accounting modules supply the participant data.

The Formal Contract

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

Outcomes
Provisioning supplies methods needed to begin recording payments.Lifecycle availability limits ordinary work during loading, disabling and deletion, retaining the defined staff and data-job exceptions.Exports follow declared customer datasets and secret guards; resumable erasure removes the target workspace’s declared data without affecting another workspace.
Surfaces
job
Intent sources
services-accounting:docs/architecture/accounting-2.0/02-decisions.md#2.11 The payment methods, deferred payment and order collection decisions (Andrew, 2026-10-18 evening); decision D-01

Controls

36 controls apply, from the corpus control catalogue.

TC-IAM-001 TC-IAM-002 TC-IAM-004 TC-IAM-005 TC-IAM-006 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-SEC-001 TC-SEC-002 TC-SEC-003 TC-SEC-004 TC-CRY-001 TC-DAT-002 TC-DAT-004 TC-DAT-005 TC-LOG-001 TC-LOG-002 TC-LOG-003 TC-LOG-004 TC-LOG-005 TC-AVL-001 TC-AVL-004 TC-MON-001 TC-MON-002 TC-MON-004 TC-PI-001 TC-PI-002 TC-PI-004 TC-PI-005

Permissions

KeyChecked atScope
accounting.application.accessapitenant

Business Rules

9 rules, 9 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
Provisioning inserts the workspace’s five system payment methods once, preserves previously renamed methods on retry and reports no provisioning work for other participants.
proved by ATS-ACC-BKS-012-09, ATS-ACC-BKS-019-01, TST-ACC-BKS-093, TST-ACC-BKS-183
lifecycleservicetest
services-accounting:modules/maintenance/tests/integration/services/participants/configuration-participant.integration.spec.js#answers provision done, having written the tenant’s five system payment methods (WP-01)
02must prove
Proposed
Erasure proceeds resumably in bounded batches through dependent records before configuration, with reconciliation first and billing, transaction and fiscal-close data ahead of their referenced configuration.
proved by ATS-ACC-BKS-019-02, TST-ACC-BKS-180, TST-ACC-BKS-183
lifecycleservice, databasetest
services-accounting:modules/maintenance/tests/integration/services/participants/configuration-participant.integration.spec.js#resumes to done when it is called again
03must prove
Proposed
Purge refuses an unknown workspace, one not being deleted or one whose deletion was cancelled, without removing records.
proved by ATS-ACC-BKS-019-03, TST-ACC-BKS-183
validationservicetest
services-accounting:modules/maintenance/tests/integration/services/participants/configuration-participant.integration.spec.js#refuses a tenant that is not being deleted
04must prove
Proposed
Purging one workspace leaves every other workspace’s records unchanged.
proved by ATS-ACC-BKS-019-04, ATS-ACC-BKS-019-09, TST-ACC-BKS-178, TST-ACC-BKS-183
invariantdatabasetest
services-accounting:modules/maintenance/tests/integration/services/participants/configuration-participant.integration.spec.js#leaves the other tenant’s rows exactly as they were, table for table
05must prove
Proposed
Lifecycle declarations assign every workspace-owned Accounting table to exactly one purge participant and exclude shared vocabularies.
proved by ATS-ACC-BKS-019-04, TST-ACC-BKS-178, TST-ACC-BKS-183
invariantservicetest
services-accounting:modules/maintenance/tests/integration/db/declaration-completeness.integration.spec.js#leaves no tenant-keyed table undeclared
06must prove
Proposed
Exports batch one dataset up to the creation cut-off, include workspace identity and processor references without credentials, and block before staging when a Stripe API-key, webhook-secret or client-secret pattern is detected.
proved by ATS-ACC-BKS-019-05, TST-ACC-BKS-181
policyservicetest
services-accounting:modules/maintenance/tests/integration/services/exports/seed-everything.integration.spec.js#stops a batch whose record carries a Stripe secret’s shape, blocked with nothing staged
07must prove
Proposed
Ordinary users are served only in active enabled workspaces; deleting workspaces permit staff reads, loading workspaces permit data-job routes, unknown workspaces are unavailable and state lookup is cached for up to thirty seconds.
proved by ATS-ACC-BKS-016-14, ATS-ACC-BKS-019-06, TST-ACC-BKS-194
policyapitest
services-accounting:modules/maintenance/tests/unit/lifecycle/tenant-availability.spec.js#serves only an active tenant that is not disabled, and refuses every other combination
08must prove
Proposed
Lifecycle requests refuse reset, unknown operations or participants, missing workspace or run identity and batch sizes outside bounded whole-number limits.
proved by ATS-ACC-BKS-019-07, TST-ACC-BKS-195
validationservicetest
services-accounting:modules/maintenance/tests/unit/lifecycle/tenant-lifecycle-operations.spec.js#refuses a reset, which Accounting does not serve
09must prove
Proposed
Export blocks undeclared datasets, completes excluded history with an empty part and warning, and permits not-applicable only for an initial request with neither dataset data nor financial history.
proved by ATS-ACC-BKS-019-08
policyserviceobserved
services-accounting:modules/maintenance/services/exports/dataset-exports.ts:exportParticipantDataset

Scenarios

IdGivenWhenThenProvenance
01Platform is deleting a workspace.It repeats Accounting purge calls, including resumption after an interrupted call.Completed batches stay removed, processing reaches completion and other workspaces retain their data.test
services-accounting:modules/maintenance/tests/integration/services/participants/configuration-participant.integration.spec.js#keeps what the batches before the interruption removed

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