---
title: "Create Ledger Account Balance Monitor"
method: POST
path: "/ledger_account_balance_monitors"
---

# Create Ledger Account Balance Monitor

`POST /ledger_account_balance_monitors`

## Request body

- object
  - `ledger_account_id` string, required — The ledger account associated with this balance monitor.
  - `description` string — An optional, free-form description for internal use.
  - `alert_condition` object, required — The condition that must be satisfied for the monitor to be triggered.
    - `field` string, required — One of `available_balance_amount`, `pending_balance_amount`, `posted_balance_amount`, `ledger_account_lock_version`.
    - `operator` string, required — A logical operator to compare the `field` against the `value`. One of `less_than`, `less_than_or_equals`, `equals`, `greater_than_or_equals`, `greater_than`.
    - `value` integer, required — The monitor will be triggered when comparing the `field` to this integer value with the `operator` is logically true.
  - `metadata` string, json — Metadata to be added to the ledger account balance monitor. Must be a JSON object.

## Response `201`

201

- object
  - `id` string
  - `object` string
  - `live_mode` boolean
  - `ledger_account_id` string
  - `description` string
  - `alert_condition` object
    - `field` string
    - `operator` string
    - `value` integer
  - `current_ledger_account_balance_state` object
    - `balances` object
      - `pending_balance` object
        - `credits` integer
        - `debits` integer
        - `amount` integer
        - `currency` string
        - `currency_exponent` integer
      - `posted_balance` object
        - `credits` integer
        - `debits` integer
        - `amount` integer
        - `currency` string
        - `currency_exponent` integer
      - `available_balance` object
        - `credits` integer
        - `debits` integer
        - `amount` integer
        - `currency` string
        - `currency_exponent` integer
    - `ledger_account_lock_version` integer
    - `triggered` boolean
  - `metadata` object
  - `discarded_at` unknown
  - `created_at` string
  - `updated_at` string

## Other responses

- `400` — 400

---

[API](https://skmtc.net/modern-treasury/apis/modern-treasury-api.md) · [All operations](https://skmtc.net/modern-treasury/apis/modern-treasury-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/modern-treasury/modern-treasury-api/revisions/ed0431a2dcd0/schema)