Click or drag to resize
PMBalance Class
Presents a balance, current value and settings for a user object
Inheritance Hierarchy

Namespace: PM90SettingsAPI
Assembly: PM90SettingsAPI (in PM90SettingsAPI.dll) Version: 9.0.23.534 (9.0.23.534)
Syntax
C#
public class PMBalance

The PMBalance type exposes the following members.

Methods
  NameDescription
Public methodAddOneTimeUpdate
Creates a new one time occuring balance update
Public methodAddRecurringUpdate
Creates a new recurring balance change
Public methodStatic memberGetAvailableBalances
Gets a list of active balances eligible for printers or cost profiles
Public methodIncrementBalance
Increases the current balance amount. The UsePages value will determine whether currency or pages value is used.
Public methodSetBalance
Sets the current balance amount. The UsePages value will determine whether currency or pages value is used.
Public methodSetGlobalBalanceName
Updates this balances name globally
Public methodSetGlobalNegativeBalance
Updates this balances negative balance option
Public methodSetGlobalOutOfBalanceAction
Specifies the action to be taken when this job is out of balance
Public methodSetUnlimited
Sets the balance Unlimited or not
Top
Fields
  NameDescription
Public fieldStatic memberMAX_BALANCE_AMOUNT_CURRENCY
The maximum amount a currency balance can be
Public fieldStatic memberMAX_BALANCE_AMOUNT_PAGES
The maximum amount a pages balance can be
Top
Properties
  NameDescription
Public propertyAllowNegative
If the balance supports a negative value
Public propertyBalanceID
The balance's unique database id
Public propertyCurrency
The amount of currency quota the object currently has
Public propertyIsDefault
If the balance is the default balance
Public propertyIsPaid
If the balance is paid for by end user directly
Public propertyName
The balance's friendly name
Public propertyOutOfBalanceAction
Gets the current action that will be applied when the balance is out
Public propertyPages
The amount of pages quota the object currently has
Public propertyScheduledUpdates
Get a list of scheduled updates for this balance
Public propertyUnlimited
True when balance is unlimited, and currency / pages values should be ignored
Public propertyUsePages
Indicates that Pages should be used instead of currency value
Top
Remarks
Balances can also be owned by a group or OU, and represents their starting amount
See Also