POST 17.0/database/recurringfees/list

Description

Retrieve a list of Recurring Fees

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 RecurringFeesUpdate
Name Description Type Additional information
ID

integer

None.
ContactID

integer

None.
PropertyID

integer

None.
ProductID

integer

None.
Amount

decimal number

None.
StartDate

date

None.
EndDate

date

None.
LastRaisedDate

date

None.
Frequency

byte

None.
TenancyID

integer

None.
BankAccountID

integer

None.
CompanyID

integer

None.
Invoiced

byte

None.
Inactive

byte

None.

application/json, text/json
Sample: 
[
  {
    "id": 1,
    "contactID": 1,
    "propertyID": 1,
    "productID": 1,
    "amount": 1.0,
    "startDate": "2025-01-09T20:52",
    "endDate": "2025-01-09T20:52",
    "lastRaisedDate": "2025-01-09T20:52",
    "frequency": 64,
    "tenancyID": 1,
    "bankAccountID": 1,
    "companyID": 1,
    "invoiced": 64,
    "inactive": 64
  },
  {
    "id": 1,
    "contactID": 1,
    "propertyID": 1,
    "productID": 1,
    "amount": 1.0,
    "startDate": "2025-01-09T20:52",
    "endDate": "2025-01-09T20:52",
    "lastRaisedDate": "2025-01-09T20:52",
    "frequency": 64,
    "tenancyID": 1,
    "bankAccountID": 1,
    "companyID": 1,
    "invoiced": 64,
    "inactive": 64
  }
]

application/xml, text/xml
Sample: 
<ArrayOfRecurringFeesUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <RecurringFeesUpdate>
    <ID>1</ID>
    <ContactID>1</ContactID>
    <PropertyID>1</PropertyID>
    <ProductID>1</ProductID>
    <Amount>1</Amount>
    <StartDate>2025-01-09T20:52:56.1411869+00:00</StartDate>
    <EndDate>2025-01-09T20:52:56.1411869+00:00</EndDate>
    <LastRaisedDate>2025-01-09T20:52:56.1411869+00:00</LastRaisedDate>
    <Frequency>64</Frequency>
    <TenancyID>1</TenancyID>
    <BankAccountID>1</BankAccountID>
    <CompanyID>1</CompanyID>
    <Invoiced>64</Invoiced>
    <Inactive>64</Inactive>
  </RecurringFeesUpdate>
  <RecurringFeesUpdate>
    <ID>1</ID>
    <ContactID>1</ContactID>
    <PropertyID>1</PropertyID>
    <ProductID>1</ProductID>
    <Amount>1</Amount>
    <StartDate>2025-01-09T20:52:56.1411869+00:00</StartDate>
    <EndDate>2025-01-09T20:52:56.1411869+00:00</EndDate>
    <LastRaisedDate>2025-01-09T20:52:56.1411869+00:00</LastRaisedDate>
    <Frequency>64</Frequency>
    <TenancyID>1</TenancyID>
    <BankAccountID>1</BankAccountID>
    <CompanyID>1</CompanyID>
    <Invoiced>64</Invoiced>
    <Inactive>64</Inactive>
  </RecurringFeesUpdate>
</ArrayOfRecurringFeesUpdate>