@nightsquawktech/appfolio-mcp-server 0.0.1

package/dist/catalog/reports/check_register_detail.json

@@ -0,0 +1,181 @@
+{
+  "slug": "check_register_detail",
+  "endpoint": "check_register_detail.json",
+  "name": "Check Register Detail (Enhanced)",
+  "description": "Returns Check Register Detail (Enhanced) 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": "bank_account_ids",
+      "type": "array",
+      "required": false,
+      "description": "The bank account ids to filter by."
+    },
+    {
+      "name": "party_contact_info",
+      "type": "object",
+      "required": false,
+      "description": "The Payee filter. Expand to view all attributes associated with this filter. You can only submit ONE of the below filters."
+    },
+    {
+      "name": "payment_type",
+      "type": "string",
+      "required": false,
+      "default": "All",
+      "enum": [
+        "All",
+        "ACH Payments Only",
+        "Checks Only",
+        "Other Payments Only"
+      ],
+      "description": "Payment type to filter by."
+    },
+    {
+      "name": "range",
+      "type": "object",
+      "required": false,
+      "description": "The Check Numbers to filter by. Expand to view all attributes associated with this filter."
+    },
+    {
+      "name": "include_voided_checks",
+      "type": "string",
+      "required": false,
+      "default": "0",
+      "enum": [
+        "0",
+        "1"
+      ],
+      "description": "Include Voided Checks"
+    },
+    {
+      "name": "group_gl_totals_by_check",
+      "type": "string",
+      "required": false,
+      "default": "0",
+      "enum": [
+        "0",
+        "1"
+      ],
+      "description": "Group GL Totals per Check"
+    },
+    {
+      "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",
+    "bank_account_ids": [
+      "1",
+      "2"
+    ],
+    "party_contact_info": {
+      "company_id": "1"
+    },
+    "payment_type": "All",
+    "range": {
+      "check_number_from": "9",
+      "check_number_to": "29"
+    },
+    "include_voided_checks": "1",
+    "group_gl_totals_by_check": "1",
+    "columns": [
+      "some_column",
+      "some_other_column"
+    ]
+  },
+  "responseColumns": [
+    "bank_account",
+    "bank_account_number",
+    "payee_name",
+    "check_number",
+    "cleared",
+    "check_memo",
+    "occurred_date",
+    "payment_amount",
+    "ach_batch_gen_date",
+    "property_name",
+    "property_address",
+    "gl_account_number",
+    "gl_account_name",
+    "invoice_amount",
+    "remarks",
+    "reference",
+    "txn_id",
+    "check_id",
+    "invoice_detail_id",
+    "gl_account_id",
+    "property_id"
+  ]
+}

package/dist/catalog/reports/completed_processes.json

@@ -0,0 +1,117 @@
+{
+  "slug": "completed_processes",
+  "endpoint": "completed_processes.json",
+  "name": "Completed Workflows",
+  "description": "Returns Completed 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/delinquency.json

@@ -0,0 +1,164 @@
+{
+  "slug": "delinquency",
+  "endpoint": "delinquency.json",
+  "name": "Delinquency",
+  "description": "Returns 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": "this and last month",
+      "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'",
+        "'3' denotes 'Evict'"
+      ],
+      "description": "List of Tenant 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 'Rent 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",
+    "tenant_statuses": [
+      "0",
+      "4"
+    ],
+    "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/delinquency_as_of.json

@@ -0,0 +1,155 @@
+{
+  "slug": "delinquency_as_of",
+  "endpoint": "delinquency_as_of.json",
+  "name": "Delinquency (As Of)",
+  "description": "Returns 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": "this and last month",
+      "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"
+      ],
+      "description": "List of Tenant 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 'Rent 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/deposit_register.json

@@ -0,0 +1,51 @@
+{
+  "slug": "deposit_register",
+  "endpoint": "deposit_register.json",
+  "name": "Deposit Register",
+  "description": "Returns Deposit Register report data.",
+  "requiredFilters": [
+    "occurred_on_from",
+    "occurred_on_to"
+  ],
+  "parameters": [
+    {
+      "name": "occurred_on_from",
+      "type": "string",
+      "format": "YYYY-MM-DD",
+      "required": true,
+      "description": "The 'Date From' date to filter by."
+    },
+    {
+      "name": "occurred_on_to",
+      "type": "string",
+      "format": "YYYY-MM-DD",
+      "required": true,
+      "description": "The 'Date To' date to filter by."
+    },
+    {
+      "name": "bank_account_ids",
+      "type": "array",
+      "required": false,
+      "description": "The bank account ids 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": {
+    "occurred_on_from": "2023-06-01",
+    "occurred_on_to": "2023-06-30",
+    "bank_account_ids": [
+      "1",
+      "2"
+    ],
+    "columns": [
+      "some_column",
+      "some_other_column"
+    ]
+  },
+  "responseColumns": []
+}