v1

latestOpenAPI 3.1.02026-07-241910582.8 KB

List Ledger Account Balance Monitors

get/ledger_account_balance_monitors

Query parameters

id[]string[]

If you have specific IDs to retrieve in bulk, you can pass them as query parameters delimited with id[]=, for example ?id[]=123&id[]=abc.

ledger_account_idstring

Query the balance monitors for a single ledger account.

metadatastring

For example, if you want to query for records with metadata key Type and value Loan, the query would be metadata%5BType%5D=Loan. This encodes the query parameters.

Response

200

idstring

objectstring

live_modeboolean

ledger_account_idstring

descriptionstring

metadataobject

{"stackTrail":"paths:/ledger_account_balance_monitors:get:responses:200:content:application/json:schema:items: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"
  }
]