# OrderCostPreviewResponse

Preview of estimated costs for a chosen quantity, asset, capacity, and limit price

## Example Usage

```typescript
import { OrderCostPreviewResponse } from "@apexfintechsolutions/ascend-sdk/models/components";

let value: OrderCostPreviewResponse = {};
```

## Fields

| Field                                                                                                                                                                                                                                                                                                                                     | Type                                                                                                                                                                                                                                                                                                                                      | Required                                                                                                                                                                                                                                                                                                                                  | Description                                                                                                                                                                                                                                                                                                                               | Example                                                                                                                                                                                                                                                                                                                                   |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `accountId`                                                                                                                                                                                                                                                                                                                               | *string*                                                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                        | The account id used in calculating order costs                                                                                                                                                                                                                                                                                            | 01HBRQ5BW6ZAY4BNWP4GWRD80X                                                                                                                                                                                                                                                                                                                |
| `assetId`                                                                                                                                                                                                                                                                                                                                 | *string*                                                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                        | Apex Asset ID for this asset.                                                                                                                                                                                                                                                                                                             | 22091                                                                                                                                                                                                                                                                                                                                     |
| `assetType`                                                                                                                                                                                                                                                                                                                               | [components.OrderCostPreviewResponseAssetType](../../models/components/ordercostpreviewresponseassettype.md)                                                                                                                                                                                                                              | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                        | The type of asset referenced by the security identifier                                                                                                                                                                                                                                                                                   | FIXED_INCOME                                                                                                                                                                                                                                                                                                                              |
| `brokerCapacity`                                                                                                                                                                                                                                                                                                                          | [components.OrderCostPreviewResponseBrokerCapacity](../../models/components/ordercostpreviewresponsebrokercapacity.md)                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                        | Capacity used in determining the order cost. Defaults to "AGENCY" if no value specified.                                                                                                                                                                                                                                                  | AGENCY                                                                                                                                                                                                                                                                                                                                    |
| `estimatedAccruedInterest`                                                                                                                                                                                                                                                                                                                | [components.EstimatedAccruedInterest](../../models/components/estimatedaccruedinterest.md)                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                        | The estimated total of accrued interest that would be exchanged in an order of the given quantity                                                                                                                                                                                                                                         | {<br/>"value": "18.99"<br/>}                                                                                                                                                                                                                                                                                                              |
| `estimatedGrossAmount`                                                                                                                                                                                                                                                                                                                    | [components.EstimatedGrossAmount](../../models/components/estimatedgrossamount.md)                                                                                                                                                                                                                                                        | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                        | The principal amount involved, which is the notional value of the underlying assets that would be exchanged for the given quantity                                                                                                                                                                                                        | {<br/>"value": "2000"<br/>}                                                                                                                                                                                                                                                                                                               |
| `estimatedGrossCreditAmount`                                                                                                                                                                                                                                                                                                              | [components.EstimatedGrossCreditAmount](../../models/components/estimatedgrosscreditamount.md)                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                        | Customer disclosure of the estimated gross credit (fee / markup) amount retained by broker based given the price adjustment schedule configured for orders executed in a principal capacity for a given quantity, and limit price. This amount is priced into the estimated_gross_credit_amount and is not separately charged explicitly. | {<br/>"value": "1.06"<br/>}                                                                                                                                                                                                                                                                                                               |
| `estimatedNetAmount`                                                                                                                                                                                                                                                                                                                      | [components.EstimatedNetAmount](../../models/components/estimatednetamount.md)                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                        | The estimated net notional amount involved in an order of the given quantity, capacity, and limit price. This will be the sum of the estimated gross amount and accrued interest, rounded to two decimal places. (For orders in the principal capacity, this total will include mark-up/mark-down price adjustments.)                     | {<br/>"value": "2020.05"<br/>}                                                                                                                                                                                                                                                                                                            |
| `identifier`                                                                                                                                                                                                                                                                                                                              | *string*                                                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                        | Identifier of the asset (of the type specified in `identifier_type`).                                                                                                                                                                                                                                                                     | 037833100                                                                                                                                                                                                                                                                                                                                 |
| `identifierType`                                                                                                                                                                                                                                                                                                                          | [components.OrderCostPreviewResponseIdentifierType](../../models/components/ordercostpreviewresponseidentifiertype.md)                                                                                                                                                                                                                    | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                        | The identifier type of the asset used for price calculations. This will be the same value as what was sent on the request.                                                                                                                                                                                                                | CUSIP                                                                                                                                                                                                                                                                                                                                     |
| `limitPrice`                                                                                                                                                                                                                                                                                                                              | [components.OrderCostPreviewResponseLimitPrice](../../models/components/ordercostpreviewresponselimitprice.md)                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                        | The limit price to use in calculating costs. Only PERCENTAGE_OF_PAR will be accepted and returned.                                                                                                                                                                                                                                        | {<br/>"price": {<br/>"value": "98.56"<br/>},<br/>"type": "PERCENTAGE_OF_PAR"<br/>}                                                                                                                                                                                                                                                        |
| `quantity`                                                                                                                                                                                                                                                                                                                                | [components.OrderCostPreviewResponseQuantity](../../models/components/ordercostpreviewresponsequantity.md)                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                        | The quantity of the designated asset that would be ordered. For Fixed Income: Expressed in the par (face-value) amount and may not exceed two decimal places for USD-based currencies.                                                                                                                                                    | {<br/>"value": "200"<br/>}                                                                                                                                                                                                                                                                                                                |
| `responseGenerationTime`                                                                                                                                                                                                                                                                                                                  | [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)                                                                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                        | The time the response was generated by the system                                                                                                                                                                                                                                                                                         | {"seconds": 171442739, "nanos": 61400000}                                                                                                                                                                                                                                                                                                 |