POST 17.0/database/contactaccountbalances/list

Description

Retrieve a list of Contact Account Balances

URI Parameters

None.

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.

Name Description Type Additional information
ContactID

integer

None.

PropertyID

integer

None.

BankAccountID

integer

None.

BalanceDate

date

None.

Balance

decimal number

None.

application/json, text/json

Sample:
[
  {
    "contactID": 1,
    "propertyID": 1,
    "bankAccountID": 1,
    "balanceDate": "2025-01-09T20:50",
    "balance": 1.0
  },
  {
    "contactID": 1,
    "propertyID": 1,
    "bankAccountID": 1,
    "balanceDate": "2025-01-09T20:50",
    "balance": 1.0
  }
]

application/xml, text/xml

Sample:
<ArrayOfContactAccountBalancesUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ContactAccountBalancesUpdate>
    <ContactID>1</ContactID>
    <PropertyID>1</PropertyID>
    <BankAccountID>1</BankAccountID>
    <BalanceDate>2025-01-09T20:50:42.6639933+00:00</BalanceDate>
    <Balance>1</Balance>
  </ContactAccountBalancesUpdate>
  <ContactAccountBalancesUpdate>
    <ContactID>1</ContactID>
    <PropertyID>1</PropertyID>
    <BankAccountID>1</BankAccountID>
    <BalanceDate>2025-01-09T20:50:42.6639933+00:00</BalanceDate>
    <Balance>1</Balance>
  </ContactAccountBalancesUpdate>
</ArrayOfContactAccountBalancesUpdate>