Chartbreaker
    Preparing search index...

    Type Alias TradeWarning

    One reason why a trade summary or a portfolio value history is incomplete.

    type TradeWarning = {
        fromDateString?: string;
        instrument?: Instrument;
        instrumentId?: InstrumentId;
        isin?: string;
        name?: string;
        reason: TradeWarningReason;
        text: string;
        toDateString?: string;
    }
    Index
    fromDateString?: string

    The first day the warning applies to, YYYY-MM-DD, for warnings that are limited to a period - for instance the first day a security had to be valued without a closing price. Missing if the warning is not tied to a period, which means that it applies to the whole result.

    instrument?: Instrument

    The stock3 instrument the ISIN has been mapped to, as the positions and orders of this library carry it. Missing if the warning is not about a single security, or if the ISIN could not be mapped - a client should then fall back to name / isin.

    instrumentId?: InstrumentId

    The id of instrument, for clients that only need to link the warning.

    isin?: string

    The ISIN of the security the warning is about. Missing if the warning concerns the portfolio as a whole instead of a single instrument (realizedPnlUnavailable, for example), or if the broker reported no ISIN.

    name?: string

    The name of the security the warning is about, see isin. Missing if unknown.

    The machine-readable cause, so that warnings can be grouped, translated or acted upon.

    text: string

    A human-readable description, currently always in german. This is meant as a fallback for displaying something at all - a client that knows reason should build its own text from the structured fields instead.

    toDateString?: string

    The last day the warning applies to, YYYY-MM-DD, see fromDateString.