@nightsquawktech/appfolio-mcp-server 0.0.1

package/dist/catalog/reports/general_ledger.json

@@ -0,0 +1,166 @@
+{
+  "slug": "general_ledger",
+  "endpoint": "general_ledger.json",
+  "name": "General Ledger",
+  "description": "Returns General Ledger report data.",
+  "requiredFilters": [
+    "posted_on_from",
+    "posted_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": "created_by",
+      "type": "string",
+      "required": false,
+      "default": "All",
+      "description": "Created by id to filter by."
+    },
+    {
+      "name": "gl_account_ids",
+      "type": "array",
+      "required": false,
+      "default": "[]",
+      "description": "The gl account ids to filter by."
+    },
+    {
+      "name": "exclude_zero_dollar_receipts_from_cash_accounts",
+      "type": "string",
+      "required": false,
+      "default": "1",
+      "enum": [
+        "0",
+        "1"
+      ],
+      "description": "Exclude Zero Dollar Receipts From Cash Accounts"
+    },
+    {
+      "name": "posted_on_from",
+      "type": "string",
+      "required": true,
+      "format": "YYYY-MM-DD",
+      "description": "The 'Date From' date to filter by."
+    },
+    {
+      "name": "posted_on_to",
+      "type": "string",
+      "required": true,
+      "format": "YYYY-MM-DD",
+      "description": "The 'Date To' date to filter by."
+    },
+    {
+      "name": "updated_at_from",
+      "type": "string",
+      "required": false,
+      "format": "YYYY-MM-DD",
+      "default": "",
+      "description": "The 'Last Edited From' date to filter by."
+    },
+    {
+      "name": "updated_at_to",
+      "type": "string",
+      "required": false,
+      "format": "YYYY-MM-DD",
+      "default": "",
+      "description": "The 'Last Edited To' date to filter by."
+    },
+    {
+      "name": "accounting_basis",
+      "type": "string",
+      "required": false,
+      "default": "Cash",
+      "enum": [
+        "Cash",
+        "Accrual",
+        "Modified Accrual"
+      ],
+      "description": "The accounting basis to filter by."
+    },
+    {
+      "name": "reverse_transaction",
+      "type": "string",
+      "required": false,
+      "default": "0",
+      "enum": [
+        "0",
+        "1"
+      ],
+      "description": "Whether or not to Show Reversed Transactions"
+    },
+    {
+      "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": []
+    },
+    "created_by": "All",
+    "gl_account_ids": [
+      "1",
+      "2"
+    ],
+    "exclude_zero_dollar_receipts_from_cash_accounts": "1",
+    "posted_on_from": "2023-06-01",
+    "posted_on_to": "2023-06-30",
+    "updated_at_from": "2023-06-01",
+    "updated_at_to": "2023-06-30",
+    "accounting_basis": "Cash",
+    "reverse_transaction": "0",
+    "columns": [
+      "some_column",
+      "some_other_column"
+    ]
+  },
+  "responseColumns": []
+}

package/dist/catalog/reports/gross_potential_rent_enhanced.json

@@ -0,0 +1,102 @@
+{
+  "slug": "gross_potential_rent_enhanced",
+  "endpoint": "gross_potential_rent_enhanced.json",
+  "name": "Gross Potential Rent",
+  "description": "Returns Gross Potential Rent report data.",
+  "requiredFilters": [
+    "month_of_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": "tags",
+      "type": "string",
+      "required": false,
+      "description": "The comma-separated tag(s) to filter by"
+    },
+    {
+      "name": "month_of_to",
+      "type": "string",
+      "required": true,
+      "format": "YYYY-MM",
+      "description": "The 'Month of' month 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": []
+    },
+    "tags": "bbq,deck",
+    "month_of_to": "2023-06",
+    "accounting_basis": "Cash",
+    "columns": [
+      "some_column",
+      "some_other_column"
+    ]
+  },
+  "responseColumns": []
+}

package/dist/catalog/reports/guest_card_inquiries.json

@@ -0,0 +1,177 @@
+{
+  "slug": "guest_card_inquiries",
+  "endpoint": "guest_card_inquiries.json",
+  "name": "Guest Card Inquiries",
+  "description": "Returns Guest Card Inquiries report data.",
+  "requiredFilters": [
+    "received_on_from",
+    "received_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": "guest_card_sources",
+      "type": "array",
+      "required": false,
+      "default": [],
+      "enum": [
+        "all",
+        "Apartment Advisor",
+        "Apartment List",
+        "Apartments.com",
+        "Phone",
+        "Realtor.com",
+        "Rent.",
+        "Rentable",
+        "Shared Application Link",
+        "Uloop",
+        "Website",
+        "Zillow Rental Network",
+        "Zumper"
+      ],
+      "description": "The Guest Card Source to filter by."
+    },
+    {
+      "name": "guest_card_statuses",
+      "type": "array",
+      "required": false,
+      "default": [
+        "prequalified",
+        "active",
+        "waitlisted"
+      ],
+      "enum": [
+        "all",
+        "'prequalified' denotes 'Pre-Qualified'",
+        "active",
+        "waitlisted",
+        "'application_completed' denotes 'Application Completed'",
+        "inactive",
+        "cold"
+      ],
+      "description": "The Guest Card Status to filter by."
+    },
+    {
+      "name": "guest_card_lead_types",
+      "type": "array",
+      "required": false,
+      "default": [],
+      "enum": [
+        "all",
+        "Free",
+        "Premium",
+        "Hang Up",
+        "Refunded"
+      ],
+      "description": "The Guest Card Lead Type to filter by."
+    },
+    {
+      "name": "assigned_user",
+      "type": "string",
+      "required": false,
+      "default": "All",
+      "description": "Assigned user id to filter by."
+    },
+    {
+      "name": "filter_date_range_by",
+      "type": "string",
+      "required": false,
+      "default": "inquiry",
+      "enum": [
+        "'inquiry' denotes 'Inquiry Received'",
+        "'interest' denotes 'Interest Received'"
+      ],
+      "description": "Filter date range by to filter by."
+    },
+    {
+      "name": "received_on_from",
+      "type": "string",
+      "required": true,
+      "format": "YYYY-MM-DD",
+      "description": "The 'Date From' date to filter by."
+    },
+    {
+      "name": "received_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": []
+    },
+    "guest_card_sources": [
+      "all"
+    ],
+    "guest_card_statuses": [
+      "all"
+    ],
+    "guest_card_lead_types": [
+      "all"
+    ],
+    "assigned_user": "All",
+    "filter_date_range_by": "inquiry",
+    "received_on_from": "2023-06-01",
+    "received_on_to": "2023-06-30",
+    "columns": [
+      "some_column",
+      "some_other_column"
+    ]
+  },
+  "responseColumns": []
+}

package/dist/catalog/reports/guest_cards.json

@@ -0,0 +1,161 @@
+{
+  "slug": "guest_cards",
+  "endpoint": "guest_cards.json",
+  "name": "Guest Card Interests",
+  "description": "Returns Guest Card Interests report data.",
+  "requiredFilters": [
+    "received_on_from",
+    "received_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": "guest_card_sources",
+      "type": "array",
+      "required": false,
+      "default": "[]",
+      "enum": [
+        "all",
+        "Apartment Advisor",
+        "Apartment List",
+        "Apartments.com",
+        "Phone",
+        "Realtor.com",
+        "Rent.",
+        "Rentable",
+        "Shared Application Link",
+        "Uloop",
+        "Website",
+        "Zillow Rental Network",
+        "Zumper"
+      ],
+      "description": "The Guest Card Source to filter by."
+    },
+    {
+      "name": "guest_card_statuses",
+      "type": "array",
+      "required": false,
+      "default": "[\"prequalified\",\"active\",\"waitlisted\"]",
+      "enum": [
+        "all",
+        "'prequalified' denotes 'Pre-Qualified'",
+        "active",
+        "waitlisted",
+        "'application_completed' denotes 'Application Completed'",
+        "inactive",
+        "cold"
+      ],
+      "description": "The Guest Card Status to filter by."
+    },
+    {
+      "name": "guest_card_lead_types",
+      "type": "array",
+      "required": false,
+      "default": "[]",
+      "enum": [
+        "all",
+        "Free",
+        "Premium",
+        "Hang Up",
+        "Refunded"
+      ],
+      "description": "The Guest Card Lead Type to filter by."
+    },
+    {
+      "name": "assigned_user",
+      "type": "string",
+      "required": false,
+      "default": "All",
+      "description": "Assigned user id to filter by."
+    },
+    {
+      "name": "received_on_from",
+      "type": "string",
+      "required": true,
+      "format": "YYYY-MM-DD",
+      "description": "The 'Interest Received From' date to filter by."
+    },
+    {
+      "name": "received_on_to",
+      "type": "string",
+      "required": true,
+      "format": "YYYY-MM-DD",
+      "description": "The 'Interest Received 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": []
+    },
+    "guest_card_sources": [
+      "all"
+    ],
+    "guest_card_statuses": [
+      "all"
+    ],
+    "guest_card_lead_types": [
+      "all"
+    ],
+    "assigned_user": "All",
+    "received_on_from": "2023-06-01",
+    "received_on_to": "2023-06-30",
+    "columns": [
+      "some_column",
+      "some_other_column"
+    ]
+  },
+  "responseColumns": []
+}

package/dist/catalog/reports/historical_advertised_rent.json

@@ -0,0 +1,92 @@
+{
+  "slug": "historical_advertised_rent",
+  "endpoint": "historical_advertised_rent.json",
+  "name": "Historical Advertised Rent",
+  "description": "Returns Historical Advertised Rent report data.",
+  "requiredFilters": [
+    "rents_advertised_on_from",
+    "rents_advertised_on_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": "rents_advertised_on_from",
+      "type": "string",
+      "required": true,
+      "format": "YYYY-MM-DD",
+      "description": "The 'Date From' date to filter by."
+    },
+    {
+      "name": "rents_advertised_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": {
+    "properties": {
+      "properties_ids": [],
+      "property_groups_ids": [],
+      "portfolios_ids": [],
+      "owners_ids": []
+    },
+    "unit_visibility": "active",
+    "rents_advertised_on_from": "2023-06-01",
+    "rents_advertised_on_to": "2023-06-30",
+    "columns": [
+      "some_column",
+      "some_other_column"
+    ]
+  },
+  "responseColumns": []
+}