GET api/receipt/statement/overview/{id}

Gets the payment item details as a Processes this receipt API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Payment item id	integer	Required

Body Parameters

None.

Response Information

Resource Description

Payment item details

StatementItemOverviewDataContract

Name	Description	Type	Additional information
OpeningBalance	The opening balance value.	decimal number	None.
ClosingBalance	The closing balance value.	decimal number	None.
TotalPayoutAmount	The total payout amount value.	decimal number	None.
PropertyRetentionAmount	The property retention amount value.	decimal number	None.
Items	The collection of items.	Collection of InvoicePaymentLineDataContract	None.

Response Formats

application/json, text/json

Sample:

{
  "OpeningBalance": 1.0,
  "ClosingBalance": 2.0,
  "TotalPayoutAmount": 3.0,
  "PropertyRetentionAmount": 1.0,
  "Items": [
    {
      "Amount": 1.0,
      "DrCr": "sample string 2",
      "DateTime": "2026-07-23T08:15:37.5275382Z",
      "Description": "sample string 4",
      "TransactionType": {
        "Name": "sample string 1",
        "SystemName": "sample string 2",
        "Id": 1
      },
      "Id": 5
    },
    {
      "Amount": 1.0,
      "DrCr": "sample string 2",
      "DateTime": "2026-07-23T08:15:37.5275382Z",
      "Description": "sample string 4",
      "TransactionType": {
        "Name": "sample string 1",
        "SystemName": "sample string 2",
        "Id": 1
      },
      "Id": 5
    }
  ]
}