Modern Treasury · Schema

ledger_account_balance_monitor_create_request

FintechPaymentsACHWiresTreasury

Properties

Name Type Description
ledger_account_id string The ledger account associated with this balance monitor.
description string An optional, free-form description for internal use.
alert_condition object Describes the condition that must be satisfied for the monitor to be triggered.
metadata object Additional data represented as key-value pairs. Both the key and value must be strings.
View JSON Schema on GitHub

JSON Schema

modern-treasury-ledger-account-balance-monitor-create-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ledger_account_balance_monitor_create_request",
  "title": "ledger_account_balance_monitor_create_request",
  "type": "object",
  "properties": {
    "ledger_account_id": {
      "type": "string",
      "description": "The ledger account associated with this balance monitor."
    },
    "description": {
      "type": "string",
      "description": "An optional, free-form description for internal use."
    },
    "alert_condition": {
      "$ref": "#/components/schemas/alert_condition_create_request",
      "description": "Describes the condition that must be satisfied for the monitor to be triggered."
    },
    "metadata": {
      "type": "object",
      "description": "Additional data represented as key-value pairs. Both the key and value must be strings.",
      "additionalProperties": {
        "type": "string"
      },
      "example": {
        "key": "value",
        "foo": "bar",
        "modern": "treasury"
      }
    }
  },
  "required": [
    "ledger_account_id",
    "alert_condition"
  ]
}