Rhythm 2.0 Specifications

Appearance

CAP-ACC-BAT-002Locate batches and inspect their current contents

Markdown

CAP-ACC-BAT-002

Locate batches and inspect their current contents

Markdown
  • DocumentDraft
  • Product intentProposed
  • ImplementationObserved

Planning

Feature
FEAT-ACC-BAT-01
Exercised by
FAS-ACC-BAT-01-01, FAS-ACC-BAT-01-04, JNY-ACC-BAT-002, JNY-ACC-BAT-004
Key concepts
CON-ACC-BAT-001
Actors
ACT-ACC-007, ACT-ACC-012, ACT-ACC-006
Journeys
JNY-ACC-BAT-001
Related
CAP-ACC-BAT-013, CAP-ACC-BAT-016
Open questions
OQ-ACC-BAT-004
Proved by
ATS-ACC-BAT-002

Implementation

Executable suites
TST-ACC-BAT-027, TST-ACC-BAT-028, TST-ACC-BAT-055, TST-ACC-BAT-058, TST-ACC-BAT-060, TST-ACC-BAT-065, TST-ACC-BAT-084, TST-ACC-BAT-086

KindCapabilityProduct areaAccountingModuleBatch ManagementRevision1

Read atservices-accounting f47cb263react-console baf6dae3

Locate batches and inspect their current contents ​

Purpose ​

Finance staff locate their batch and inspect its current document and cash figures.

How It Works ​

Staff start with the Batches list and narrow their search to the work they need. Paging lets them continue through the matching results. Opening a batch supplies the current document and cash figures. Those figures describe the present documents rather than replaying the posting snapshot. Dependent lookup follows downstream batches when staff need to understand an unposting restriction. Readers without the required access receive the access refusal.

Relationships ​

  • Related outcome: Run and monitor a batch posting job, which addresses the connected batch work.
  • Related outcome: Unpost a batch for correction and replacement posting, which addresses the connected batch work.

The Formal Contract

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

Outcomes
Readers can inspect collections, their live totals and their downstream relationships.
Surfaces
consoleapi

Controls

17 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-TEN-004 TC-LOG-004 TC-LOG-005 TC-PI-001 TC-PI-005

Permissions

KeyChecked atScope
accounting.batches.readapitenant
accounting.batches.readconsoletenant
accounting.batches.queryservicetenant

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
Batch-read permission governs the API and console pages; without it, the console presents its access refusal rather than an empty batch list.
proved by ATS-ACC-BAT-002-01, TST-ACC-BAT-027, TST-ACC-BAT-055, TST-ACC-BAT-060
permissionapi, consoletest
services-accounting:modules/batches/tests/e2e/batch-actions.e2e.spec.js#refuses a caller without accounting.batches.read 403
02must prove
Proposed
Lists sort by date and then reference, return no more than two hundred batches per page, and support unit, status, year and period filters, with a year required for a period filter.
proved by ATS-ACC-BAT-002-02, TST-ACC-BAT-060, TST-ACC-BAT-086
validationapi, servicetest
services-accounting:modules/batches/tests/e2e/batches.e2e.spec.js#refuses a fiscal_period filter without its fiscal_year_id 400
03must prove
Proposed
Reads and lists calculate current document counts and amounts for every batch status, including payment and refund totals and net cash as payments minus refunds.
proved by ATS-ACC-BAT-002-03, ATS-ACC-BAT-002-08, ATS-ACC-BAT-013-14, TST-ACC-BAT-058, TST-ACC-BAT-084
calculationservicetest
services-accounting:modules/batches/tests/integration/services/persistence/batch-totals.queries.integration.spec.js#counts exactly the real transactions of every kind and sums their amounts
04must prove
Proposed
Live totals exclude drafts, pro forma and void invoices, void memos, voided payments, void credits and both sides of a reversed write-off.
proved by ATS-ACC-BAT-002-04, TST-ACC-BAT-084
calculationservicetest
services-accounting:modules/batches/tests/integration/services/persistence/batch-totals.queries.integration.spec.js#leaves a reversal out of its own batch, and answers minor units as major units to two decimals
05must prove
Proposed
Live monetary totals use the batch currency and are rounded to two decimal places.
proved by ATS-ACC-BAT-002-03, TST-ACC-BAT-058, TST-ACC-BAT-084
calculationserviceobserved
services-accounting:modules/batches/services/persistence/batch-totals.ts:batchTotalsStatement
06must prove
Proposed
A request from another workspace cannot distinguish the batch from a missing batch.
proved by ATS-ACC-BAT-002-05, TST-ACC-BAT-028, TST-ACC-BAT-055, TST-ACC-BAT-086
invariantdatabase, apitest
services-accounting:modules/batches/tests/integration/services/persistence/batches.queries.integration.spec.js#reads another tenant’s batch as absent
07must prove
Proposed
Dependent lookup follows downstream references through posted, downloaded and errored batches and rejects an empty starting list.
proved by ATS-ACC-BAT-002-06, ATS-ACC-BAT-002-09, ATS-ACC-BAT-016-08, TST-ACC-BAT-060, TST-ACC-BAT-086
calculationapi, servicetest
services-accounting:modules/batches/tests/integration/services/persistence/batches.queries.integration.spec.js#answers the posted and downloaded batches depending on those named, through others, with their id, name, date and status
08must prove
Proposed
The Batches reporting dataset uses code as the batch number, falling back to name, links transaction batches and declares a separate query permission.
proved by ATS-ACC-BAT-002-10, ATS-ACC-BAT-002-11, TST-ACC-BAT-065
policydatabasetest
services-accounting:modules/batches/tests/integration/db/batches-view.integration.spec.js#answers the reader of tenant A its batches, with every column, the number the code else the name
09must prove
Proposed
Dependent lookup permits one to one hundred starting references and refuses a traversal containing more than one thousand references, including its starting set.
proved by ATS-ACC-BAT-002-07
validationserviceobserved
services-accounting:modules/batches/services/persistence/batches.ts:dependentBatchesOf; services-accounting:modules/batches/services/rules/batch-rules.ts:dependentBatchesOf

Scenarios

IdGivenWhenThenProvenance
01An October batch contains live invoices and adjustments alongside a void invoice.Staff inspect the batch totals.The live document kinds contribute their counts and amounts, while the void invoice is excluded.documented
services-accounting:docs/milestones/walkthroughs/ACCT-M3-handoff.md#Start here (step 2)
02The business unit has more batches than one maximum-size page.A reader follows the result cursor.The subsequent page continues the ordered results so all matching batches remain reachable.test
services-accounting:modules/batches/tests/integration/services/persistence/batches.queries.integration.spec.js#answers a page with more to follow, then the page after it

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