# ITokenizedVaultFacet

# Functions

# internalBalanceOf

Gets balance of an account within platform Internal balance for given account

  function internalBalanceOf(
    bytes32 tokenId
  ) external returns (uint256)

# Arguments:

| Argument | Type | Description | | --- | --- | --- | |tokenId | bytes32 | Internal ID of the asset |

# Returns:

| Type | Description | | --- | --- | |current | balance|

# internalTokenSupply

Current supply for the asset Total supply of platform asset

  function internalTokenSupply(
    bytes32 tokenId
  ) external returns (uint256)

# Arguments:

| Argument | Type | Description | | --- | --- | --- | |tokenId | bytes32 | Internal ID of the asset |

# Returns:

| Type | Description | | --- | --- | |current | balance|

# internalTransferFromEntity

Internal transfer of amount tokens Transfer tokens internally

  function internalTransferFromEntity(
    bytes32 to,
    bytes32 tokenId
  ) external

# Arguments:

| Argument | Type | Description | | --- | --- | --- | |to | bytes32 | token receiver |tokenId | bytes32 | Internal ID of the token|

# wrapperInternalTransferFrom

Internal transfer of amount tokens from -> to Transfer tokens internally between two IDs

  function wrapperInternalTransferFrom(
    bytes32 from,
    bytes32 to,
    bytes32 tokenId
  ) external

# Arguments:

| Argument | Type | Description | | --- | --- | --- | |from | bytes32 | token sender |to | bytes32 | token receiver |tokenId | bytes32 | Internal ID of the token|

# internalBurn

No description

  function internalBurn(
  ) external

# getWithdrawableDividend

Get withdrawable dividend amount Divident available for an entity to withdraw

  function getWithdrawableDividend(
    bytes32 _entityId,
    bytes32 _tokenId,
    bytes32 _dividendTokenId
  ) external returns (uint256 _entityPayout)

# Arguments:

| Argument | Type | Description | | --- | --- | --- | |_entityId | bytes32 | Unique ID of the entity |_tokenId | bytes32 | Unique ID of token |_dividendTokenId | bytes32 | Unique ID of dividend token |

# Returns:

| Type | Description | | --- | --- | |_entityPayout | accumulated dividend|

# withdrawDividend

Withdraw available dividend Transfer dividends to the entity

  function withdrawDividend(
    bytes32 ownerId,
    bytes32 tokenId,
    bytes32 dividendTokenId
  ) external

# Arguments:

| Argument | Type | Description | | --- | --- | --- | |ownerId | bytes32 | Unique ID of the dividend receiver |tokenId | bytes32 | Unique ID of token |dividendTokenId | bytes32 | Unique ID of dividend token|

# withdrawAllDividends

Withdraws a user's available dividends. Dividends can be available in more than one dividend denomination. This method will withdraw all available dividends in the different dividend denominations.

  function withdrawAllDividends(
    bytes32 ownerId,
    bytes32 tokenId
  ) external

# Arguments:

| Argument | Type | Description | | --- | --- | --- | |ownerId | bytes32 | Unique ID of the dividend receiver |tokenId | bytes32 | Unique ID of token|

# payDividendFromEntity

Pay amount of dividends Transfer dividends to the entity

  function payDividendFromEntity(
    bytes32 guid,
    uint256 amount
  ) external

# Arguments:

| Argument | Type | Description | | --- | --- | --- | |guid | bytes32 | Globally unique identifier of a dividend distribution. |amount | uint256 | the mamount of the dividend token to be distributed to NAYMS token holders.|

# getLockedBalance

Get the amount of tokens that an entity has for sale in the marketplace.

  function getLockedBalance(
    bytes32 _entityId,
    bytes32 _tokenId
  ) external returns (uint256 amount)

# Arguments:

| Argument | Type | Description | | --- | --- | --- | |_entityId | bytes32 | Unique platform ID of the entity. |_tokenId | bytes32 | The ID assigned to an external token. |

# Returns:

| Type | Description | | --- | --- | |amount | of tokens that the entity has for sale in the marketplace.|

# internalTransferBySystemAdmin

No description

  function internalTransferBySystemAdmin(
  ) external