Skip to main content

Tenant Charge

TenantCharge objects represents a tenant charge from AppFolio®. To retreive and query tenant charges, use the Tenant Ledger endpoint.

The TenantCharge Object#

This object is returned from the create a tenant charge endpoint.

Attributes

tenantChargeIdinteger
The ID of the charge created. This is the same as the matching TenantLedger transaction.id.
Example:
5432
occupancyIdinteger
The occupancy the tenant charge belongs to.
Example:
1234
amountstring
The amount of the tenant charge in dollars.
Example:
"780.00"
chargeDatestring
The date the tenant charge was charged.
Example:
"1/03/2025"
postingDatestring
The date the tenant charge was posted.
Example:
"1/03/2025"
glAccountIdstring
The GL Account of the transaction.
Example:
12
descriptionstring
Description of the tenant charge.
Example:
"Sample created tenant charge!"
warningsstring[]
Any warnings from creating the tenant charge such as posting to previous month.
The TenantCharge Object
{
"tenantChargeId": 5432,
"occupancyId": 1234,
"amount": "780.00",
"chargeDate": "1/03/2025",
"postingDate": "1/03/2025",
"glAccountId": 12,
"description": "Sample created tenant charge!"
}

Create a Tenant Charge#

POST /v1/tenant-charge

Follows: Authentication • Caching • Polling • List Response Format

The tenant charge endpoint creates a tenant charge.

Parameters#

occupancyIdselect
AppFolio ID of a Occupancy for the tenant ledger.
amountstring
The amount of the tenant charge in dollars.
chargeDatedate
The charge date of the tenant charge.
postingDatedate
The posting date of the tenant charge.
glAccountIdselect
AppFolio ID of the GL Account for the tenant charge.
descriptionstring
Description for the tenant charge.
warningsOkboolean
If true the tenant charge will still be created even if there are warnings such as previous month.
 

Returns#

The standard List Response Format with a data property containing an array with the created TenantCharge object.

POST /v1/tenant-charge
curl -X POST 'https://api.skywalkapi.com/v1/tenant-charge' \
-H "X-API-Key: PUT_YOUR_API_KEY_HERE" \
-d '{"occupancyId":1234,"glAccountId":12,"amount":"780.00","chargeDate":"1/03/2025","postingDate":"1/03/2025","description":"Sample created tenant charge!"}'
Response
{
"meta": {
"status": "ok",
"path": "/v1/tenant-charge",
"query": {
"occupancyId": 123
},
"count": 1,
"lastUpdated": 1610992228
},
"links": {
"next": "/v1/tenant-ledger?occupancyId=123&cursor=abcdefg"
},
"data": [
{
"tenantChargeId": 5432,
"occupancyId": 1234,
"amount": "780.00",
"chargeDate": "1/03/2025",
"postingDate": "1/03/2025",
"glAccountId": 12,
"description": "Sample created tenant charge!"
}
]
}