# OrderCanceled

PATH: /aurora.core.apiengine.omsv1.OmsEventsService/OrderCanceled

Endpoint: POST /aurora.core.apiengine.omsv1.OmsEventsService/OrderCanceled
Version: v1.23.0
Security: Bearer

## Request fields (application/json):

  - `order` (object, required)
    Fields: id, external_id, version_reference, instrument, side, order_status, order_type, order_intent, time_in_force, good_till_time, quantity, min_quantity, fee, rebate, agreement_ids, open_quantity, total_execution_quantity, avg_execution_fee, avg_execution_rebate, created_at, updated_at, created_by, last_updated_by, firm_quantity, ioi_quantity, executions, allow_odd_lots

  - `order.agreement_ids` (array)
    agreements set on the order

  - `order.allow_odd_lots` (boolean, required)
    Allow odd lots

  - `order.avg_execution_fee` (string)
    Average fee of executed quantity so far

  - `order.avg_execution_rebate` (string)
    Average rebate of executed quantity so far

  - `order.created_at` (string, required)
    Order created at - time in RFC3339 with millisecond precision

  - `order.created_by` (string, required)
    Created by user

  - `order.executions` (array)
    List of executions on this Order

  - `order.executions.agreement` (object, required)
    Fields: id, short_name, side, counterparty_id, settlement_type, rounding_rule, collateral_rate, status, proposer_user, proposed_by_side, responder_user, version, collateral_type, pricing_currency, billing_currency, collateral_currency, collateral_method, dividend_required, term_type, term_start_date, term_end_date, balance_target, balance_target_variance, rwa_bucket, settlement_system, created_at, approved_at, booking_account, counterparty_booking_account, trade_type, profit_center, delivery_type

  - `order.executions.agreement.approved_at` (string)
    Datetime that agreement was approved by the second party - time in RFC3339 with millisecond precision

  - `order.executions.agreement.balance_target` (string)

  - `order.executions.agreement.balance_target_variance` (string)

  - `order.executions.agreement.billing_currency` (string, required)
    Enum: "USD", "CAD", "GBP", "EUR", "JPY"

  - `order.executions.agreement.booking_account` (string)

  - `order.executions.agreement.collateral_currency` (string)
    Enum: "USD", "CAD", "GBP", "EUR", "JPY"

  - `order.executions.agreement.collateral_method` (string, required)
    Enum: "COLLATERAL_METHOD_UNSPECIFIED", "PLEDGE", "TITLE_TRANSFER"

  - `order.executions.agreement.collateral_rate` (string, required)
    Collateral Rate

  - `order.executions.agreement.collateral_type` (string, required)
    Enum: "COLLATERAL_TYPE_UNSPECIFIED", "CASH", "NON_CASH_UST", "NON_CASH_EQ", "NON_CASH_JGB"

  - `order.executions.agreement.counterparty_booking_account` (string)

  - `order.executions.agreement.counterparty_id` (string, required)
    The Provable assigned company_id of the counterparty in the agreement

  - `order.executions.agreement.created_at` (string, required)
    Datetime that agreement was initially created - time in RFC3339 with millisecond precision

  - `order.executions.agreement.delivery_type` (string, required)
    Enum: "DELIVERY_TYPE_UNSPECIFIED", "DVP", "FOP"

  - `order.executions.agreement.dividend_required` (string, required)

  - `order.executions.agreement.id` (string, required)
    A unique reference for the agreement assigned by Provable Markets

  - `order.executions.agreement.pricing_currency` (string, required)
    Enum: "USD", "CAD", "GBP", "EUR", "JPY"

  - `order.executions.agreement.profit_center` (string)

  - `order.executions.agreement.proposed_by_side` (string, required)
    Enum: "BORROW", "LOAN"

  - `order.executions.agreement.proposer_user` (string, required)
    The user who initially created the agreement

  - `order.executions.agreement.responder_user` (string)
    The user who approved or rejected the agreement

  - `order.executions.agreement.rounding_rule` (string, required)
    Enum: "NO_ROUNDING", "UP_TO_NEAREST_0_DOT_01", "UP_TO_NEAREST_0_DOT_05", "UP_TO_NEAREST_0_DOT_10", "UP_TO_NEAREST_0_DOT_25", "UP_TO_NEAREST_1_DOT_0"

  - `order.executions.agreement.rwa_bucket` (string)

  - `order.executions.agreement.settlement_system` (string)
    Enum: "SETTLEMENT_SYSTEM_UNSPECIFIED", "PROVABLE_MARKET", "LOANET", "LOANET_SFT", "SPIRE", "PROP"

  - `order.executions.agreement.settlement_type` (string, required)
    Enum: "NSCC", "BILATERAL"

  - `order.executions.agreement.short_name` (string, required)
    The short name your company has assigned to this agreement

  - `order.executions.agreement.side` (string, required)
    Enum: "BORROW", "LOAN"

  - `order.executions.agreement.status` (string, required)
    possible agreement status
    Enum: "AGREEMENT_STATUS_UNSPECIFIED", "DRAFT", "ACTIVE", "REJECTED", "CANCELED", "INACTIVE"

  - `order.executions.agreement.term_end_date` (string)

  - `order.executions.agreement.term_start_date` (string)

  - `order.executions.agreement.term_type` (string, required)
    Enum: "TERM_TYPE_UNSPECIFIED", "NONE", "FIXED", "EVERGREEN", "ONE_DAY", "BULLET"

  - `order.executions.agreement.trade_type` (string)

  - `order.executions.agreement.version` (string, required)
    After modifications are accepted, the sequential count changes to the next value. Note: Short Name changes do not result in a new version. Just shared element updates do.

  - `order.executions.cancel_reason` (string)
    Reason of cancellation if status is cancelled

  - `order.executions.collateral_price` (string, required)
    The collateral_rate adjusted price rounded up.

  - `order.executions.contra_status` (string, required)
    Execution status of other side

  - `order.executions.contract_value` (string, required)
    The contract value (calculated as Collateral Adjusted Price * Quantity)

  - `order.executions.counterparty_id` (string, required)
    Company id of the counterparty

  - `order.executions.execution_quantity` (string, required)
    Executed quantity

  - `order.executions.execution_time` (string, required)
    date and time of the execution - time in RFC3339 with millisecond precision

  - `order.executions.fee` (string, required)
    Rate as fee

  - `order.executions.id` (string, required)
    A execution reference ID assigned by Provable Markets

  - `order.executions.instrument` (object, required)
    Instruments can be identified by their CUSIP or Ticker SymbolFields: cusip, ticker, name

  - `order.executions.instrument.cusip` (string, required)
    CUSIP

  - `order.executions.instrument.name` (string, required)
    Security name

  - `order.executions.instrument.ticker` (string, required)
    Ticker

  - `order.executions.is_acknowledged` (boolean, required)
    has the execution been acknowledged

  - `order.executions.order_created_by` (string, required)
    Order created by user

  - `order.executions.order_id` (string, required)
    Id of the order

  - `order.executions.order_last_updated_by` (string, required)
    Order last updated by user

  - `order.executions.rebate` (string, required)
    Rate as rebate

  - `order.executions.settlement_amount` (string, required)
    Deprecated. Please use contract_value.

  - `order.executions.settlement_date` (string, required)
    settlement date - date in YYYY-MM-DD format

  - `order.executions.settlement_price` (string, required)
    Deprecated. Please use collateral_price.

  - `order.executions.side` (string, required)
    Enum: "BORROW", "LOAN"

  - `order.executions.start_date` (string, required)
    Start date
deprecated

  - `order.executions.status` (string, required)
    Execution status

  - `order.executions.trade_date` (string, required)
    trade date - date in YYYY-MM-DD format

  - `order.executions.unit_price` (string, required)
    Last prior day market price

  - `order.executions.updated_at` (string, required)
    Last Updated - time in RFC3339 with millisecond precision

  - `order.external_id` (string)
    Customer internal id of the order

  - `order.fee` (string)
    Rate limit, expressed as fee
Optional for certain order types: IOI
And not applicable for certain order types: Market

  - `order.firm_quantity` (string, required)
    The number of shares exposed as Firm order

  - `order.good_till_time` (string)
    The time the order will be canceled if populated. Time in RFC3339 with millisecond precision

  - `order.id` (string, required)
    Provable Markets assigned order identifier for the order event notification

  - `order.instrument` (object, required)
    Instruments can be identified by their CUSIP or Ticker SymbolFields: cusip, ticker, name

  - `order.instrument.cusip` (string, required)
    CUSIP

  - `order.instrument.name` (string, required)
    Security name

  - `order.instrument.ticker` (string, required)
    Ticker

  - `order.ioi_quantity` (string, required)
    The number of shares exposed as IOI order

  - `order.last_updated_by` (string, required)
    Last updated by user

  - `order.min_quantity` (string, required)
    The minimum quantity on the order.

  - `order.open_quantity` (string, required)
    The number of shares still open on the order

  - `order.order_intent` (string, required)
    Enum: "FIRM", "IOI"

  - `order.order_status` (string, required)
    Enum: "OPEN", "FILLED", "CANCELED", "EXPIRED", "TERMINATED", "HELD", "FORCE_CANCELED"

  - `order.order_type` (string, required)
    Enum: "LIMIT"

  - `order.quantity` (string, required)
    The number of shares on the original order

  - `order.rebate` (string)
    Rate limit, expressed as rebate (same as fee, but relative to benchmark)
Optional for certain order types: IOI
And not applicable for certain order types: Market

  - `order.side` (string, required)
    Enum: "BORROW", "LOAN"

  - `order.time_in_force` (string, required)
    Enum: "DAY", "GOOD_TILL_CANCEL", "IMMEDIATE_OR_CANCEL", "FILL_OR_KILL", "GOOD_TILL_TIME"

  - `order.total_execution_quantity` (string, required)
    Total shares executed on order so far

  - `order.updated_at` (string, required)
    Order was last changed at - time in RFC3339 with millisecond precision

  - `order.version_reference` (string, required)
    An identifier provided by the user to help associate with any internal references.

  - `request_id` (string, required)
    Unique request identifier assigned to the event