@nightsquawktech/appfolio-mcp-server 0.0.1

package/dist/catalog/reports/budget_comparative.json

@@ -0,0 +1,162 @@
+{
+  "slug": "budget_comparative",
+  "endpoint": "budget_comparative.json",
+  "name": "Budget - Comparative",
+  "description": "Returns Budget - Comparative report data.",
+  "requiredFilters": [
+    "period_from",
+    "period_to",
+    "comparison_period_from",
+    "comparison_period_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": "period_from",
+      "type": "string",
+      "format": "YYYY-MM",
+      "required": true,
+      "description": "The 'Period From' month to filter by."
+    },
+    {
+      "name": "period_to",
+      "type": "string",
+      "format": "YYYY-MM",
+      "required": true,
+      "description": "The 'Period To' month to filter by."
+    },
+    {
+      "name": "comparison_period_from",
+      "type": "string",
+      "format": "YYYY-MM",
+      "required": true,
+      "description": "The 'Comparison Period From' month to filter by."
+    },
+    {
+      "name": "comparison_period_to",
+      "type": "string",
+      "format": "YYYY-MM",
+      "required": true,
+      "description": "The 'Comparison Period To' month to filter by."
+    },
+    {
+      "name": "additional_account_types",
+      "type": "array",
+      "required": false,
+      "default": "[\"Asset\",\"Cash\",\"Liability\",\"Capital\"]",
+      "enum": [
+        "Asset",
+        "Cash",
+        "Liability",
+        "Capital"
+      ],
+      "description": "Additional account types 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": "level_of_detail",
+      "type": "string",
+      "required": false,
+      "default": "detail_view",
+      "enum": [
+        "detail_view",
+        "summary_view"
+      ],
+      "description": "The level of detail 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": []
+    },
+    "period_from": "2023-06",
+    "period_to": "2023-06",
+    "comparison_period_from": "2023-06",
+    "comparison_period_to": "2023-06",
+    "additional_account_types": [
+      "Asset"
+    ],
+    "accounting_basis": "Cash",
+    "level_of_detail": "detail_view",
+    "columns": [
+      "some_column",
+      "some_other_column"
+    ]
+  },
+  "responseColumns": [
+    "account_number",
+    "account_name",
+    "period_actual",
+    "period_budget",
+    "period_amount_var",
+    "period_percent_var",
+    "comparison_actual",
+    "comparison_budget",
+    "comparison_amount_var",
+    "comparison_percent_var"
+  ]
+}

package/dist/catalog/reports/budget_comparison.json

@@ -0,0 +1,141 @@
+{
+  "slug": "budget_comparison",
+  "endpoint": "budget_comparison.json",
+  "name": "Budget - Property Comparison",
+  "description": "Returns Budget - Property Comparison report data.",
+  "requiredFilters": [
+    "properties",
+    "period_from",
+    "period_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": true,
+      "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": "period_from",
+      "type": "string",
+      "format": "YYYY-MM",
+      "required": true,
+      "description": "The 'Period From' month to filter by."
+    },
+    {
+      "name": "period_to",
+      "type": "string",
+      "format": "YYYY-MM",
+      "required": true,
+      "description": "The 'Period To' month to filter by."
+    },
+    {
+      "name": "additional_account_types",
+      "type": "array",
+      "required": false,
+      "default": [],
+      "enum": [
+        "Asset",
+        "Cash",
+        "Liability",
+        "Capital"
+      ],
+      "description": "Additional account types to filter by."
+    },
+    {
+      "name": "accounting_basis",
+      "type": "string",
+      "required": false,
+      "default": "Cash",
+      "enum": [
+        "Cash",
+        "Accrual"
+      ],
+      "description": "The accounting basis to filter by."
+    },
+    {
+      "name": "level_of_detail",
+      "type": "string",
+      "required": false,
+      "default": "detail_view",
+      "enum": [
+        "detail_view",
+        "summary_view"
+      ],
+      "description": "The level of detail 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": []
+    },
+    "period_from": "2023-06",
+    "period_to": "2023-06",
+    "additional_account_types": [
+      "Asset"
+    ],
+    "accounting_basis": "Cash",
+    "level_of_detail": "detail_view",
+    "columns": [
+      "some_column",
+      "some_other_column"
+    ]
+  },
+  "responseColumns": [
+    "account_name",
+    "properties",
+    "total_period_actual",
+    "total_period_budget",
+    "total_period_variance",
+    "total_period_percent_variance",
+    "account_number"
+  ]
+}

package/dist/catalog/reports/cancelled_processes.json

@@ -0,0 +1,122 @@
+{
+  "slug": "cancelled_processes",
+  "endpoint": "cancelled_processes.json",
+  "name": "Cancelled Workflows",
+  "description": "Returns Cancelled 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": "cancelled_by",
+      "type": "string",
+      "required": false,
+      "default": "All",
+      "description": "The 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": {
+    "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",
+    "cancelled_by": "All",
+    "columns": ["some_column", "some_other_column"]
+  },
+  "responseColumns": []
+}

package/dist/catalog/reports/cash_flow.json

@@ -0,0 +1,158 @@
+{
+  "slug": "cash_flow",
+  "endpoint": "cash_flow.json",
+  "name": "Cash Flow",
+  "description": "Returns Cash Flow 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": "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": "accounting_basis",
+      "type": "string",
+      "required": false,
+      "default": "Cash",
+      "enum": [
+        "Cash",
+        "Accrual"
+      ],
+      "description": "The accounting basis to filter by."
+    },
+    {
+      "name": "gl_account_ids",
+      "type": "array",
+      "required": false,
+      "default": "[]",
+      "description": "The gl account ids to filter by."
+    },
+    {
+      "name": "level_of_detail",
+      "type": "string",
+      "required": false,
+      "default": "detail_view",
+      "enum": [
+        "detail_view",
+        "summary_view"
+      ],
+      "description": "The level of detail to filter by."
+    },
+    {
+      "name": "include_zero_balance_gl_accounts",
+      "type": "string",
+      "required": false,
+      "default": "0",
+      "enum": [
+        "0",
+        "1"
+      ],
+      "description": "Include Zero Balance GL Accounts"
+    },
+    {
+      "name": "exclude_suppressed_fees",
+      "type": "string",
+      "required": false,
+      "default": "0",
+      "enum": [
+        "0",
+        "1"
+      ],
+      "description": "Exclude Suppressed Fees"
+    },
+    {
+      "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": []
+    },
+    "posted_on_from": "2023-06-01",
+    "posted_on_to": "2023-06-30",
+    "accounting_basis": "Cash",
+    "gl_account_ids": [
+      "1",
+      "2"
+    ],
+    "level_of_detail": "detail_view",
+    "include_zero_balance_gl_accounts": "1",
+    "exclude_suppressed_fees": "1",
+    "columns": [
+      "some_column",
+      "some_other_column"
+    ]
+  },
+  "responseColumns": [
+    "account_name",
+    "account_number",
+    "selected_period",
+    "selected_period_percent",
+    "fiscal_year_to_date",
+    "fiscal_year_to_date_percent"
+  ]
+}