Transactions format

The format of transactions: one message per movement into or out of a store's safe, with one line per currency and the safe's balance after it. What each field means for an integration, and how to consume the event, is in Receiving the events.

Transactions booked before 28 October 2026 can include lines with amount 0 and no expected amount. They move no balance and carry no meaning: skip them.

A line with amount 0 can still appear at any date, typically on a Reconciliation or CashChangerTransfer transaction. It records a till or cash changer counted at 0 against a non-zero expected amount.

The copy External Events links to is cmm.public.event.transactions.v2.json.

{
  "$id": "cmm.public.event.transactions.v2",
  "title": "CashManagementPublicTransactions",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Cash Management event used in a public pubsub topic",
  "type": "object",
  "required": [
    "tenantId",
    "businessUnitId",
    "eventId",
    "eventType",
    "eventDateTime",
    "correlationId",
    "exportDateTime"
  ],
  "properties": {
    "tenantId": {
      "type": "string",
      "description": "The tenant id of event"
    },
    "businessUnitId": {
      "type": "string",
      "description": "The business unit id of the event"
    },
    "eventId": {
      "type": "string",
      "description": "Id of the source event. Together with eventType it identifies the event; deduplicate on both."
    },
    "eventType": {
      "type": "string",
      "description": "Type of the event. Fixed values: InitialBalance, Reconciliation, ReconciliationRecount, CashChangerTransfer, CashChangerRecount, Transfer, BankDeposit, BankWithdrawal, Correction. A safe audit also posts one event per dynamic property, with the property id as eventType, so the set is open-ended per tenant; consumers must handle unrecognised values."
    },
    "eventDateTime": {
      "type": "string",
      "format": "date-time",
      "description": "Event timestamp"
    },
    "correlationId": {
      "type": "string",
      "description": "Correlation id of the event"
    },
    "exportDateTime": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp of when exported"
    },
    "businessDate": {
      "type": "string",
      "format": "date",
      "description": "The date (not time) of the event"
    },
    "createdBy": {
      "type": [
        "null",
        "string"
      ],
      "description": "Id of the user who created this event"
    },
    "externalUserId": {
      "type": [
        "null",
        "string"
      ],
      "description": "External user id of the user who created this event"
    },
    "workstationId": {
      "type": [
        "null",
        "string"
      ],
      "description": "Workstation id of the transaction"
    },
    "operatorId": {
      "type": [
        "null",
        "string"
      ],
      "description": "Operator id of the transaction"
    },
    "transactions": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/CashManagementPublicEventTransaction"
      },
      "description": "Transactions of the event"
    }
  },
  "$defs": {
    "CashManagementPublicEventTransaction": {
      "title": "CashManagementPublicEventTransaction",
      "type": "object",
      "required": [
        "transactionId",
        "currencyId",
        "amount"
      ],
      "properties": {
        "transactionId": {
          "type": "string",
          "description": "Id of the transaction"
        },
        "currencyId": {
          "type": "string",
          "description": "The currency id"
        },
        "amount": {
          "type": "number",
          "description": "The actual amount"
        },
        "repositoryFromBalance": {
          "type": [
            "number",
            "null"
          ],
          "description": "Balance of the sending repository after transaction has been committed"
        },
        "repositoryToBalance": {
          "type": [
            "number",
            "null"
          ],
          "description": "Balance of the receiving repository after transaction has been committed"
        },
        "repositoryIdFrom": {
          "type": [
            "string",
            "null"
          ],
          "description": "Id of repository from which money is reduced"
        },
        "repositoryIdTo": {
          "type": [
            "string",
            "null"
          ],
          "description": "Id of repository to which money is added"
        },
        "referenceId": {
          "type": [
            "string",
            "null"
          ],
          "description": "Id of bank bag reference"
        },
        "comment": {
          "type": [
            "string",
            "null"
          ],
          "description": "Comment to the transaction"
        },
        "reasonCode": {
          "type": [
            "string",
            "null"
          ],
          "description": "Reason code to the transaction"
        },
        "sequenceNumber": {
          "description": "A sequence number on type of transaction",
          "type": "integer"
        }
      }
    }
  }
}