@nightsquawktech/appfolio-mcp-server 0.0.1

package/dist/catalog/reports/cash_flow_comparison.json

@@ -0,0 +1,158 @@
+{
+  "slug": "cash_flow_comparison",
+  "endpoint": "cash_flow_comparison.json",
+  "name": "Cash Flow - Property Comparison",
+  "description": "Returns Cash Flow - Property Comparison report data.",
+  "requiredFilters": [
+    "properties",
+    "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": 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": "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",
+        "Modified 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",
+    "properties",
+    "total",
+    "account_number"
+  ]
+}

package/dist/catalog/reports/cash_flow_detail.json

@@ -0,0 +1,129 @@
+{
+  "slug": "cash_flow_detail",
+  "endpoint": "cash_flow_detail.json",
+  "name": "Cash Flow Detail",
+  "description": "Returns Cash Flow Detail 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": "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",
+    "exclude_suppressed_fees": "1",
+    "columns": [
+      "some_column",
+      "some_other_column"
+    ]
+  },
+  "responseColumns": [
+    "account_name",
+    "property",
+    "unit",
+    "post_date",
+    "payee_name",
+    "type",
+    "txn_amount",
+    "reference",
+    "remarks",
+    "description",
+    "property_id",
+    "unit_id"
+  ]
+}

package/dist/catalog/reports/charge_detail.json

@@ -0,0 +1,198 @@
+{
+  "slug": "charge_detail",
+  "endpoint": "charge_detail.json",
+  "name": "Charge Detail",
+  "description": "Returns Charge Detail report data.",
+  "requiredFilters": [
+    "charge_date_from",
+    "charge_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": "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'",
+        "'4' denotes 'Notice'",
+        "'1' denotes 'Past'",
+        "'3' denotes 'Evict'"
+      ],
+      "description": "List of Tenant status to filter by."
+    },
+    {
+      "name": "gl_account_ids",
+      "type": "array",
+      "required": false,
+      "default": "[]",
+      "description": "The gl account ids to filter by."
+    },
+    {
+      "name": "date_type",
+      "type": "string",
+      "required": false,
+      "default": "Charge Date",
+      "enum": [
+        "Charge Date",
+        "Posting Date"
+      ],
+      "description": "The Date Type to filter by."
+    },
+    {
+      "name": "payment_status",
+      "type": "string",
+      "required": false,
+      "default": "All",
+      "enum": [
+        "All",
+        "Paid",
+        "Unpaid"
+      ],
+      "description": "The Charge Status to filter by."
+    },
+    {
+      "name": "charge_date_from",
+      "type": "string",
+      "required": true,
+      "format": "YYYY-MM-DD",
+      "description": "The 'Charge Date From' date to filter by."
+    },
+    {
+      "name": "charge_date_to",
+      "type": "string",
+      "required": true,
+      "format": "YYYY-MM-DD",
+      "description": "The 'Charge Date To' date to filter by."
+    },
+    {
+      "name": "receipt_type",
+      "type": "string",
+      "required": false,
+      "default": "All",
+      "enum": [
+        "All",
+        "Tenant Receipts Only",
+        "Other Receipts Only",
+        "Owner Receipts Only"
+      ],
+      "description": "Receipt Type to filter by."
+    },
+    {
+      "name": "receipt_date_from",
+      "type": "string",
+      "required": false,
+      "default": "",
+      "format": "YYYY-MM-DD",
+      "description": "The 'Receipt Date From' date to filter by."
+    },
+    {
+      "name": "receipt_date_to",
+      "type": "string",
+      "required": false,
+      "default": "",
+      "format": "YYYY-MM-DD",
+      "description": "The 'Receipt 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": []
+    },
+    "parties_ids": {
+      "occupancies_ids": []
+    },
+    "tenant_statuses": [
+      "0",
+      "4"
+    ],
+    "gl_account_ids": [
+      "1",
+      "2"
+    ],
+    "date_type": "Charge Date",
+    "payment_status": "All",
+    "charge_date_from": "2023-06-01",
+    "charge_date_to": "2023-06-30",
+    "receipt_type": [
+      "1",
+      "2"
+    ],
+    "receipt_date_from": "2023-06-01",
+    "receipt_date_to": "2023-06-30",
+    "columns": [
+      "some_column",
+      "some_other_column"
+    ]
+  },
+  "responseColumns": []
+}

package/dist/catalog/reports/chart_of_accounts.json

@@ -0,0 +1,22 @@
+{
+  "slug": "chart_of_accounts",
+  "endpoint": "chart_of_accounts.json",
+  "name": "Chart of Accounts",
+  "description": "Returns Chart of Accounts report data.",
+  "requiredFilters": [],
+  "parameters": [
+    {
+      "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": {
+    "columns": [
+      "some_column",
+      "some_other_column"
+    ]
+  },
+  "responseColumns": []
+}

package/dist/catalog/reports/check_register.json

@@ -0,0 +1,181 @@
+{
+  "slug": "check_register",
+  "endpoint": "check_register.json",
+  "name": "Check Register",
+  "description": "Returns Check Register 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",
+      "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": "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.",
+      "attributes": [
+        {
+          "name": "company_id",
+          "type": "string",
+          "required": false,
+          "description": ""
+        }
+      ]
+    },
+    {
+      "name": "payment_type",
+      "type": "string",
+      "required": false,
+      "default": "All",
+      "enum": [
+        "All",
+        "ACH Payments Only",
+        "Checks Only",
+        "Other Payments Only"
+      ],
+      "description": "The 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.",
+      "attributes": [
+        {
+          "name": "check_number_from",
+          "type": "string",
+          "required": false,
+          "description": ""
+        },
+        {
+          "name": "check_number_to",
+          "type": "string",
+          "required": false,
+          "description": ""
+        }
+      ]
+    },
+    {
+      "name": "reverse_transaction",
+      "type": "string",
+      "required": false,
+      "default": "0",
+      "enum": [
+        "0",
+        "1"
+      ],
+      "description": "Whether or not to Include Voided Checks"
+    },
+    {
+      "name": "exclude_cleared_checks",
+      "type": "string",
+      "required": false,
+      "default": "0",
+      "enum": [
+        "0",
+        "1"
+      ],
+      "description": "Exclude Cleared Checks"
+    },
+    {
+      "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"
+    },
+    "reverse_transaction": "0",
+    "exclude_cleared_checks": "1",
+    "columns": [
+      "some_column",
+      "some_other_column"
+    ]
+  },
+  "responseColumns": []
+}