Skip to main content

Gross Potential Rent

NewBeta

GrossPotentialRent objects represent individual unit rows from the AppFolio® Gross Potential Rent report, showing scheduled rent, vacancy and concession losses, and net rent income for a given month.

The GrossPotentialRent Object​

Attributes

appfolioIdstring
AppFolio row ID for this Gross Potential Rent record.
Example:
"51"
periodstring
Billing period covered by this record (e.g. "04/01/2026 to 04/30/2026").
Example:
"04/01/2026 to 04/30/2026"
tenantstring
Name of the current tenant occupying the unit, or null if vacant.
Example:
null
occupancyIdstring
AppFolio ID of the current occupancy, or null if vacant.
Example:
null
grossPotentialRentstring
Gross potential rent formatted as a display string (e.g. "2,995.00").
Example:
"2,995.00"
lossGainstring
Loss/gain amount formatted as a display string.
Example:
"0.00"
monthlyRentstring
Monthly rent formatted as a display string.
Example:
"2,995.00"
concessionsstring
Concessions amount formatted as a display string.
Example:
"0.00"
vacancyLossstring
Vacancy loss amount formatted as a display string.
Example:
"2,995.00"
modelLossstring
Model loss amount formatted as a display string.
Example:
"0.00"
renovationLossstring
Renovation loss amount formatted as a display string.
Example:
"0.00"
officeLossstring
Office loss amount formatted as a display string.
Example:
"0.00"
delinquencyLossstring
Delinquency loss amount formatted as a display string.
Example:
"0.00"
netRentIncomestring
Net rent income formatted as a display string.
Example:
"0.00"
marketRentstring
Market rent formatted as a display string.
Example:
"2,995.00"
rentChargesstring
Rent charges formatted as a display string.
Example:
"0.00"
Show Additional 2 Attributes
The GrossPotentialRent Object
{
  "appfolioId": "51",
  "period": "04/01/2026 to 04/30/2026",
  "tenant": null,
  "property": {
    "appfolioId": "2",
    "label": "Example Property - 100 Main St. Los Angeles, CA 90049",
    "name": "Example Property",
    "address": "100 Main St. Los Angeles, CA 90049",
    "street": "100 Main St.",
    "street2": null,
    "city": "Los Angeles",
    "state": "CA",
    "zip": "90049",
    "type": "Multi-Family"
  },
  "unit": {
    "appfolioId": "3",
    "label": "102",
    "type": "Loft",
    "tags": "Cadiz, Loft",
    "bdBa": "0/1.00"
  },
  "occupancyId": null,
  "grossPotentialRent": "2,995.00",
  "lossGain": "0.00",
  "monthlyRent": "2,995.00",
  "concessions": "0.00",
  "vacancyLoss": "2,995.00",
  "modelLoss": "0.00",
  "renovationLoss": "0.00",
  "officeLoss": "0.00",
  "delinquencyLoss": "0.00",
  "netRentIncome": "0.00",
  "marketRent": "2,995.00",
  "rentCharges": "0.00"
}

Get All Gross Potential Rent Records​

GET /v1/gross-potential-rent?month=04/2026

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

The gross-potential-rent endpoint returns the Gross Potential Rent report for your AppFolio® portfolio. Each row represents a single unit for the selected month, showing scheduled rent, vacancy and concession losses, and the resulting net rent income. Use the month parameter (MM/YYYY) to select the reporting month; it defaults to the current month. The accounting parameter accepts cash (default) or accrual.

Parameters​

propertyIdselect
AppFolio ID of a Property to serve as a filter.
propertyGroupIdselect
AppFolio ID of a Property Group to serve as a filter.
ownerIdselect
AppFolio ID of an Owner to serve as a filter.
monthstring
Month of the report (1-12).
yearstring
Year of the report (e.g. 2026).
propertyVisibilityselect
Filter by property visibility. Default: active.
Default Value:  
active
Possible Values:  
active
active_and_inactive
inactive
accountingselect
Accounting Basis.
Default: cash.
Possible Values: cash, accrual
Default Value:  
cash
Possible Values:  
cash
accrual
 

Returns​

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

GET /v1/gross-potential-rent?month=04/2026
curl -X GET 'https://api.skywalkapi.com/v1/gross-potential-rent?month=04/2026' \ 
  -H "X-API-Key: PUT_YOUR_API_KEY_HERE"
Response
{
  "meta": {
    "status": "ok",
    "path": "/v1/gross-potential-rent",
    "query": {
      "month": "4",
      "year": "2026"
    },
    "count": 1,
    "lastUpdated": 1610992228
  },
  "links": {
    "next": "/v1/gross-potential-rent?cursor=abcdefg"
  },
  "data": [
    {
      "appfolioId": "51",
      "period": "04/01/2026 to 04/30/2026",
      "tenant": null,
      "property": {
        "appfolioId": "2",
        "label": "Example Property - 100 Main St. Los Angeles, CA 90049",
        "name": "Example Property",
        "address": "100 Main St. Los Angeles, CA 90049",
        "street": "100 Main St.",
        "street2": null,
        "city": "Los Angeles",
        "state": "CA",
        "zip": "90049",
        "type": "Multi-Family"
      },
      "unit": {
        "appfolioId": "3",
        "label": "102",
        "type": "Loft",
        "tags": "Cadiz, Loft",
        "bdBa": "0/1.00"
      },
      "occupancyId": null,
      "grossPotentialRent": "2,995.00",
      "lossGain": "0.00",
      "monthlyRent": "2,995.00",
      "concessions": "0.00",
      "vacancyLoss": "2,995.00",
      "modelLoss": "0.00",
      "renovationLoss": "0.00",
      "officeLoss": "0.00",
      "delinquencyLoss": "0.00",
      "netRentIncome": "0.00",
      "marketRent": "2,995.00",
      "rentCharges": "0.00"
    }
  ]
}