Class FinancialDataPoint

Namespace

MassiveDotNet.Rest.Models

Assembly

MassiveDotNet.Rest.dll

One line item of a financial statement: its label, value, and unit, its place in the statement, and, when sources are requested, where it came from.

public sealed record FinancialDataPoint : IEquatable<FinancialDataPoint>

Inheritance

object

FinancialDataPoint

Implements

IEquatable<FinancialDataPoint>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Generated from the shape the description documents under the balance sheet's * property and used for every statement (D-R11). Source, Formula, XPath, and DerivedFrom arrive only when the request asked for sources.

Properties

DerivedFrom

The list of report IDs (or errata) which were used to derive this data point. This value is only returned for data points taken directly from XBRL when the include_sources query parameter is true and if source is SourceInterReportDerived.

[JsonPropertyName("derived_from")]
[JsonConverter(typeof(PooledArrayConverter<string>))]
public string[]? DerivedFrom { get; init; }

Property Value

string[]

Formula

The name of the formula used to derive this data point from other financial data points. Information about the formulas can be found here. This value is only returned for data points that are not explicitly expressed within the XBRL source file when the include_sources query parameter is true and if source is SourceIntraReportImpute.

[JsonPropertyName("formula")]
public string? Formula { get; init; }

Property Value

string

Label

A human readable label for the financial data point.

[JsonPropertyName("label")]
public required string Label { get; init; }

Property Value

string

Order

An indicator of what order within the statement that you would find this data point.

[JsonPropertyName("order")]
public int Order { get; init; }

Property Value

int

Source

The source where this data point came from. This will be one of: SourceDirectReport, SourceIntraReportImpute or SourceInterReportDerived.

[JsonPropertyName("source")]
public string? Source { get; init; }

Property Value

string

Unit

The unit of the financial data point.

[JsonPropertyName("unit")]
public required string Unit { get; init; }

Property Value

string

Value

The value of the financial data point.

[JsonPropertyName("value")]
public double Value { get; init; }

Property Value

double

XPath

The XPath 1.0 query that identifies the fact from within the XBRL source file. This value is only returned for data points taken directly from XBRL when the include_sources query parameter is true and if source is SourceDirectReport.

[JsonPropertyName("xpath")]
public string? XPath { get; init; }

Property Value

string