v1

latestOpenAPI 3.1.02026-07-241910582.8 KB

Get Ledger Account Balance Monitor

get/ledger_account_balance_monitors/{id}

Path parameters

idstring required

The ID of the ledger account balance monitor.

Response

200

idstring

objectstring

live_modeboolean

ledger_account_idstring

descriptionstring

metadataobject

{"stackTrail":"paths:/ledger_account_balance_monitors/{id}:get:responses:200:content:application/json:schema:properties:discarded_at","oasType":"schema","type":"unknown"}

created_atstring

updated_atstring

Example response

{
  "id": "36f99587-e551-4836-bab5-62250338ef70",
  "object": "ledger_account_balance_monitor",
  "live_mode": true,
  "ledger_account_id": "895cf384-3d37-48bf-b04d-ea34bf358079",
  "description": "Alert when balance changes",
  "alert_condition": {
    "field": "available_amount",
    "operator": "greater_than"
  },
  "current_ledger_account_balance_state": {
    "balances": {
      "pending_balance": {
        "currency": "USD",
        "currency_exponent": 2
      },
      "posted_balance": {
        "currency": "USD",
        "currency_exponent": 2
      },
      "available_balance": {
        "currency": "USD",
        "currency_exponent": 2
      }
    }
  },
  "created_at": "2023-08-14T17:22:37Z",
  "updated_at": "2023-08-14T17:22:37Z"
}