Skip to main content

Tenant Ledger

TenantLedger objects represent the individual line-items in a tenant ledger report. Skywalk API allows you to obtain the following attributes from a Tenant Ledger report:

The TenantLedger Object#

Attributes

rowIdinteger
Line number of entry in the tenant ledger.
Example:
1
creditstring
Credit amount for entry
Example:
"2,295.00"
debitstring
Debut amount for entry.
balancestring
Running balance of ledger including this row.
Example:
"2,295.00"
datestring
Date of enty.
Example:
"10/08/2021"
descriptionstring
Description of entry.
Example:
"Payment"
payerstring
Payer of entry.
Example:
"Betty Lee"
âž–
transaction.idinteger
ID number of transaction of this row.
Example:
1234
âž–
transaction.typestring
Type of transaction.
Example:
"ReceivablePayment"
âž–
transaction.createdAtstring
Date transaction was created.
Example:
"10/08/2021"
The TenantLedger Object
{
"rowId": 1,
"credit": "2,295.00",
"balance": "2,295.00",
"date": "10/08/2021",
"description": "Payment",
"payer": "Betty Lee",
"transaction": {
"id": 1234,
"type": "ReceivablePayment",
"createdAt": "10/08/2021"
}
}

Get Tenant Ledger#

GET /v1/tenant-ledger?occupancyId=<occupancyId>

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

The tenant ledger endpoint returns a list of all tenant ledger items for a given tenant in your AppFolio® account. This endpoint should respond immediately with your most recently cached data.

Parameters#

occupancyIdselect
AppFolio ID of a Occupancy for the tenant ledger.
dateRangeselect
Date Range for report.
Default Value:  
all_time
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 TenantLedger objects.

GET /v1/tenant-ledger
curl -X GET 'https://api.skywalkapi.com/v1/tenant-ledger?occupancyId=123' \
-H "X-API-Key: PUT_YOUR_API_KEY_HERE"
Response
{
"meta": {
"status": "ok",
"path": "/v1/tenant-ledger",
"query": {
"occupancyId": 123
},
"count": 1,
"lastUpdated": 1610992228
},
"links": {
"next": "/v1/tenant-ledger?occupancyId=123&cursor=abcdefg"
},
"data": [
{
"rowId": 1,
"credit": "2,295.00",
"balance": "2,295.00",
"date": "10/08/2021",
"description": "Payment",
"payer": "Betty Lee",
"transaction": {
"id": 1234,
"type": "ReceivablePayment",
"createdAt": "10/08/2021"
}
}
]
}