Skip to main content
Version: v28.0.x

Interface: CreateBallotParams

api/procedures/types.CreateBallotParams

Properties

declarationDate

declarationDate: Date

Date on which the Corporate Action is declared

Defined in

api/procedures/types.ts:1847


description

description: string

Description of the Corporate Action to which the Ballot is attached

Defined in

api/procedures/types.ts:1835


endDate

endDate: Date

Date when Ballot voting ends

Defined in

api/procedures/types.ts:1830


meta

meta: BallotMeta

Title and motions of the Ballot

Defined in

api/procedures/types.ts:1820


rcv

rcv: boolean

Specifies whether Ranked Choice Voting (RCV) is enabled for this ballot.

Defined in

api/procedures/types.ts:1852


startDate

startDate: Date

Date when Ballot voting starts

Defined in

api/procedures/types.ts:1825


targets

Optional targets: InputCorporateActionTargets

Asset Holder Identities to be included (or excluded) from the Ballot. Inclusion/exclusion is controlled by the treatment property. When the value is Include, all Asset Holders not present in the array are excluded, and vice-versa. If no value is passed, the default value for the Asset is used. If there is no default value, all Asset Holders will be part of the Ballot

Defined in

api/procedures/types.ts:1842