@openpit/engine
    Preparing search index...

    Class AccountAdjustmentBalanceOperation

    Balance-scoped adjustment operation for one physical asset. Average entry price and realized PnL are denominated in the account currency.

    Index
    constructor
    asset averageEntryPrice realizedPnl
    [dispose] clone free
    • get asset(): string | undefined

      The asset, or undefined.

      Returns string | undefined

    • set asset(value: string | null | undefined): void

      Sets the asset.

      Errors

      Throws AssetError when the asset string is empty.

      Parameters

      • value: string | null | undefined

      Returns void

    • get averageEntryPrice(): Price | undefined

      The account-currency average entry price, or undefined.

      Returns Price | undefined

    • set averageEntryPrice(
          value: string | number | bigint | Price | null | undefined,
      ): void

      Sets the account-currency average entry price (accepts a value object or DecimalInput). No FX is applied.

      Errors

      Throws ParamError on an invalid value.

      Parameters

      • value: string | number | bigint | Price | null | undefined

      Returns void

    • get realizedPnl(): PnlHaltReason | Pnl | undefined

      The account-currency position PnL state, or undefined when this adjustment does not correct it.

      Returns PnlHaltReason | Pnl | undefined

    • set realizedPnl(
          value: string | number | bigint | PnlHaltReason | Pnl | null | undefined,
      ): void

      Sets or clears the account-currency position PnL state.

      Errors

      Throws TypeError, RangeError, or ParamError on an invalid PnL state.

      Parameters

      Returns void

    • Returns void

    • Returns void

    Settings
    Member Visibility

    On This Page
    Constructors
    Accessors
    Methods