POST 17.0/app/paymentruns/fetchcontactstopay

Description

Returns the contacts to be paid

URI Parameters

None.

The filters such as the contact type and bank account id

PaymentRunContactsRequest
Name Description Type Additional information
BankAccountId

integer

None.
SiteId

integer

None.
LandlordId

integer

None.
ContactType

byte

None.
OnlyIncludeWithBankAccounts

boolean

None.
PaymentExportFormat

integer

None.

application/json, text/json
Sample: 
{
  "bankAccountId": 1,
  "siteId": 2,
  "landlordId": 3,
  "contactType": 64,
  "onlyIncludeWithBankAccounts": true,
  "paymentExportFormat": 6
}

application/xml, text/xml
Sample: 
<PaymentRunContactsRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <BankAccountId>1</BankAccountId>
  <SiteId>2</SiteId>
  <LandlordId>3</LandlordId>
  <ContactType>64</ContactType>
  <OnlyIncludeWithBankAccounts>true</OnlyIncludeWithBankAccounts>
  <PaymentExportFormat>6</PaymentExportFormat>
</PaymentRunContactsRequest>

application/x-www-form-urlencoded
Sample:

Sample not available.

Returns a list of contact details such as contact id, property address etc

Collection of PaymentRunContactResponse
Name Description Type Additional information
Id

integer

None.
ContactId

integer

None.
Contact

string

None.
PropertyId

integer

None.
Property

string

None.
OwnerId

integer

None.
Owner

string

None.
LastPaymentDate

date

None.
RentDueDay

string

None.
RentArrears

decimal number

None.
Warnings

string

None.
ReferenceChequeNo

string

None.
Balance

decimal number

None.
FloatToRetain

decimal number

None.
TaxToDeduct

decimal number

None.
InvoiceFeesSeparately

boolean

None.
InvoiceFeesTotal

decimal number

None.
AmountToPay

decimal number

None.

application/json, text/json
Sample: 
[
  {
    "id": 1,
    "contactId": 2,
    "contact": "sample string 3",
    "propertyId": 4,
    "property": "sample string 5",
    "ownerId": 6,
    "owner": "sample string 7",
    "lastPaymentDate": "2026-03-13T12:40",
    "rentDueDay": "sample string 9",
    "rentArrears": 10.0,
    "warnings": "sample string 11",
    "referenceChequeNo": "sample string 12",
    "balance": 13.0,
    "floatToRetain": 14.0,
    "taxToDeduct": 15.0,
    "invoiceFeesSeparately": true,
    "invoiceFeesTotal": 17.0,
    "amountToPay": 18.0
  },
  {
    "id": 1,
    "contactId": 2,
    "contact": "sample string 3",
    "propertyId": 4,
    "property": "sample string 5",
    "ownerId": 6,
    "owner": "sample string 7",
    "lastPaymentDate": "2026-03-13T12:40",
    "rentDueDay": "sample string 9",
    "rentArrears": 10.0,
    "warnings": "sample string 11",
    "referenceChequeNo": "sample string 12",
    "balance": 13.0,
    "floatToRetain": 14.0,
    "taxToDeduct": 15.0,
    "invoiceFeesSeparately": true,
    "invoiceFeesTotal": 17.0,
    "amountToPay": 18.0
  }
]

application/xml, text/xml
Sample: 
<ArrayOfPaymentRunContactResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PaymentRunContactResponse>
    <Id>1</Id>
    <ContactId>2</ContactId>
    <Contact>sample string 3</Contact>
    <PropertyId>4</PropertyId>
    <Property>sample string 5</Property>
    <OwnerId>6</OwnerId>
    <Owner>sample string 7</Owner>
    <LastPaymentDate>2026-03-13T12:40:02.1255693+00:00</LastPaymentDate>
    <RentDueDay>sample string 9</RentDueDay>
    <RentArrears>10</RentArrears>
    <Warnings>sample string 11</Warnings>
    <ReferenceChequeNo>sample string 12</ReferenceChequeNo>
    <Balance>13</Balance>
    <FloatToRetain>14</FloatToRetain>
    <TaxToDeduct>15</TaxToDeduct>
    <InvoiceFeesSeparately>true</InvoiceFeesSeparately>
    <InvoiceFeesTotal>17</InvoiceFeesTotal>
    <AmountToPay>18</AmountToPay>
  </PaymentRunContactResponse>
  <PaymentRunContactResponse>
    <Id>1</Id>
    <ContactId>2</ContactId>
    <Contact>sample string 3</Contact>
    <PropertyId>4</PropertyId>
    <Property>sample string 5</Property>
    <OwnerId>6</OwnerId>
    <Owner>sample string 7</Owner>
    <LastPaymentDate>2026-03-13T12:40:02.1255693+00:00</LastPaymentDate>
    <RentDueDay>sample string 9</RentDueDay>
    <RentArrears>10</RentArrears>
    <Warnings>sample string 11</Warnings>
    <ReferenceChequeNo>sample string 12</ReferenceChequeNo>
    <Balance>13</Balance>
    <FloatToRetain>14</FloatToRetain>
    <TaxToDeduct>15</TaxToDeduct>
    <InvoiceFeesSeparately>true</InvoiceFeesSeparately>
    <InvoiceFeesTotal>17</InvoiceFeesTotal>
    <AmountToPay>18</AmountToPay>
  </PaymentRunContactResponse>
</ArrayOfPaymentRunContactResponse>