TaxWithholding

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

Hierarchy

• Entity‹Params›

  ↳ TaxWithholding

Index

Constructors

• constructor

Properties

• percentage

• securityTokenId

• securityTokenSymbol

• tokenholderAddress

• uid

Methods

• _refresh

• toPojo

• generateId

• unserialize

Constructors

constructor

+ new TaxWithholding(params: Params & UniqueIdentifiers): TaxWithholding

Defined in src/entities/TaxWithholding.ts:82

Create a new tax withholding instance

Parameters:

Name	Type
params	Params & UniqueIdentifiers

Returns: TaxWithholding

Properties

percentage

• percentage: number

Defined in src/entities/TaxWithholding.ts:82

percentage of tax to be withheld (0 to 1)

securityTokenId

• securityTokenId: string

Defined in src/entities/TaxWithholding.ts:75

securityTokenSymbol

• securityTokenSymbol: string

Defined in src/entities/TaxWithholding.ts:73

tokenholderAddress

• tokenholderAddress: string

Defined in src/entities/TaxWithholding.ts:77

uid

• uid: string

Overrides Entity.uid

Defined in src/entities/TaxWithholding.ts:71

unique generated identifer for tax withholding entity

Methods

_refresh

▸ _refresh(params: Partial‹Params›): void

Overrides Entity._refresh

Defined in src/entities/TaxWithholding.ts:120

Hydrate the entity

Parameters:

Name	Type
params	Partial‹Params›

Returns: void

toPojo

▸ toPojo(): object

Overrides Entity.toPojo

Defined in src/entities/TaxWithholding.ts:105

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

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

Defined in src/entities/TaxWithholding.ts:55

Unserialize a serialized entity of tax withholding information

Parameters:

Name	Type	Description
serialized	string	string with tax withholding information

Returns: UniqueIdentifiers