POST 17.0/app/accounts/getavailablecredits

Description

Retrieves available credits for a specified bank account based on the provided request details. This endpoint processes the request to fetch credit information, populates a list of credit items, calculates the total amount, and returns an AvailableCreditItem object.

URI Parameters

None.

The request containing ContactId, PropertyId, BankAccountId, and IsConsolidatedAccount.

AvailableCreditRequest
Name Description Type Additional information
ContactId

integer

None.
PropertyId

integer

None.
BankAccountId

integer

None.
IsConsolidatedAccount

boolean

None.

application/json, text/json
Sample: 
{
  "contactId": 1,
  "propertyId": 2,
  "bankAccountId": 3,
  "isConsolidatedAccount": true
}

application/xml, text/xml
Sample: 
<AvailableCreditRequest 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>
  <IsConsolidatedAccount>true</IsConsolidatedAccount>
</AvailableCreditRequest>

application/x-www-form-urlencoded
Sample:

Sample not available.

An AvailableCreditItem object with available date, list of credits, and total amount.

AvailableCreditItem
Name Description Type Additional information
TotalAmount

decimal number

None.
AvailableDate

date

None.
Credits

Collection of CreditItem

None.

application/json, text/json
Sample: 
{
  "totalAmount": 1.0,
  "availableDate": "2025-12-12T18:53",
  "credits": [
    {
      "id": 1,
      "receivedDate": "2025-12-12T18:53",
      "product": "sample string 3",
      "amount": 4.0,
      "cleared": true
    },
    {
      "id": 1,
      "receivedDate": "2025-12-12T18:53",
      "product": "sample string 3",
      "amount": 4.0,
      "cleared": true
    }
  ]
}

application/xml, text/xml
Sample: 
<AvailableCreditItem xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <TotalAmount>1</TotalAmount>
  <AvailableDate>2025-12-12T18:53:57.00336+00:00</AvailableDate>
  <Credits>
    <CreditItem>
      <Id>1</Id>
      <ReceivedDate>2025-12-12T18:53:57.00336+00:00</ReceivedDate>
      <Product>sample string 3</Product>
      <Amount>4</Amount>
      <Cleared>true</Cleared>
    </CreditItem>
    <CreditItem>
      <Id>1</Id>
      <ReceivedDate>2025-12-12T18:53:57.00336+00:00</ReceivedDate>
      <Product>sample string 3</Product>
      <Amount>4</Amount>
      <Cleared>true</Cleared>
    </CreditItem>
  </Credits>
</AvailableCreditItem>