PUT web/Deal/WebDeal

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
deal	UpdateWebDeals	Required
deal_transaction	Collection of WebDealTransaction	None.
payments	Collection of WebDealPayments	None.
settlements	Collection of WebDealSettlements	None.

Request Formats

application/json, text/json

Sample:

{
  "deal": {
    "record": {
      "value": "sample string 1",
      "id": 2
    },
    "notes": "sample string 1",
    "internal_remarks": "sample string 2",
    "entity_id": 3,
    "deal_type": {
      "value": "sample string 1",
      "id": 2
    },
    "value_date": "sample string 4",
    "start_date": "sample string 5",
    "sub_inv_org": {
      "value": "sample string 1",
      "id": 2
    },
    "is_institutional": 6,
    "close_at_value_date": true,
    "reverse_deal": {
      "value": "sample string 1",
      "id": 2
    }
  },
  "deal_transaction": [
    {
      "buy_currency": {
        "value": "sample string 1",
        "id": 2
      },
      "buy_amount": 1.0,
      "sell_amount": 2.0,
      "exchange_rate": 3.0,
      "actual_market_rate": 4.0,
      "market_rate": 5.0,
      "spot_rate": 6.0,
      "forward_points": 7.0,
      "is_equivalent": true,
      "is_buy": true,
      "sell_currency": {
        "value": "sample string 1",
        "id": 2
      },
      "liquidity_provider": {
        "value": "sample string 1",
        "id": 2
      },
      "fix_price_output": "sample string 10",
      "funding_bank_account": 11
    },
    {
      "buy_currency": {
        "value": "sample string 1",
        "id": 2
      },
      "buy_amount": 1.0,
      "sell_amount": 2.0,
      "exchange_rate": 3.0,
      "actual_market_rate": 4.0,
      "market_rate": 5.0,
      "spot_rate": 6.0,
      "forward_points": 7.0,
      "is_equivalent": true,
      "is_buy": true,
      "sell_currency": {
        "value": "sample string 1",
        "id": 2
      },
      "liquidity_provider": {
        "value": "sample string 1",
        "id": 2
      },
      "fix_price_output": "sample string 10",
      "funding_bank_account": 11
    }
  ],
  "payments": [
    {
      "currency": {
        "value": "sample string 1",
        "id": 2
      },
      "amount": 1.0,
      "value_date": "sample string 2",
      "entry_date": "sample string 3",
      "account": {
        "value": "sample string 1",
        "id": 2
      },
      "payee": {
        "value": "sample string 1",
        "id": 2
      },
      "payee_name": "sample string 4",
      "action": {
        "value": "sample string 1",
        "id": 2
      },
      "act_type": "sample string 5",
      "edocuments": [
        {
          "document_type_id": 1,
          "file_name": "sample string 2",
          "description": "sample string 3",
          "public_for_organization": true,
          "file_bytes": "sample string 5"
        },
        {
          "document_type_id": 1,
          "file_name": "sample string 2",
          "description": "sample string 3",
          "public_for_organization": true,
          "file_bytes": "sample string 5"
        }
      ]
    },
    {
      "currency": {
        "value": "sample string 1",
        "id": 2
      },
      "amount": 1.0,
      "value_date": "sample string 2",
      "entry_date": "sample string 3",
      "account": {
        "value": "sample string 1",
        "id": 2
      },
      "payee": {
        "value": "sample string 1",
        "id": 2
      },
      "payee_name": "sample string 4",
      "action": {
        "value": "sample string 1",
        "id": 2
      },
      "act_type": "sample string 5",
      "edocuments": [
        {
          "document_type_id": 1,
          "file_name": "sample string 2",
          "description": "sample string 3",
          "public_for_organization": true,
          "file_bytes": "sample string 5"
        },
        {
          "document_type_id": 1,
          "file_name": "sample string 2",
          "description": "sample string 3",
          "public_for_organization": true,
          "file_bytes": "sample string 5"
        }
      ]
    }
  ],
  "settlements": [
    {
      "action": {
        "value": "sample string 1",
        "id": 2
      },
      "currency": {
        "value": "sample string 1",
        "id": 2
      },
      "amount": 1.0,
      "value_date": "sample string 2",
      "account": {
        "value": "sample string 1",
        "id": 2
      },
      "payee": {
        "value": "sample string 1",
        "id": 2
      },
      "payee_name": "sample string 3",
      "act_type": "sample string 4",
      "reference": "sample string 5",
      "beneficiary_reference": "sample string 6",
      "notify_my_receipient": "sample string 7",
      "beneficiary_remarks": "sample string 8",
      "internal_reference": "sample string 9",
      "remittence_remarks": "sample string 10",
      "purpose_of_payment": {
        "value": "sample string 1",
        "id": 2
      },
      "purpose_of_payment_details": "sample string 11",
      "is_equivalent": true,
      "fee": 13.1,
      "fee_type": {
        "value": "sample string 1",
        "id": 2
      },
      "fee_currency": {
        "value": "sample string 1",
        "id": 2
      },
      "is_manual_fee": true,
      "edocuments": [
        {
          "document_type_id": 1,
          "file_name": "sample string 2",
          "description": "sample string 3",
          "public_for_organization": true,
          "file_bytes": "sample string 5"
        },
        {
          "document_type_id": 1,
          "file_name": "sample string 2",
          "description": "sample string 3",
          "public_for_organization": true,
          "file_bytes": "sample string 5"
        }
      ]
    },
    {
      "action": {
        "value": "sample string 1",
        "id": 2
      },
      "currency": {
        "value": "sample string 1",
        "id": 2
      },
      "amount": 1.0,
      "value_date": "sample string 2",
      "account": {
        "value": "sample string 1",
        "id": 2
      },
      "payee": {
        "value": "sample string 1",
        "id": 2
      },
      "payee_name": "sample string 3",
      "act_type": "sample string 4",
      "reference": "sample string 5",
      "beneficiary_reference": "sample string 6",
      "notify_my_receipient": "sample string 7",
      "beneficiary_remarks": "sample string 8",
      "internal_reference": "sample string 9",
      "remittence_remarks": "sample string 10",
      "purpose_of_payment": {
        "value": "sample string 1",
        "id": 2
      },
      "purpose_of_payment_details": "sample string 11",
      "is_equivalent": true,
      "fee": 13.1,
      "fee_type": {
        "value": "sample string 1",
        "id": 2
      },
      "fee_currency": {
        "value": "sample string 1",
        "id": 2
      },
      "is_manual_fee": true,
      "edocuments": [
        {
          "document_type_id": 1,
          "file_name": "sample string 2",
          "description": "sample string 3",
          "public_for_organization": true,
          "file_bytes": "sample string 5"
        },
        {
          "document_type_id": 1,
          "file_name": "sample string 2",
          "description": "sample string 3",
          "public_for_organization": true,
          "file_bytes": "sample string 5"
        }
      ]
    }
  ]
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'UpdateWebDeal'.

application/xml

Sample:

An exception has occurred while using the formatter 'CustomXmlFormatter' to generate sample for media type 'application/xml'. Exception message: Cannot access a closed Stream.

text/xml

Sample:

An exception has occurred while using the formatter 'CustomXmlFormatter' to generate sample for media type 'text/xml'. Exception message: Cannot access a closed Stream.

Response Information

Resource Description

DSOutput

Name	Type	Additional information
status	boolean	None.
data	Object	None.
code	integer	None.
message	string	None.
error	Error	None.
paging	Paging	None.
additional_codes	string	None.

Response Formats

application/json, text/json

Sample:

{
  "status": true,
  "data": {},
  "code": 0,
  "message": "sample string 3",
  "error": {
    "code": 0,
    "message": "sample string 1",
    "target": "sample string 2",
    "details": [
      {
        "code": 0,
        "target": "sample string 1",
        "message": "sample string 2"
      },
      {
        "code": 0,
        "target": "sample string 1",
        "message": "sample string 2"
      }
    ]
  },
  "paging": {
    "page_number": 1,
    "page_size": 2,
    "page_from": 3,
    "page_to": 4,
    "record_count": 5
  },
  "additional_codes": "sample string 4"
}

application/xml

Sample:

An exception has occurred while using the formatter 'CustomXmlFormatter' to generate sample for media type 'application/xml'. Exception message: Cannot access a closed Stream.

text/xml

Sample:

An exception has occurred while using the formatter 'CustomXmlFormatter' to generate sample for media type 'text/xml'. Exception message: Cannot access a closed Stream.