POST 17.0/app/paymentruns/downloadpaymentrunstatements

Description

Returns a pdf for the payment runs

URI Parameters

None.

This contains the request data

DownloadPaymentRunStatementRequest
Name Description Type Additional information
BankAccountId

integer

None.
AllForFiling

boolean

None.
ContactType

integer

None.
UsePreferredDeliveryMethod

boolean

None.
Payments

Collection of PaymnetRunStatementsToBeDownloaded

None.

application/json, text/json
Sample: 
{
  "bankAccountId": 1,
  "allForFiling": true,
  "contactType": 3,
  "usePreferredDeliveryMethod": true,
  "payments": [
    {
      "contactId": 1,
      "propertyId": 2,
      "statementId": 3
    },
    {
      "contactId": 1,
      "propertyId": 2,
      "statementId": 3
    }
  ]
}

application/xml, text/xml
Sample: 
<DownloadPaymentRunStatementRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <BankAccountId>1</BankAccountId>
  <AllForFiling>true</AllForFiling>
  <ContactType>3</ContactType>
  <UsePreferredDeliveryMethod>true</UsePreferredDeliveryMethod>
  <Payments>
    <PaymnetRunStatementsToBeDownloaded>
      <ContactId>1</ContactId>
      <PropertyId>2</PropertyId>
      <StatementId>3</StatementId>
    </PaymnetRunStatementsToBeDownloaded>
    <PaymnetRunStatementsToBeDownloaded>
      <ContactId>1</ContactId>
      <PropertyId>2</PropertyId>
      <StatementId>3</StatementId>
    </PaymnetRunStatementsToBeDownloaded>
  </Payments>
</DownloadPaymentRunStatementRequest>

application/x-www-form-urlencoded
Sample:

Sample not available.

application/json, text/json
Sample:

Sample not available.