@nightsquawktech/appfolio-mcp-server 0.0.1

package/dist/catalog/reports/homeowner_resale.json

@@ -0,0 +1,107 @@
+{
+  "slug": "homeowner_resale",
+  "endpoint": "homeowner_resale.json",
+  "name": "Homeowner Resale",
+  "description": "Returns Homeowner Resale report data.",
+  "requiredFilters": [
+    "occurred_on_from",
+    "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_from",
+      "type": "string",
+      "required": true,
+      "format": "YYYY-MM-DD",
+      "description": "The 'Occurred From' date to filter by."
+    },
+    {
+      "name": "occurred_on_to",
+      "type": "string",
+      "required": true,
+      "format": "YYYY-MM-DD",
+      "description": "The 'Occurred To' date to filter by."
+    },
+    {
+      "name": "events",
+      "type": "array",
+      "required": false,
+      "default": "[\"all\"]",
+      "enum": [
+        "all",
+        "Purchase",
+        "Sale"
+      ],
+      "description": "Events 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",
+    "events": [
+      "all"
+    ],
+    "columns": [
+      "some_column",
+      "some_other_column"
+    ]
+  },
+  "responseColumns": []
+}

package/dist/catalog/reports/homeowner_vehicle_info.json

@@ -0,0 +1,104 @@
+{
+  "slug": "homeowner_vehicle_info",
+  "endpoint": "homeowner_vehicle_info.json",
+  "name": "Homeowner Vehicle Info",
+  "description": "Returns Homeowner Vehicle Info report data.",
+  "requiredFilters": [],
+  "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": "tenant_visibility",
+      "type": "string",
+      "required": false,
+      "default": "active",
+      "enum": [
+        "active",
+        "hidden",
+        "all"
+      ],
+      "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 Homeowner status 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": []
+    },
+    "tenant_visibility": "active",
+    "tenant_statuses": [
+      "0",
+      "4"
+    ],
+    "columns": [
+      "some_column",
+      "some_other_column"
+    ]
+  },
+  "responseColumns": []
+}

package/dist/catalog/reports/import_variances.json

@@ -0,0 +1,41 @@
+{
+  "slug": "import_variances",
+  "endpoint": "import_variances.json",
+  "name": "Import Variances",
+  "description": "Returns Import Variances report data.",
+  "requiredFilters": [],
+  "parameters": [
+    {
+      "name": "groups",
+      "type": "array",
+      "required": false,
+      "default": "[\"all\"]",
+      "enum": [
+        "all",
+        "'Commercial Tenant Past Charges' denotes 'Commercial Tenant Past Charges (1 message)'",
+        "'Open Bills/Credits' denotes 'Open Bills/Credits (1 message)'",
+        "'Prepayments' denotes 'Prepayments (1 message)'",
+        "'Tenant Unpaid Charges/Credits' denotes 'Tenant Unpaid Charges/Credits (1 message)'",
+        "'Uncleared Items' denotes 'Uncleared Items (1 message)'",
+        "'Vendor 1099 Balances' denotes 'Vendor 1099 Balances (1 message)'"
+      ],
+      "description": "Sections 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": {
+    "groups": [
+      "all"
+    ],
+    "columns": [
+      "some_column",
+      "some_other_column"
+    ]
+  },
+  "responseColumns": []
+}

package/dist/catalog/reports/in_progress_workflows.json

@@ -0,0 +1,181 @@
+{
+  "slug": "in_progress_workflows",
+  "endpoint": "in_progress_workflows.json",
+  "name": "In-Progress Workflows",
+  "description": "Returns In-Progress Workflows report data.",
+  "requiredFilters": [],
+  "parameters": [
+    {
+      "name": "attachables",
+      "type": "object",
+      "required": false,
+      "description": "The attachables filter. Expand to view all attributes associated with this filter.",
+      "attributes": [
+        {
+          "name": "properties_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "units_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "tenants_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "owners_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "rental_applications_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "guest_cards_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "guest_card_interests_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "service_requests_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "vendors_ids",
+          "type": "array",
+          "required": false,
+          "description": ""
+        }
+      ]
+    },
+    {
+      "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": "process_template",
+      "type": "string",
+      "required": false,
+      "default": "All",
+      "description": "The workflow template id to filter by."
+    },
+    {
+      "name": "workflow_step",
+      "type": "string",
+      "required": false,
+      "default": "All",
+      "description": "The workflow step id to filter by."
+    },
+    {
+      "name": "assigned_user",
+      "type": "string",
+      "required": false,
+      "default": "All",
+      "description": "Assigned user id to filter by."
+    },
+    {
+      "name": "date_range_from",
+      "type": "string",
+      "required": false,
+      "default": "",
+      "format": "YYYY-MM-DD",
+      "description": "The 'Date From' date to filter by."
+    },
+    {
+      "name": "date_range_to",
+      "type": "string",
+      "required": false,
+      "default": "",
+      "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": {
+    "attachables": {
+      "properties_ids": [],
+      "units_ids": [],
+      "tenants_ids": [],
+      "owners_ids": [],
+      "rental_applications_ids": [],
+      "guest_cards_ids": [],
+      "guest_card_interests_ids": [],
+      "service_requests_ids": [],
+      "vendors_ids": []
+    },
+    "property_visibility": "active",
+    "properties": {
+      "properties_ids": [],
+      "property_groups_ids": [],
+      "portfolios_ids": []
+    },
+    "process_template": "All",
+    "workflow_step": "All",
+    "assigned_user": "All",
+    "date_range_from": "2023-06-01",
+    "date_range_to": "2023-06-30",
+    "columns": [
+      "some_column",
+      "some_other_column"
+    ]
+  },
+  "responseColumns": []
+}

package/dist/catalog/reports/inactive_guest_cards.json

@@ -0,0 +1,134 @@
+{
+  "slug": "inactive_guest_cards",
+  "endpoint": "inactive_guest_cards.json",
+  "name": "Inactive Guest Card Interests",
+  "description": "Returns Inactive 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_lead_types",
+      "type": "array",
+      "required": false,
+      "default": "[]",
+      "enum": [
+        "all",
+        "Free",
+        "Premium",
+        "Hang Up",
+        "Refunded"
+      ],
+      "description": "The Guest Card Lead Type 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_lead_types": [
+      "all"
+    ],
+    "received_on_from": "2023-06-01",
+    "received_on_to": "2023-06-30",
+    "columns": [
+      "some_column",
+      "some_other_column"
+    ]
+  },
+  "responseColumns": []
+}

package/dist/catalog/reports/income_register.json

@@ -0,0 +1,131 @@
+{
+  "slug": "income_register",
+  "endpoint": "income_register.json",
+  "name": "Income Register",
+  "description": "Returns Income Register report data.",
+  "requiredFilters": [
+    "receipt_date_from",
+    "receipt_date_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": "receipt_date_from",
+      "type": "string",
+      "required": true,
+      "format": "YYYY-MM-DD",
+      "description": "The 'Receipt Date From' date to filter by."
+    },
+    {
+      "name": "receipt_date_to",
+      "type": "string",
+      "required": true,
+      "format": "YYYY-MM-DD",
+      "description": "The 'Receipt Date To' date to filter by."
+    },
+    {
+      "name": "party_contact_info",
+      "type": "object",
+      "required": false,
+      "description": "The Payer filter. Expand to view all attributes associated with this filter. You can only submit ONE of the below filters.",
+      "attributes": [
+        {
+          "name": "company_id",
+          "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": []
+    },
+    "receipt_date_from": "2023-06-01",
+    "receipt_date_to": "2023-06-30",
+    "party_contact_info": {
+      "company_id": "1"
+    },
+    "columns": [
+      "some_column",
+      "some_other_column"
+    ]
+  },
+  "responseColumns": [
+    "type",
+    "reference",
+    "property",
+    "property_name",
+    "property_id",
+    "property_address",
+    "property_street",
+    "property_street2",
+    "property_city",
+    "property_state",
+    "property_zip",
+    "unit",
+    "payer",
+    "receipt_date",
+    "cash_gl",
+    "receipt_amount",
+    "charge_amount",
+    "receipt_description",
+    "txn_id",
+    "receipt_id",
+    "unit_id"
+  ]
+}