Class ReferenceDividend

Namespace

MassiveDotNet.Rest.Models

Assembly

MassiveDotNet.Rest.dll

A cash dividend from the v3 reference route: the ticker, the four dates that govern it, the amount, its type, and how often it pays.

public sealed record ReferenceDividend : IEquatable<ReferenceDividend>

Inheritance

object

ReferenceDividend

Implements

IEquatable<ReferenceDividend>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Reference data, so a class (decision D4). Prefixed because the stocks/v1 route's Dividend carries two properties this one lacks, so the two cannot share a model (decision D16, D-R7). The four dates are bare strings in the description; the published example carries ISO calendar dates, so the map binds them to LocalDate (D-R9).

Properties

CashAmount

The cash amount of the dividend per share owned.

[JsonPropertyName("cash_amount")]
public double CashAmount { get; init; }

Property Value

double

Currency

The currency in which the dividend is paid.

[JsonPropertyName("currency")]
public string? Currency { get; init; }

Property Value

string

DeclarationDate

The date the dividend was announced. The description types this a bare string; the wire carries an ISO calendar date (D-R9).

[JsonPropertyName("declaration_date")]
public LocalDate? DeclarationDate { get; init; }

Property Value

LocalDate?

DividendType

The type of dividend. Dividends that have been paid and/or are expected to be paid on consistent schedules are denoted as CD. Special Cash dividends that have been paid that are infrequent or unusual, and/or can not be expected to occur in the future are denoted as SC. Long-Term and Short-Term capital gain distributions are denoted as LT and ST, respectively.

[JsonPropertyName("dividend_type")]
public required string DividendType { get; init; }

Property Value

string

ExDividendDate

The first trading day on which a buyer is not entitled to the dividend. The description types this a bare string; the wire carries an ISO calendar date (D-R9).

[JsonPropertyName("ex_dividend_date")]
public LocalDate ExDividendDate { get; init; }

Property Value

LocalDate

Frequency

The number of times per year the dividend is paid out. Possible values are 0 (one-time), 1 (annually), 2 (bi-annually), 4 (quarterly), 12 (monthly), 24 (bi-monthly), and 52 (weekly).

[JsonPropertyName("frequency")]
public int Frequency { get; init; }

Property Value

int

Id

The unique identifier of the dividend.

[JsonPropertyName("id")]
public required string Id { get; init; }

Property Value

string

PayDate

The date the dividend is paid. The description types this a bare string; the wire carries an ISO calendar date (D-R9).

[JsonPropertyName("pay_date")]
public LocalDate? PayDate { get; init; }

Property Value

LocalDate?

RecordDate

The date a holder must be on the register to receive the dividend. The description types this a bare string; the wire carries an ISO calendar date (D-R9).

[JsonPropertyName("record_date")]
public LocalDate? RecordDate { get; init; }

Property Value

LocalDate?

Ticker

The ticker symbol of the dividend.

[JsonPropertyName("ticker")]
public required string Ticker { get; init; }

Property Value

string