POST 17.0/app/accounts/paychargewithexistingcredit

Description

Processes a payment for a charge using existing credits. Validates the request parameters, converts the CreditIds list to a Collection, and invokes the tenancy manager to apply credits.

URI Parameters

None.

The request containing ChargeId, CreditIds, CreditAvailableDate, CreditTotal, and PayAdvanceRentToLandlordNow.

ExistingCreditRequest
Name Description Type Additional information
ChargeId

integer

None.
CreditIds

Collection of integer

None.
CreditTotal

decimal number

None.
CreditAvailableDate

date

None.
PayAdvanceRentToLandlordNow

boolean

None.

application/json, text/json
Sample: 
{
  "chargeId": 1,
  "creditIds": [
    1,
    2
  ],
  "creditTotal": 2.1,
  "creditAvailableDate": "2025-12-12T18:54",
  "payAdvanceRentToLandlordNow": true
}

application/xml, text/xml
Sample: 
<ExistingCreditRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ChargeId>1</ChargeId>
  <CreditIds>
    <int>1</int>
    <int>2</int>
  </CreditIds>
  <CreditTotal>2.1</CreditTotal>
  <CreditAvailableDate>2025-12-12T18:54:28.1162871+00:00</CreditAvailableDate>
  <PayAdvanceRentToLandlordNow>true</PayAdvanceRentToLandlordNow>
</ExistingCreditRequest>

application/x-www-form-urlencoded
Sample:

Sample not available.

An integer result from the credit tenancy operation.

integer

application/json, text/json
Sample: 
1

application/xml, text/xml
Sample: 
<int>1</int>