POST 17.0/app/paymentruns/processpayments

Description

Pays the selected contacts

URI Parameters

None.

Contains the bank account details and details of the contacts to pay

PaymentRunPayContactsRequest
Name Description Type Additional information
PaymentMethodId

integer

None.
BankAccountId

integer

None.
BankAccountDescription

string

None.
PaymentExportFormat

byte

None.
ContactTypeId

byte

None.
ContactTypeDescription

string

None.
PaymentDate

date

None.
ProcessingDate

date

None.
Items

Collection of PaymentItem

None.

application/json, text/json
Sample: 
{
  "paymentMethodId": 1,
  "bankAccountId": 2,
  "bankAccountDescription": "sample string 3",
  "paymentExportFormat": 64,
  "contactTypeId": 64,
  "contactTypeDescription": "sample string 6",
  "paymentDate": "2026-04-27T16:20",
  "processingDate": "2026-04-27T16:20",
  "items": [
    {
      "amountToPay": 1.0,
      "contactId": 2,
      "propertyId": 3,
      "ownerId": 4,
      "taxDeduction": 5.0,
      "referenceChequeNo": "sample string 6",
      "balance": 7.0,
      "invoiceFeesTotal": 8.0,
      "invoiceFeesSeparately": true
    },
    {
      "amountToPay": 1.0,
      "contactId": 2,
      "propertyId": 3,
      "ownerId": 4,
      "taxDeduction": 5.0,
      "referenceChequeNo": "sample string 6",
      "balance": 7.0,
      "invoiceFeesTotal": 8.0,
      "invoiceFeesSeparately": true
    }
  ]
}

application/xml, text/xml
Sample: 
<PaymentRunPayContactsRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PaymentMethodId>1</PaymentMethodId>
  <BankAccountId>2</BankAccountId>
  <BankAccountDescription>sample string 3</BankAccountDescription>
  <PaymentExportFormat>64</PaymentExportFormat>
  <ContactTypeId>64</ContactTypeId>
  <ContactTypeDescription>sample string 6</ContactTypeDescription>
  <PaymentDate>2026-04-27T16:20:01.3434792+01:00</PaymentDate>
  <ProcessingDate>2026-04-27T16:20:01.3434792+01:00</ProcessingDate>
  <Items>
    <PaymentItem>
      <AmountToPay>1</AmountToPay>
      <ContactId>2</ContactId>
      <PropertyId>3</PropertyId>
      <OwnerId>4</OwnerId>
      <TaxDeduction>5</TaxDeduction>
      <ReferenceChequeNo>sample string 6</ReferenceChequeNo>
      <Balance>7</Balance>
      <InvoiceFeesTotal>8</InvoiceFeesTotal>
      <InvoiceFeesSeparately>true</InvoiceFeesSeparately>
    </PaymentItem>
    <PaymentItem>
      <AmountToPay>1</AmountToPay>
      <ContactId>2</ContactId>
      <PropertyId>3</PropertyId>
      <OwnerId>4</OwnerId>
      <TaxDeduction>5</TaxDeduction>
      <ReferenceChequeNo>sample string 6</ReferenceChequeNo>
      <Balance>7</Balance>
      <InvoiceFeesTotal>8</InvoiceFeesTotal>
      <InvoiceFeesSeparately>true</InvoiceFeesSeparately>
    </PaymentItem>
  </Items>
</PaymentRunPayContactsRequest>

application/x-www-form-urlencoded
Sample:

Sample not available.

Returns the successful payments

ProcessPaymentRunsResponse
Name Description Type Additional information
PaymentRunId

integer

None.
PaymentRunExportFileName

string

None.
Payments

Collection of PaymentRunPayment

None.

application/json, text/json
Sample: 
{
  "paymentRunId": 1,
  "paymentRunExportFileName": "sample string 2",
  "payments": [
    {
      "contactId": 1,
      "propertyId": 2,
      "statementId": 3
    },
    {
      "contactId": 1,
      "propertyId": 2,
      "statementId": 3
    }
  ]
}

application/xml, text/xml
Sample: 
<ProcessPaymentRunsResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PaymentRunId>1</PaymentRunId>
  <PaymentRunExportFileName>sample string 2</PaymentRunExportFileName>
  <Payments>
    <PaymentRunPayment>
      <ContactId>1</ContactId>
      <PropertyId>2</PropertyId>
      <StatementId>3</StatementId>
    </PaymentRunPayment>
    <PaymentRunPayment>
      <ContactId>1</ContactId>
      <PropertyId>2</PropertyId>
      <StatementId>3</StatementId>
    </PaymentRunPayment>
  </Payments>
</ProcessPaymentRunsResponse>