POST 17.0/app/payments/produceconsolidatedstatements

Description

Generates consolidated PDF statements for multiple payments based on the specified criteria. Filters payments based on contact delivery preferences and includes them in a single PDF report.

URI Parameters

None.

The bulk statement request containing bank account ID, filtering options, and list of payments to process.

BulkStatementRequest
Name Description Type Additional information
BankAccountId

integer

None.
AllForFilling

boolean

None.
UsePreferredDeliveryMethod

boolean

None.
AccountStatments

Collection of AccountStatement

None.

application/json, text/json
Sample: 
{
  "bankAccountId": 1,
  "allForFilling": true,
  "usePreferredDeliveryMethod": true,
  "accountStatments": [
    {
      "contactId": 1,
      "statementId": 2
    },
    {
      "contactId": 1,
      "statementId": 2
    }
  ]
}

application/xml, text/xml
Sample: 
<BulkStatementRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <BankAccountId>1</BankAccountId>
  <AllForFilling>true</AllForFilling>
  <UsePreferredDeliveryMethod>true</UsePreferredDeliveryMethod>
  <AccountStatments>
    <AccountStatement>
      <ContactId>1</ContactId>
      <StatementId>2</StatementId>
    </AccountStatement>
    <AccountStatement>
      <ContactId>1</ContactId>
      <StatementId>2</StatementId>
    </AccountStatement>
  </AccountStatments>
</BulkStatementRequest>

application/x-www-form-urlencoded
Sample:

Sample not available.

HTTP 200 OK with a PDF file attachment containing the consolidated statements, or HTTP 400 Bad Request if no payments match the filtering criteria.

IHttpActionResult

None.

application/json, text/json
Sample:

Sample not available.