Chartbreaker
    Preparing search index...

    Interface OrderCostEstimation

    Result of a cost estimation ("Ex-ante Kosteninformation"), as returned by PreparedInstrument.estimateOrderCosts and Quote.estimateOrderCosts.

    All fields are optional; brokers only fill what they know. The summary fields (orderFees, expectedCounterValue, transactionTax, ...) should be displayed as early as possible, so the estimation should be requested as soon as the order is prepared or the quote has been received.

    A broker provides its full cost statement in one of two ways:

    • as a document link in costDetailsLink of this estimation, or
    • as a table, loaded with a token from buildDetailedOrderCostEstimationToken (of PreparedInstrument or Quote) and getDetailedCostEstimationTable of the session. The table itself may consist of only a detailsLink.

    Both are alternative ways to the same cost statement. Frontends must display exactly one "Kostenausweis" entry, which is visible if costDetailsLink.url is set or a token can be built. When the user clicks it:

    1. if costDetailsLink.url is set, open that URL,
    2. otherwise build the token and load the table via getDetailedCostEstimationTable. Only load it at this point, as it sends another request to the broker. If the table has rows or footerHtml, display it; if it only has detailsLink.url, open that URL.
    interface OrderCostEstimation {
        costAcceptancePrompt?: string;
        costDetailsLink?: CostDetailsLink;
        entryCosts?: Amount;
        expectedCounterValue?: Amount;
        orderFees?: Amount;
        orderFeesExplanation?: string;
        totalCosts?: Amount;
        transactionTax?: Amount;
    }
    Index
    costAcceptancePrompt? costDetailsLink? entryCosts? expectedCounterValue? orderFees? orderFeesExplanation? totalCosts? transactionTax?
    costAcceptancePrompt?: string

    If present, users have to accept this message before creating an order. May contain (some) HTML. If accepting the costs and performing the order is one click (which is allowed), the create order button label must contain the information that costs are accepted.

    costDetailsLink?: CostDetailsLink

    Link to the broker's cost statement document. See "Cost statement" above for how to present it.

    entryCosts?: Amount

    Entry costs for the order.

    not provided by any broker

    expectedCounterValue?: Amount

    Expected counter value (Kurswert) when the order is executed.

    orderFees?: Amount

    Order fees ("Orderkosten": sum of commission, exchange fees and brokerage).

    orderFeesExplanation?: string

    Explanation for orderFees (plain text), e.g. to be displayed as a tooltip or below the order fees.

    totalCosts?: Amount

    The total amount spent for this order.

    not provided by any broker

    transactionTax?: Amount

    Financial transaction tax.

    Settings
    Member Visibility

    On This Page
    Cost statement ("Kostenausweis")
    Properties