> For the complete documentation index, see [llms.txt](https://developers.polymath.network/classic-sdk/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.polymath.network/classic-sdk/beta/external-modules/_entities_taxwithholding_.taxwithholding.md).

# TaxWithholding

Represents the percentage that should be withheld from a Tokenholder's dividend payment for tax purposes

## Hierarchy

* [Entity](broken://pages/-M-tw-_WeBJcuS0_s0nR)‹[Params](broken://pages/-M-tw-c2Hk4gnL2bXBrh)›

  ↳ **TaxWithholding**

## Index

### Constructors

* [constructor](broken://pages/-M-tw-_rpf93lk7u5A2D#constructor)

### Properties

* [percentage](broken://pages/-M-tw-_rpf93lk7u5A2D#percentage)
* [securityTokenId](broken://pages/-M-tw-_rpf93lk7u5A2D#securitytokenid)
* [securityTokenSymbol](broken://pages/-M-tw-_rpf93lk7u5A2D#securitytokensymbol)
* [tokenholderAddress](broken://pages/-M-tw-_rpf93lk7u5A2D#tokenholderaddress)
* [uid](broken://pages/-M-tw-_rpf93lk7u5A2D#uid)

### Methods

* [\_refresh](broken://pages/-M-tw-_rpf93lk7u5A2D#_refresh)
* [toPojo](broken://pages/-M-tw-_rpf93lk7u5A2D#topojo)
* [generateId](broken://pages/-M-tw-_rpf93lk7u5A2D#static-generateid)
* [unserialize](broken://pages/-M-tw-_rpf93lk7u5A2D#static-unserialize)

## Constructors

### constructor

\+ **new TaxWithholding**(`params`: [Params](broken://pages/-M-tw-c2Hk4gnL2bXBrh) & [UniqueIdentifiers](broken://pages/-M-tw-c3WpN6T0UuXdPd)): [*TaxWithholding*](broken://pages/-M-tw-_rpf93lk7u5A2D)

*Defined in* [*src/entities/TaxWithholding.ts:82*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/TaxWithholding.ts#L82)

Create a new tax withholding instance

**Parameters:**

| Name     | Type                                                                                                     |
| -------- | -------------------------------------------------------------------------------------------------------- |
| `params` | [Params](broken://pages/-M-tw-c2Hk4gnL2bXBrh) & [UniqueIdentifiers](broken://pages/-M-tw-c3WpN6T0UuXdPd) |

**Returns:** [*TaxWithholding*](broken://pages/-M-tw-_rpf93lk7u5A2D)

## Properties

### percentage

• **percentage**: *number*

*Defined in* [*src/entities/TaxWithholding.ts:82*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/TaxWithholding.ts#L82)

percentage of tax to be withheld (0 to 1)

### securityTokenId

• **securityTokenId**: *string*

*Defined in* [*src/entities/TaxWithholding.ts:75*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/TaxWithholding.ts#L75)

### securityTokenSymbol

• **securityTokenSymbol**: *string*

*Defined in* [*src/entities/TaxWithholding.ts:73*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/TaxWithholding.ts#L73)

### tokenholderAddress

• **tokenholderAddress**: *string*

*Defined in* [*src/entities/TaxWithholding.ts:77*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/TaxWithholding.ts#L77)

### uid

• **uid**: *string*

*Overrides* [*Entity*](broken://pages/-M-tw-_WeBJcuS0_s0nR)*.*[*uid*](broken://pages/-M-tw-_WeBJcuS0_s0nR#abstract-uid)

*Defined in* [*src/entities/TaxWithholding.ts:71*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/TaxWithholding.ts#L71)

unique generated identifer for tax withholding entity

## Methods

### \_refresh

▸ **\_refresh**(`params`: Partial‹[Params](broken://pages/-M-tw-c2Hk4gnL2bXBrh)›): *void*

*Overrides* [*Entity*](broken://pages/-M-tw-_WeBJcuS0_s0nR)*.*[*\_refresh*](broken://pages/-M-tw-_WeBJcuS0_s0nR#abstract-_refresh)

*Defined in* [*src/entities/TaxWithholding.ts:120*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/TaxWithholding.ts#L120)

Hydrate the entity

**Parameters:**

| Name     | Type                                                   |
| -------- | ------------------------------------------------------ |
| `params` | Partial‹[Params](broken://pages/-M-tw-c2Hk4gnL2bXBrh)› |

**Returns:** *void*

### toPojo

▸ **toPojo**(): *object*

*Overrides* [*Entity*](broken://pages/-M-tw-_WeBJcuS0_s0nR)*.*[*toPojo*](broken://pages/-M-tw-_WeBJcuS0_s0nR#abstract-topojo)

*Defined in* [*src/entities/TaxWithholding.ts:105*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/TaxWithholding.ts#L105)

Convert entity to a POJO (Plain Old Javascript Object)

**Returns:** *object*

* **percentage**: *number*
* **securityTokenId**: *string*
* **securityTokenSymbol**: *string*
* **tokenholderAddress**: *string*
* **uid**: *string*

### `Static` generateId

▸ **generateId**(`__namedParameters`: object): *string*

*Defined in* [*src/entities/TaxWithholding.ts:43*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/TaxWithholding.ts#L43)

Generate the Tax Withholding's UUID from its identifying properties

**Parameters:**

▪ **\_\_namedParameters**: *object*

| Name                 | Type   |
| -------------------- | ------ |
| `securityTokenId`    | string |
| `tokenholderAddress` | string |

**Returns:** *string*

### `Static` unserialize

▸ **unserialize**(`serialized`: string): [*UniqueIdentifiers*](broken://pages/-M-tw-c3WpN6T0UuXdPd)

*Defined in* [*src/entities/TaxWithholding.ts:55*](https://github.com/PolymathNetwork/polymath-sdk/blob/550676f/src/entities/TaxWithholding.ts#L55)

Unserialize a serialized entity of tax withholding information

**Parameters:**

| Name         | Type   | Description                             |
| ------------ | ------ | --------------------------------------- |
| `serialized` | string | string with tax withholding information |

**Returns:** [*UniqueIdentifiers*](broken://pages/-M-tw-c3WpN6T0UuXdPd)