POST 17.0/app/tenancy/retrievesrentstopay

Description

No description available.

URI Parameters

None.

RetrieveRentsRequests
Name Description Type Additional information
BankAccountId

integer

None.
DaysOverdue

integer

None.
OnlyIncludeCurrentTenancies

boolean

None.
LandlordId

integer

None.
DueDate

date

None.

application/json, text/json
Sample: 
{
  "bankAccountId": 1,
  "daysOverdue": 2,
  "onlyIncludeCurrentTenancies": true,
  "landlordId": 4,
  "dueDate": "2026-03-13T12:39"
}

application/xml, text/xml
Sample: 
<RetrieveRentsRequests xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <BankAccountId>1</BankAccountId>
  <DaysOverdue>2</DaysOverdue>
  <OnlyIncludeCurrentTenancies>true</OnlyIncludeCurrentTenancies>
  <LandlordId>4</LandlordId>
  <DueDate>2026-03-13T12:39:59.6724475+00:00</DueDate>
</RetrieveRentsRequests>

application/x-www-form-urlencoded
Sample:

Sample not available.

Collection of RentToPayItem
Name Description Type Additional information
Id

integer

None.
DueDate

date

None.
Overdue

integer

None.
ContactId

integer

None.
Contact

string

None.
Reference

string

None.
PropertyId

integer

None.
Property

string

None.
LandlordId

integer

None.
Landlord

string

None.
CommissionFee

decimal number

None.
CommissionPercentage

decimal number

None.
RentGuarantee

string

None.
Due

decimal number

None.
Received

decimal number

None.
ReferenceChequeNo

string

None.

application/json, text/json
Sample: 
[
  {
    "id": 1,
    "dueDate": "2026-03-13T12:39",
    "overdue": 3,
    "contactId": 4,
    "contact": "sample string 5",
    "reference": "sample string 6",
    "propertyId": 7,
    "property": "sample string 8",
    "landlordId": 9,
    "landlord": "sample string 10",
    "commissionFee": 11.0,
    "commissionPercentage": 12.0,
    "rentGuarantee": "sample string 13",
    "due": 14.0,
    "received": 15.0,
    "referenceChequeNo": "sample string 16"
  },
  {
    "id": 1,
    "dueDate": "2026-03-13T12:39",
    "overdue": 3,
    "contactId": 4,
    "contact": "sample string 5",
    "reference": "sample string 6",
    "propertyId": 7,
    "property": "sample string 8",
    "landlordId": 9,
    "landlord": "sample string 10",
    "commissionFee": 11.0,
    "commissionPercentage": 12.0,
    "rentGuarantee": "sample string 13",
    "due": 14.0,
    "received": 15.0,
    "referenceChequeNo": "sample string 16"
  }
]

application/xml, text/xml
Sample: 
<ArrayOfRentToPayItem xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <RentToPayItem>
    <Id>1</Id>
    <DueDate>2026-03-13T12:39:59.6724475+00:00</DueDate>
    <Overdue>3</Overdue>
    <ContactId>4</ContactId>
    <Contact>sample string 5</Contact>
    <Reference>sample string 6</Reference>
    <PropertyId>7</PropertyId>
    <Property>sample string 8</Property>
    <LandlordId>9</LandlordId>
    <Landlord>sample string 10</Landlord>
    <CommissionFee>11</CommissionFee>
    <CommissionPercentage>12</CommissionPercentage>
    <RentGuarantee>sample string 13</RentGuarantee>
    <Due>14</Due>
    <Received>15</Received>
    <ReferenceChequeNo>sample string 16</ReferenceChequeNo>
  </RentToPayItem>
  <RentToPayItem>
    <Id>1</Id>
    <DueDate>2026-03-13T12:39:59.6724475+00:00</DueDate>
    <Overdue>3</Overdue>
    <ContactId>4</ContactId>
    <Contact>sample string 5</Contact>
    <Reference>sample string 6</Reference>
    <PropertyId>7</PropertyId>
    <Property>sample string 8</Property>
    <LandlordId>9</LandlordId>
    <Landlord>sample string 10</Landlord>
    <CommissionFee>11</CommissionFee>
    <CommissionPercentage>12</CommissionPercentage>
    <RentGuarantee>sample string 13</RentGuarantee>
    <Due>14</Due>
    <Received>15</Received>
    <ReferenceChequeNo>sample string 16</ReferenceChequeNo>
  </RentToPayItem>
</ArrayOfRentToPayItem>