---
title: "Search forward deals"
method: POST
path: "/forward-deals/account/{AccountIdentifier}/action/search"
tags: ["Forward Deals"]
---

# Search forward deals

`POST /forward-deals/account/{AccountIdentifier}/action/search`

## Request

- Base URL: `https://sandbox.preprod.connect.xpansiv.com/app/api/v1`
- URL: `https://sandbox.preprod.connect.xpansiv.com/app/api/v1/forward-deals/account/{AccountIdentifier}/action/search`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/xpansiv/apis/xpansiv-connect-api/docs/forward-deals/account/:AccountIdentifier/action/search/post.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `AccountIdentifier` string, required

## Query parameters

- `page` integer
- `size` integer
- `include` string

## Request body

- object
  - `programs` RefProgram[]
  - `lastUpdatedDateFrom` string, date-time
  - `lastUpdatedDateTo` string, date-time
  - `counterpartyName` string: If this search parameter is passed as ““ then deals with no counterparty identifier specified will be returned.
  - `dealName` string

## Response `200`

List of forward deals

- object
  - `page` integer, required
  - `size` integer, required
  - `totalPages` integer, required
  - `totalElements` integer, required
  - `content` object[]
    - `name` string: Name of the forward deal.
    - `memo` string: Memo if provided by the XC user.
    - `executionDate` string, date-time: Execution date.
    - `externalDealId` string: Optional external ID.
    - `type` string: Type of deal as either Market or Project Specific. Ref.Data.FORWARD_DEAL_TYPE
    - `status` string: Ref.Data.FORWARD_DEAL_STATUS
    - `transactionSideType` string: Buy or Sell. Ref.Data.FORWARD_DEAL_TRANSACTION_TYPE
    - `program` string: Ref.Data.PROGRAM
    - `vintageType` string: Ref.Data.FORWARD_DEAL_VINTAGE_TYPE
    - `createdBy` string: Created by id.
    - `trader` string: Trader name associated with the deal.
    - `privateCounterpartyDetails` object
      - `contactName` string: Optional contact name.
      - `name` string: Optional counterparty name.
      - `tradeDate` string, date-time: Optional trade date.
      - `contractNumber` string: Optional contract number.
    - `unitOfMeasure` string: Unit of measure. Ref.Data.UNIT_OF_MEASURE
    - `counterpartyName` string: Name of the counterparty in the registry for this deal.
    - `brokerDetails` object
      - `identifier` string: Broker id.
      - `name` string: Broker name.
      - `fee` Price
        - `currency` string, required: Ref.Data.CURRENCY
        - `amount` number, required: The numeric value of the price
    - `lastUpdatedDate` string, date-time: Last updated date.
    - `forwardPortfolio` object
      - `identifier` string
      - `name` string
    - `confirmDetails` object
      - `comments` string: Comments associated with the confirm action if provided by the XC client.
      - `brokerInWriting` boolean: Flag for if confirm was agreed with broker in writing.
      - `receivedDate` string, date-time: Date the confirm was received.
      - `executionDate` string, date-time: Date of deal execution related to this confirm action.
    - `statusEvents` ForwardStatusEvent[]: Optional property. Use `include` param.
      - `action` string: Action for the statusEvent.
      - `notes` string: Notes for the statusEvent.
      - `timestamp` string, date-time: Timestamp for the statusEvent.
      - `user` string: User for the statusEvent.
    - `forwardTransactions` object[]
      - `identifier` string: Unique identifier.
      - `deliveryDate` string, date-time: Schedule delivery date.
      - `quantity` integer: Scheduled delivery quantity.
      - `quantityType` string: Quantity type. Ref.Data.FORWARD_DEAL_QUANTITY_TYPE
      - `status` string: Delivery status. Ref.Data.FORWARD_DEAL_TRANSACTION_STATUS
      - `deliveryScheduleType` string: Delivery schedule type. Ref.Data.FORWARD_DEAL_DELIVERY_SCHEDULE_TYPE
      - `contractedDetails` ForwardContract
        - `volume` integer: Delivered volume.
        - `unitPrice` Price
          - `currency` string, required: Ref.Data.CURRENCY
          - `amount` number, required: The numeric value of the price
        - `value` Price
          - `currency` string, required: Ref.Data.CURRENCY
          - `amount` number, required: The numeric value of the price
      - `deliveredDetails` ForwardContract
        - `volume` integer: Delivered volume.
        - `unitPrice` Price
          - `currency` string, required: Ref.Data.CURRENCY
          - `amount` number, required: The numeric value of the price
        - `value` Price
          - `currency` string, required: Ref.Data.CURRENCY
          - `amount` number, required: The numeric value of the price
      - `netOpenVolume` integer: Remaining open volume.
      - `createdDate` string, date-time: Delivery created date.
      - `lastUpdatedDate` string, date-time: Delivery last updated date.
      - `forwardInstrument` union
        - object
          - `type` string
          - `deliveryDateRange` ForwardDateRange
            - `startMonth` integer: Month of delivery start.
            - `startYear` integer: Year of delivery start.
            - `endMonth` integer: Month of delivery end.
            - `endYear` integer: Year of delivery end.
          - `attributeBundle` object
            - `name` string: Bundle name.
            - `dateRange` ForwardDateRange
              - …
            - `market` ForwardMarket
              - …
            - `projects` object[]
              - …
        - object
          - `type` string
          - `deliveryDateRange` ForwardDateRange
            - `startMonth` integer: Month of delivery start.
            - `startYear` integer: Year of delivery start.
            - `endMonth` integer: Month of delivery end.
            - `endYear` integer: Year of delivery end.
          - `marketModelInstrument` object
            - `dateRange` ForwardDateRange
              - …
            - `market` ForwardMarket
              - …
      - `deliveryNotes` string
      - `statusEvents` ForwardStatusEvent[]: Optional property. Use `include` param. Status event types.
        - `action` string: Action for the statusEvent.
        - `notes` string: Notes for the statusEvent.
        - `timestamp` string, date-time: Timestamp for the statusEvent.
        - `user` string: User for the statusEvent.
      - `linkedTransfers` string[]: Optional property. Use `include` param. Each value represents a transaction ID for the linked transfer.

## Other responses

- `400`: Bad request
- `401`: Not authorized error
- `500`: Internal server error

---

[API](https://skmtc.dev/xpansiv/apis/xpansiv-connect-api.md) - [All operations](https://skmtc.dev/xpansiv/apis/xpansiv-connect-api/llms.txt) - [OpenAPI document](https://skmtc.dev/xpansiv/apis/xpansiv-connect-api/revisions/01c1f2c4ec1e?raw)