Skip to main content

Bank Account Activity

BankAccountActivity objects represent the individual line-items in a bank account activity report. Skywalk API allows you to obtain the following attributes from a Bank Account Activity report:

The BankAccountActivity Object#

Attributes


rowIdinteger
Line number of entry in the tenant ledger.
Example:
1

creditstring
Credit amount for entry
Example:
null

debitstring
Debut amount for entry.
Example:
"11,098.99"

balancestring
Running balance of bank account including this row.
Example:
"14,509.99"

transactionTypestring
Type of transaction.
Example:
"Deposit"

datestring
Date of enty.
Example:
"10/08/2021"

descriptionstring
Description of entry.
Example:
null

referencestring
Reference of entry.
Example:
"Automatic ACH Deposit"

payeeNamestring
Name of Payee.
Example:
null

The BankAccountActivity Object
{
"rowId": 1,
"credit": null,
"debit": "11,098.99",
"balance": "14,509.99",
"transactionType": "Deposit",
"date": "10/08/2021",
"description": null,
"reference": "Automatic ACH Deposit",
"payeeName": null,
"transaction": {
"id": 1234,
"type": "BankDeposit"
},
"createdAt": "10/08/2021 at 06:00 AM",
"lastEditedAt": "10/08/2021 at 06:00 AM",
"reconciled": "No"
}

Get Tenant Ledger#

GET /v1/bank-account-activity?bankAccountId=<bankAccountId>

Follows: Authentication • Caching • Polling • List Response Format • Scheduled Job

The bank account activity endpoint returns a list of all bank account activity items for a given bank account and date range in your AppFolio® account. This endpoint should respond immediately with your most recently cached data.

Parameters#


bankAccountIdselect
AppFolio ID of the Bank Account to get activity for.

dateRangeselect
Date Range for report.
Default Value:  
this_month_to_date
Possible Values:  
today
this_week
this_week_to_date
this_month
this_month_to_date
this_quarter
this_quarter_to_date
this_year_to_date
last_year
last_year_to_date
yesterday
last_week
last_week_to_date
last_month
last_month_to_date
last_quarter
last_quarter_to_date
last_7_days
last_30_days
last_60_days
last_90_days
trailing_12_months
next_7_days
next_30_days
next_60_days
next_90_days
next_week
next_month
next_quarter
until_1_week_ago
until_1_month_ago
all_time

dateFromdate
Date to given in MM/DD/YYYY (e.g. 01/31/2021)

dateTodate
Date to given in MM/DD/YYYY (e.g. 01/31/2021)

 

Returns#


The standard List Response Format with a data property containing an array of BankAccountActivity objects.

GET /v1/tenant-ledger
curl -X GET 'https://api.skywalkapi.com/v1/bank-account-activity?bankAccountActivity=123' \
-H "X-API-Key: PUT_YOUR_API_KEY_HERE"
Response
{
"meta": {
"status": "ok",
"path": "/v1/bank-account-activity",
"query": {
"bankAccountId": 123
},
"count": 1,
"lastUpdated": 1610992228
},
"links": {
"next": "/v1/bank-account-activity?bankAccountId=123&cursor=abcdefg"
},
"data": [
{
"rowId": 1,
"credit": null,
"debit": "11,098.99",
"balance": "14,509.99",
"transactionType": "Deposit",
"date": "10/08/2021",
"description": null,
"reference": "Automatic ACH Deposit",
"payeeName": null,
"transaction": {
"id": 1234,
"type": "BankDeposit"
},
"createdAt": "10/08/2021 at 06:00 AM",
"lastEditedAt": "10/08/2021 at 06:00 AM",
"reconciled": "No"
}
]
}