Upload 895 files

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 BizAgentBench contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,3 +1,97 @@
 ---
+pretty_name: BizAgentBench
 license: mit
+language:
+  - en
+size_categories:
+  - n<1K
+tags:
+  - benchmark
+  - agents
+  - finance
+  - payments
+  - multi-turn
+  - tool-use
+configs:
+  - config_name: tasks
+    default: true
+    data_files:
+      - split: test
+        path: tasks.jsonl
 ---
+
+# BizAgentBench
+
+[Paper](https://arxiv.org/abs/2610.20424) | [Evaluation code](https://github.com/ant-intl/BizAgentBench) | [Dataset](https://huggingface.co/datasets/ant-intl/BizAgentBench)
+
+BizAgentBench evaluates long-horizon agents on 50 payment-service tasks through multi-turn customer conversations and tool use. The tasks combine information gathering, business operations, and constraints on both final outcomes and intermediate actions.
+
+This repository contains the task contracts, customer scenarios, knowledge documents, initial database states, and business-tool definitions. The executable environment, user simulator, and deterministic evaluator are provided in the [code repository](https://github.com/ant-intl/BizAgentBench).
+
+## Contents
+
+| Path | Contents |
+| --- | --- |
+| `tasks.jsonl` | A browsable index of all 50 tasks, numbered 1-50. |
+| `payment/data/manifest.json` | Task IDs, searchable document IDs, and registered business domains. |
+| `payment/data/private/` | 50 task contracts containing customer scenarios and acceptance criteria. |
+| `payment/data/patches/` | 50 task-specific initial-state patches. |
+| `payment/data/base_world.json` | The shared initial business database. |
+| `payment/data/knowledge/` | 789 knowledge documents covering business rules, product guidance, operations, and tool interfaces. |
+| `payment/data/tool_catalog.json` | Definitions of 601 discoverable business capabilities. |
+| `LICENSE` | MIT license. |
+
+The `private` directory is an environment visibility boundary: the harness uses these files to configure the customer and evaluator. The agent receives information through dialogue and public tools rather than reading the task contracts directly. The initial database for a task is assembled from `base_world.json` and its corresponding patch.
+
+The task index contains `task_id`, `number`, `title`, `opening_request`, `contract_path`, and `initial_state_patch_path`. It supports browsing; interactive evaluation uses the complete assets under `payment/data/`.
+
+## Load the task index
+
+```python
+from datasets import load_dataset
+
+tasks = load_dataset("ant-intl/BizAgentBench", "tasks", split="test")
+print(tasks[0]["opening_request"])
+```
+
+## Download the complete dataset
+
+```bash
+hf download ant-intl/BizAgentBench \
+  --type dataset \
+  --local-dir BizAgentBench-data
+```
+
+The dataset has one evaluation split, `test`, containing all 50 tasks. There is no training split.
+
+## Evaluate an agent
+
+Follow the [evaluation README](https://github.com/ant-intl/BizAgentBench#installation) to install the environment, configure the agent and user-simulator models, and run the tasks. Both models can use hosted APIs or self-hosted servers.
+
+These data files match the assets bundled with code commit [`dfebabaa9f7fb7f74c7d7236b08ae53e64d2185d`](https://github.com/ant-intl/BizAgentBench/tree/dfebabaa9f7fb7f74c7d7236b08ae53e64d2185d). The `payment/data/` layout is identical in both repositories, so the downloaded tree can be used at the same path in the code checkout.
+
+The evaluator reports:
+
+| Metric | Meaning |
+| --- | --- |
+| Goal (G) | Requested business outcomes and permitted terminal conditions. |
+| Process (P) | Requirements governing the execution of business operations. |
+| Protection (F) | Protected objects, ledger integrity, and prohibited side effects. |
+| Strict | All three dimensions pass: `G and P and F`. |
+| Intermediate failure | A process or protection requirement fails: `not (P and F)`. |
+
+Scores are computed by deterministic checks over business states and execution histories, without an LLM judge.
+
+## Citation
+
+```bibtex
+@misc{zhao2026bizagentbench,
+  title = {{BizAgentBench}: Unveiling Hidden Challenges in Deploying Long-Horizon Agents for Real-World Business},
+  author = {Enhan Zhao and Yongqi Tong and Xuejun Yu and Hang Wang and Pan Wang and Yichao Wang and Di He and Jianshe Li and Wei Wu},
+  year = {2026},
+  eprint = {2610.20424},
+  archivePrefix = {arXiv},
+  primaryClass = {cs.CE},
+  url = {https://arxiv.org/abs/2610.20424}
+}
+```

payment/data/knowledge/CAP-certificate.json

@@ -0,0 +1,12 @@
+{
+  "applicability": "Accounts with a published operational coverage agreement. Contract edition 4.2.0.",
+  "content": "The GINKGO-DESK operational agreement uses certified endorsement units. Its covered activities include Wholesale original endorsements, Booked registry endorsement, Existing export-license endorsements. These institution-approved commitments are listed under this agreement in the operational ledger. A limit shown for one activity does not enlarge the shared institutional pool. The ledger records compatible sources and any differing coverage multipliers.\n\nThe normal certificate product rules continue to determine identity, settlement, monetary balances and business results. Operational coverage is consumed only by the linked operation or its standing execution event. Coverage does not pay an invoice or replace that operation. The two standing instructions represent continuation of previously accepted business, not additional cash transfers charged to the current account.\n\nThe institution review date and the standing execution times appear in the published records. Follow the shared operational coverage contract for version changes and cancellation rights. Tools `propose_capacity_reservation` and `propose_capacity_release` manage these reservations; their requests require the ordinary bound customer approval.",
+  "id": "CAP-certificate",
+  "provenance": {
+    "classification": "synthetic_execution_extension",
+    "source": "Primary-author synthetic shared-capacity mechanism; not a verbatim source SOP rule."
+  },
+  "quoted_text": "The GINKGO-DESK operational agreement uses certified endorsement units. Its covered activities include Wholesale original endorsements, Booked registry endorsement, Existing export-license endorsements. These institution-approved commitments are listed under this agreement in the operational ledger. A limit shown for one activity does not enlarge the shared institutional pool. The ledger records compatible sources and any differing coverage multipliers.",
+  "title": "GINKGO-DESK operational agreement",
+  "topic": "shared-capacity"
+}

payment/data/knowledge/CAP-correction.json

@@ -0,0 +1,12 @@
+{
+  "applicability": "Accounts with a published operational coverage agreement. Contract edition 4.2.0.",
+  "content": "The CEDAR-RISK operational agreement uses USD receivable risk coverage in cents. Its covered activities include Receivable bridge backing, Confirmed buyer-performance guarantee, Existing export advance renewal. These institution-approved commitments are listed under this agreement in the operational ledger. A limit shown for one activity does not enlarge the shared institutional pool. The ledger records compatible sources and any differing coverage multipliers.\n\nThe normal correction product rules continue to determine identity, settlement, monetary balances and business results. Operational coverage is consumed only by the linked operation or its standing execution event. Coverage does not pay an invoice or replace that operation. The two standing instructions represent continuation of previously accepted business, not additional cash transfers charged to the current account.\n\nThe institution review date and the standing execution times appear in the published records. Follow the shared operational coverage contract for version changes and cancellation rights. Tools `propose_capacity_reservation` and `propose_capacity_release` manage these reservations; their requests require the ordinary bound customer approval.",
+  "id": "CAP-correction",
+  "provenance": {
+    "classification": "synthetic_execution_extension",
+    "source": "Primary-author synthetic shared-capacity mechanism; not a verbatim source SOP rule."
+  },
+  "quoted_text": "The CEDAR-RISK operational agreement uses USD receivable risk coverage in cents. Its covered activities include Receivable bridge backing, Confirmed buyer-performance guarantee, Existing export advance renewal. These institution-approved commitments are listed under this agreement in the operational ledger. A limit shown for one activity does not enlarge the shared institutional pool. The ledger records compatible sources and any differing coverage multipliers.",
+  "title": "CEDAR-RISK operational agreement",
+  "topic": "shared-capacity"
+}

payment/data/knowledge/CAP-operations.json

@@ -0,0 +1,19 @@
+{
+  "applicability": "Accounts with a published operational coverage agreement. Contract edition 4.2.0.",
+  "content": "Operational agreements may share a limited amount of institutional coverage. This coverage is not a cash balance, sales quota, a tariff deposit or a customer's approval. It is a separate limit on the institution's exposure or service commitments. The ordinary account and product rules still apply.\n\nA business record may carry `operational_agreement`, identifying the scope of its linked operational ledger. `capacity_pools` lists available agreements by business scope, unit, released capacity, coverage lot, version and review status. `capacity_obligations` lists the current instruction and standing commitments, their required quantities, eligible agreements and deadlines. Each row's `business_link` identifies the actual business operation that consumes its coverage. Standing commitments have a fixed automatic execution time. Read associated rows individually after searching by scope.\n\n`propose_capacity_reservation(pool_id, obligation_id, quantity)` reserves coverage after actual customer approval and execution. Quantity must be a positive multiple of the selected pool's coverage lot. An obligation may be split among compatible pools; reservations together may not exceed its requirement. A missing cost multiplier means one unit of pool capacity for one unit of coverage. A stated multiplier of two consumes two units for each covered unit. The same pool cannot back two obligations with the same capacity. Pool limits apply to the sum of RESERVED and CONSUMED debits. A reservation is tied to the pool version.\n\nAn operation named in a business link atomically consumes its required reserved coverage along with its usual effects. Ordinary authorization and other preconditions remain necessary. Failure rolls back both effects. The fixed coverage schedule in that instruction applies to that business operation; it does not change according to the amount of a later quote. A linked instruction is single-use. Repeating its already executed request is idempotent; a new execution needs a new institution-issued instruction and cannot reuse the old coverage. Consumed coverage is charged against the current institution accounting cycle. Repayment of a bridge, return of a tariff deposit or completion of a payment does not restore this daily coverage.\n\nAt a standing instruction's published event time, the institution uses its complete current reserved coverage. It records FULFILLED when coverage is sufficient, or FAILED when incomplete or invalid. It does not choose a pool or move another instruction's coverage automatically. A failed standing instruction has no replacement execution in the current cycle. Reserving capacity after its execution time cannot repair it.\n\nA PENDING institution review is a provisional allocation. Its scheduled event publishes the final released capacity and increments its version. Pending allocations can be reduced; the final amount is not known before the event. All unused reservations on that pool become STALE at this change and cease to occupy capacity. Consumed coverage remains charged. Both event status and updated pool record are observable. Reservations on other unchanged pools remain current.\n\n`propose_capacity_reservations(allocations)` accepts an explicit map from obligation ID to pool ID to integer quantity. It applies the same reservation checks to every entry atomically; any invalid entry rolls back the entire request. It permits partial allocations and does not optimize the supplied plan or assess future customer goals. One bound approval covers exactly the submitted map. Single-reservation and batch requests are interchangeable.\n\n`propose_capacity_release(reservation_id)` releases unused RESERVED or STALE coverage. It cannot reverse CONSUMED coverage. Unused reservations can be cancelled and rearranged freely while instructions remain open. Search, planning, failed proposals and legitimate changes of unused reservations do not themselves violate a customer goal. Acceptance of a reservation or a single instruction does not certify whether another customer commitment will be fulfilled.\n\n## Standardized exact service interfaces\n\nThe following exact interfaces belong to this business service. Unlocking one returns the executable JSON Schema. Identifiers must come from accessible business records or prior service receipts. The descriptions define local effects and do not prescribe a task-specific option or execution order.\n\n### `propose_capacity_reservations`\n\nAtomically reserve an explicit caller-supplied allocation map: obligation ID to pool ID to integer quantity. This executes the supplied allocation and does not select or optimize a plan.\n\n| Field | Type | Required | Public source and meaning |\n| --- | --- | --- | --- |\n| `allocations` | object | yes | Use the value established by the applicable business record, customer fact, or prior service receipt. |\n\nRead only: `false`. Customer approval required before execution: `true`.\n",
+  "id": "CAP-operations",
+  "provenance": {
+    "classification": "synthetic_execution_extension",
+    "source": "Primary-author synthetic shared-capacity mechanism; not a verbatim source SOP rule."
+  },
+  "quoted_text": "Operational agreements may share a limited amount of institutional coverage. This coverage is not a cash balance, sales quota, a tariff deposit or a customer's approval. It is a separate limit on the institution's exposure or service commitments. The ordinary account and product rules still apply.",
+  "title": "Shared operational coverage: limits, reservation and settlement",
+  "topic": "shared-capacity",
+  "document_layers": [
+    "business_rules",
+    "service_interfaces"
+  ],
+  "capabilities": [
+    "propose_capacity_reservations"
+  ]
+}

payment/data/knowledge/CAP-portal_authorization.json

@@ -0,0 +1,12 @@
+{
+  "applicability": "Accounts with a published operational coverage agreement. Contract edition 4.2.0.",
+  "content": "The LARCH-CLEARING operational agreement uses USD marketplace clearing coverage in cents. Its covered activities include Larch sales withdrawal clearing, Confirmed merchant reserve continuation, Scheduled buyer-protection renewal. These institution-approved commitments are listed under this agreement in the operational ledger. A limit shown for one activity does not enlarge the shared institutional pool. The ledger records compatible sources and any differing coverage multipliers.\n\nThe normal authorization product rules continue to determine identity, settlement, monetary balances and business results. Operational coverage is consumed only by the linked operation or its standing execution event. Coverage does not pay an invoice or replace that operation. The two standing instructions represent continuation of previously accepted business, not additional cash transfers charged to the current account.\n\nThe institution review date and the standing execution times appear in the published records. Follow the shared operational coverage contract for version changes and cancellation rights. Tools `propose_capacity_reservation` and `propose_capacity_release` manage these reservations; their requests require the ordinary bound customer approval.",
+  "id": "CAP-portal_authorization",
+  "provenance": {
+    "classification": "synthetic_execution_extension",
+    "source": "Primary-author synthetic shared-capacity mechanism; not a verbatim source SOP rule."
+  },
+  "quoted_text": "The LARCH-CLEARING operational agreement uses USD marketplace clearing coverage in cents. Its covered activities include Larch sales withdrawal clearing, Confirmed merchant reserve continuation, Scheduled buyer-protection renewal. These institution-approved commitments are listed under this agreement in the operational ledger. A limit shown for one activity does not enlarge the shared institutional pool. The ledger records compatible sources and any differing coverage multipliers.",
+  "title": "LARCH-CLEARING operational agreement",
+  "topic": "shared-capacity"
+}

payment/data/knowledge/CAP-portal_cards.json

@@ -0,0 +1,12 @@
+{
+  "applicability": "Accounts with a published operational coverage agreement. Contract edition 4.2.0.",
+  "content": "The ROWAN-CLEARING operational agreement uses USD card settlement guarantee in cents. Its covered activities include Urgent card purchase settlement backing, Existing merchant-acquiring guarantee, Existing travel-card guarantee. These institution-approved commitments are listed under this agreement in the operational ledger. A limit shown for one activity does not enlarge the shared institutional pool. The ledger records compatible sources and any differing coverage multipliers.\n\nThe normal cards product rules continue to determine identity, settlement, monetary balances and business results. Operational coverage is consumed only by the linked operation or its standing execution event. Coverage does not pay an invoice or replace that operation. The two standing instructions represent continuation of previously accepted business, not additional cash transfers charged to the current account.\n\nThe institution review date and the standing execution times appear in the published records. Follow the shared operational coverage contract for version changes and cancellation rights. Tools `propose_capacity_reservation` and `propose_capacity_release` manage these reservations; their requests require the ordinary bound customer approval.",
+  "id": "CAP-portal_cards",
+  "provenance": {
+    "classification": "synthetic_execution_extension",
+    "source": "Primary-author synthetic shared-capacity mechanism; not a verbatim source SOP rule."
+  },
+  "quoted_text": "The ROWAN-CLEARING operational agreement uses USD card settlement guarantee in cents. Its covered activities include Urgent card purchase settlement backing, Existing merchant-acquiring guarantee, Existing travel-card guarantee. These institution-approved commitments are listed under this agreement in the operational ledger. A limit shown for one activity does not enlarge the shared institutional pool. The ledger records compatible sources and any differing coverage multipliers.",
+  "title": "ROWAN-CLEARING operational agreement",
+  "topic": "shared-capacity"
+}

payment/data/knowledge/CAP-portal_fees.json

@@ -0,0 +1,12 @@
+{
+  "applicability": "Accounts with a published operational coverage agreement. Contract edition 4.2.0.",
+  "content": "The SAGE-GUARANTEES operational agreement uses USD guarantee underwriting cents. Its covered activities include Refundable tariff margin underwriting, Existing collection guarantee renewal, Existing fee-wallet guarantee renewal. These institution-approved commitments are listed under this agreement in the operational ledger. A limit shown for one activity does not enlarge the shared institutional pool. The ledger records compatible sources and any differing coverage multipliers.\n\nThe normal fees product rules continue to determine identity, settlement, monetary balances and business results. Operational coverage is consumed only by the linked operation or its standing execution event. Coverage does not pay an invoice or replace that operation. The two standing instructions represent continuation of previously accepted business, not additional cash transfers charged to the current account.\n\nThe institution review date and the standing execution times appear in the published records. Follow the shared operational coverage contract for version changes and cancellation rights. Tools `propose_capacity_reservation` and `propose_capacity_release` manage these reservations; their requests require the ordinary bound customer approval.",
+  "id": "CAP-portal_fees",
+  "provenance": {
+    "classification": "synthetic_execution_extension",
+    "source": "Primary-author synthetic shared-capacity mechanism; not a verbatim source SOP rule."
+  },
+  "quoted_text": "The SAGE-GUARANTEES operational agreement uses USD guarantee underwriting cents. Its covered activities include Refundable tariff margin underwriting, Existing collection guarantee renewal, Existing fee-wallet guarantee renewal. These institution-approved commitments are listed under this agreement in the operational ledger. A limit shown for one activity does not enlarge the shared institutional pool. The ledger records compatible sources and any differing coverage multipliers.",
+  "title": "SAGE-GUARANTEES operational agreement",
+  "topic": "shared-capacity"
+}

payment/data/knowledge/CAP-portal_groups.json

@@ -0,0 +1,12 @@
+{
+  "applicability": "Accounts with a published operational coverage agreement. Contract edition 4.2.0.",
+  "content": "The OAK-LICENSES operational agreement uses licensed child-account seats. Its covered activities include Five-seat capacity expansion license, Existing regional child-license renewal, Existing wholesale child-license renewal. These institution-approved commitments are listed under this agreement in the operational ledger. A limit shown for one activity does not enlarge the shared institutional pool. The ledger records compatible sources and any differing coverage multipliers.\n\nThe normal groups product rules continue to determine identity, settlement, monetary balances and business results. Operational coverage is consumed only by the linked operation or its standing execution event. Coverage does not pay an invoice or replace that operation. The two standing instructions represent continuation of previously accepted business, not additional cash transfers charged to the current account.\n\nThe institution review date and the standing execution times appear in the published records. Follow the shared operational coverage contract for version changes and cancellation rights. Tools `propose_capacity_reservation` and `propose_capacity_release` manage these reservations; their requests require the ordinary bound customer approval.",
+  "id": "CAP-portal_groups",
+  "provenance": {
+    "classification": "synthetic_execution_extension",
+    "source": "Primary-author synthetic shared-capacity mechanism; not a verbatim source SOP rule."
+  },
+  "quoted_text": "The OAK-LICENSES operational agreement uses licensed child-account seats. Its covered activities include Five-seat capacity expansion license, Existing regional child-license renewal, Existing wholesale child-license renewal. These institution-approved commitments are listed under this agreement in the operational ledger. A limit shown for one activity does not enlarge the shared institutional pool. The ledger records compatible sources and any differing coverage multipliers.",
+  "title": "OAK-LICENSES operational agreement",
+  "topic": "shared-capacity"
+}

payment/data/knowledge/CAP-portal_returns.json

@@ -0,0 +1,12 @@
+{
+  "applicability": "Accounts with a published operational coverage agreement. Contract edition 4.2.0.",
+  "content": "The PINE-CORRESPONDENT operational agreement uses EUR correspondent settlement coverage in cents. Its covered activities include Pine buyer refund settlement backing, Other accepted return-batch coverage, Standing EUR collection guarantee. These institution-approved commitments are listed under this agreement in the operational ledger. A limit shown for one activity does not enlarge the shared institutional pool. The ledger records compatible sources and any differing coverage multipliers.\n\nThe normal returns product rules continue to determine identity, settlement, monetary balances and business results. Operational coverage is consumed only by the linked operation or its standing execution event. Coverage does not pay an invoice or replace that operation. The two standing instructions represent continuation of previously accepted business, not additional cash transfers charged to the current account.\n\nThe institution review date and the standing execution times appear in the published records. Follow the shared operational coverage contract for version changes and cancellation rights. Tools `propose_capacity_reservation` and `propose_capacity_release` manage these reservations; their requests require the ordinary bound customer approval.",
+  "id": "CAP-portal_returns",
+  "provenance": {
+    "classification": "synthetic_execution_extension",
+    "source": "Primary-author synthetic shared-capacity mechanism; not a verbatim source SOP rule."
+  },
+  "quoted_text": "The PINE-CORRESPONDENT operational agreement uses EUR correspondent settlement coverage in cents. Its covered activities include Pine buyer refund settlement backing, Other accepted return-batch coverage, Standing EUR collection guarantee. These institution-approved commitments are listed under this agreement in the operational ledger. A limit shown for one activity does not enlarge the shared institutional pool. The ledger records compatible sources and any differing coverage multipliers.",
+  "title": "PINE-CORRESPONDENT operational agreement",
+  "topic": "shared-capacity"
+}

payment/data/knowledge/CAP-portal_rmb.json

@@ -0,0 +1,12 @@
+{
+  "applicability": "Accounts with a published operational coverage agreement. Contract edition 4.2.0.",
+  "content": "The NERIUM-CUSTOMS operational agreement uses USD export clearing indemnity in cents. Its covered activities include Manufacturing payment export clearance, Existing consignment indemnity, Bonded export release guarantee. These institution-approved commitments are listed under this agreement in the operational ledger. A limit shown for one activity does not enlarge the shared institutional pool. The ledger records compatible sources and any differing coverage multipliers.\n\nThe normal rmb product rules continue to determine identity, settlement, monetary balances and business results. Operational coverage is consumed only by the linked operation or its standing execution event. Coverage does not pay an invoice or replace that operation. The two standing instructions represent continuation of previously accepted business, not additional cash transfers charged to the current account.\n\nThe institution review date and the standing execution times appear in the published records. Follow the shared operational coverage contract for version changes and cancellation rights. Tools `propose_capacity_reservation` and `propose_capacity_release` manage these reservations; their requests require the ordinary bound customer approval.",
+  "id": "CAP-portal_rmb",
+  "provenance": {
+    "classification": "synthetic_execution_extension",
+    "source": "Primary-author synthetic shared-capacity mechanism; not a verbatim source SOP rule."
+  },
+  "quoted_text": "The NERIUM-CUSTOMS operational agreement uses USD export clearing indemnity in cents. Its covered activities include Manufacturing payment export clearance, Existing consignment indemnity, Bonded export release guarantee. These institution-approved commitments are listed under this agreement in the operational ledger. A limit shown for one activity does not enlarge the shared institutional pool. The ledger records compatible sources and any differing coverage multipliers.",
+  "title": "NERIUM-CUSTOMS operational agreement",
+  "topic": "shared-capacity"
+}

payment/data/knowledge/CAP-portal_security.json

@@ -0,0 +1,12 @@
+{
+  "applicability": "Accounts with a published operational coverage agreement. Contract edition 4.2.0.",
+  "content": "The MAPLE-MANDATES operational agreement uses USD payment mandate coverage in cents. Its covered activities include Maple remaining invoice authorization, Standing payroll mandate renewal, Contractor settlement mandate renewal. These institution-approved commitments are listed under this agreement in the operational ledger. A limit shown for one activity does not enlarge the shared institutional pool. The ledger records compatible sources and any differing coverage multipliers.\n\nThe normal security product rules continue to determine identity, settlement, monetary balances and business results. Operational coverage is consumed only by the linked operation or its standing execution event. Coverage does not pay an invoice or replace that operation. The two standing instructions represent continuation of previously accepted business, not additional cash transfers charged to the current account.\n\nThe institution review date and the standing execution times appear in the published records. Follow the shared operational coverage contract for version changes and cancellation rights. Tools `propose_capacity_reservation` and `propose_capacity_release` manage these reservations; their requests require the ordinary bound customer approval.",
+  "id": "CAP-portal_security",
+  "provenance": {
+    "classification": "synthetic_execution_extension",
+    "source": "Primary-author synthetic shared-capacity mechanism; not a verbatim source SOP rule."
+  },
+  "quoted_text": "The MAPLE-MANDATES operational agreement uses USD payment mandate coverage in cents. Its covered activities include Maple remaining invoice authorization, Standing payroll mandate renewal, Contractor settlement mandate renewal. These institution-approved commitments are listed under this agreement in the operational ledger. A limit shown for one activity does not enlarge the shared institutional pool. The ledger records compatible sources and any differing coverage multipliers.",
+  "title": "MAPLE-MANDATES operational agreement",
+  "topic": "shared-capacity"
+}

payment/data/knowledge/CAP-repayment.json

@@ -0,0 +1,12 @@
+{
+  "applicability": "Accounts with a published operational coverage agreement. Contract edition 4.2.0.",
+  "content": "The DAHLIA-COVER operational agreement uses USD supplier indemnity coverage in cents. Its covered activities include Returned-goods credit redemption backing, Supplier warranty continuation, Existing cash-advance indemnity. These institution-approved commitments are listed under this agreement in the operational ledger. A limit shown for one activity does not enlarge the shared institutional pool. The ledger records compatible sources and any differing coverage multipliers.\n\nThe normal repayment product rules continue to determine identity, settlement, monetary balances and business results. Operational coverage is consumed only by the linked operation or its standing execution event. Coverage does not pay an invoice or replace that operation. The two standing instructions represent continuation of previously accepted business, not additional cash transfers charged to the current account.\n\nThe institution review date and the standing execution times appear in the published records. Follow the shared operational coverage contract for version changes and cancellation rights. Tools `propose_capacity_reservation` and `propose_capacity_release` manage these reservations; their requests require the ordinary bound customer approval.",
+  "id": "CAP-repayment",
+  "provenance": {
+    "classification": "synthetic_execution_extension",
+    "source": "Primary-author synthetic shared-capacity mechanism; not a verbatim source SOP rule."
+  },
+  "quoted_text": "The DAHLIA-COVER operational agreement uses USD supplier indemnity coverage in cents. Its covered activities include Returned-goods credit redemption backing, Supplier warranty continuation, Existing cash-advance indemnity. These institution-approved commitments are listed under this agreement in the operational ledger. A limit shown for one activity does not enlarge the shared institutional pool. The ledger records compatible sources and any differing coverage multipliers.",
+  "title": "DAHLIA-COVER operational agreement",
+  "topic": "shared-capacity"
+}

payment/data/knowledge/DB-accounts.json

@@ -0,0 +1,13 @@
+{
+  "applicability": "Shared Payment database interface; all tasks use the same dictionary",
+  "content": "> Inherited interface: no populated public shape in this release's admitted workflow inventory. See DB-inherited-collections and the product entry points in DB-index.\n\n# accounts\n\nAccounts records in CORE and product extensions. Product articles define their operational scope.\n\nRead this collection using `search_records(resource=\"accounts\", filters={}, cursor=0, limit=20)` or `get_record(resource=\"accounts\", record_id=\"<returned id>\")`.\n\n**Filters:** exact scalar equality; in, contains, gte and lte operator objects on supported top-level fields. See DB-query-syntax for type and null behavior.\n\nSearch returns selected summary fields, so omission from a summary is not proof of absence from the complete record. Read detail before interpreting an optional field. Fields depend on the record type and processing stage; null and absent fields are not zero amounts. Types below describe public record shapes, rather than mandatory properties on every row.\n\nThis inherited collection has no populated public-record shape in the current admitted workflow inventory. Its query entry remains available. No empty collection is treated as evidence about a particular customer enquiry; the actual query determines accessible matches. Its producers and product articles govern any records it creates.",
+  "id": "DB-accounts",
+  "provenance": {
+    "classification": "interface_documentation",
+    "contains_task_specific_values": false,
+    "kind": "interface_documentation",
+    "source": "Public record shapes plus query/transition implementation; reviewed field semantics"
+  },
+  "title": "Database reference: accounts",
+  "topic": "Database interface"
+}

payment/data/knowledge/DB-advances.json

@@ -0,0 +1,13 @@
+{
+  "applicability": "Shared Payment database interface; all tasks use the same dictionary",
+  "content": "> Inherited interface: no populated public shape in this release's admitted workflow inventory. See DB-inherited-collections and the product entry points in DB-index.\n\n# advances\n\nAdvances records in CORE and product extensions. Product articles define their operational scope.\n\nRead this collection using `search_records(resource=\"advances\", filters={}, cursor=0, limit=20)` or `get_record(resource=\"advances\", record_id=\"<returned id>\")`.\n\n**Filters:** exact scalar equality; in, contains, gte and lte operator objects on supported top-level fields. See DB-query-syntax for type and null behavior.\n\nSearch returns selected summary fields, so omission from a summary is not proof of absence from the complete record. Read detail before interpreting an optional field. Fields depend on the record type and processing stage; null and absent fields are not zero amounts. Types below describe public record shapes, rather than mandatory properties on every row.\n\nThis inherited collection has no populated public-record shape in the current admitted workflow inventory. Its query entry remains available. No empty collection is treated as evidence about a particular customer enquiry; the actual query determines accessible matches. Its producers and product articles govern any records it creates.",
+  "id": "DB-advances",
+  "provenance": {
+    "classification": "interface_documentation",
+    "contains_task_specific_values": false,
+    "kind": "interface_documentation",
+    "source": "Public record shapes plus query/transition implementation; reviewed field semantics"
+  },
+  "title": "Database reference: advances",
+  "topic": "Database interface"
+}

payment/data/knowledge/DB-agreements.json

@@ -0,0 +1,13 @@
+{
+  "applicability": "Shared Payment database interface; all tasks use the same dictionary",
+  "content": "> Inherited interface: no populated public shape in this release's admitted workflow inventory. See DB-inherited-collections and the product entry points in DB-index.\n\n# agreements\n\nAgreements records in CORE and product extensions. Product articles define their operational scope.\n\nRead this collection using `search_records(resource=\"agreements\", filters={}, cursor=0, limit=20)` or `get_record(resource=\"agreements\", record_id=\"<returned id>\")`.\n\n**Filters:** exact scalar equality; in, contains, gte and lte operator objects on supported top-level fields. See DB-query-syntax for type and null behavior.\n\nSearch returns selected summary fields, so omission from a summary is not proof of absence from the complete record. Read detail before interpreting an optional field. Fields depend on the record type and processing stage; null and absent fields are not zero amounts. Types below describe public record shapes, rather than mandatory properties on every row.\n\nThis inherited collection has no populated public-record shape in the current admitted workflow inventory. Its query entry remains available. No empty collection is treated as evidence about a particular customer enquiry; the actual query determines accessible matches. Its producers and product articles govern any records it creates.",
+  "id": "DB-agreements",
+  "provenance": {
+    "classification": "interface_documentation",
+    "contains_task_specific_values": false,
+    "kind": "interface_documentation",
+    "source": "Public record shapes plus query/transition implementation; reviewed field semantics"
+  },
+  "title": "Database reference: agreements",
+  "topic": "Database interface"
+}

payment/data/knowledge/DB-authorizations.json

@@ -0,0 +1,13 @@
+{
+  "applicability": "Shared Payment database interface; all tasks use the same dictionary",
+  "content": "> Inherited interface: no populated public shape in this release's admitted workflow inventory. See DB-inherited-collections and the product entry points in DB-index.\n\n# authorizations\n\nAuthorizations records in CORE and product extensions. Product articles define their operational scope.\n\nRead this collection using `search_records(resource=\"authorizations\", filters={}, cursor=0, limit=20)` or `get_record(resource=\"authorizations\", record_id=\"<returned id>\")`.\n\n**Filters:** exact scalar equality; in, contains, gte and lte operator objects on supported top-level fields. See DB-query-syntax for type and null behavior.\n\nSearch returns selected summary fields, so omission from a summary is not proof of absence from the complete record. Read detail before interpreting an optional field. Fields depend on the record type and processing stage; null and absent fields are not zero amounts. Types below describe public record shapes, rather than mandatory properties on every row.\n\nThis inherited collection has no populated public-record shape in the current admitted workflow inventory. Its query entry remains available. No empty collection is treated as evidence about a particular customer enquiry; the actual query determines accessible matches. Its producers and product articles govern any records it creates.",
+  "id": "DB-authorizations",
+  "provenance": {
+    "classification": "interface_documentation",
+    "contains_task_specific_values": false,
+    "kind": "interface_documentation",
+    "source": "Public record shapes plus query/transition implementation; reviewed field semantics"
+  },
+  "title": "Database reference: authorizations",
+  "topic": "Database interface"
+}

payment/data/knowledge/DB-bank_receipts.json

@@ -0,0 +1,13 @@
+{
+  "applicability": "Shared Payment database interface; all tasks use the same dictionary",
+  "content": "# bank_receipts\n\nActual bank payment receipts associated with submitted batch items.\n\nRead this collection using `search_records(resource=\"bank_receipts\", filters={}, cursor=0, limit=20)` or `get_record(resource=\"bank_receipts\", record_id=\"<returned id>\")`.\n\n**Filters:** exact scalar equality; in, contains, gte and lte operator objects on supported top-level fields. See DB-query-syntax for type and null behavior.\n\nSearch returns selected summary fields, so omission from a summary is not proof of absence from the complete record. Read detail before interpreting an optional field. Fields depend on the record type and processing stage; null and absent fields are not zero amounts. Types below describe public record shapes, rather than mandatory properties on every row.\n\n## Explicit identifier relationships\n\n- `item_id` references a `payment_batch_items` record ID when present. See `DB-payment_batch_items`.\n- `attempt_id` references a `submission_attempts` record ID when present. See `DB-submission_attempts`.\n\nCommercial references can require entity, period or issuer matching. An ID relationship does not imply that every related record repeats the same case_id.\n\n## Fields\n\n| Field | Observed public types | Search use | Meaning |\n| --- | --- | --- | --- |\n| `amount_minor` | integer | Top-level filter | Amount in integer minor currency units. Whether it denotes an instruction, liability or posted movement depends on this record type. |\n| `attempt_id` | string | Top-level filter | Record ID in submission_attempts. Use get_record on that collection; the link does not make other rows implicitly belong to the same object. |\n| `bank_reference` | string | Top-level filter | Bank reference: commercial reference, which may differ from the storage id. Match using the documented reference field and business context. |\n| `business_area` | string | Top-level filter | Business area: public attribute of this record type. The associated service article defines its operational use. |\n| `commercial_reference` | string | Top-level filter | Reference supplied by a commercial source; use the source and period when matching evidence. |\n| `id` | string | Top-level filter | Opaque record key used by get_record; obtain it from returned records or explicit references. It is not an amount, date or proof of business identity. |\n| `instruction_minor` | integer | Top-level filter | Instruction amount, in integer minor units of the applicable currency. Inspect this record type and its source/receipt to distinguish declared values from actual movements. |\n| `item_id` | string | Top-level filter | Record ID in payment_batch_items. Use get_record on that collection; the link does not make other rows implicitly belong to the same object. |\n| `received_minute` | integer | Top-level filter | Received minute: logical minute or duration, as indicated by the field name; compare with get_clock and the applicable event/validity terms. |\n| `scope` | string | Top-level filter | Access namespace for the record. It is not a customer name or a universal case_id. |\n| `status` | string | Top-level filter | Current state of this particular object. A proposal or submission state is distinct from a posted payment or completed review. Public values represented here: `NOT_RECEIVED`, `REJECTED`, `SETTLED`. This list describes the documented records, not an input-validation enum. |\n",
+  "id": "DB-bank_receipts",
+  "provenance": {
+    "classification": "interface_documentation",
+    "contains_task_specific_values": false,
+    "kind": "interface_documentation",
+    "source": "Public record shapes plus query/transition implementation; reviewed field semantics"
+  },
+  "title": "Database reference: bank_receipts",
+  "topic": "Database interface"
+}

payment/data/knowledge/DB-batches.json

@@ -0,0 +1,13 @@
+{
+  "applicability": "Shared Payment database interface; all tasks use the same dictionary",
+  "content": "> Inherited interface: no populated public shape in this release's admitted workflow inventory. See DB-inherited-collections and the product entry points in DB-index.\n\n# batches\n\nBatches records in CORE and product extensions. Product articles define their operational scope.\n\nRead this collection using `search_records(resource=\"batches\", filters={}, cursor=0, limit=20)` or `get_record(resource=\"batches\", record_id=\"<returned id>\")`.\n\n**Filters:** exact scalar equality; in, contains, gte and lte operator objects on supported top-level fields. See DB-query-syntax for type and null behavior.\n\nSearch returns selected summary fields, so omission from a summary is not proof of absence from the complete record. Read detail before interpreting an optional field. Fields depend on the record type and processing stage; null and absent fields are not zero amounts. Types below describe public record shapes, rather than mandatory properties on every row.\n\nThis inherited collection has no populated public-record shape in the current admitted workflow inventory. Its query entry remains available. No empty collection is treated as evidence about a particular customer enquiry; the actual query determines accessible matches. Its producers and product articles govern any records it creates.",
+  "id": "DB-batches",
+  "provenance": {
+    "classification": "interface_documentation",
+    "contains_task_specific_values": false,
+    "kind": "interface_documentation",
+    "source": "Public record shapes plus query/transition implementation; reviewed field semantics"
+  },
+  "title": "Database reference: batches",
+  "topic": "Database interface"
+}

payment/data/knowledge/DB-beneficiaries.json

@@ -0,0 +1,13 @@
+{
+  "applicability": "Shared Payment database interface; all tasks use the same dictionary",
+  "content": "> Inherited interface: no populated public shape in this release's admitted workflow inventory. See DB-inherited-collections and the product entry points in DB-index.\n\n# beneficiaries\n\nBeneficiaries records in CORE and product extensions. Product articles define their operational scope.\n\nRead this collection using `search_records(resource=\"beneficiaries\", filters={}, cursor=0, limit=20)` or `get_record(resource=\"beneficiaries\", record_id=\"<returned id>\")`.\n\n**Filters:** exact scalar equality; in, contains, gte and lte operator objects on supported top-level fields. See DB-query-syntax for type and null behavior.\n\nSearch returns selected summary fields, so omission from a summary is not proof of absence from the complete record. Read detail before interpreting an optional field. Fields depend on the record type and processing stage; null and absent fields are not zero amounts. Types below describe public record shapes, rather than mandatory properties on every row.\n\nThis inherited collection has no populated public-record shape in the current admitted workflow inventory. Its query entry remains available. No empty collection is treated as evidence about a particular customer enquiry; the actual query determines accessible matches. Its producers and product articles govern any records it creates.",
+  "id": "DB-beneficiaries",
+  "provenance": {
+    "classification": "interface_documentation",
+    "contains_task_specific_values": false,
+    "kind": "interface_documentation",
+    "source": "Public record shapes plus query/transition implementation; reviewed field semantics"
+  },
+  "title": "Database reference: beneficiaries",
+  "topic": "Database interface"
+}

payment/data/knowledge/DB-billing_instances.json

@@ -0,0 +1,13 @@
+{
+  "applicability": "Shared Payment database interface; all tasks use the same dictionary",
+  "content": "# billing_instances\n\nBilling instances records in Operations Desk. Product articles define their operational scope.\n\nRead this collection using `search_records(resource=\"billing_instances\", filters={}, cursor=0, limit=20)` or `get_record(resource=\"billing_instances\", record_id=\"<returned id>\")`.\n\n**Filters:** exact scalar equality; in, contains, gte and lte operator objects on supported top-level fields. See DB-query-syntax for type and null behavior.\n\nSearch returns selected summary fields, so omission from a summary is not proof of absence from the complete record. Read detail before interpreting an optional field. Fields depend on the record type and processing stage; null and absent fields are not zero amounts. Types below describe public record shapes, rather than mandatory properties on every row.\n\n## Fields\n\n| Field | Observed public types | Search use | Meaning |\n| --- | --- | --- | --- |\n| `accepted_minute` | integer | Top-level filter | Accepted minute: logical minute or duration, as indicated by the field name; compare with get_clock and the applicable event/validity terms. |\n| `account_id` | string | Top-level filter | Account id: opaque identifier reference. Its target depends on the containing record/operation; do not infer a collection merely by pluralizing the field name. Explicit joins are listed separately. |\n| `amount_minor` | integer | Top-level filter | Amount in integer minor currency units. Whether it denotes an instruction, liability or posted movement depends on this record type. |\n| `business_area` | string | Top-level filter | Business area: public attribute of this record type. The associated service article defines its operational use. |\n| `commercial_reference` | string | Top-level filter | Reference supplied by a commercial source; use the source and period when matching evidence. |\n| `currency` | string | Top-level filter | Currency code for the associated monetary fields. Preserve separate currency balances. Public values represented here: `USD`. This list describes the documented records, not an input-validation enum. |\n| `id` | string | Top-level filter | Opaque record key used by get_record; obtain it from returned records or explicit references. It is not an amount, date or proof of business identity. |\n| `processed_minute` | integer | Top-level filter | Processed minute: logical minute or duration, as indicated by the field name; compare with get_clock and the applicable event/validity terms. |\n| `scope` | string | Top-level filter | Access namespace for the record. It is not a customer name or a universal case_id. |\n| `service_id` | string | Top-level filter | Service id: opaque identifier reference. Its target depends on the containing record/operation; do not infer a collection merely by pluralizing the field name. Explicit joins are listed separately. |\n| `status` | string | Top-level filter | Current state of this particular object. A proposal or submission state is distinct from a posted payment or completed review. Public values represented here: `ACCEPTED`, `PAID`, `REFUNDED`, `RETURN_PENDING`. This list describes the documented records, not an input-validation enum. |\n",
+  "id": "DB-billing_instances",
+  "provenance": {
+    "classification": "interface_documentation",
+    "contains_task_specific_values": false,
+    "kind": "interface_documentation",
+    "source": "Public record shapes plus query/transition implementation; reviewed field semantics"
+  },
+  "title": "Database reference: billing_instances",
+  "topic": "Database interface"
+}

payment/data/knowledge/DB-bridge_facilities.json

@@ -0,0 +1,13 @@
+{
+  "applicability": "Shared Payment database interface; all tasks use the same dictionary",
+  "content": "> Inherited interface: no populated public shape in this release's admitted workflow inventory. See DB-inherited-collections and the product entry points in DB-index.\n\n# bridge_facilities\n\nBridge facilities records in CORE and product extensions. Product articles define their operational scope.\n\nRead this collection using `search_records(resource=\"bridge_facilities\", filters={}, cursor=0, limit=20)` or `get_record(resource=\"bridge_facilities\", record_id=\"<returned id>\")`.\n\n**Filters:** exact scalar equality; in, contains, gte and lte operator objects on supported top-level fields. See DB-query-syntax for type and null behavior.\n\nSearch returns selected summary fields, so omission from a summary is not proof of absence from the complete record. Read detail before interpreting an optional field. Fields depend on the record type and processing stage; null and absent fields are not zero amounts. Types below describe public record shapes, rather than mandatory properties on every row.\n\nThis inherited collection has no populated public-record shape in the current admitted workflow inventory. Its query entry remains available. No empty collection is treated as evidence about a particular customer enquiry; the actual query determines accessible matches. Its producers and product articles govern any records it creates.",
+  "id": "DB-bridge_facilities",
+  "provenance": {
+    "classification": "interface_documentation",
+    "contains_task_specific_values": false,
+    "kind": "interface_documentation",
+    "source": "Public record shapes plus query/transition implementation; reviewed field semantics"
+  },
+  "title": "Database reference: bridge_facilities",
+  "topic": "Database interface"
+}

payment/data/knowledge/DB-business_documents.json

@@ -0,0 +1,13 @@
+{
+  "applicability": "Shared Payment database interface; all tasks use the same dictionary",
+  "content": "# business_documents\n\nPublic business-source evidence returned by the service desk.\n\nRead this collection using `search_records(resource=\"business_documents\", filters={}, cursor=0, limit=20)` or `get_record(resource=\"business_documents\", record_id=\"<returned id>\")`.\n\n**Filters:** exact scalar equality; in, contains, gte and lte operator objects on supported top-level fields. See DB-query-syntax for type and null behavior.\n\nSearch returns selected summary fields, so omission from a summary is not proof of absence from the complete record. Read detail before interpreting an optional field. Fields depend on the record type and processing stage; null and absent fields are not zero amounts. Types below describe public record shapes, rather than mandatory properties on every row.\n\n## Fields\n\n| Field | Observed public types | Search use | Meaning |\n| --- | --- | --- | --- |\n| `body` | object | Object value; see collection filter rules | Business-source document content; read the document as evidence rather than treating its title as the conclusion. |\n| `body.accepted_units` | integer | Nested output only | Accepted units: public attribute of this record type. The associated service article defines its operational use. |\n| `body.assessment` | array | Nested output only | Assessment: list of the named business attributes or references; inspect all entries relevant to the record. |\n| `body.bill_to_registration` | string | Nested output only | Bill to registration: public attribute of this record type. The associated service article defines its operational use. |\n| `body.buyer_name` | string | Nested output only | Buyer name: public attribute of this record type. The associated service article defines its operational use. |\n| `body.currency` | string | Nested output only | Currency code for the associated monetary fields. Preserve separate currency balances. Public values represented here: `USD`. This list describes the documented records, not an input-validation enum. |\n| `body.dispatched_revision` | integer | Nested output only | Dispatched revision: version of the named evidence/object. Check applicability and status along with its version. |\n| `body.invoice_month` | string | Nested output only | Invoice month: public attribute of this record type. The associated service article defines its operational use. |\n| `body.merchant_categories` | array | Nested output only | Merchant categories: list of the named business attributes or references; inspect all entries relevant to the record. |\n| `body.message_type` | string | Nested output only | Message type: public attribute of this record type. The associated service article defines its operational use. |\n| `body.new_issuance` | boolean | Nested output only | New issuance: true/false state flag for this record. |\n| `body.ordered_units` | integer | Nested output only | Ordered units: public attribute of this record type. The associated service article defines its operational use. |\n| `body.payment_networks` | array | Nested output only | Payment networks: list of the named business attributes or references; inspect all entries relevant to the record. |\n| `body.permitted_expenditure` | array | Nested output only | Permitted expenditure: list of the named business attributes or references; inspect all entries relevant to the record. |\n| `body.principal_minor` | integer | Nested output only | Principal amount, in integer minor units of the applicable currency. Inspect this record type and its source/receipt to distinguish declared values from actual movements. |\n| `body.purchase_orders` | array | Nested output only | Purchase orders: list of the named business attributes or references; inspect all entries relevant to the record. |\n| `body.registration_regions` | array | Nested output only | Registration regions: list of the named business attributes or references; inspect all entries relevant to the record. |\n| `body.release` | array | Nested output only | Release: list of the named business attributes or references; inspect all entries relevant to the record. |\n| `body.request_processing_minutes` | integer | Nested output only | Request processing minutes: logical minute or duration, as indicated by the field name; compare with get_clock and the applicable event/validity terms. |\n| `body.returned_units` | integer | Nested output only | Returned units: public attribute of this record type. The associated service article defines its operational use. |\n| `body.settlement_markets` | array | Nested output only | Settlement markets: list of the named business attributes or references; inspect all entries relevant to the record. |\n| `body.shipment_reference` | string | Nested output only | Shipment reference: commercial reference, which may differ from the storage id. Match using the documented reference field and business context. |\n| `body.supplier` | string | Nested output only | Supplier: public attribute of this record type. The associated service article defines its operational use. |\n| `body.transmission_status` | string | Nested output only | Transmission status: public attribute of this record type. The associated service article defines its operational use. |\n| `body.unit_price_minor` | integer | Nested output only | Unit price amount, in integer minor units of the applicable currency. Inspect this record type and its source/receipt to distinguish declared values from actual movements. |\n| `business_area` | string | Top-level filter | Business area: public attribute of this record type. The associated service article defines its operational use. |\n| `id` | string | Top-level filter | Opaque record key used by get_record; obtain it from returned records or explicit references. It is not an amount, date or proof of business identity. |\n| `issued_minute` | integer | Top-level filter | Issued minute: logical minute or duration, as indicated by the field name; compare with get_clock and the applicable event/validity terms. |\n| `issuer` | string | Top-level filter | Issuer: public attribute of this record type. The associated service article defines its operational use. |\n| `kind` | string | Top-level filter | Record or service type. Fields and meanings can differ between kinds. Public values represented here: `buyer_payment_terms`, `collection_product_terms`, `facility_covenant`, `payer_dispatch_notice`, `proceeds_assignment`, `supplier_invoice`, `warehouse_receipt`. This list describes the documented records, not an input-validation enum. |\n| `reference` | string | Top-level filter | Business reference on this object; its uniqueness depends on the issuer, entity and period. |\n| `scope` | string | Top-level filter | Access namespace for the record. It is not a customer name or a universal case_id. |\n| `status` | string | Top-level filter | Current state of this particular object. A proposal or submission state is distinct from a posted payment or completed review. Public values represented here: `RECEIVED`. This list describes the documented records, not an input-validation enum. |\n\n\n## Evidence and customer files\n\nbusiness_documents contains public source evidence; its body is searchable with a contains operator. remittance_advice contains received payer letters. service_records may itself contain source-document records; consult the service-kind dictionary before interpreting them. submissions contains actual user uploads and their target and purpose; evidence_bundles contains grouped evidence for the documented process.\n\nPrivate files belong to the customer's file inventory. Only the user can call list_my_files and upload_file. Asking the customer for an identified business document does not require discovering their private file ID in the public database. Neither files nor documents is a public search_records resource. service_documents is an inherited interface without a populated public shape in this release's admitted workflow inventory; it is not the general upload store.\n\n\n## Complete filter examples\n\nFilter keys name fields. Operators are nested inside the value for a field:\n\n```json\n{\"resource\":\"business_documents\",\"filters\":{\"body\":{\"contains\":\"tax\"}},\"cursor\":0,\"limit\":20}\n```\n\n```json\n{\"resource\":\"joint_agreements\",\"filters\":{\"id\":\"<returned agreement ID>\"},\"cursor\":0,\"limit\":20}\n```\n\n```json\n{\"resource\":\"joint_sources\",\"filters\":{\"agreement_id\":\"<same returned agreement ID>\"},\"cursor\":0,\"limit\":20}\n```\n\n```json\n{\"resource\":\"service_records\",\"filters\":{\"case_id\":\"<returned service case ID>\"},\"cursor\":0,\"limit\":20}\n```\n\nfilters={\"contains\":\"tax\"} is not a text search: it addresses a nonexistent field named contains. Unknown scalar fields can return no matches without a schema error. An empty result remains compatible with a correct query when no accessible record matches.\n",
+  "id": "DB-business_documents",
+  "provenance": {
+    "classification": "interface_documentation",
+    "contains_task_specific_values": false,
+    "kind": "interface_documentation",
+    "source": "Public record shapes plus query/transition implementation; reviewed field semantics"
+  },
+  "title": "Database reference: business_documents",
+  "topic": "Database interface"
+}

payment/data/knowledge/DB-capacity_obligations.json

@@ -0,0 +1,13 @@
+{
+  "applicability": "Shared Payment database interface; all tasks use the same dictionary",
+  "content": "> Inherited interface: no populated public shape in this release's admitted workflow inventory. See DB-inherited-collections and the product entry points in DB-index.\n\n# capacity_obligations\n\nCapacity obligations records in CORE and product extensions. Product articles define their operational scope.\n\nRead this collection using `search_records(resource=\"capacity_obligations\", filters={}, cursor=0, limit=20)` or `get_record(resource=\"capacity_obligations\", record_id=\"<returned id>\")`.\n\n**Filters:** exact scalar equality; in, contains, gte and lte operator objects on supported top-level fields. See DB-query-syntax for type and null behavior.\n\nSearch returns selected summary fields, so omission from a summary is not proof of absence from the complete record. Read detail before interpreting an optional field. Fields depend on the record type and processing stage; null and absent fields are not zero amounts. Types below describe public record shapes, rather than mandatory properties on every row.\n\nThis inherited collection has no populated public-record shape in the current admitted workflow inventory. Its query entry remains available. No empty collection is treated as evidence about a particular customer enquiry; the actual query determines accessible matches. Its producers and product articles govern any records it creates.",
+  "id": "DB-capacity_obligations",
+  "provenance": {
+    "classification": "interface_documentation",
+    "contains_task_specific_values": false,
+    "kind": "interface_documentation",
+    "source": "Public record shapes plus query/transition implementation; reviewed field semantics"
+  },
+  "title": "Database reference: capacity_obligations",
+  "topic": "Database interface"
+}

payment/data/knowledge/DB-capacity_pools.json

@@ -0,0 +1,13 @@
+{
+  "applicability": "Shared Payment database interface; all tasks use the same dictionary",
+  "content": "> Inherited interface: no populated public shape in this release's admitted workflow inventory. See DB-inherited-collections and the product entry points in DB-index.\n\n# capacity_pools\n\nCapacity pools records in CORE and product extensions. Product articles define their operational scope.\n\nRead this collection using `search_records(resource=\"capacity_pools\", filters={}, cursor=0, limit=20)` or `get_record(resource=\"capacity_pools\", record_id=\"<returned id>\")`.\n\n**Filters:** exact scalar equality; in, contains, gte and lte operator objects on supported top-level fields. See DB-query-syntax for type and null behavior.\n\nSearch returns selected summary fields, so omission from a summary is not proof of absence from the complete record. Read detail before interpreting an optional field. Fields depend on the record type and processing stage; null and absent fields are not zero amounts. Types below describe public record shapes, rather than mandatory properties on every row.\n\nThis inherited collection has no populated public-record shape in the current admitted workflow inventory. Its query entry remains available. No empty collection is treated as evidence about a particular customer enquiry; the actual query determines accessible matches. Its producers and product articles govern any records it creates.",
+  "id": "DB-capacity_pools",
+  "provenance": {
+    "classification": "interface_documentation",
+    "contains_task_specific_values": false,
+    "kind": "interface_documentation",
+    "source": "Public record shapes plus query/transition implementation; reviewed field semantics"
+  },
+  "title": "Database reference: capacity_pools",
+  "topic": "Database interface"
+}

payment/data/knowledge/DB-capacity_reservations.json

@@ -0,0 +1,13 @@
+{
+  "applicability": "Shared Payment database interface; all tasks use the same dictionary",
+  "content": "> Inherited interface: no populated public shape in this release's admitted workflow inventory. See DB-inherited-collections and the product entry points in DB-index.\n\n# capacity_reservations\n\nCapacity reservations records in CORE and product extensions. Product articles define their operational scope.\n\nRead this collection using `search_records(resource=\"capacity_reservations\", filters={}, cursor=0, limit=20)` or `get_record(resource=\"capacity_reservations\", record_id=\"<returned id>\")`.\n\n**Filters:** exact scalar equality; in, contains, gte and lte operator objects on supported top-level fields. See DB-query-syntax for type and null behavior.\n\nSearch returns selected summary fields, so omission from a summary is not proof of absence from the complete record. Read detail before interpreting an optional field. Fields depend on the record type and processing stage; null and absent fields are not zero amounts. Types below describe public record shapes, rather than mandatory properties on every row.\n\nThis inherited collection has no populated public-record shape in the current admitted workflow inventory. Its query entry remains available. No empty collection is treated as evidence about a particular customer enquiry; the actual query determines accessible matches. Its producers and product articles govern any records it creates.",
+  "id": "DB-capacity_reservations",
+  "provenance": {
+    "classification": "interface_documentation",
+    "contains_task_specific_values": false,
+    "kind": "interface_documentation",
+    "source": "Public record shapes plus query/transition implementation; reviewed field semantics"
+  },
+  "title": "Database reference: capacity_reservations",
+  "topic": "Database interface"
+}

payment/data/knowledge/DB-card_disputes.json

@@ -0,0 +1,13 @@
+{
+  "applicability": "Shared Payment database interface; all tasks use the same dictionary",
+  "content": "# card_disputes\n\nCard disputes records in Operations Desk. Product articles define their operational scope.\n\nRead this collection using `search_records(resource=\"card_disputes\", filters={}, cursor=0, limit=20)` or `get_record(resource=\"card_disputes\", record_id=\"<returned id>\")`.\n\n**Filters:** exact scalar equality; in, contains, gte and lte operator objects on supported top-level fields. See DB-query-syntax for type and null behavior.\n\nSearch returns selected summary fields, so omission from a summary is not proof of absence from the complete record. Read detail before interpreting an optional field. Fields depend on the record type and processing stage; null and absent fields are not zero amounts. Types below describe public record shapes, rather than mandatory properties on every row.\n\n## Fields\n\n| Field | Observed public types | Search use | Meaning |\n| --- | --- | --- | --- |\n| `business_area` | string | Top-level filter | Business area: public attribute of this record type. The associated service article defines its operational use. |\n| `case_id` | string | Top-level filter | Case id: opaque identifier reference. Its target depends on the containing record/operation; do not infer a collection merely by pluralizing the field name. Explicit joins are listed separately. |\n| `charged_filing_fee_minor` | integer | Top-level filter | Charged filing fee amount, in integer minor units of the applicable currency. Inspect this record type and its source/receipt to distinguish declared values from actual movements. |\n| `claims` | object | Object value; see collection filter rules | Claims: structured business data. Named nested fields are listed below when present; maps retain their own key/value meaning. |\n| `finalized_minute` | integer | Top-level filter | Finalized minute: logical minute or duration, as indicated by the field name; compare with get_clock and the applicable event/validity terms. |\n| `id` | string | Top-level filter | Opaque record key used by get_record; obtain it from returned records or explicit references. It is not an amount, date or proof of business identity. |\n| `opened_minute` | integer | Top-level filter | Opened minute: logical minute or duration, as indicated by the field name; compare with get_clock and the applicable event/validity terms. |\n| `registered_components` | array | Top-level filter | Registered components: list of the named business attributes or references; inspect all entries relevant to the record. |\n| `scope` | string | Top-level filter | Access namespace for the record. It is not a customer name or a universal case_id. |\n| `settled_minute` | integer | Top-level filter | Settled minute: logical minute or duration, as indicated by the field name; compare with get_clock and the applicable event/validity terms. |\n| `status` | string | Top-level filter | Current state of this particular object. A proposal or submission state is distinct from a posted payment or completed review. Public values represented here: `SETTLED`. This list describes the documented records, not an input-validation enum. |\n| `submission_id` | string | Top-level filter | Submission id: opaque identifier reference. Its target depends on the containing record/operation; do not infer a collection merely by pluralizing the field name. Explicit joins are listed separately. |\n",
+  "id": "DB-card_disputes",
+  "provenance": {
+    "classification": "interface_documentation",
+    "contains_task_specific_values": false,
+    "kind": "interface_documentation",
+    "source": "Public record shapes plus query/transition implementation; reviewed field semantics"
+  },
+  "title": "Database reference: card_disputes",
+  "topic": "Database interface"
+}

payment/data/knowledge/DB-card_limits.json

@@ -0,0 +1,13 @@
+{
+  "applicability": "Shared Payment database interface; all tasks use the same dictionary",
+  "content": "> Inherited interface: no populated public shape in this release's admitted workflow inventory. See DB-inherited-collections and the product entry points in DB-index.\n\n# card_limits\n\nCard limits records in CORE and product extensions. Product articles define their operational scope.\n\nRead this collection using `search_records(resource=\"card_limits\", filters={}, cursor=0, limit=20)` or `get_record(resource=\"card_limits\", record_id=\"<returned id>\")`.\n\n**Filters:** exact scalar equality; in, contains, gte and lte operator objects on supported top-level fields. See DB-query-syntax for type and null behavior.\n\nSearch returns selected summary fields, so omission from a summary is not proof of absence from the complete record. Read detail before interpreting an optional field. Fields depend on the record type and processing stage; null and absent fields are not zero amounts. Types below describe public record shapes, rather than mandatory properties on every row.\n\nThis inherited collection has no populated public-record shape in the current admitted workflow inventory. Its query entry remains available. No empty collection is treated as evidence about a particular customer enquiry; the actual query determines accessible matches. Its producers and product articles govern any records it creates.",
+  "id": "DB-card_limits",
+  "provenance": {
+    "classification": "interface_documentation",
+    "contains_task_specific_values": false,
+    "kind": "interface_documentation",
+    "source": "Public record shapes plus query/transition implementation; reviewed field semantics"
+  },
+  "title": "Database reference: card_limits",
+  "topic": "Database interface"
+}

payment/data/knowledge/DB-card_loss_cases.json

@@ -0,0 +1,13 @@
+{
+  "applicability": "Shared Payment database interface; all tasks use the same dictionary",
+  "content": "# card_loss_cases\n\nCard loss cases records in Operations Desk. Product articles define their operational scope.\n\nRead this collection using `search_records(resource=\"card_loss_cases\", filters={}, cursor=0, limit=20)` or `get_record(resource=\"card_loss_cases\", record_id=\"<returned id>\")`.\n\n**Filters:** exact scalar equality; in, contains, gte and lte operator objects on supported top-level fields. See DB-query-syntax for type and null behavior.\n\nSearch returns selected summary fields, so omission from a summary is not proof of absence from the complete record. Read detail before interpreting an optional field. Fields depend on the record type and processing stage; null and absent fields are not zero amounts. Types below describe public record shapes, rather than mandatory properties on every row.\n\n## Fields\n\n| Field | Observed public types | Search use | Meaning |\n| --- | --- | --- | --- |\n| `authorization_minor` | integer | Top-level filter | Authorization amount, in integer minor units of the applicable currency. Inspect this record type and its source/receipt to distinguish declared values from actual movements. |\n| `billing_account_id` | string | Top-level filter | Billing account id: opaque identifier reference. Its target depends on the containing record/operation; do not infer a collection merely by pluralizing the field name. Explicit joins are listed separately. |\n| `business_area` | string | Top-level filter | Business area: public attribute of this record type. The associated service article defines its operational use. |\n| `cleared_minor` | integer | Top-level filter | Cleared amount, in integer minor units of the applicable currency. Inspect this record type and its source/receipt to distinguish declared values from actual movements. |\n| `commercial_reference` | string | Top-level filter | Reference supplied by a commercial source; use the source and period when matching evidence. |\n| `filing_deadline_minute` | integer | Top-level filter | Filing deadline minute: logical minute or duration, as indicated by the field name; compare with get_clock and the applicable event/validity terms. |\n| `filing_fee_minor` | integer | Top-level filter | Filing fee amount, in integer minor units of the applicable currency. Inspect this record type and its source/receipt to distinguish declared values from actual movements. |\n| `id` | string | Top-level filter | Opaque record key used by get_record; obtain it from returned records or explicit references. It is not an amount, date or proof of business identity. |\n| `name` | string | Top-level filter | Human-readable name. Names need not be unique; exact filters are case-sensitive. |\n| `review_minute` | integer | Top-level filter | Review minute: logical minute or duration, as indicated by the field name; compare with get_clock and the applicable event/validity terms. |\n| `scope` | string | Top-level filter | Access namespace for the record. It is not a customer name or a universal case_id. |\n| `settlement_delay` | integer | Top-level filter | Settlement delay: public attribute of this record type. The associated service article defines its operational use. |\n| `status` | string | Top-level filter | Current state of this particular object. A proposal or submission state is distinct from a posted payment or completed review. Public values represented here: `OPEN`. This list describes the documented records, not an input-validation enum. |\n",
+  "id": "DB-card_loss_cases",
+  "provenance": {
+    "classification": "interface_documentation",
+    "contains_task_specific_values": false,
+    "kind": "interface_documentation",
+    "source": "Public record shapes plus query/transition implementation; reviewed field semantics"
+  },
+  "title": "Database reference: card_loss_cases",
+  "topic": "Database interface"
+}

payment/data/knowledge/DB-cards.json

@@ -0,0 +1,13 @@
+{
+  "applicability": "Shared Payment database interface; all tasks use the same dictionary",
+  "content": "> Inherited interface: no populated public shape in this release's admitted workflow inventory. See DB-inherited-collections and the product entry points in DB-index.\n\n# cards\n\nCards records in CORE and product extensions. Product articles define their operational scope.\n\nRead this collection using `search_records(resource=\"cards\", filters={}, cursor=0, limit=20)` or `get_record(resource=\"cards\", record_id=\"<returned id>\")`.\n\n**Filters:** exact scalar equality; in, contains, gte and lte operator objects on supported top-level fields. See DB-query-syntax for type and null behavior.\n\nSearch returns selected summary fields, so omission from a summary is not proof of absence from the complete record. Read detail before interpreting an optional field. Fields depend on the record type and processing stage; null and absent fields are not zero amounts. Types below describe public record shapes, rather than mandatory properties on every row.\n\nThis inherited collection has no populated public-record shape in the current admitted workflow inventory. Its query entry remains available. No empty collection is treated as evidence about a particular customer enquiry; the actual query determines accessible matches. Its producers and product articles govern any records it creates.",
+  "id": "DB-cards",
+  "provenance": {
+    "classification": "interface_documentation",
+    "contains_task_specific_values": false,
+    "kind": "interface_documentation",
+    "source": "Public record shapes plus query/transition implementation; reviewed field semantics"
+  },
+  "title": "Database reference: cards",
+  "topic": "Database interface"
+}

payment/data/knowledge/DB-claims.json

@@ -0,0 +1,13 @@
+{
+  "applicability": "Shared Payment database interface; all tasks use the same dictionary",
+  "content": "> Inherited interface: no populated public shape in this release's admitted workflow inventory. See DB-inherited-collections and the product entry points in DB-index.\n\n# claims\n\nClaims records in CORE and product extensions. Product articles define their operational scope.\n\nRead this collection using `search_records(resource=\"claims\", filters={}, cursor=0, limit=20)` or `get_record(resource=\"claims\", record_id=\"<returned id>\")`.\n\n**Filters:** exact scalar equality; in, contains, gte and lte operator objects on supported top-level fields. See DB-query-syntax for type and null behavior.\n\nSearch returns selected summary fields, so omission from a summary is not proof of absence from the complete record. Read detail before interpreting an optional field. Fields depend on the record type and processing stage; null and absent fields are not zero amounts. Types below describe public record shapes, rather than mandatory properties on every row.\n\nThis inherited collection has no populated public-record shape in the current admitted workflow inventory. Its query entry remains available. No empty collection is treated as evidence about a particular customer enquiry; the actual query determines accessible matches. Its producers and product articles govern any records it creates.",
+  "id": "DB-claims",
+  "provenance": {
+    "classification": "interface_documentation",
+    "contains_task_specific_values": false,
+    "kind": "interface_documentation",
+    "source": "Public record shapes plus query/transition implementation; reviewed field semantics"
+  },
+  "title": "Database reference: claims",
+  "topic": "Database interface"
+}

payment/data/knowledge/DB-company_profiles.json

@@ -0,0 +1,13 @@
+{
+  "applicability": "Shared Payment database interface; all tasks use the same dictionary",
+  "content": "# company_profiles\n\nCompany profiles records in Operations Desk. Product articles define their operational scope.\n\nRead this collection using `search_records(resource=\"company_profiles\", filters={}, cursor=0, limit=20)` or `get_record(resource=\"company_profiles\", record_id=\"<returned id>\")`.\n\n**Filters:** exact scalar equality; in, contains, gte and lte operator objects on supported top-level fields. See DB-query-syntax for type and null behavior.\n\nSearch returns selected summary fields, so omission from a summary is not proof of absence from the complete record. Read detail before interpreting an optional field. Fields depend on the record type and processing stage; null and absent fields are not zero amounts. Types below describe public record shapes, rather than mandatory properties on every row.\n\n## Fields\n\n| Field | Observed public types | Search use | Meaning |\n| --- | --- | --- | --- |\n| `business_area` | string | Top-level filter | Business area: public attribute of this record type. The associated service article defines its operational use. |\n| `commercial_reference` | string | Top-level filter | Reference supplied by a commercial source; use the source and period when matching evidence. |\n| `id` | string | Top-level filter | Opaque record key used by get_record; obtain it from returned records or explicit references. It is not an amount, date or proof of business identity. |\n| `kind` | string | Top-level filter | Record or service type. Fields and meanings can differ between kinds. Public values represented here: `COMPANY`, `PERSON`. This list describes the documented records, not an input-validation enum. |\n| `legal_name` | string | Top-level filter | Legal name: public attribute of this record type. The associated service article defines its operational use. |\n| `name` | string | Top-level filter | Human-readable name. Names need not be unique; exact filters are case-sensitive. |\n| `openings_remaining` | integer | Top-level filter | Openings remaining: public attribute of this record type. The associated service article defines its operational use. |\n| `published_next_version` | integer | Top-level filter | Published next version: version of the named evidence/object. Check applicability and status along with its version. |\n| `published_revision_minute` | integer | Top-level filter | Published revision minute: logical minute or duration, as indicated by the field name; compare with get_clock and the applicable event/validity terms. |\n| `region` | string | Top-level filter | Region: public attribute of this record type. The associated service article defines its operational use. |\n| `scope` | string | Top-level filter | Access namespace for the record. It is not a customer name or a universal case_id. |\n| `version` | integer | Top-level filter | Version of the underlying record or evidence, not the benchmark release version. |\n",
+  "id": "DB-company_profiles",
+  "provenance": {
+    "classification": "interface_documentation",
+    "contains_task_specific_values": false,
+    "kind": "interface_documentation",
+    "source": "Public record shapes plus query/transition implementation; reviewed field semantics"
+  },
+  "title": "Database reference: company_profiles",
+  "topic": "Database interface"
+}

payment/data/knowledge/DB-compensation_entries.json

@@ -0,0 +1,13 @@
+{
+  "applicability": "Shared Payment database interface; all tasks use the same dictionary",
+  "content": "# compensation_entries\n\nCompensation entries records in Operations Desk. Product articles define their operational scope.\n\nRead this collection using `search_records(resource=\"compensation_entries\", filters={}, cursor=0, limit=20)` or `get_record(resource=\"compensation_entries\", record_id=\"<returned id>\")`.\n\n**Filters:** exact scalar equality; in, contains, gte and lte operator objects on supported top-level fields. See DB-query-syntax for type and null behavior.\n\nSearch returns selected summary fields, so omission from a summary is not proof of absence from the complete record. Read detail before interpreting an optional field. Fields depend on the record type and processing stage; null and absent fields are not zero amounts. Types below describe public record shapes, rather than mandatory properties on every row.\n\n## Fields\n\n| Field | Observed public types | Search use | Meaning |\n| --- | --- | --- | --- |\n| `amount_minor` | integer | Top-level filter | Amount in integer minor currency units. Whether it denotes an instruction, liability or posted movement depends on this record type. |\n| `business_area` | string | Top-level filter | Business area: public attribute of this record type. The associated service article defines its operational use. |\n| `case_id` | string | Top-level filter | Case id: opaque identifier reference. Its target depends on the containing record/operation; do not infer a collection merely by pluralizing the field name. Explicit joins are listed separately. |\n| `commercial_reference` | string | Top-level filter | Reference supplied by a commercial source; use the source and period when matching evidence. |\n| `dispute_id` | string | Top-level filter | Dispute id: opaque identifier reference. Its target depends on the containing record/operation; do not infer a collection merely by pluralizing the field name. Explicit joins are listed separately. |\n| `id` | string | Top-level filter | Opaque record key used by get_record; obtain it from returned records or explicit references. It is not an amount, date or proof of business identity. |\n| `kind` | string | Top-level filter | Record or service type. Fields and meanings can differ between kinds. Public values represented here: `CARD_NETWORK`, `DISPUTE`, `MERCHANT`. This list describes the documented records, not an input-validation enum. |\n| `published_status_updates` | array | Top-level filter | Published status updates: list of the named business attributes or references; inspect all entries relevant to the record. |\n| `received_minute` | integer | Top-level filter | Received minute: logical minute or duration, as indicated by the field name; compare with get_clock and the applicable event/validity terms. |\n| `scope` | string | Top-level filter | Access namespace for the record. It is not a customer name or a universal case_id. |\n| `shipment_reference` | string | Top-level filter | Shipment reference: commercial reference, which may differ from the storage id. Match using the documented reference field and business context. |\n| `status` | string | Top-level filter | Current state of this particular object. A proposal or submission state is distinct from a posted payment or completed review. Public values represented here: `FAILED`, `PROMISED`, `PROVISIONAL`, `SETTLED`. This list describes the documented records, not an input-validation enum. |\n",
+  "id": "DB-compensation_entries",
+  "provenance": {
+    "classification": "interface_documentation",
+    "contains_task_specific_values": false,
+    "kind": "interface_documentation",
+    "source": "Public record shapes plus query/transition implementation; reviewed field semantics"
+  },
+  "title": "Database reference: compensation_entries",
+  "topic": "Database interface"
+}

payment/data/knowledge/DB-covenants.json

@@ -0,0 +1,13 @@
+{
+  "applicability": "Shared Payment database interface; all tasks use the same dictionary",
+  "content": "> Inherited interface: no populated public shape in this release's admitted workflow inventory. See DB-inherited-collections and the product entry points in DB-index.\n\n# covenants\n\nCovenants records in CORE and product extensions. Product articles define their operational scope.\n\nRead this collection using `search_records(resource=\"covenants\", filters={}, cursor=0, limit=20)` or `get_record(resource=\"covenants\", record_id=\"<returned id>\")`.\n\n**Filters:** exact scalar equality; in, contains, gte and lte operator objects on supported top-level fields. See DB-query-syntax for type and null behavior.\n\nSearch returns selected summary fields, so omission from a summary is not proof of absence from the complete record. Read detail before interpreting an optional field. Fields depend on the record type and processing stage; null and absent fields are not zero amounts. Types below describe public record shapes, rather than mandatory properties on every row.\n\nThis inherited collection has no populated public-record shape in the current admitted workflow inventory. Its query entry remains available. No empty collection is treated as evidence about a particular customer enquiry; the actual query determines accessible matches. Its producers and product articles govern any records it creates.",
+  "id": "DB-covenants",
+  "provenance": {
+    "classification": "interface_documentation",
+    "contains_task_specific_values": false,
+    "kind": "interface_documentation",
+    "source": "Public record shapes plus query/transition implementation; reviewed field semantics"
+  },
+  "title": "Database reference: covenants",
+  "topic": "Database interface"
+}

payment/data/knowledge/DB-credit_notes.json

@@ -0,0 +1,13 @@
+{
+  "applicability": "Shared Payment database interface; all tasks use the same dictionary",
+  "content": "> Inherited interface: no populated public shape in this release's admitted workflow inventory. See DB-inherited-collections and the product entry points in DB-index.\n\n# credit_notes\n\nCredit notes records in CORE and product extensions. Product articles define their operational scope.\n\nRead this collection using `search_records(resource=\"credit_notes\", filters={}, cursor=0, limit=20)` or `get_record(resource=\"credit_notes\", record_id=\"<returned id>\")`.\n\n**Filters:** exact scalar equality; in, contains, gte and lte operator objects on supported top-level fields. See DB-query-syntax for type and null behavior.\n\nSearch returns selected summary fields, so omission from a summary is not proof of absence from the complete record. Read detail before interpreting an optional field. Fields depend on the record type and processing stage; null and absent fields are not zero amounts. Types below describe public record shapes, rather than mandatory properties on every row.\n\nThis inherited collection has no populated public-record shape in the current admitted workflow inventory. Its query entry remains available. No empty collection is treated as evidence about a particular customer enquiry; the actual query determines accessible matches. Its producers and product articles govern any records it creates.",
+  "id": "DB-credit_notes",
+  "provenance": {
+    "classification": "interface_documentation",
+    "contains_task_specific_values": false,
+    "kind": "interface_documentation",
+    "source": "Public record shapes plus query/transition implementation; reviewed field semantics"
+  },
+  "title": "Database reference: credit_notes",
+  "topic": "Database interface"
+}

payment/data/knowledge/DB-credit_redemptions.json

@@ -0,0 +1,13 @@
+{
+  "applicability": "Shared Payment database interface; all tasks use the same dictionary",
+  "content": "> Inherited interface: no populated public shape in this release's admitted workflow inventory. See DB-inherited-collections and the product entry points in DB-index.\n\n# credit_redemptions\n\nCredit redemptions records in CORE and product extensions. Product articles define their operational scope.\n\nRead this collection using `search_records(resource=\"credit_redemptions\", filters={}, cursor=0, limit=20)` or `get_record(resource=\"credit_redemptions\", record_id=\"<returned id>\")`.\n\n**Filters:** exact scalar equality; in, contains, gte and lte operator objects on supported top-level fields. See DB-query-syntax for type and null behavior.\n\nSearch returns selected summary fields, so omission from a summary is not proof of absence from the complete record. Read detail before interpreting an optional field. Fields depend on the record type and processing stage; null and absent fields are not zero amounts. Types below describe public record shapes, rather than mandatory properties on every row.\n\nThis inherited collection has no populated public-record shape in the current admitted workflow inventory. Its query entry remains available. No empty collection is treated as evidence about a particular customer enquiry; the actual query determines accessible matches. Its producers and product articles govern any records it creates.",
+  "id": "DB-credit_redemptions",
+  "provenance": {
+    "classification": "interface_documentation",
+    "contains_task_specific_values": false,
+    "kind": "interface_documentation",
+    "source": "Public record shapes plus query/transition implementation; reviewed field semantics"
+  },
+  "title": "Database reference: credit_redemptions",
+  "topic": "Database interface"
+}

payment/data/knowledge/DB-currency_obligations.json

@@ -0,0 +1,13 @@
+{
+  "applicability": "Shared Payment database interface; all tasks use the same dictionary",
+  "content": "# currency_obligations\n\nCurrency obligations records in Operations Desk. Product articles define their operational scope.\n\nRead this collection using `search_records(resource=\"currency_obligations\", filters={}, cursor=0, limit=20)` or `get_record(resource=\"currency_obligations\", record_id=\"<returned id>\")`.\n\n**Filters:** exact scalar equality; in, contains, gte and lte operator objects on supported top-level fields. See DB-query-syntax for type and null behavior.\n\nSearch returns selected summary fields, so omission from a summary is not proof of absence from the complete record. Read detail before interpreting an optional field. Fields depend on the record type and processing stage; null and absent fields are not zero amounts. Types below describe public record shapes, rather than mandatory properties on every row.\n\n## Fields\n\n| Field | Observed public types | Search use | Meaning |\n| --- | --- | --- | --- |\n| `amount_minor` | integer | Top-level filter | Amount in integer minor currency units. Whether it denotes an instruction, liability or posted movement depends on this record type. |\n| `beneficiary_reference` | string | Top-level filter | Beneficiary reference: commercial reference, which may differ from the storage id. Match using the documented reference field and business context. |\n| `business_area` | string | Top-level filter | Business area: public attribute of this record type. The associated service article defines its operational use. |\n| `commercial_reference` | string | Top-level filter | Reference supplied by a commercial source; use the source and period when matching evidence. |\n| `currency` | string | Top-level filter | Currency code for the associated monetary fields. Preserve separate currency balances. Public values represented here: `EUR`, `GBP`. This list describes the documented records, not an input-validation enum. |\n| `delivery_fee_minor` | integer | Top-level filter | Delivery fee amount, in integer minor units of the applicable currency. Inspect this record type and its source/receipt to distinguish declared values from actual movements. |\n| `due_minute` | integer | Top-level filter | Due minute: logical minute or duration, as indicated by the field name; compare with get_clock and the applicable event/validity terms. |\n| `id` | string | Top-level filter | Opaque record key used by get_record; obtain it from returned records or explicit references. It is not an amount, date or proof of business identity. |\n| `scope` | string | Top-level filter | Access namespace for the record. It is not a customer name or a universal case_id. |\n",
+  "id": "DB-currency_obligations",
+  "provenance": {
+    "classification": "interface_documentation",
+    "contains_task_specific_values": false,
+    "kind": "interface_documentation",
+    "source": "Public record shapes plus query/transition implementation; reviewed field semantics"
+  },
+  "title": "Database reference: currency_obligations",
+  "topic": "Database interface"
+}

payment/data/knowledge/DB-desk_accounts.json

@@ -0,0 +1,13 @@
+{
+  "applicability": "Shared Payment database interface; all tasks use the same dictionary",
+  "content": "# desk_accounts\n\nOperations Desk accounts, their legal owner and currency wallets.\n\nRead this collection using `search_records(resource=\"desk_accounts\", filters={}, cursor=0, limit=20)` or `get_record(resource=\"desk_accounts\", record_id=\"<returned id>\")`.\n\n**Filters:** exact scalar equality; in, contains, gte and lte operator objects on supported top-level fields. See DB-query-syntax for type and null behavior.\n\nSearch returns selected summary fields, so omission from a summary is not proof of absence from the complete record. Read detail before interpreting an optional field. Fields depend on the record type and processing stage; null and absent fields are not zero amounts. Types below describe public record shapes, rather than mandatory properties on every row.\n\n## Explicit identifier relationships\n\n- `entity_id` references a `entities` record ID when present. See `DB-entities`.\n- `profile_id` references a `rail_profiles` record ID when present. See `DB-rail_profiles`.\n\nCommercial references can require entity, period or issuer matching. An ID relationship does not imply that every related record repeats the same case_id.\n\n## Fields\n\n| Field | Observed public types | Search use | Meaning |\n| --- | --- | --- | --- |\n| `business_area` | string | Top-level filter | Business area: public attribute of this record type. The associated service article defines its operational use. |\n| `cash_control` | string | Top-level filter | Cash control: public attribute of this record type. The associated service article defines its operational use. |\n| `charged_issuance_fee_minor` | integer | Top-level filter | Charged issuance fee amount, in integer minor units of the applicable currency. Inspect this record type and its source/receipt to distinguish declared values from actual movements. |\n| `closed_minute` | integer | Top-level filter | Closed minute: logical minute or duration, as indicated by the field name; compare with get_clock and the applicable event/validity terms. |\n| `commercial_reference` | string | Top-level filter | Reference supplied by a commercial source; use the source and period when matching evidence. |\n| `currency` | string | Top-level filter | Currency code for the associated monetary fields. Preserve separate currency balances. Public values represented here: `USD`. This list describes the documented records, not an input-validation enum. |\n| `entity_id` | string | Top-level filter | Record ID in entities. Use get_record on that collection; the link does not make other rows implicitly belong to the same object. |\n| `holder_name` | string | Top-level filter | Holder name: public attribute of this record type. The associated service article defines its operational use. |\n| `id` | string | Top-level filter | Opaque record key used by get_record; obtain it from returned records or explicit references. It is not an amount, date or proof of business identity. |\n| `name` | string | Top-level filter | Human-readable name. Names need not be unique; exact filters are case-sensitive. |\n| `opened_minute` | integer | Top-level filter | Opened minute: logical minute or duration, as indicated by the field name; compare with get_clock and the applicable event/validity terms. |\n| `profile_id` | string | Top-level filter | Record ID in rail_profiles. Use get_record on that collection; the link does not make other rows implicitly belong to the same object. |\n| `scope` | string | Top-level filter | Access namespace for the record. It is not a customer name or a universal case_id. |\n| `status` | string | Top-level filter | Current state of this particular object. A proposal or submission state is distinct from a posted payment or completed review. Public values represented here: `CLOSED`, `OPEN`. This list describes the documented records, not an input-validation enum. |\n| `wallet` | object | Object value; see collection filter rules | Map from currency code to integer minor-unit cash balance. |\n\n\n## Product entry points\n\n| Product / record model | Starting collection | Related records |\n| --- | --- | --- |\n| Trade Services and typed Payment services | service_cases | service_records by case_id; service_bookings for executed operations. Parent kind selects DB-service-<kind>. |\n| Operations Desk: commercial receivables | desk_portfolios | trade_invoices, remittances, remittance_advice and invoice_allocations. |\n| Operations Desk: corporate onboarding | onboarding_applications, entities | company_profiles, ownership_edges, evidence_bundles and submissions. |\n| Operations Desk: collection rails and account exit | rail_sites, desk_accounts | rail_profiles, rail_bindings, desk_services and billing_instances. |\n| Operations Desk: treasury and card loss | treasury_obligations, card_loss_cases | treasury_mandates, loss_components, compensation_entries and card_disputes. |\n| Operations Desk: restricted funds and batch payments | restricted_lots, payment_batch_items | fund_restrictions, receivable_rights, purpose_instructions, submission_attempts and bank_receipts. |\n| Operations Desk: currency delivery and tax | currency_obligations, tax_transfers | fx_routes, fx_quotes, fx_trades, tax_periods, tax_allocations and message_amendments. |\n| Reserve funding facilities | reserve_routes | reserve_disbursements and the explicitly referenced destination desk_accounts. |\n| Joint capital for typed services | joint_agreements | joint_sources, joint_routes and joint_fundings by agreement_id. |\n| Contract links between typed services | link_contracts | primary_case_id and secondary_case_id reference service_cases. |\n\nThese are distinct record models. service_cases is not a universal directory for Operations Desk accounts, invoices or onboarding. A service_cases query with no results does not require trying its sibling collections. Use the product's documented starting collection. desk_accounts holds Operations Desk wallets; generic accounts is a separate inherited product interface. A title or ordinary customer name is not an internal record ID.\n",
+  "id": "DB-desk_accounts",
+  "provenance": {
+    "classification": "interface_documentation",
+    "contains_task_specific_values": false,
+    "kind": "interface_documentation",
+    "source": "Public record shapes plus query/transition implementation; reviewed field semantics"
+  },
+  "title": "Database reference: desk_accounts",
+  "topic": "Database interface"
+}

payment/data/knowledge/DB-desk_journal.json

@@ -0,0 +1,13 @@
+{
+  "applicability": "Shared Payment database interface; all tasks use the same dictionary",
+  "content": "# desk_journal\n\nDesk journal records in Operations Desk. Product articles define their operational scope.\n\nRead this collection using `search_records(resource=\"desk_journal\", filters={}, cursor=0, limit=20)` or `get_record(resource=\"desk_journal\", record_id=\"<returned id>\")`.\n\n**Filters:** exact scalar equality; in, contains, gte and lte operator objects on supported top-level fields. See DB-query-syntax for type and null behavior.\n\nSearch returns selected summary fields, so omission from a summary is not proof of absence from the complete record. Read detail before interpreting an optional field. Fields depend on the record type and processing stage; null and absent fields are not zero amounts. Types below describe public record shapes, rather than mandatory properties on every row.\n\n## Fields\n\n| Field | Observed public types | Search use | Meaning |\n| --- | --- | --- | --- |\n| `account_id` | string | Top-level filter | Account id: opaque identifier reference. Its target depends on the containing record/operation; do not infer a collection merely by pluralizing the field name. Explicit joins are listed separately. |\n| `business_area` | string | Top-level filter | Business area: public attribute of this record type. The associated service article defines its operational use. |\n| `currency` | string | Top-level filter | Currency code for the associated monetary fields. Preserve separate currency balances. Public values represented here: `EUR`, `GBP`, `USD`. This list describes the documented records, not an input-validation enum. |\n| `delta_minor` | integer | Top-level filter | Delta amount, in integer minor units of the applicable currency. Inspect this record type and its source/receipt to distinguish declared values from actual movements. |\n| `id` | string | Top-level filter | Opaque record key used by get_record; obtain it from returned records or explicit references. It is not an amount, date or proof of business identity. |\n| `minute` | integer | Top-level filter | Logical event or posting minute measured from the session clock, not wall-clock runtime. |\n| `reason` | string | Top-level filter | Reason: public attribute of this record type. The associated service article defines its operational use. |\n| `reference` | string | Top-level filter | Business reference on this object; its uniqueness depends on the issuer, entity and period. |\n| `scope` | string | Top-level filter | Access namespace for the record. It is not a customer name or a universal case_id. |\n",
+  "id": "DB-desk_journal",
+  "provenance": {
+    "classification": "interface_documentation",
+    "contains_task_specific_values": false,
+    "kind": "interface_documentation",
+    "source": "Public record shapes plus query/transition implementation; reviewed field semantics"
+  },
+  "title": "Database reference: desk_journal",
+  "topic": "Database interface"
+}

payment/data/knowledge/DB-desk_payments.json

@@ -0,0 +1,13 @@
+{
+  "applicability": "Shared Payment database interface; all tasks use the same dictionary",
+  "content": "# desk_payments\n\nDesk payments records in Operations Desk. Product articles define their operational scope.\n\nRead this collection using `search_records(resource=\"desk_payments\", filters={}, cursor=0, limit=20)` or `get_record(resource=\"desk_payments\", record_id=\"<returned id>\")`.\n\n**Filters:** exact scalar equality; in, contains, gte and lte operator objects on supported top-level fields. See DB-query-syntax for type and null behavior.\n\nSearch returns selected summary fields, so omission from a summary is not proof of absence from the complete record. Read detail before interpreting an optional field. Fields depend on the record type and processing stage; null and absent fields are not zero amounts. Types below describe public record shapes, rather than mandatory properties on every row.\n\n## Fields\n\n| Field | Observed public types | Search use | Meaning |\n| --- | --- | --- | --- |\n| `account_id` | string | Top-level filter | Account id: opaque identifier reference. Its target depends on the containing record/operation; do not infer a collection merely by pluralizing the field name. Explicit joins are listed separately. |\n| `allocations` | object | Object value; see collection filter rules | Map identifying sources/targets and assigned amounts; the containing collection determines the key type. joint_fundings keys are joint_sources IDs. |\n| `amount_minor` | integer | Top-level filter | Amount in integer minor currency units. Whether it denotes an instruction, liability or posted movement depends on this record type. |\n| `business_area` | string | Top-level filter | Business area: public attribute of this record type. The associated service article defines its operational use. |\n| `currency` | string | Top-level filter | Currency code for the associated monetary fields. Preserve separate currency balances. Public values represented here: `EUR`, `GBP`, `USD`. This list describes the documented records, not an input-validation enum. |\n| `executor_id` | string | Top-level filter | Executor id: opaque identifier reference. Its target depends on the containing record/operation; do not infer a collection merely by pluralizing the field name. Explicit joins are listed separately. |\n| `fee_minor` | integer | Top-level filter | Charge for this object/operation in minor units; use the applicable product terms for when it is incurred. |\n| `id` | string | Top-level filter | Opaque record key used by get_record; obtain it from returned records or explicit references. It is not an amount, date or proof of business identity. |\n| `instruction_id` | string | Top-level filter | Instruction id: opaque identifier reference. Its target depends on the containing record/operation; do not infer a collection merely by pluralizing the field name. Explicit joins are listed separately. |\n| `kind` | string | Top-level filter | Record or service type. Fields and meanings can differ between kinds. Public values represented here: `CURRENCY`, `PURPOSE`, `TREASURY`. This list describes the documented records, not an input-validation enum. |\n| `mandate_id` | string | Top-level filter | Mandate id: opaque identifier reference. Its target depends on the containing record/operation; do not infer a collection merely by pluralizing the field name. Explicit joins are listed separately. |\n| `mandate_version` | integer | Top-level filter | Mandate version: version of the named evidence/object. Check applicability and status along with its version. |\n| `minute` | integer | Top-level filter | Logical event or posting minute measured from the session clock, not wall-clock runtime. |\n| `obligation_id` | string | Top-level filter | Obligation id: opaque identifier reference. Its target depends on the containing record/operation; do not infer a collection merely by pluralizing the field name. Explicit joins are listed separately. |\n| `scope` | string | Top-level filter | Access namespace for the record. It is not a customer name or a universal case_id. |\n| `status` | string | Top-level filter | Current state of this particular object. A proposal or submission state is distinct from a posted payment or completed review. Public values represented here: `SETTLED`. This list describes the documented records, not an input-validation enum. |\n",
+  "id": "DB-desk_payments",
+  "provenance": {
+    "classification": "interface_documentation",
+    "contains_task_specific_values": false,
+    "kind": "interface_documentation",
+    "source": "Public record shapes plus query/transition implementation; reviewed field semantics"
+  },
+  "title": "Database reference: desk_payments",
+  "topic": "Database interface"
+}

payment/data/knowledge/DB-desk_portfolios.json

@@ -0,0 +1,13 @@
+{
+  "applicability": "Shared Payment database interface; all tasks use the same dictionary",
+  "content": "# desk_portfolios\n\nCommercial receivables portfolios.\n\nRead this collection using `search_records(resource=\"desk_portfolios\", filters={}, cursor=0, limit=20)` or `get_record(resource=\"desk_portfolios\", record_id=\"<returned id>\")`.\n\n**Filters:** exact scalar equality; in, contains, gte and lte operator objects on supported top-level fields. See DB-query-syntax for type and null behavior.\n\nSearch returns selected summary fields, so omission from a summary is not proof of absence from the complete record. Read detail before interpreting an optional field. Fields depend on the record type and processing stage; null and absent fields are not zero amounts. Types below describe public record shapes, rather than mandatory properties on every row.\n\n## Explicit identifier relationships\n\n- `account_id` references a `desk_accounts` record ID when present. See `DB-desk_accounts`.\n\nCommercial references can require entity, period or issuer matching. An ID relationship does not imply that every related record repeats the same case_id.\n\n## Fields\n\n| Field | Observed public types | Search use | Meaning |\n| --- | --- | --- | --- |\n| `business_area` | string | Top-level filter | Business area: public attribute of this record type. The associated service article defines its operational use. |\n| `closed_minute` | integer | Top-level filter | Closed minute: logical minute or duration, as indicated by the field name; compare with get_clock and the applicable event/validity terms. |\n| `commercial_reference` | string | Top-level filter | Reference supplied by a commercial source; use the source and period when matching evidence. |\n| `currency` | string | Top-level filter | Currency code for the associated monetary fields. Preserve separate currency balances. Public values represented here: `USD`. This list describes the documented records, not an input-validation enum. |\n| `id` | string | Top-level filter | Opaque record key used by get_record; obtain it from returned records or explicit references. It is not an amount, date or proof of business identity. |\n| `name` | string | Top-level filter | Human-readable name. Names need not be unique; exact filters are case-sensitive. |\n| `scope` | string | Top-level filter | Access namespace for the record. It is not a customer name or a universal case_id. |\n| `status` | string | Top-level filter | Current state of this particular object. A proposal or submission state is distinct from a posted payment or completed review. Public values represented here: `CLOSED`, `OPEN`. This list describes the documented records, not an input-validation enum. |\n\n\n## Product entry points\n\n| Product / record model | Starting collection | Related records |\n| --- | --- | --- |\n| Trade Services and typed Payment services | service_cases | service_records by case_id; service_bookings for executed operations. Parent kind selects DB-service-<kind>. |\n| Operations Desk: commercial receivables | desk_portfolios | trade_invoices, remittances, remittance_advice and invoice_allocations. |\n| Operations Desk: corporate onboarding | onboarding_applications, entities | company_profiles, ownership_edges, evidence_bundles and submissions. |\n| Operations Desk: collection rails and account exit | rail_sites, desk_accounts | rail_profiles, rail_bindings, desk_services and billing_instances. |\n| Operations Desk: treasury and card loss | treasury_obligations, card_loss_cases | treasury_mandates, loss_components, compensation_entries and card_disputes. |\n| Operations Desk: restricted funds and batch payments | restricted_lots, payment_batch_items | fund_restrictions, receivable_rights, purpose_instructions, submission_attempts and bank_receipts. |\n| Operations Desk: currency delivery and tax | currency_obligations, tax_transfers | fx_routes, fx_quotes, fx_trades, tax_periods, tax_allocations and message_amendments. |\n| Reserve funding facilities | reserve_routes | reserve_disbursements and the explicitly referenced destination desk_accounts. |\n| Joint capital for typed services | joint_agreements | joint_sources, joint_routes and joint_fundings by agreement_id. |\n| Contract links between typed services | link_contracts | primary_case_id and secondary_case_id reference service_cases. |\n\nThese are distinct record models. service_cases is not a universal directory for Operations Desk accounts, invoices or onboarding. A service_cases query with no results does not require trying its sibling collections. Use the product's documented starting collection. desk_accounts holds Operations Desk wallets; generic accounts is a separate inherited product interface. A title or ordinary customer name is not an internal record ID.\n",
+  "id": "DB-desk_portfolios",
+  "provenance": {
+    "classification": "interface_documentation",
+    "contains_task_specific_values": false,
+    "kind": "interface_documentation",
+    "source": "Public record shapes plus query/transition implementation; reviewed field semantics"
+  },
+  "title": "Database reference: desk_portfolios",
+  "topic": "Database interface"
+}

payment/data/knowledge/DB-desk_services.json

@@ -0,0 +1,13 @@
+{
+  "applicability": "Shared Payment database interface; all tasks use the same dictionary",
+  "content": "# desk_services\n\nDesk services records in Operations Desk. Product articles define their operational scope.\n\nRead this collection using `search_records(resource=\"desk_services\", filters={}, cursor=0, limit=20)` or `get_record(resource=\"desk_services\", record_id=\"<returned id>\")`.\n\n**Filters:** exact scalar equality; in, contains, gte and lte operator objects on supported top-level fields. See DB-query-syntax for type and null behavior.\n\nSearch returns selected summary fields, so omission from a summary is not proof of absence from the complete record. Read detail before interpreting an optional field. Fields depend on the record type and processing stage; null and absent fields are not zero amounts. Types below describe public record shapes, rather than mandatory properties on every row.\n\n## Fields\n\n| Field | Observed public types | Search use | Meaning |\n| --- | --- | --- | --- |\n| `billing_account` | string | Top-level filter | Billing account: public attribute of this record type. The associated service article defines its operational use. |\n| `business_area` | string | Top-level filter | Business area: public attribute of this record type. The associated service article defines its operational use. |\n| `commercial_reference` | string | Top-level filter | Reference supplied by a commercial source; use the source and period when matching evidence. |\n| `currency` | string | Top-level filter | Currency code for the associated monetary fields. Preserve separate currency balances. Public values represented here: `USD`. This list describes the documented records, not an input-validation enum. |\n| `entity_id` | string | Top-level filter | Entity id: opaque identifier reference. Its target depends on the containing record/operation; do not infer a collection merely by pluralizing the field name. Explicit joins are listed separately. |\n| `id` | string | Top-level filter | Opaque record key used by get_record; obtain it from returned records or explicit references. It is not an amount, date or proof of business identity. |\n| `migration_delay` | integer | Top-level filter | Migration delay: public attribute of this record type. The associated service article defines its operational use. |\n| `name` | string | Top-level filter | Human-readable name. Names need not be unique; exact filters are case-sensitive. |\n| `notice_delay` | integer | Top-level filter | Notice delay: public attribute of this record type. The associated service article defines its operational use. |\n| `scope` | string | Top-level filter | Access namespace for the record. It is not a customer name or a universal case_id. |\n| `status` | string | Top-level filter | Current state of this particular object. A proposal or submission state is distinct from a posted payment or completed review. Public values represented here: `ACTIVE`, `TERMINATED`. This list describes the documented records, not an input-validation enum. |\n| `terminated_minute` | integer | Top-level filter | Terminated minute: logical minute or duration, as indicated by the field name; compare with get_clock and the applicable event/validity terms. |\n",
+  "id": "DB-desk_services",
+  "provenance": {
+    "classification": "interface_documentation",
+    "contains_task_specific_values": false,
+    "kind": "interface_documentation",
+    "source": "Public record shapes plus query/transition implementation; reviewed field semantics"
+  },
+  "title": "Database reference: desk_services",
+  "topic": "Database interface"
+}

payment/data/knowledge/DB-entities.json

@@ -0,0 +1,13 @@
+{
+  "applicability": "Shared Payment database interface; all tasks use the same dictionary",
+  "content": "# entities\n\nRegistered legal entities, registration references and legal-information versions.\n\nRead this collection using `search_records(resource=\"entities\", filters={}, cursor=0, limit=20)` or `get_record(resource=\"entities\", record_id=\"<returned id>\")`.\n\n**Filters:** exact scalar equality; in, contains, gte and lte operator objects on supported top-level fields. See DB-query-syntax for type and null behavior.\n\nSearch returns selected summary fields, so omission from a summary is not proof of absence from the complete record. Read detail before interpreting an optional field. Fields depend on the record type and processing stage; null and absent fields are not zero amounts. Types below describe public record shapes, rather than mandatory properties on every row.\n\n## Fields\n\n| Field | Observed public types | Search use | Meaning |\n| --- | --- | --- | --- |\n| `business_area` | string | Top-level filter | Business area: public attribute of this record type. The associated service article defines its operational use. |\n| `commercial_reference` | string | Top-level filter | Reference supplied by a commercial source; use the source and period when matching evidence. |\n| `id` | string | Top-level filter | Opaque record key used by get_record; obtain it from returned records or explicit references. It is not an amount, date or proof of business identity. |\n| `legal_name` | string | Top-level filter | Legal name: public attribute of this record type. The associated service article defines its operational use. |\n| `region` | string | Top-level filter | Region: public attribute of this record type. The associated service article defines its operational use. |\n| `registration_number` | string | Top-level filter | Registration number: public attribute of this record type. The associated service article defines its operational use. |\n| `scope` | string | Top-level filter | Access namespace for the record. It is not a customer name or a universal case_id. |\n| `version` | integer | Top-level filter | Version of the underlying record or evidence, not the benchmark release version. |\n",
+  "id": "DB-entities",
+  "provenance": {
+    "classification": "interface_documentation",
+    "contains_task_specific_values": false,
+    "kind": "interface_documentation",
+    "source": "Public record shapes plus query/transition implementation; reviewed field semantics"
+  },
+  "title": "Database reference: entities",
+  "topic": "Database interface"
+}

payment/data/knowledge/DB-events.json

@@ -0,0 +1,13 @@
+{
+  "applicability": "Shared Payment database interface; all tasks use the same dictionary",
+  "content": "# events\n\nScheduled logical events. Event payloads are not completed bank outcomes.\n\nRead this collection using `search_records(resource=\"events\", filters={}, cursor=0, limit=20)` or `get_record(resource=\"events\", record_id=\"<returned id>\")`.\n\n**Filters:** exact scalar equality; in, contains, gte and lte operator objects on supported top-level fields. See DB-query-syntax for type and null behavior.\n\nSearch returns selected summary fields, so omission from a summary is not proof of absence from the complete record. Read detail before interpreting an optional field. Fields depend on the record type and processing stage; null and absent fields are not zero amounts. Types below describe public record shapes, rather than mandatory properties on every row.\n\n## Fields\n\n| Field | Observed public types | Search use | Meaning |\n| --- | --- | --- | --- |\n| `amount_minor` | integer | Top-level filter | Amount in integer minor currency units. Whether it denotes an instruction, liability or posted movement depends on this record type. |\n| `business_area` | string | Top-level filter | Business area: public attribute of this record type. The associated service article defines its operational use. |\n| `commercial_reference` | string | Top-level filter | Reference supplied by a commercial source; use the source and period when matching evidence. |\n| `due_minute` | integer | Top-level filter | Due minute: logical minute or duration, as indicated by the field name; compare with get_clock and the applicable event/validity terms. |\n| `event_category` | string | Top-level filter | Event category: public attribute of this record type. The associated service article defines its operational use. |\n| `id` | string | Top-level filter | Opaque record key used by get_record; obtain it from returned records or explicit references. It is not an amount, date or proof of business identity. |\n| `kind` | string | Top-level filter | Record or service type. Fields and meanings can differ between kinds. Public values represented here: `actual_collections_event`, `authority_event`, `billing_event`, `card_reconciliation_event`, `certificate_event`, `consolidation_event`, `contingent_net_event`, `continuous_guarantees_event`, `credit_event`, `dated_collateral_event`, `debit_event`, `desk_account_return`, `desk_advice`, `desk_attempt_receipt`, `desk_batch_settlement`, `desk_bill_accept`, `desk_bill_debit`, `desk_billing_move`, `desk_dispute_settle`, `desk_dispute_window`, `desk_document_available`, `desk_fx_revision`, `desk_fx_settle`, `desk_mandate_effective`, `desk_mandate_revision`, `desk_message_ack`, `desk_onboarding_review`, `desk_profile_revision`, `desk_rail_test`, `desk_rail_validation`, `desk_refund_receipt`, `desk_reserve_assessment`, `desk_restriction_release`, `desk_right_release`, `desk_sender_revision`, `desk_service_stop`, `desk_tax_cutoff`, `desk_tax_post`, `discount_credit_event`, `distribution_event`, `entitlement_event`, `escrow_event`, `expense_event`, `factoring_event`, `forward_event`, `handling_event`, `insurance_event`, `interest_event`, `license_event`, `loan_servicing_event`, `maturing_refund_reserves_event`, `netting_event`, `origin_currency_refunds_event`, `overlapping_remedies_event`, `payment_acquirer_batch_close_event`, `payment_authentication_binding_event`, `payment_cheque_stop_and_replacement_event`, `payment_cross_calendar_delivery_event`, `payment_group_purchase_commitment_event`, `payment_installment_return_event`, `payment_marketplace_split_refund_event`, `payment_split_capture_event`, `payment_stored_value_restitution_event`, `payment_subscription_proration_event`, `payroll_event`, `period_coverage_event`, `revised_tolerances_event`, `sync_event`, `tiered_deposit_calendar_event`, `title_window_event`, `trade_source_receipt`, `windowed_payment_recovery_event`. This list describes the documented records, not an input-validation enum. |\n| `name` | string | Top-level filter | Human-readable name. Names need not be unique; exact filters are case-sensitive. |\n| `reference` | string | Top-level filter | Business reference on this object; its uniqueness depends on the issuer, entity and period. |\n| `scope` | string | Top-level filter | Access namespace for the record. It is not a customer name or a universal case_id. |\n| `status` | string | Top-level filter | Current state of this particular object. A proposal or submission state is distinct from a posted payment or completed review. Public values represented here: `COMPLETED`, `SCHEDULED`. This list describes the documented records, not an input-validation enum. |\n| `target_id` | string | Top-level filter | Target id: opaque identifier reference. Its target depends on the containing record/operation; do not infer a collection merely by pluralizing the field name. Explicit joins are listed separately. |\n",
+  "id": "DB-events",
+  "provenance": {
+    "classification": "interface_documentation",
+    "contains_task_specific_values": false,
+    "kind": "interface_documentation",
+    "source": "Public record shapes plus query/transition implementation; reviewed field semantics"
+  },
+  "title": "Database reference: events",
+  "topic": "Database interface"
+}

payment/data/knowledge/DB-evidence_bundles.json

@@ -0,0 +1,13 @@
+{
+  "applicability": "Shared Payment database interface; all tasks use the same dictionary",
+  "content": "# evidence_bundles\n\nEvidence bundles records in Operations Desk. Product articles define their operational scope.\n\nRead this collection using `search_records(resource=\"evidence_bundles\", filters={}, cursor=0, limit=20)` or `get_record(resource=\"evidence_bundles\", record_id=\"<returned id>\")`.\n\n**Filters:** exact scalar equality; in, contains, gte and lte operator objects on supported top-level fields. See DB-query-syntax for type and null behavior.\n\nSearch returns selected summary fields, so omission from a summary is not proof of absence from the complete record. Read detail before interpreting an optional field. Fields depend on the record type and processing stage; null and absent fields are not zero amounts. Types below describe public record shapes, rather than mandatory properties on every row.\n\n## Fields\n\n| Field | Observed public types | Search use | Meaning |\n| --- | --- | --- | --- |\n| `application_id` | string | Top-level filter | Application id: opaque identifier reference. Its target depends on the containing record/operation; do not infer a collection merely by pluralizing the field name. Explicit joins are listed separately. |\n| `billing_account_id` | string | Top-level filter | Billing account id: opaque identifier reference. Its target depends on the containing record/operation; do not infer a collection merely by pluralizing the field name. Explicit joins are listed separately. |\n| `business_area` | string | Top-level filter | Business area: public attribute of this record type. The associated service article defines its operational use. |\n| `charged_fee_minor` | integer | Top-level filter | Charged fee amount, in integer minor units of the applicable currency. Inspect this record type and its source/receipt to distinguish declared values from actual movements. |\n| `id` | string | Top-level filter | Opaque record key used by get_record; obtain it from returned records or explicit references. It is not an amount, date or proof of business identity. |\n| `scope` | string | Top-level filter | Access namespace for the record. It is not a customer name or a universal case_id. |\n| `status` | string | Top-level filter | Current state of this particular object. A proposal or submission state is distinct from a posted payment or completed review. Public values represented here: `APPROVED`. This list describes the documented records, not an input-validation enum. |\n| `submission_ids` | array | Top-level filter | Submission ids: opaque identifier reference. Its target depends on the containing record/operation; do not infer a collection merely by pluralizing the field name. Explicit joins are listed separately. |\n| `submitted_minute` | integer | Top-level filter | Submitted minute: logical minute or duration, as indicated by the field name; compare with get_clock and the applicable event/validity terms. |\n",
+  "id": "DB-evidence_bundles",
+  "provenance": {
+    "classification": "interface_documentation",
+    "contains_task_specific_values": false,
+    "kind": "interface_documentation",
+    "source": "Public record shapes plus query/transition implementation; reviewed field semantics"
+  },
+  "title": "Database reference: evidence_bundles",
+  "topic": "Database interface"
+}

payment/data/knowledge/DB-export_allocations.json

@@ -0,0 +1,13 @@
+{
+  "applicability": "Shared Payment database interface; all tasks use the same dictionary",
+  "content": "> Inherited interface: no populated public shape in this release's admitted workflow inventory. See DB-inherited-collections and the product entry points in DB-index.\n\n# export_allocations\n\nExport allocations records in CORE and product extensions. Product articles define their operational scope.\n\nRead this collection using `search_records(resource=\"export_allocations\", filters={}, cursor=0, limit=20)` or `get_record(resource=\"export_allocations\", record_id=\"<returned id>\")`.\n\n**Filters:** exact scalar equality; in, contains, gte and lte operator objects on supported top-level fields. See DB-query-syntax for type and null behavior.\n\nSearch returns selected summary fields, so omission from a summary is not proof of absence from the complete record. Read detail before interpreting an optional field. Fields depend on the record type and processing stage; null and absent fields are not zero amounts. Types below describe public record shapes, rather than mandatory properties on every row.\n\nThis inherited collection has no populated public-record shape in the current admitted workflow inventory. Its query entry remains available. No empty collection is treated as evidence about a particular customer enquiry; the actual query determines accessible matches. Its producers and product articles govern any records it creates.",
+  "id": "DB-export_allocations",
+  "provenance": {
+    "classification": "interface_documentation",
+    "contains_task_specific_values": false,
+    "kind": "interface_documentation",
+    "source": "Public record shapes plus query/transition implementation; reviewed field semantics"
+  },
+  "title": "Database reference: export_allocations",
+  "topic": "Database interface"
+}

payment/data/knowledge/DB-export_declarations.json

@@ -0,0 +1,13 @@
+{
+  "applicability": "Shared Payment database interface; all tasks use the same dictionary",
+  "content": "> Inherited interface: no populated public shape in this release's admitted workflow inventory. See DB-inherited-collections and the product entry points in DB-index.\n\n# export_declarations\n\nExport declarations records in CORE and product extensions. Product articles define their operational scope.\n\nRead this collection using `search_records(resource=\"export_declarations\", filters={}, cursor=0, limit=20)` or `get_record(resource=\"export_declarations\", record_id=\"<returned id>\")`.\n\n**Filters:** exact scalar equality; in, contains, gte and lte operator objects on supported top-level fields. See DB-query-syntax for type and null behavior.\n\nSearch returns selected summary fields, so omission from a summary is not proof of absence from the complete record. Read detail before interpreting an optional field. Fields depend on the record type and processing stage; null and absent fields are not zero amounts. Types below describe public record shapes, rather than mandatory properties on every row.\n\nThis inherited collection has no populated public-record shape in the current admitted workflow inventory. Its query entry remains available. No empty collection is treated as evidence about a particular customer enquiry; the actual query determines accessible matches. Its producers and product articles govern any records it creates.",
+  "id": "DB-export_declarations",
+  "provenance": {
+    "classification": "interface_documentation",
+    "contains_task_specific_values": false,
+    "kind": "interface_documentation",
+    "source": "Public record shapes plus query/transition implementation; reviewed field semantics"
+  },
+  "title": "Database reference: export_declarations",
+  "topic": "Database interface"
+}

payment/data/knowledge/DB-fee_guarantees.json

@@ -0,0 +1,13 @@
+{
+  "applicability": "Shared Payment database interface; all tasks use the same dictionary",
+  "content": "> Inherited interface: no populated public shape in this release's admitted workflow inventory. See DB-inherited-collections and the product entry points in DB-index.\n\n# fee_guarantees\n\nFee guarantees records in CORE and product extensions. Product articles define their operational scope.\n\nRead this collection using `search_records(resource=\"fee_guarantees\", filters={}, cursor=0, limit=20)` or `get_record(resource=\"fee_guarantees\", record_id=\"<returned id>\")`.\n\n**Filters:** exact scalar equality; in, contains, gte and lte operator objects on supported top-level fields. See DB-query-syntax for type and null behavior.\n\nSearch returns selected summary fields, so omission from a summary is not proof of absence from the complete record. Read detail before interpreting an optional field. Fields depend on the record type and processing stage; null and absent fields are not zero amounts. Types below describe public record shapes, rather than mandatory properties on every row.\n\nThis inherited collection has no populated public-record shape in the current admitted workflow inventory. Its query entry remains available. No empty collection is treated as evidence about a particular customer enquiry; the actual query determines accessible matches. Its producers and product articles govern any records it creates.",
+  "id": "DB-fee_guarantees",
+  "provenance": {
+    "classification": "interface_documentation",
+    "contains_task_specific_values": false,
+    "kind": "interface_documentation",
+    "source": "Public record shapes plus query/transition implementation; reviewed field semantics"
+  },
+  "title": "Database reference: fee_guarantees",
+  "topic": "Database interface"
+}

payment/data/knowledge/DB-fund_lots.json

@@ -0,0 +1,13 @@
+{
+  "applicability": "Shared Payment database interface; all tasks use the same dictionary",
+  "content": "> Inherited interface: no populated public shape in this release's admitted workflow inventory. See DB-inherited-collections and the product entry points in DB-index.\n\n# fund_lots\n\nFund lots records in CORE and product extensions. Product articles define their operational scope.\n\nRead this collection using `search_records(resource=\"fund_lots\", filters={}, cursor=0, limit=20)` or `get_record(resource=\"fund_lots\", record_id=\"<returned id>\")`.\n\n**Filters:** exact scalar equality; in, contains, gte and lte operator objects on supported top-level fields. See DB-query-syntax for type and null behavior.\n\nSearch returns selected summary fields, so omission from a summary is not proof of absence from the complete record. Read detail before interpreting an optional field. Fields depend on the record type and processing stage; null and absent fields are not zero amounts. Types below describe public record shapes, rather than mandatory properties on every row.\n\nThis inherited collection has no populated public-record shape in the current admitted workflow inventory. Its query entry remains available. No empty collection is treated as evidence about a particular customer enquiry; the actual query determines accessible matches. Its producers and product articles govern any records it creates.",
+  "id": "DB-fund_lots",
+  "provenance": {
+    "classification": "interface_documentation",
+    "contains_task_specific_values": false,
+    "kind": "interface_documentation",
+    "source": "Public record shapes plus query/transition implementation; reviewed field semantics"
+  },
+  "title": "Database reference: fund_lots",
+  "topic": "Database interface"
+}