# Execution

PATH: /aurora.core.apiengine.executionsv1.ExecutionEventsService/Execution

Endpoint: POST /aurora.core.apiengine.executionsv1.ExecutionEventsService/Execution
Version: v1.23.0
Security: Bearer

## Request fields (application/json):

  - `execution` (object, required)
    Fields: id, order_id, instrument, side, counterparty_id, execution_quantity, unit_price, settlement_price, collateral_price, fee, rebate, settlement_amount, contract_value, start_date, execution_time, trade_date, settlement_date, is_acknowledged, status, contra_status, cancel_reason, updated_at, order_created_by, order_last_updated_by, agreement

  - `execution.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

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

  - `execution.agreement.balance_target` (string)

  - `execution.agreement.balance_target_variance` (string)

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

  - `execution.agreement.booking_account` (string)

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

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

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

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

  - `execution.agreement.counterparty_booking_account` (string)

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

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

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

  - `execution.agreement.dividend_required` (string, required)

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

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

  - `execution.agreement.profit_center` (string)

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

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

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

  - `execution.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"

  - `execution.agreement.rwa_bucket` (string)

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

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

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

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

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

  - `execution.agreement.term_end_date` (string)

  - `execution.agreement.term_start_date` (string)

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

  - `execution.agreement.trade_type` (string)

  - `execution.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.

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

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

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

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

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

  - `execution.execution_quantity` (string, required)
    Executed quantity

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

  - `execution.fee` (string, required)
    Rate as fee

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

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

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

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

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

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

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

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

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

  - `execution.rebate` (string, required)
    Rate as rebate

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

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

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

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

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

  - `execution.status` (string, required)
    Execution status

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

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

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

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