GET residentapi/units/{unitId}/accountbalance?transactions={transactions}&sort={sort}&startDate={startDate}

Returns the account balance and optionally the transactions for a unit

Request Information

URI Parameters

Name	Description	Type	Additional information
unitId		integer	Required
transactions	Pass in a value of yes/true to include the transactions in the result object	string
sort	Can sort by the following string fields: 'date', 'amount', 'code', 'description', 'type'	string
startDate	Pass in this date to filter on the start date	date	None.

Body Parameters

None.

Response Information

Resource Description

Accounting

Name	Description	Type	Additional information
Result	Account Status	string	None.
AccountNumber	Account Number	string	None.
Balance	Account Balance	decimal number	None.
LastPayDate	Account Last Payment Date	date	None.
LastPayAmount	Account Last Payment Amount	decimal number	None.
Transactions	List of transactions	Collection of AccountingTransaction	None.

Response Formats

application/json, text/json

Sample:

{
  "result": "sample string 1",
  "accountNumber": "sample string 2",
  "balance": 3.0,
  "lastPayDate": "2025-12-24T09:17:28.3380368-05:00",
  "lastPayAmount": 5.0,
  "transactions": [
    {
      "date": "2025-12-24T09:17:28.3380368-05:00",
      "description": "sample string 2",
      "transactionType": "sample string 3",
      "chargeCode": "sample string 4",
      "amount": 5.0,
      "balance": 6.0,
      "transactionOrder": 7
    },
    {
      "date": "2025-12-24T09:17:28.3380368-05:00",
      "description": "sample string 2",
      "transactionType": "sample string 3",
      "chargeCode": "sample string 4",
      "amount": 5.0,
      "balance": 6.0,
      "transactionOrder": 7
    }
  ]
}