POST 17.0/app/summarystatements/getsummarystatements

Description

Retrieves a list of summary statement items for transactions within a specified date range.

URI Parameters

None.

The summary statement request containing contact type, optional contact ID, bank account ID, and date range for filtering transactions.

SummaryStatementRequest
Name Description Type Additional information
ContactType

byte

None.
ContactId

integer

None.
BankAccountId

integer

None.
StartDate

date

None.
EndDate

date

None.

application/json, text/json
Sample: 
{
  "contactType": 64,
  "contactId": 2,
  "bankAccountId": 3,
  "startDate": "2026-03-13T12:40",
  "endDate": "2026-03-13T12:40"
}

application/xml, text/xml
Sample: 
<SummaryStatementRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ContactType>64</ContactType>
  <ContactId>2</ContactId>
  <BankAccountId>3</BankAccountId>
  <StartDate>2026-03-13T12:40:01.7036956+00:00</StartDate>
  <EndDate>2026-03-13T12:40:01.7036956+00:00</EndDate>
</SummaryStatementRequest>

application/x-www-form-urlencoded
Sample:

Sample not available.

A list of SummaryStatementItem objects containing transaction IDs, contact details, and property information for transactions matching the filter criteria.

Collection of SummaryStatementItem
Name Description Type Additional information
Id

integer

None.
ContactId

integer

None.
Contact

string

None.
PropertyId

integer

None.
Property

string

None.

application/json, text/json
Sample: 
[
  {
    "id": 1,
    "contactId": 2,
    "contact": "sample string 3",
    "propertyId": 4,
    "property": "sample string 5"
  },
  {
    "id": 1,
    "contactId": 2,
    "contact": "sample string 3",
    "propertyId": 4,
    "property": "sample string 5"
  }
]

application/xml, text/xml
Sample: 
<ArrayOfSummaryStatementItem xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <SummaryStatementItem>
    <Id>1</Id>
    <ContactId>2</ContactId>
    <Contact>sample string 3</Contact>
    <PropertyId>4</PropertyId>
    <Property>sample string 5</Property>
  </SummaryStatementItem>
  <SummaryStatementItem>
    <Id>1</Id>
    <ContactId>2</ContactId>
    <Contact>sample string 3</Contact>
    <PropertyId>4</PropertyId>
    <Property>sample string 5</Property>
  </SummaryStatementItem>
</ArrayOfSummaryStatementItem>