Skip to content

Transaction Tags — Proposed Guide

Planned API — Reference Only

Transaction Tags: Transaction tags annotate a financial record for analysis or workflow context. They do not necessarily represent validated accounting…

Overview

Transaction tags annotate a financial record for analysis or workflow context. They do not necessarily represent validated accounting dimensions.

Key concepts

Retain tag ownership and distinguish operational labels from exportable coding fields. Use stable identities.

Implementation considerations

Do not propagate confidential annotations to an external ledger by default. Export only approved mapped fields.

Illustrative data model

This local fixture shows a possible representation for the concepts above. It is not an endpoint response, production configuration or a claim that the described capability is implemented.

JSON fixture
Fictional concept fixture
{
  "reference_only": true,
  "topic": "Transaction Tags",
  "transaction_id": "txn_example_123",
  "tag_ids": [
    "tag_example_123"
  ],
  "metadata": {
    "example.source": "local-fixture"
  }
}

Design review checklist

  • Document which organization owns the transaction tags representation and which actor may view or change it.
  • Test the boundaries of transaction id, tag ids, metadata using synthetic values, including missing or inconsistent references.
  • Before future implementation, obtain an approved contract and review failure behavior. This documentation does not authorize production activation.

Proposed data types

Illustrative field dictionary
NameTypeDescription
transaction_idstringStable fictional transaction reference; not a secret and not evidence that a resource exists.
tag_idsarray<string>Fictional tag references; validate ownership and avoid duplicate membership.
metadataobjectBounded, namespaced annotations. Do not store credentials or bank details here.