post-all-copy

Follows: Authentication • Caching • Polling • List Response Format

The tenant charge endpoint creates a tenant charge on an occupancy's ledger in your AppFolio® account.

Note: The tenant will not be notified of the new charge, unless notifyTenant is set to true.

Parameters

---

occupancyIdselect

AppFolio ID of the occupancy the charge is posted to.

---

amountstring

The amount of the tenant charge in dollars.

---

chargeDatedate

Charge date of the tenant charge, as MM/DD/YYYY. Defaults to today.

---

postingDatedate

Posting date of the tenant charge, as MM/DD/YYYY. Defaults to the charge date.

---

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.

---

notifyTenantboolean

If true the tenant is notified of the new charge, as AppFolio's "Notify tenant of new charge" option does. Defaults to false. Refused when the occupancy has no tenant portal or email to notify.

---

attachmentsmulti

Files to attach to the tenant charge, as a JSON array. Each entry requires "fileName" (with its extension) and exactly one of "content" (the file's bytes as base64) or "url" (an https URL the file can be fetched from). Accepted types: .pdf. Up to 10 files, each at most 30 MB; base64 content also has to fit the request body limit. Skywalk API does not retain file contents; the response reports each file by name, size and SHA-256 hash, and the tenant charge is returned with each file's AppFolio ID.

---

 

Returns

---

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