POST 17.0/app/tenancy/tenantpayments

Description

This processes the tenant payment

URI Parameters

None.

The TenantPaymentRequest contains payment data such as the bank account id and received date

TenantPaymentRequest
Name Description Type Additional information
BankAccountId

integer

None.
ReceivedDate

date

None.
PaymentMethodId

integer

None.
PayAdvancedRentToLandlord

boolean

None.
Payments

Collection of Payment

None.

application/json, text/json
Sample: 
{
  "bankAccountId": 1,
  "receivedDate": "2026-03-13T12:39",
  "paymentMethodId": 3,
  "payAdvancedRentToLandlord": true,
  "payments": [
    {
      "id": 1,
      "receivedDate": "2026-03-13T12:39",
      "receivedAmount": 3.0,
      "landlordId": 4,
      "referenceChequeNo": "sample string 5",
      "receivedFromContactId": 6
    },
    {
      "id": 1,
      "receivedDate": "2026-03-13T12:39",
      "receivedAmount": 3.0,
      "landlordId": 4,
      "referenceChequeNo": "sample string 5",
      "receivedFromContactId": 6
    }
  ]
}

application/xml, text/xml
Sample: 
<TenantPaymentRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <BankAccountId>1</BankAccountId>
  <ReceivedDate>2026-03-13T12:39:59.9693212+00:00</ReceivedDate>
  <PaymentMethodId>3</PaymentMethodId>
  <PayAdvancedRentToLandlord>true</PayAdvancedRentToLandlord>
  <Payments>
    <Payment>
      <Id>1</Id>
      <ReceivedDate>2026-03-13T12:39:59.9693212+00:00</ReceivedDate>
      <ReceivedAmount>3</ReceivedAmount>
      <LandlordId>4</LandlordId>
      <ReferenceChequeNo>sample string 5</ReferenceChequeNo>
      <ReceivedFromContactId>6</ReceivedFromContactId>
    </Payment>
    <Payment>
      <Id>1</Id>
      <ReceivedDate>2026-03-13T12:39:59.9693212+00:00</ReceivedDate>
      <ReceivedAmount>3</ReceivedAmount>
      <LandlordId>4</LandlordId>
      <ReferenceChequeNo>sample string 5</ReferenceChequeNo>
      <ReceivedFromContactId>6</ReceivedFromContactId>
    </Payment>
  </Payments>
</TenantPaymentRequest>

application/x-www-form-urlencoded
Sample:

Sample not available.

This returns true if the payment was processed successfully

IHttpActionResult

None.

application/json, text/json
Sample:

Sample not available.