@nightsquawktech/appfolio-mcp-server 0.0.1

package/dist/catalog/reports/screening_assessments.json

@@ -0,0 +1,104 @@
+{
+  "slug": "screening_assessments",
+  "endpoint": "screening_assessments.json",
+  "name": "Screening Assessments",
+  "description": "Returns Screening Assessments report data.",
+  "requiredFilters": [
+    "screen_ran_at_from",
+    "screen_ran_at_to"
+  ],
+  "parameters": [
+    {
+      "name": "property_visibility",
+      "type": "string",
+      "required": false,
+      "default": "all",
+      "enum": [
+        "active",
+        "hidden",
+        "all"
+      ],
+      "description": "The property visibility to filter by."
+    },
+    {
+      "name": "properties",
+      "type": "object",
+      "required": false,
+      "description": "The property filter. Expand to view all attributes associated with this filter. If required, you must submit an id for at least one of the below filters.",
+      "attributes": [
+        {
+          "name": "properties_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "property_groups_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "portfolios_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "owners_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        }
+      ]
+    },
+    {
+      "name": "screen_ran_at_from",
+      "type": "string",
+      "required": true,
+      "format": "YYYY-MM-DD",
+      "description": "The 'Date From' date to filter by."
+    },
+    {
+      "name": "screen_ran_at_to",
+      "type": "string",
+      "required": true,
+      "format": "YYYY-MM-DD",
+      "description": "The 'Date To' date to filter by."
+    },
+    {
+      "name": "only_show_overridden_assessments",
+      "type": "string",
+      "required": false,
+      "default": "0",
+      "enum": [
+        "0",
+        "1"
+      ],
+      "description": "Only Show Override Assessments"
+    },
+    {
+      "name": "columns",
+      "type": "array",
+      "required": false,
+      "description": "Returns the specified columns. All columns are returned by default. Look at the response schema to see the available columns."
+    }
+  ],
+  "requestSample": {
+    "property_visibility": "active",
+    "properties": {
+      "properties_ids": [],
+      "property_groups_ids": [],
+      "portfolios_ids": [],
+      "owners_ids": []
+    },
+    "screen_ran_at_from": "2023-06-01",
+    "screen_ran_at_to": "2023-06-30",
+    "only_show_overridden_assessments": "1",
+    "columns": [
+      "some_column",
+      "some_other_column"
+    ]
+  },
+  "responseColumns": []
+}

package/dist/catalog/reports/screening_usage.json

@@ -0,0 +1,92 @@
+{
+  "slug": "screening_usage",
+  "endpoint": "screening_usage.json",
+  "name": "Screening Usage",
+  "description": "Returns Screening Usage report data.",
+  "requiredFilters": [
+    "occurred_on_from",
+    "occurred_on_to"
+  ],
+  "parameters": [
+    {
+      "name": "property_visibility",
+      "type": "string",
+      "required": false,
+      "default": "all",
+      "enum": [
+        "active",
+        "hidden",
+        "all"
+      ],
+      "description": "The property visibility to filter by."
+    },
+    {
+      "name": "properties",
+      "type": "object",
+      "required": false,
+      "description": "The property filter. Expand to view all attributes associated with this filter. If required, you must submit an id for at least one of the below filters.",
+      "attributes": [
+        {
+          "name": "properties_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "property_groups_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "portfolios_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "owners_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        }
+      ]
+    },
+    {
+      "name": "occurred_on_from",
+      "type": "string",
+      "required": true,
+      "format": "YYYY-MM-DD",
+      "description": "The 'Date From' date to filter by."
+    },
+    {
+      "name": "occurred_on_to",
+      "type": "string",
+      "required": true,
+      "format": "YYYY-MM-DD",
+      "description": "The 'Date To' date to filter by."
+    },
+    {
+      "name": "columns",
+      "type": "array",
+      "required": false,
+      "description": "Returns the specified columns. All columns are returned by default. Look at the response schema to see the available columns."
+    }
+  ],
+  "requestSample": {
+    "property_visibility": "active",
+    "properties": {
+      "properties_ids": [],
+      "property_groups_ids": [],
+      "portfolios_ids": [],
+      "owners_ids": []
+    },
+    "occurred_on_from": "2023-06-01",
+    "occurred_on_to": "2023-06-30",
+    "columns": [
+      "some_column",
+      "some_other_column"
+    ]
+  },
+  "responseColumns": []
+}

package/dist/catalog/reports/security_deposit_funds_detail.json

@@ -0,0 +1,141 @@
+{
+  "slug": "security_deposit_funds_detail",
+  "endpoint": "security_deposit_funds_detail.json",
+  "name": "Security Deposit Funds Detail",
+  "description": "Returns Security Deposit Funds Detail report data.",
+  "requiredFilters": [
+    "occurred_on_to"
+  ],
+  "parameters": [
+    {
+      "name": "property_visibility",
+      "type": "string",
+      "required": false,
+      "default": "active",
+      "enum": [
+        "active",
+        "hidden",
+        "all"
+      ],
+      "description": "The property visibility to filter by."
+    },
+    {
+      "name": "properties",
+      "type": "object",
+      "required": false,
+      "description": "The property filter. Expand to view all attributes associated with this filter. If required, you must submit an id for at least one of the below filters.",
+      "attributes": [
+        {
+          "name": "properties_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "property_groups_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "portfolios_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "owners_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        }
+      ]
+    },
+    {
+      "name": "parties_ids",
+      "type": "object",
+      "required": false,
+      "description": "The occupancy ids to filter by. Expand to view all attributes associated with this filter. If required, you must submit an id for at least one of the below filters.",
+      "attributes": [
+        {
+          "name": "occupancies_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        }
+      ]
+    },
+    {
+      "name": "tenant_statuses",
+      "type": "array",
+      "required": false,
+      "default": "[\"0\",\"4\"]",
+      "enum": [
+        "'2' denotes 'Future'",
+        "'0' denotes 'Current'",
+        "'4' denotes 'Notice'",
+        "'1' denotes 'Past'",
+        "'3' denotes 'Evict'"
+      ],
+      "description": "List of Tenant status to filter by."
+    },
+    {
+      "name": "gl_account_ids",
+      "type": "array",
+      "required": false,
+      "default": "Your Deposit Key Account IDs",
+      "description": "The gl account ids to filter by."
+    },
+    {
+      "name": "occurred_on_to",
+      "type": "string",
+      "required": true,
+      "format": "YYYY-MM-DD",
+      "description": "The 'As of To' date to filter by."
+    },
+    {
+      "name": "accounting_basis",
+      "type": "string",
+      "required": false,
+      "default": "Cash",
+      "enum": [
+        "Cash",
+        "Accrual"
+      ],
+      "description": "The accounting basis to filter by."
+    },
+    {
+      "name": "columns",
+      "type": "array",
+      "required": false,
+      "description": "Returns the specified columns. All columns are returned by default. Look at the response schema to see the available columns."
+    }
+  ],
+  "requestSample": {
+    "property_visibility": "active",
+    "properties": {
+      "properties_ids": [],
+      "property_groups_ids": [],
+      "portfolios_ids": [],
+      "owners_ids": []
+    },
+    "parties_ids": {
+      "occupancies_ids": []
+    },
+    "tenant_statuses": [
+      "0",
+      "4"
+    ],
+    "gl_account_ids": [
+      "1",
+      "2"
+    ],
+    "occurred_on_to": "2023-06-30",
+    "accounting_basis": "Cash",
+    "columns": [
+      "some_column",
+      "some_other_column"
+    ]
+  },
+  "responseColumns": []
+}

package/dist/catalog/reports/showings.json

@@ -0,0 +1,123 @@
+{
+  "slug": "showings",
+  "endpoint": "showings.json",
+  "name": "Showings",
+  "description": "Returns Showings report data.",
+  "requiredFilters": [
+    "showing_date_from",
+    "showing_date_to"
+  ],
+  "parameters": [
+    {
+      "name": "showing_date_from",
+      "type": "string",
+      "format": "YYYY-MM-DD",
+      "required": true,
+      "description": "The 'Showing Time From' date to filter by."
+    },
+    {
+      "name": "showing_date_to",
+      "type": "string",
+      "format": "YYYY-MM-DD",
+      "required": true,
+      "description": "The 'Showing Time To' date to filter by."
+    },
+    {
+      "name": "property_visibility",
+      "type": "string",
+      "required": false,
+      "default": "active",
+      "enum": [
+        "active",
+        "hidden",
+        "all"
+      ],
+      "description": "The property visibility to filter by."
+    },
+    {
+      "name": "properties",
+      "type": "object",
+      "required": false,
+      "description": "The property filter. Expand to view all attributes associated with this filter. If required, you must submit an id for at least one of the below filters.",
+      "attributes": [
+        {
+          "name": "properties_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "property_groups_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "portfolios_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "owners_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        }
+      ]
+    },
+    {
+      "name": "statuses",
+      "type": "array",
+      "required": false,
+      "default": [],
+      "enum": [
+        "all",
+        "Completed",
+        "Scheduled",
+        "Canceled",
+        "No Show",
+        "Confirmation Pending",
+        "Prospect Confirmed",
+        "Prospect Canceled",
+        "Canceled (Unconfirmed)",
+        "Cancel In Progress",
+        "Reschedule In Progress"
+      ],
+      "description": "Statuses to filter by."
+    },
+    {
+      "name": "assigned_user",
+      "type": "string",
+      "required": false,
+      "default": "All",
+      "description": "Assigned user id to filter by."
+    },
+    {
+      "name": "columns",
+      "type": "array",
+      "required": false,
+      "description": "Returns the specified columns. All columns are returned by default. Look at the response schema to see the available columns."
+    }
+  ],
+  "requestSample": {
+    "showing_date_from": "2023-06-01",
+    "showing_date_to": "2023-06-30",
+    "property_visibility": "active",
+    "properties": {
+      "properties_ids": [],
+      "property_groups_ids": [],
+      "portfolios_ids": [],
+      "owners_ids": []
+    },
+    "statuses": [
+      "all"
+    ],
+    "assigned_user": "All",
+    "columns": [
+      "some_column",
+      "some_other_column"
+    ]
+  },
+  "responseColumns": []
+}

package/dist/catalog/reports/student_housing_rent_roll_by_bed.json

@@ -0,0 +1,125 @@
+{
+  "slug": "student_housing_rent_roll_by_bed",
+  "endpoint": "student_housing_rent_roll_by_bed.json",
+  "name": "Rent Roll (By Bed)",
+  "description": "Returns Rent Roll (By Bed) report data.",
+  "requiredFilters": [
+    "as_of_to"
+  ],
+  "parameters": [
+    {
+      "name": "properties",
+      "type": "object",
+      "required": false,
+      "description": "The property filter. Expand to view all attributes associated with this filter. If required, you must submit an id for at least one of the below filters.",
+      "attributes": [
+        {
+          "name": "properties_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "property_groups_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "portfolios_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "owners_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        }
+      ]
+    },
+    {
+      "name": "unit_visibility",
+      "type": "string",
+      "required": false,
+      "default": "active",
+      "enum": [
+        "active",
+        "hidden",
+        "all"
+      ],
+      "description": ""
+    },
+    {
+      "name": "tags",
+      "type": "string",
+      "required": false,
+      "description": "The comma-separated tag(s) to filter by"
+    },
+    {
+      "name": "include_advertised_rent",
+      "type": "string",
+      "required": false,
+      "default": "1",
+      "enum": [
+        "0",
+        "1"
+      ],
+      "description": "Include Advertised Rent"
+    },
+    {
+      "name": "gl_account_ids",
+      "type": "array",
+      "required": false,
+      "default": "[]",
+      "description": "The gl account ids to filter by. There is a limit of 250 GL Accounts to choose from. Only GL Accounts associated with Recurring Charges are valid."
+    },
+    {
+      "name": "as_of_to",
+      "type": "string",
+      "required": true,
+      "format": "YYYY-MM-DD",
+      "description": "The 'As of To' date to filter by."
+    },
+    {
+      "name": "non_revenue_units",
+      "type": "string",
+      "required": false,
+      "default": "0",
+      "enum": [
+        "0",
+        "1"
+      ],
+      "description": "Include Non-Revenue Units"
+    },
+    {
+      "name": "columns",
+      "type": "array",
+      "required": false,
+      "description": "Returns the specified columns. All columns are returned by default. Look at the response schema to see the available columns."
+    }
+  ],
+  "requestSample": {
+    "properties": {
+      "properties_ids": [],
+      "property_groups_ids": [],
+      "portfolios_ids": [],
+      "owners_ids": []
+    },
+    "unit_visibility": "active",
+    "tags": "bbq,deck",
+    "include_advertised_rent": "1",
+    "gl_account_ids": [
+      "1",
+      "2"
+    ],
+    "as_of_to": "2023-06-30",
+    "non_revenue_units": "1",
+    "columns": [
+      "some_column",
+      "some_other_column"
+    ]
+  },
+  "responseColumns": []
+}

package/dist/catalog/reports/surveys_summary.json

@@ -0,0 +1,118 @@
+{
+  "slug": "surveys_summary",
+  "endpoint": "surveys_summary.json",
+  "name": "Survey Responses",
+  "description": "Returns Survey Responses report data.",
+  "requiredFilters": [
+    "occurred_on_from",
+    "occurred_on_to"
+  ],
+  "parameters": [
+    {
+      "name": "survey_type",
+      "type": "string",
+      "required": false,
+      "default": "maintenance",
+      "enum": [
+        "maintenance",
+        "'move-in' denotes 'Move In'",
+        "'move-out' denotes 'Move Out'",
+        "showing"
+      ],
+      "description": "Survey type to filter by."
+    },
+    {
+      "name": "property_visibility",
+      "type": "string",
+      "required": false,
+      "default": "active",
+      "enum": [
+        "active",
+        "hidden",
+        "all"
+      ],
+      "description": "The property visibility to filter by."
+    },
+    {
+      "name": "properties",
+      "type": "object",
+      "required": false,
+      "description": "The property filter. Expand to view all attributes associated with this filter. If required, you must submit an id for at least one of the below filters.",
+      "attributes": [
+        {
+          "name": "properties_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "property_groups_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "portfolios_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "owners_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        }
+      ]
+    },
+    {
+      "name": "date_type",
+      "type": "string",
+      "required": false,
+      "default": "Date Sent",
+      "enum": [
+        "Date Sent",
+        "Date Received"
+      ],
+      "description": "The Date Type to filter by."
+    },
+    {
+      "name": "occurred_on_from",
+      "type": "string",
+      "required": true,
+      "format": "YYYY-MM-DD",
+      "description": "The 'Date From' date to filter by."
+    },
+    {
+      "name": "occurred_on_to",
+      "type": "string",
+      "required": true,
+      "format": "YYYY-MM-DD",
+      "description": "The 'Date To' date to filter by."
+    },
+    {
+      "name": "columns",
+      "type": "array",
+      "required": false,
+      "description": "Returns the specified columns. All columns are returned by default. Look at the response schema to see the available columns."
+    }
+  ],
+  "requestSample": {
+    "survey_type": "maintenance",
+    "property_visibility": "active",
+    "properties": {
+      "properties_ids": [],
+      "property_groups_ids": [],
+      "portfolios_ids": [],
+      "owners_ids": []
+    },
+    "date_type": "Date Sent",
+    "occurred_on_from": "2023-06-01",
+    "occurred_on_to": "2023-06-30",
+    "columns": [
+      "some_column",
+      "some_other_column"
+    ]
+  },
+  "responseColumns": []
+}