Upload an attachment to a unit or occupancy.

Attributes

UnitId - Unit to which the file is attached.
File - Filename and extension type being attached.

Create a bill, bulk create bills, or update a bill.

Attributes

DueDate - Date the invoice is due.
InvoiceDate - Date the invoice was received.
LineItems - A bill’s line items. Includes amount, description, general ledger account, and unit ID pertaining to the bill.
PropertyId - Unique identifier of the property associated with the bill. 
TotalAmount - Total amount of the bill.
VendorId - Unique identifier for the payee’s vendor.
CheckMemo - Memo, or brief note written on the check.
PostingDate - Accrual-accounting invoice date of the bill.
Reference - Invoice number of the bill.
Remarks - A description or summary of the invoice.
WorkOrderId - Unique identifier of the work order corresponding to the invoice.
BillId - Id of the bill to update.

Get all open charges for occupants residing at a specific property.

Attributes

PropertyId - Unique identifier of the property associated with the charge(s).
id - Unique identifier of the charge.
AmountDue - Current outstanding charges and/or future charges not yet paid.
ChargedOn - All current outstanding charges with amounts and charged on date(s).
Description - Brief description of the charge.
GlAccountId - Unique identifier of the general ledger account associated with the charge(s).
OccupancyId - Unique identifier of the occupancy associated with the charge.

Get all General Ledger accounts that meet the filter criteria.

Attributes

Id - Unique identifier of the community association.
Name - The name of the community association.
Address1 - The primary address of the community association.
Address2 - The secondary address of the community association.
City - The city where the community association is located.
State - The state where the community association is located.
Zip - The zip where the community association is located.
LastUpdatedAt - The date the community association’s information was last updated by an AppFolio Property Manager User.

Get all Community Association (CA) Homeowners that meet the filter criteria. 

Attributes

Id - Unique identifier of the CA homeowner.
UnitId - Unique identifier of the unit associated with the CA homeowner
AssociationId - Unique identifier of the association related to the CA homeowner.
OccupandyId - Unique identifier of a CA occupancy of one or more CA homeowners.
FirstName - The first name of the CA homeowner.
MiddleName - The middle name of the CA homeowner.
LastName - The last name of the CA homeowner.
PhoneNumber -- The phone number of the CA homeowner.
Email - The email of the CA homeowner
LastUpdatedAt - Returns the CA homeowner records updated since the date provided. The default time zone is Coordinated Universal Time (UTC).

Get all Community Association (CA) Units that meet the filter criteria.

Attributes

Id - Unique identifier of the CA unit
Name - The name of the CA unit
AssociationId - Unique identifier of the CA associated with the unit
CurrentOccupandyId - Unique identifier of the current occupancy associated with the CA unit
Address1 - The primary address of the CA unit
Address2 - The secondary address of the CA unit
City - The city where the CA unit is located
State - The state where the CA unit is located
Zip - The zip where the CA unit is located
LastUpdatedAt - Returns the CA unit records updated since the date provided. The default time zone is Coordinated Universal Time (UTC)

Get all delinquent charges

Attributes

Id - Unique identifier of the delinquent charge.
AmountDue - The current amount outstanding for the delinquent charge.
ChargedOn - The date the delinquent charge was initially charged on.
Description - A summary or description of the delinquent charge.
GlAccountId - Unique identifier of the General Ledger account associated with the delinquent charge.
OccupancyId - Unique identifier of the occupancy associated with the delinquent charge.
LastUpdatedAt - The last time an AppFolio Property Manager user updated the delinquent charge.
Subsidy - Whether or not the delinquent charge is subsidized.

Get all General Ledger accounts that meet the filter criteria.

Attributes

LastUpdatedAtFrom - Returns General Ledger Account records that have been updated since the date provided.

Get general ledger transaction details

Attributes

LineItemId - Unique identifier of the line item associated to the general ledger transaction.
GlAccountId - Unique identifier of the general ledger account.
PropertyId - Unique identifier of property associated with the general ledger account.
UnitId - Unique identifier of the unit associated with the general ledger account.
Date - The date of the transaction.
Reference - The reference number of the transaction associated with the general ledger account.
Remarks - Remarks or notes pertaining to the general ledger transaction.
Description - A brief, informative message pertaining to the general ledger transaction.
Credit - The total amount of credit.
Debit - The total amount of credit.
TransactionId - Unique identifier of the transaction.
TransactionType - The AppFolio transaction type.

Get all journal entries

Attributes

EntryDate - The date the journal entry was created.
LastUpdatedAt - The last time an AppFolio Property Manager user updated the journal entry.
LineItems - The line items on the journal entry.
PropertyId - Unique identifier of the property or association related to the journal entry.
Remarks - A description or summary of the journal entry.

Get, create and update leads.

Attributes

Ids - Unique identifier for the lead.
PropertyIds - Unique identifier of the property associated with the lead.
LastUpdatedAtFrom - Returns lead records that have been updated since the date provided.
FirstName - First name of the prospective resident.
LastName - Last name of the prospective resident.
PropertyId - Unique identifier for the property associated with the lead.
AdditionalOccupants - Number of other potential occupants.
Bathrooms - Number of bathrooms the prospective resident desires.
Bedrooms - Number of bedrooms the prospective resident desires.
CreatedAt - Date the inquiry was created.
CreditScore - Self-reported credit score of the prospective resident.
DesiredMovein - Desired move-in date of the prospective resident.
Email - Email address of the prospective resident.
HasCats - Whether or not the prospective resident has a cat(s).
HasDogs - Whether or not the prospective resident has a dog(s).
HasOtherPet - Whether or not the prospective resident has other pet(s).
MaxRent - Max amount the prospective resident is willing to pay per month.
MiddleInitial - Middle initial of the prospective resident.
MonthlyIncome - Self-reported monthly income of the prospective resident.
PhoneNumber - Phone number of the prospective resident.
Source - Mechanism through which the prospective resident submitted the inquiry.
Status - The status of the lead.
UnitIds - Unique identifier of the unit the prospective resident inquired into.
LeadId - Unique identifier of the lead to update.

Get all listings that meet the filter criteria.

Attributes

Id - Unique identifier of the listing.
Address1 - The primary street address of the listing.
Address2 - Additional street address information pertaining to the listing.
AdvertisedRent - The rent per month as advertised.
ApplicationFee - The Application Fee amount for the listing.
ApplicationURL - The URL link to the application page for the listing.
AvailableOn - The date upon which the listing can be leased.
Bathrooms - The number of bathrooms listed for the unit.
Bedrooms - The number of bedrooms listed for the unit.
CatsAllowed - Whether or not the listing allows cats.
City - The city where the listing is located.
Deposit - The security, rent, or pet and cleaning deposit amount.
DogPolicy - Whether or not the listing allows dogs.
IsCampaign - Whether or not the listing is part of a campaign.
LastUpdatedAt - The last time the listing was updated by an AppFolio Property Manager user.
MarketingDescription - A description of the listing for syndication.
MarketingTitle - The title of the listing for syndication.
PropertyId - Unique identifier of the property associated with the listing.
PropertyMarketingDescription - The title of the property associated with the listing for syndication.
SquareFeet - The size of the listing in square feet.
State - The state where the listing is located.
UnitAmentities - The amenities offered by the building associated with the listing.
UnitId - Unique identifier of the unit associated with the listing.
UnitPhotos - Photos of the listing.
UnitType - The floor plan of the listing.
UtilitiesIncluded - The utilities which are included with rent.
YouTubeURL - The URL of the YouTube video for the listing.
Zip - The zip code where the listing is located.

Get, create, and update owners

Attributes

Id - Unique identifier of the owner.
CompanyName - The company name associated with the owner.
Email - The owner’s email address.
FirstName - The owner’s first name.
HiddenAt - When the owner was marked inactive by an AppFolio Property Manager user.
IsCompany - Whether or not the owner is identified as a company.
LastName - The last name of the owner.
Link - A link to the owner’s page in the AppFolio Property Manager.
MaintenanceNotes - Maintenance notes for the properties owned.
PhoneNumber - The owner’s phone number.
Address1 - The primary street address of the owner.
Address2 - Additional street address information about the owner.
City - The city where the owner is located.
State - The state where the owner is located.
Zip - The zip code where the owner is located.

Get all owner groups that meet the filter criteria.

Attributes

Current - Signals if the owner currently owns the property.
LastUpdatedAtFrom - Returns owner group records that have been updated since the date provided.
PropertyIds - Property ID corresponding to all owners within the owner group.

Get, create, and update pending charge batches.

Attributes

BatchId - The unique identifier for the pending charge batch.
LastUpdatedAtFrom - Returns pending batch charge records that have been updated since the date provided.
PropertyIds - Unique identifier of the property associated with the pending charge batch(es).
Status - The statuses of the pending charge batches.
BatchType - The type of pending charge batch, such as the "initial" pending charge batch.
Charges - Lists descriptive information associated with the pending charge batch such as "amount" and "description."
PropertyId - Unique identifier for the property where the charged resident resides.

Get all properties that meet the filter criteria.

Attributes

Ids - Unique identifier of the properties that are sought for retrieval.
LastUpdatedAtFrom - Returns property records that have been updated since the date provided.
IncludeHidden - Whether or not to include properties hidden by an AppFolio Property Manager user.
Id - Unique identifier of the property.
Address1 - Primary street address of the property.
Address 2 - Additional street address information.
City - City where the property is located.
HiddenAt - When the property was labeled no longer active by an AppFollio Property Manager user.
LastUpdatedAt - The last time the property was updated by an AppFollio Property Manager user.
MaintenanceNotes - A brief informative message about the property's maintenance.
Name - The name of the property.
PropertyGroupIds - A list of property group IDs that the property belongs to.
PropertyType - The type of property, such as Single-family or HOA property.
State - State where the property is located.
TenantPortalLink - Link to direct a resident to their resident portal.
Zip - Zip code where the property is located.

Get all property groups that meet the filter criteria.

Attributes

LastUpdatedAtFrom - Returns property group records that have been updated since the date provided.
Id - Unique identifier of the property.
LastUpdatedAt - The last time the property group was updated by an AppFollio Property Manager user.
Name - Name of the property group.
Type - The type of property group, such as a portfolio.

Create and update showings.

Attributes

EndAt - End time of the showing.
StartAt - Start time of the showing.
LeadId - Unique identifier of the lead associated with the showing.
UnitId - Unique identifier of the unit to be shown.
AssignedUserId - Unique identifier of the AppFolio Property Manager user responsible for the showing.
Notes - A brief informative message about the showing.
Status - Current status of the showing, such as "scheduled" or "canceled."
ShowingId - Unique identifier for the showing to update.

Get all tenants

Attributes

Id - Unique identifier of the tenant.
OccupancyId - Unique identifier of an occupancy of one or more tenants.
UnitId - The unit the tenant occupies
PropertyId - The property with the unit occupied by the tenant.
FirstName - The tenant’s first name.
LastName - The tenant’s last name.
Link - A link to the tenant’s page in the AppFolio Property Manager.
CompanyName - The display name of the tenant’s company.
Status - The status of the tenant.
PhoneNumber - The tenant’s phone number.
Email - The tenant’s email address.
MoveInOn - The tenant started, or will begin occupancy.
MoveOutOn - The date the tenant ended, or will end occupancy.
RentalApplicationId - Unique identifier of the tenant-submitted rental application.
TenantType - The type of tenant.
PrimaryTenant - Whether or not the tenant is the primary leaseholder for the occupancy.
LeaseSignedDate - The date the lease was executed by the tenant.
LeaseStartDate - The day the lease agreement starts.
LeaseEndDate - The last day of the lease agreement.
HiddenAt - When the tenant was placed into an inactive state by an AppFolio Property Manager user.
LastUpdatedAt - The last time an AppFolio Property Manager user updated the tenant’s information.

Get all residents based on the filter criteria.

Attributes

Ids - Unique identifier of the resident(s).
PropertyIds - Unique identifier of the property the resident occupies.
UnitIds - Unique identifier of the unit the resident occupies.
Status - The occupancy status of the resident, such as "current" or "past" occupant.
MoveInOnFrom - Move-in date range from the time stipulated.
MoveInOnTo - Move-in date range to the time stipulated.
MoveOutOnFrom - Move-out date range from the time stipulated.
MoveOutOnTo - Move-out date range to the time stipulated.
LastUpdatedAtFrom - Returns resident records that have been updated since the date provided.
IncludeHidden - Whether or not to include inactive residents from the list of residents.

Get and update units.

Attributes

Ids - Unique identifier of the unit(s).
PropertyIds - Unique identifier of the property the unit belongs to.
UnitGroupIds - Unique identifier of the unit group associated with the unit.
LeasingType - The type of lease associated with the unit, such as a "bed unit."
LastUpdatedAtFrom - Returns unit records that have been updated since the date provided.
IncludeHidden - Whether or not to include units that were chosen to be hidden from the list of units.
UnitId - The unique identifier of the unit to update.
RentReady - Whether or not the unit is ready to be occupied by a resident.

Get all AppFolio Property Manager users that meet the filter criteria.

Attributes

PropertyId - Unique identifier of the property associated with the user.
LastUpdatedAtFrom - Returns AppFolio Property Manager user records that have been updated since the date provided.
Id - Unique identifier of an AppFolio Property Manager user.
Email - The user’s email address.
FirstName - The first name of the user.
LastName - The last name of the user.
UserRole - The system role assigned to the user.
LastUpdatedAt - The last time a user’s information was updated by an AppFollio Property Manager user.

Get, create or update vendors.

Attributes

Ids - Unique identifier of the vendor(s) that are sought for retrieval.
LastUpdatedAtFrom - Returns vendor records that have been updated since the date provided.
IncludeHidden - Whether or not to include vendors hidden by an AppFolio Property Manager user.
IsCompany - Whether or not the vendor is a company.
UseCompanyNameAsTaxpayerName - Company name of the vendor used for tax purposes.
TaxpayerName - The taxpayer name of the vendor.
TaxpayerId - The vendor’s taxpayer identification.
CompanyName - Optional display name of the vendor’s company name.
Send1099 - Whether or not the vendor needs a 1099 tax from the management company.
FirstName - The vendor’s first name.
LastName - The vendor’s last name.
Address1 - Primary street address of the vendor.
Address2 - Additional street address information.
City - City where the vendor is located.
State - State where the vendor is located.
Zip - Zip code where the vendor is located.
CountryCode - Country code of the vendor. For example, “JP” for Japan.
PhoneNumber - The phone number of the vendor.
Email - The email address of the vendor.
CompanyURL -  Internet address of the vendor’s website.
LiabilityInsuranceExpiration - Expiration date of the vendor’s liability insurance.
AutoInsuranceExpiration - Expiration date of the vendor’s auto insurance.
WorkersCompExpiration - Expiration date of the vendor’s worker’s compensation insurance.
ContractExpiration - Expiration date of the vendor’s contract.
UmbrellaInsuranceExpiration - Expiration date of the vendor’s umbrella insurance.
CompliantStatus - Whether or not the vendor meets compliance.
VendorId - Unique identifier of the vendor to update.

Get, create or update work orders for a property, unit, or occupancy.

Attributes

Ids - Unique identifier of the created, or updated.
PropertyId - Unique identifier of the property associated with the work order.
UnitId - Unique identifier of the unit associated with the work order.
CreatedAtFrom - Filter to return results created at the specified date.
CreatedAtTo - Filter to return results created until the specified date.
Statuses - The status of the work order, such as “completed.”
LastUpdatedAtFrom - Returns work orders that have been updated since the date provided.
JobDescription - A brief description of the work order to be performed.
PropertyId - Unique identifier of the property associated with the work order.
AssignedUsers - Unique identifier of the AppFolio Property Manager user assigned to the work order.
CanceledOn - When the work order status changed to “canceled”.
CompletedOn - When the work order status changed to “completed”.
PermissionToEnter - Whether or not permission has been granted to enter the unit.
Priority - The priority of the work order, such as “urgent”.
ScheduledEnd -  Projected time the work order will be completed.
ScheduledStart -  Projected time the work order will start.
Status - The status of the work order, such as “completed”.
VendorId - Unique identifier of the vendor associated with the work order.
VendorTrade - The type of service offered by the vendor.
WorkOrderId - Unique identifier of the work order to update.