GET api/bfg/v1/contract-notes/netting-orders/{nettingOrderId}?sourceType={sourceType}
Contract note totals for a netting order (<c>SH_GetContractNoteByNettingOrderID</c>).
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| nettingOrderId |
Paris netting order id. |
integer |
Required |
| sourceType |
Paris TContractNote.SourceType; defaults to (49). |
integer |
None. |
Body Parameters
None.
Response Information
Resource Description
GetContractNoteByNettingOrderResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Count | integer |
None. |
|
| Amounts | decimal number |
None. |
|
| Brokerages | decimal number |
None. |
|
| GST | decimal number |
None. |
|
| TradeValues | decimal number |
None. |
|
| TotalQuantity | integer |
None. |
|
| MaxContractNoteId | integer |
None. |
|
| ContractNoteIds | string |
None. |
|
| AchFeeTotal | decimal number |
None. |
|
| OptionExerciseFeeTotal | decimal number |
None. |
|
| Multiplier | decimal number |
None. |
Response Formats
application/json, text/json
Sample:
{
"Count": 1,
"Amounts": 2.0,
"Brokerages": 3.0,
"GST": 4.0,
"TradeValues": 5.0,
"TotalQuantity": 6,
"MaxContractNoteId": 1,
"ContractNoteIds": "sample string 7",
"AchFeeTotal": 8.0,
"OptionExerciseFeeTotal": 9.0,
"Multiplier": 10.0
}
application/xml, text/xml
Sample:
<GetContractNoteByNettingOrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contracts2.BFG.ContractNote"> <AchFeeTotal>8</AchFeeTotal> <Amounts>2</Amounts> <Brokerages>3</Brokerages> <ContractNoteIds>sample string 7</ContractNoteIds> <Count>1</Count> <GST>4</GST> <MaxContractNoteId>1</MaxContractNoteId> <Multiplier>10</Multiplier> <OptionExerciseFeeTotal>9</OptionExerciseFeeTotal> <TotalQuantity>6</TotalQuantity> <TradeValues>5</TradeValues> </GetContractNoteByNettingOrderResponse>