POST 17.0/app/accounts/refund/unallocatedcredits

Description

Refunds unallocated credits passed in the request model

URI Parameters

None.

Unallocated credits to refund and who to refund them to

Name Description Type Additional information
ContactId

integer

None.

PropertyId

integer

None.

BankAccountId

integer

None.

PaymentMethodId

integer

None.

Amount

decimal number

None.

RefundDate

date

None.

StatementNotes

string

None.

Notes

string

None.

CreditIds

Collection of integer

None.

application/json, text/json

Sample:
{
  "contactId": 1,
  "propertyId": 2,
  "bankAccountId": 3,
  "paymentMethodId": 4,
  "amount": 5.1,
  "refundDate": "2026-03-13T12:39",
  "statementNotes": "sample string 7",
  "notes": "sample string 8",
  "creditIds": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:
<RefundUnallocatedCreditsRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ContactId>1</ContactId>
  <PropertyId>2</PropertyId>
  <BankAccountId>3</BankAccountId>
  <PaymentMethodId>4</PaymentMethodId>
  <Amount>5.1</Amount>
  <RefundDate>2026-03-13T12:39:56.1255911+00:00</RefundDate>
  <StatementNotes>sample string 7</StatementNotes>
  <Notes>sample string 8</Notes>
  <CreditIds>
    <int>1</int>
    <int>2</int>
  </CreditIds>
</RefundUnallocatedCreditsRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Id of the Payment Made transaction linked to the refund

integer

application/json, text/json

Sample:
1

application/xml, text/xml

Sample:
<int>1</int>