POST 17.0/database/rentguarantees/list

Description

Retrieve a list of Rent Guarantees

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

integer

None.
PropertyID

integer

None.
BankAccountID

integer

None.
StartDate

date

None.
EndDate

date

None.
Amount

decimal number

None.
PaymentFrequency

byte

None.
LastPaymentDate

date

None.
NextPaymentDate

date

None.
UserID

integer

None.
AddedDate

date

None.
UpdatedDate

date

None.
Notes

string

None.

application/json, text/json
Sample: 
[
  {
    "id": 1,
    "propertyID": 1,
    "bankAccountID": 1,
    "startDate": "2025-01-09T20:11",
    "endDate": "2025-01-09T20:11",
    "amount": 1.0,
    "paymentFrequency": 64,
    "lastPaymentDate": "2025-01-09T20:11",
    "nextPaymentDate": "2025-01-09T20:11",
    "userID": 1,
    "addedDate": "2025-01-09T20:11",
    "updatedDate": "2025-01-09T20:11",
    "notes": "sample string 1"
  },
  {
    "id": 1,
    "propertyID": 1,
    "bankAccountID": 1,
    "startDate": "2025-01-09T20:11",
    "endDate": "2025-01-09T20:11",
    "amount": 1.0,
    "paymentFrequency": 64,
    "lastPaymentDate": "2025-01-09T20:11",
    "nextPaymentDate": "2025-01-09T20:11",
    "userID": 1,
    "addedDate": "2025-01-09T20:11",
    "updatedDate": "2025-01-09T20:11",
    "notes": "sample string 1"
  }
]

application/xml, text/xml
Sample: 
<ArrayOfRentGuaranteesUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <RentGuaranteesUpdate>
    <ID>1</ID>
    <PropertyID>1</PropertyID>
    <BankAccountID>1</BankAccountID>
    <StartDate>2025-01-09T20:11:12.0499641+00:00</StartDate>
    <EndDate>2025-01-09T20:11:12.0499641+00:00</EndDate>
    <Amount>1</Amount>
    <PaymentFrequency>64</PaymentFrequency>
    <LastPaymentDate>2025-01-09T20:11:12.0499641+00:00</LastPaymentDate>
    <NextPaymentDate>2025-01-09T20:11:12.0499641+00:00</NextPaymentDate>
    <UserID>1</UserID>
    <AddedDate>2025-01-09T20:11:12.0499641+00:00</AddedDate>
    <UpdatedDate>2025-01-09T20:11:12.0499641+00:00</UpdatedDate>
    <Notes>sample string 1</Notes>
  </RentGuaranteesUpdate>
  <RentGuaranteesUpdate>
    <ID>1</ID>
    <PropertyID>1</PropertyID>
    <BankAccountID>1</BankAccountID>
    <StartDate>2025-01-09T20:11:12.0499641+00:00</StartDate>
    <EndDate>2025-01-09T20:11:12.0499641+00:00</EndDate>
    <Amount>1</Amount>
    <PaymentFrequency>64</PaymentFrequency>
    <LastPaymentDate>2025-01-09T20:11:12.0499641+00:00</LastPaymentDate>
    <NextPaymentDate>2025-01-09T20:11:12.0499641+00:00</NextPaymentDate>
    <UserID>1</UserID>
    <AddedDate>2025-01-09T20:11:12.0499641+00:00</AddedDate>
    <UpdatedDate>2025-01-09T20:11:12.0499641+00:00</UpdatedDate>
    <Notes>sample string 1</Notes>
  </RentGuaranteesUpdate>
</ArrayOfRentGuaranteesUpdate>