POST 17.0/database/statements/list

Description

Retrieve a list of Statements

URI Parameters

None.

ListOptions
Name Description Type Additional information
Fields

Collection of string

None.
Filters

Collection of DatabaseFilter

None.
Order

string

None.

application/json, text/json
Sample: 
{
  "fields": [
    "sample string 1",
    "sample string 2"
  ],
  "filters": [
    {
      "fieldName": "sample string 1",
      "value": "sample string 2",
      "operator": "sample string 3",
      "valueType": "sample string 4"
    },
    {
      "fieldName": "sample string 1",
      "value": "sample string 2",
      "operator": "sample string 3",
      "valueType": "sample string 4"
    }
  ],
  "order": "sample string 1"
}

application/xml, text/xml
Sample: 
<ListOptions xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Fields>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </Fields>
  <Filters>
    <DatabaseFilter>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
      <Operator>sample string 3</Operator>
      <ValueType>sample string 4</ValueType>
    </DatabaseFilter>
    <DatabaseFilter>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
      <Operator>sample string 3</Operator>
      <ValueType>sample string 4</ValueType>
    </DatabaseFilter>
  </Filters>
  <Order>sample string 1</Order>
</ListOptions>

application/x-www-form-urlencoded
Sample:

Sample not available.

Collection of StatementsUpdate
Name Description Type Additional information
ID

integer

None.
ContactID

integer

None.
PropertyID

integer

None.
TenancyID

integer

None.
PaymentRunID

integer

None.
AddedDate

date

None.
UserID

integer

None.
SiteID

integer

None.
FooterText

string

None.
CompanyID

integer

None.
Uploaded

byte

None.

application/json, text/json
Sample: 
[
  {
    "id": 1,
    "contactID": 1,
    "propertyID": 1,
    "tenancyID": 1,
    "paymentRunID": 1,
    "addedDate": "2025-01-09T20:35",
    "userID": 1,
    "siteID": 1,
    "footerText": "sample string 1",
    "companyID": 1,
    "uploaded": 64
  },
  {
    "id": 1,
    "contactID": 1,
    "propertyID": 1,
    "tenancyID": 1,
    "paymentRunID": 1,
    "addedDate": "2025-01-09T20:35",
    "userID": 1,
    "siteID": 1,
    "footerText": "sample string 1",
    "companyID": 1,
    "uploaded": 64
  }
]

application/xml, text/xml
Sample: 
<ArrayOfStatementsUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <StatementsUpdate>
    <ID>1</ID>
    <ContactID>1</ContactID>
    <PropertyID>1</PropertyID>
    <TenancyID>1</TenancyID>
    <PaymentRunID>1</PaymentRunID>
    <AddedDate>2025-01-09T20:35:46.6113993+00:00</AddedDate>
    <UserID>1</UserID>
    <SiteID>1</SiteID>
    <FooterText>sample string 1</FooterText>
    <CompanyID>1</CompanyID>
    <Uploaded>64</Uploaded>
  </StatementsUpdate>
  <StatementsUpdate>
    <ID>1</ID>
    <ContactID>1</ContactID>
    <PropertyID>1</PropertyID>
    <TenancyID>1</TenancyID>
    <PaymentRunID>1</PaymentRunID>
    <AddedDate>2025-01-09T20:35:46.6113993+00:00</AddedDate>
    <UserID>1</UserID>
    <SiteID>1</SiteID>
    <FooterText>sample string 1</FooterText>
    <CompanyID>1</CompanyID>
    <Uploaded>64</Uploaded>
  </StatementsUpdate>
</ArrayOfStatementsUpdate>