@nightsquawktech/appfolio-mcp-server 0.0.1

package/dist/catalog/reports/homeowner_delinquency.json

@@ -0,0 +1,143 @@
+{
+  "slug": "homeowner_delinquency",
+  "endpoint": "homeowner_delinquency.json",
+  "name": "Homeowner Delinquency",
+  "description": "Returns Homeowner Delinquency report data.",
+  "requiredFilters": [],
+  "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": "delinquency_note_range",
+      "type": "string",
+      "required": false,
+      "default": "all time",
+      "enum": [
+        "this month",
+        "'this and last month' denotes 'This Month and Last Month'",
+        "last month",
+        "last year",
+        "all time"
+      ],
+      "description": "Delinquency note range to filter by."
+    },
+    {
+      "name": "tags",
+      "type": "string",
+      "required": false,
+      "description": "The comma-separated tag(s) to filter by"
+    },
+    {
+      "name": "amount_owed_in_account",
+      "type": "string",
+      "required": false,
+      "default": "all",
+      "enum": [
+        "all",
+        "'dues' denotes 'Dues Income'"
+      ],
+      "description": "Amount owed in account to filter by."
+    },
+    {
+      "name": "balance_operator",
+      "type": "object",
+      "required": false,
+      "description": "The Balance to filter by. Expand to view all attributes associated with this filter.",
+      "attributes": [
+        {
+          "name": "amount",
+          "type": "string",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "comparator",
+          "type": "string",
+          "required": false,
+          "description": ""
+        }
+      ]
+    },
+    {
+      "name": "include_future_dated_charges",
+      "type": "string",
+      "required": false,
+      "default": "0",
+      "enum": [
+        "0",
+        "1"
+      ],
+      "description": "Include future dated charges"
+    },
+    {
+      "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": []
+    },
+    "delinquency_note_range": "this month",
+    "tags": "bbq,deck",
+    "amount_owed_in_account": "all",
+    "balance_operator": {
+      "amount": "100",
+      "comparator": "="
+    },
+    "include_future_dated_charges": "1",
+    "columns": [
+      "some_column",
+      "some_other_column"
+    ]
+  },
+  "responseColumns": []
+}

package/dist/catalog/reports/homeowner_delinquency_as_of.json

@@ -0,0 +1,161 @@
+{
+  "slug": "homeowner_delinquency_as_of",
+  "endpoint": "homeowner_delinquency_as_of.json",
+  "name": "Homeowner Delinquency (As Of)",
+  "description": "Returns Homeowner Delinquency (As Of) 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": "occurred_on_to",
+      "type": "string",
+      "required": true,
+      "format": "YYYY-MM-DD",
+      "description": "The 'As of To' date to filter by."
+    },
+    {
+      "name": "delinquency_note_range",
+      "type": "string",
+      "required": false,
+      "default": "all time",
+      "enum": [
+        "this month",
+        "'this and last month' denotes 'This Month and Last Month'",
+        "last month",
+        "last year",
+        "all time"
+      ],
+      "description": "Delinquency note range to filter by."
+    },
+    {
+      "name": "tenant_statuses",
+      "type": "array",
+      "required": false,
+      "default": [
+        "0",
+        "4"
+      ],
+      "enum": [
+        "'2' denotes 'Future'",
+        "'0' denotes 'Current'",
+        "'4' denotes 'Notice'",
+        "'1' denotes 'Past'"
+      ],
+      "description": "List of Homeowner status to filter by."
+    },
+    {
+      "name": "tags",
+      "type": "string",
+      "required": false,
+      "description": "The comma-separated tag(s) to filter by"
+    },
+    {
+      "name": "amount_owed_in_account",
+      "type": "string",
+      "required": false,
+      "default": "all",
+      "enum": [
+        "all",
+        "'rent' denotes 'Dues Income'"
+      ],
+      "description": "Amount owed in account to filter by."
+    },
+    {
+      "name": "balance_operator",
+      "type": "object",
+      "required": false,
+      "description": "The Balance to filter by. Expand to view all attributes associated with this filter.",
+      "attributes": [
+        {
+          "name": "amount",
+          "type": "string",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "comparator",
+          "type": "string",
+          "required": false,
+          "description": ""
+        }
+      ]
+    },
+    {
+      "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_to": "2023-06-30",
+    "delinquency_note_range": "this month",
+    "tenant_statuses": [
+      "0",
+      "4"
+    ],
+    "tags": "bbq,deck",
+    "amount_owed_in_account": "all",
+    "balance_operator": {
+      "amount": "100",
+      "comparator": "="
+    },
+    "columns": [
+      "some_column",
+      "some_other_column"
+    ]
+  },
+  "responseColumns": []
+}

package/dist/catalog/reports/homeowner_directory.json

@@ -0,0 +1,126 @@
+{
+  "slug": "homeowner_directory",
+  "endpoint": "homeowner_directory.json",
+  "name": "Homeowner Directory",
+  "description": "Returns Homeowner Directory report data.",
+  "requiredFilters": [],
+  "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": "tenant_statuses",
+      "type": "array",
+      "required": false,
+      "default": "[\"0\"]",
+      "enum": [
+        "'2' denotes 'Future'",
+        "'0' denotes 'Current'",
+        "'4' denotes 'Notice'",
+        "'1' denotes 'Past'"
+      ],
+      "description": "List of Homeowner status to filter by."
+    },
+    {
+      "name": "homeowner_visibility",
+      "type": "string",
+      "required": false,
+      "default": "active",
+      "enum": [
+        "active",
+        "hidden",
+        "all"
+      ],
+      "description": ""
+    },
+    {
+      "name": "display_only_primary_homeowners",
+      "type": "string",
+      "required": false,
+      "default": "0",
+      "enum": [
+        "0",
+        "1"
+      ],
+      "description": "Display Primary Contact only for each unit"
+    },
+    {
+      "name": "hoa_homeowner_directory_exclusions",
+      "type": "string",
+      "required": false,
+      "default": "1",
+      "enum": [
+        "0",
+        "1"
+      ],
+      "description": "Hide information checked “exclude from directory”"
+    },
+    {
+      "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": []
+    },
+    "tenant_statuses": [
+      "0"
+    ],
+    "homeowner_visibility": "active",
+    "display_only_primary_homeowners": "1",
+    "hoa_homeowner_directory_exclusions": "1",
+    "columns": [
+      "some_column",
+      "some_other_column"
+    ]
+  },
+  "responseColumns": []
+}

package/dist/catalog/reports/homeowner_ledger.json

@@ -0,0 +1,59 @@
+{
+  "slug": "homeowner_ledger",
+  "endpoint": "homeowner_ledger.json",
+  "name": "Homeowner Ledger",
+  "description": "Returns Homeowner Ledger report data.",
+  "requiredFilters": [
+    "parties_ids",
+    "occurred_on_from",
+    "occurred_on_to"
+  ],
+  "parameters": [
+    {
+      "name": "parties_ids",
+      "type": "object",
+      "required": true,
+      "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": "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": {
+    "parties_ids": {
+      "occupancies_ids": []
+    },
+    "occurred_on_from": "2023-06-01",
+    "occurred_on_to": "2023-06-30",
+    "columns": [
+      "some_column",
+      "some_other_column"
+    ]
+  },
+  "responseColumns": []
+}

package/dist/catalog/reports/homeowner_prepayment_balance.json

@@ -0,0 +1,127 @@
+{
+  "slug": "homeowner_prepayment_balance",
+  "endpoint": "homeowner_prepayment_balance.json",
+  "name": "Homeowner Prepayment Balance",
+  "description": "Returns Homeowner Prepayment Balance 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'",
+        "'1' denotes 'Past'"
+      ],
+      "description": "List of Homeowner status to filter by."
+    },
+    {
+      "name": "gl_account_ids",
+      "type": "array",
+      "required": false,
+      "default": "Your Prepaid Income 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": "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",
+    "columns": [
+      "some_column",
+      "some_other_column"
+    ]
+  },
+  "responseColumns": []
+}