POST 17.0/app/payments/getconsolidatedaccountstopay

Description

Gets the list of consolidated accounts/contacts that have amounts available to pay.

URI Parameters

None.

Payment run parameters including bank account and filters.

ConsolidatedToPayquest
Name Description Type Additional information
ContactId

integer

None.
BankAccountId

integer

None.
SiteId

integer

None.
OnlyIncludeWithBankAccounts

boolean

None.
PaymentExportFormat

byte

None.

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

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

application/x-www-form-urlencoded
Sample:

Sample not available.

List of consolidated payment items with calculated amounts due.

Collection of ConsolidatedToPayItem
Name Description Type Additional information
ContactId

integer

None.
Contact

string

None.
PreferredPaymentDay

string

None.
LastPaymentDate

date

None.
RentArrears

decimal number

None.
Warnings

string

None.
ReferenceChequeNo

string

None.
Balance

decimal number

None.
ConsolidatedFloat

decimal number

None.
TaxToDeduct

decimal number

None.
InvoiceFeesSeparately

boolean

None.
InvoiceFeesTotal

decimal number

None.
AmountToPay

decimal number

None.

application/json, text/json
Sample: 
[
  {
    "contactId": 1,
    "contact": "sample string 2",
    "preferredPaymentDay": "sample string 3",
    "lastPaymentDate": "2026-03-13T12:39",
    "rentArrears": 5.0,
    "warnings": "sample string 6",
    "referenceChequeNo": "sample string 7",
    "balance": 8.0,
    "consolidatedFloat": 9.0,
    "taxToDeduct": 10.0,
    "invoiceFeesSeparately": true,
    "invoiceFeesTotal": 12.0,
    "amountToPay": 13.0
  },
  {
    "contactId": 1,
    "contact": "sample string 2",
    "preferredPaymentDay": "sample string 3",
    "lastPaymentDate": "2026-03-13T12:39",
    "rentArrears": 5.0,
    "warnings": "sample string 6",
    "referenceChequeNo": "sample string 7",
    "balance": 8.0,
    "consolidatedFloat": 9.0,
    "taxToDeduct": 10.0,
    "invoiceFeesSeparately": true,
    "invoiceFeesTotal": 12.0,
    "amountToPay": 13.0
  }
]

application/xml, text/xml
Sample: 
<ArrayOfConsolidatedToPayItem xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ConsolidatedToPayItem>
    <ContactId>1</ContactId>
    <Contact>sample string 2</Contact>
    <PreferredPaymentDay>sample string 3</PreferredPaymentDay>
    <LastPaymentDate>2026-03-13T12:39:58.766196+00:00</LastPaymentDate>
    <RentArrears>5</RentArrears>
    <Warnings>sample string 6</Warnings>
    <ReferenceChequeNo>sample string 7</ReferenceChequeNo>
    <Balance>8</Balance>
    <ConsolidatedFloat>9</ConsolidatedFloat>
    <TaxToDeduct>10</TaxToDeduct>
    <InvoiceFeesSeparately>true</InvoiceFeesSeparately>
    <InvoiceFeesTotal>12</InvoiceFeesTotal>
    <AmountToPay>13</AmountToPay>
  </ConsolidatedToPayItem>
  <ConsolidatedToPayItem>
    <ContactId>1</ContactId>
    <Contact>sample string 2</Contact>
    <PreferredPaymentDay>sample string 3</PreferredPaymentDay>
    <LastPaymentDate>2026-03-13T12:39:58.766196+00:00</LastPaymentDate>
    <RentArrears>5</RentArrears>
    <Warnings>sample string 6</Warnings>
    <ReferenceChequeNo>sample string 7</ReferenceChequeNo>
    <Balance>8</Balance>
    <ConsolidatedFloat>9</ConsolidatedFloat>
    <TaxToDeduct>10</TaxToDeduct>
    <InvoiceFeesSeparately>true</InvoiceFeesSeparately>
    <InvoiceFeesTotal>12</InvoiceFeesTotal>
    <AmountToPay>13</AmountToPay>
  </ConsolidatedToPayItem>
</ArrayOfConsolidatedToPayItem>