Specifies the balance id of the ledger balance to be monitored.
conditionobjectrequiredbody
Defines the criteria for monitoring a specific balance type.
Details
fieldstringrequiredbody
Specifies the balance type to be monitored. Every ledger balance has 6 balance types - balance, inflight_balance, credit_balance, inflight_credit_balance, debit_balance, and inflight_debit_balance.
operatorstringrequiredbody
Comparison to apply: >, <, >=, <=, =, or !=. An operator outside this list returns 400 GEN_VALIDATION_ERROR.
valuenumberrequiredbody
Threshold in major units. 0 and fractions such as 100.50 are valid. Blnk multiplies value by precision and compares the balance to that minor-unit amount.
precisionnumberrequiredbody
Scale for value, the same precision you use when recording that currency. Must be greater than 0.
triggerstringdefault edgebody
How you want the monitor to behave. edge notifies you once when the rule first matches, then stays quiet until the amount no longer matches.
level notifies you on every transaction that updates the balance while the rule still matches.
descriptionstringbody
A brief explanation of the purpose of the monitor.
Response
monitor_idstring
The unique id of the balance monitor.
triggerstring
edge or level.
condition_stateboolean
Last value of the condition. Present when trigger is edge. Omitted when trigger is level.
created_atstring
Date and time when the monitor was created.
condition.precise_valuenumber
Minor units Blnk compares against. value multiplied by precision.
