GET api/bfg/v1/holdings/holding-entries
Lists holding entries (<c>SH_GetClientHoldingEntries</c>).
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| HoldingIds | Collection of integer |
None. |
|
| AfterDateTimeTransacted | date |
None. |
|
| AfterHoldingEntryID | integer |
None. |
|
| PageNumber | integer |
None. |
|
| PageSize | integer |
None. |
|
| SortBy | string |
None. |
|
| SortColumn | string |
None. |
|
| SortDirection | string |
None. |
|
| AfterId | integer |
None. |
|
| Search | string |
None. |
|
| SearchKeyword | string |
None. |
|
| FromDate | date |
None. |
|
| StartDate | date |
None. |
|
| ToDate | date |
None. |
|
| EndDate | date |
None. |
Body Parameters
None.
Response Information
Resource Description
GetClientHoldingEntriesResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| HoldingEntries | Collection of HoldingEntryListItem |
None. |
|
| Pagination | HoldingPaginationInfo |
None. |
Response Formats
application/json, text/json
Sample:
{
"HoldingEntries": [
{
"HoldingID": 1,
"HoldingEntryID": 2,
"EntryType": 64,
"DateTimeTransacted": "2026-11-16T17:51:32.505769+11:00",
"DrCr": 64,
"Description": "sample string 6",
"Quantity": 7.0,
"Value": 8.0,
"ContractNoteID": 1
},
{
"HoldingID": 1,
"HoldingEntryID": 2,
"EntryType": 64,
"DateTimeTransacted": "2026-11-16T17:51:32.505769+11:00",
"DrCr": 64,
"Description": "sample string 6",
"Quantity": 7.0,
"Value": 8.0,
"ContractNoteID": 1
}
],
"Pagination": {
"PageNumber": 1,
"PageSize": 2,
"TotalCount": 3,
"TotalPages": 4,
"HasNext": true
}
}
application/xml, text/xml
Sample:
<GetClientHoldingEntriesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contracts2.BFG.Holding">
<HoldingEntries>
<HoldingEntryListItem>
<ContractNoteID>1</ContractNoteID>
<DateTimeTransacted>2026-11-16T17:51:32.505769+11:00</DateTimeTransacted>
<Description>sample string 6</Description>
<DrCr>64</DrCr>
<EntryType>64</EntryType>
<HoldingEntryID>2</HoldingEntryID>
<HoldingID>1</HoldingID>
<Quantity>7</Quantity>
<Value>8</Value>
</HoldingEntryListItem>
<HoldingEntryListItem>
<ContractNoteID>1</ContractNoteID>
<DateTimeTransacted>2026-11-16T17:51:32.505769+11:00</DateTimeTransacted>
<Description>sample string 6</Description>
<DrCr>64</DrCr>
<EntryType>64</EntryType>
<HoldingEntryID>2</HoldingEntryID>
<HoldingID>1</HoldingID>
<Quantity>7</Quantity>
<Value>8</Value>
</HoldingEntryListItem>
</HoldingEntries>
<Pagination>
<HasNext>true</HasNext>
<PageNumber>1</PageNumber>
<PageSize>2</PageSize>
<TotalCount>3</TotalCount>
<TotalPages>4</TotalPages>
</Pagination>
</GetClientHoldingEntriesResponse>