@nightsquawktech/appfolio-mcp-server 0.0.1

package/dist/catalog-db/endpoints/get_gl_accounts.json

@@ -0,0 +1,115 @@
+{
+  "operationId": "get_gl_accounts",
+  "resource": "gl_accounts",
+  "name": "List All General Ledger Accounts",
+  "method": "GET",
+  "path": "/gl_accounts",
+  "description": "Returns all General Ledger (GL) accounts that meet the filter criteria",
+  "deprecated": false,
+  "writeOperation": false,
+  "pagination": true,
+  "queryFilters": [
+    {
+      "name": "filters[LastUpdatedAtFrom]",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "Filter GL accounts updated at or after this date-time"
+    },
+    {
+      "name": "filters[IsCorporateAccount]",
+      "type": "boolean",
+      "required": false,
+      "description": "Filter by whether the GL account is a corporate or non-corporate (standard) GL account"
+    }
+  ],
+  "responseFields": [
+    {
+      "name": "data",
+      "type": "array",
+      "required": false,
+      "description": "Array of GL account objects"
+    },
+    {
+      "name": "data[].Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the GL account"
+    },
+    {
+      "name": "data[].IsCorporateAccount",
+      "type": "boolean",
+      "required": false,
+      "description": "Indicates whether the GL account is a corporate or non-corporate (standard) GL account"
+    },
+    {
+      "name": "data[].AccountName",
+      "type": "string",
+      "required": false,
+      "deprecated": true,
+      "description": "User provided name of the GL account"
+    },
+    {
+      "name": "data[].AccountType",
+      "type": "string",
+      "required": false,
+      "deprecated": true,
+      "description": "The account type or category of the GL account"
+    },
+    {
+      "name": "data[].FundAccount",
+      "type": "object",
+      "required": false,
+      "description": "The type of fund account. Options: Reserve (funds set aside for specific future purposes), Operating (funds set aside for regular operating expenses)"
+    },
+    {
+      "name": "data[].LastUpdatedAt",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "The date the GL account's details were last updated"
+    },
+    {
+      "name": "data[].Name",
+      "type": "string",
+      "required": false,
+      "description": "User provided name of the GL account"
+    },
+    {
+      "name": "data[].Number",
+      "type": "string",
+      "required": false,
+      "description": "The GL account number"
+    },
+    {
+      "name": "data[].Type",
+      "type": "string",
+      "required": false,
+      "description": "The account type or category of the GL account",
+      "enum": ["asset", "capital", "cash", "expense", "income", "liability", "other_expense", "other_income"]
+    },
+    {
+      "name": "data[].OffsetAccountId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the offset account"
+    },
+    {
+      "name": "data[].ParentGlAccountId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the parent general ledger account. If present, it indicates the parent account to which the sub-account belongs."
+    },
+    {
+      "name": "data[].PropertyIds",
+      "type": "Array of arrays",
+      "required": false,
+      "description": "Unique identifier(s) of the properties associated with the GL account. Note: This endpoint returns hidden properties. To associate hidden properties yielded from this endpoint with those from the Properties endpoint, ensure the IncludeHidden filter is enabled."
+    },
+    {
+      "name": "next_page_path",
+      "type": "any",
+      "required": false,
+      "description": "The URL path to the next page of responses"
+    }
+  ],
+  "requestSample": "curl --location -g \\\n     --request GET 'https://api.appfolio.com/api/v0/gl_accounts?filters[LastUpdatedAtFrom]=2020-12-15T16:30:46Z&filters[IsCorporateAccount]=true' \\\n     --header 'Authorization: Basic {Auth}' \\\n     --header 'X-AppFolio-Developer-ID: a965e7d8-a17d-11ec-b909-0242ac120002'"
+}

package/dist/catalog-db/endpoints/get_gl_details.json

@@ -0,0 +1,154 @@
+{
+  "operationId": "get_gl_details",
+  "resource": "gl_details",
+  "name": "List All General Ledger Details",
+  "method": "GET",
+  "path": "/gl_details",
+  "description": "Returns all General Ledger (GL) Details that meet the filter criteria",
+  "deprecated": false,
+  "writeOperation": false,
+  "pagination": true,
+  "queryFilters": [
+    {
+      "name": "filters[DateFrom]",
+      "type": "string <date>",
+      "required": true,
+      "description": "Start date for filtering GL details by transaction date. Required unless both LastUpdatedOnFrom and LastUpdatedOnTo are provided with a time range of 2 days or less."
+    },
+    {
+      "name": "filters[DateTo]",
+      "type": "string <date>",
+      "required": true,
+      "description": "End date for filtering GL details by transaction date. Required unless both LastUpdatedOnFrom and LastUpdatedOnTo are provided with a time range of 2 days or less."
+    },
+    {
+      "name": "filters[PropertyId]",
+      "type": "string",
+      "required": false,
+      "description": "Unique identifier(s) of the property to filter by. Required unless both LastUpdatedOnFrom and LastUpdatedOnTo are provided and the time range between them is 2 days or less. Accepts comma-separated values."
+    },
+    {
+      "name": "filters[GlAccountId]",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the GL account to filter by."
+    },
+    {
+      "name": "filters[AccountingBasis]",
+      "type": "string",
+      "required": false,
+      "description": "The accounting basis to filter by (e.g. Cash or Accrual)."
+    },
+    {
+      "name": "filters[LastUpdatedOnFrom]",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "Start of the last-updated range. When provided together with LastUpdatedOnTo with a range of 2 days or less, PropertyId is not required."
+    },
+    {
+      "name": "filters[LastUpdatedOnTo]",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "End of the last-updated range. When provided together with LastUpdatedOnFrom with a range of 2 days or less, PropertyId is not required."
+    },
+    {
+      "name": "page[number]",
+      "type": "integer",
+      "required": false,
+      "description": "Page number to retrieve. Default is 1."
+    },
+    {
+      "name": "page[size]",
+      "type": "integer",
+      "required": false,
+      "description": "Number of results per page. Default is 1000."
+    }
+  ],
+  "responseFields": [
+    {
+      "name": "data",
+      "type": "array",
+      "required": false,
+      "description": "Array of GL detail objects"
+    },
+    {
+      "name": "data[].LineItemId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the line item associated to this GL detail"
+    },
+    {
+      "name": "data[].GlAccountId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the GL account"
+    },
+    {
+      "name": "data[].PropertyId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the property associated with the GL transaction"
+    },
+    {
+      "name": "data[].UnitId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the unit associated with the GL transaction"
+    },
+    {
+      "name": "data[].Date",
+      "type": "string <date>",
+      "required": false,
+      "description": "The date of the transaction associated with the GL transaction"
+    },
+    {
+      "name": "data[].Reference",
+      "type": "string",
+      "required": false,
+      "description": "The reference number of the transaction associated with the GL transaction"
+    },
+    {
+      "name": "data[].Remarks",
+      "type": "string",
+      "required": false,
+      "description": "Remarks or notes pertaining to the GL transaction"
+    },
+    {
+      "name": "data[].Description",
+      "type": "string",
+      "required": false,
+      "description": "A brief, informative message pertaining to the GL transaction"
+    },
+    {
+      "name": "data[].Credit",
+      "type": "string",
+      "required": false,
+      "description": "Total amount of credit"
+    },
+    {
+      "name": "data[].Debit",
+      "type": "string",
+      "required": false,
+      "description": "Total amount of debit"
+    },
+    {
+      "name": "data[].TransactionId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the transaction"
+    },
+    {
+      "name": "data[].TransactionType",
+      "type": "string",
+      "required": false,
+      "description": "The AppFolio transaction type"
+    },
+    {
+      "name": "next_page_path",
+      "type": "any",
+      "required": false,
+      "description": "The URL path to the next page of responses"
+    }
+  ],
+  "requestSample": "curl --location -g \\\n     --request GET 'https://api.appfolio.com/api/v0/gl_details?filters[DateFrom]=2020-12-15&filters[DateTo]=2020-12-16&filters[GlAccountId]=1abcde23-c543-456e-abc9-123456789cba&filters[PropertyId]=1abcde23-c543-456e-abc9-123456789cee,1abcde23-c543-456e-abc9-123456789cbb&filters[AccountingBasis]=Cash' \\\n     --header 'Authorization: Basic {Auth}' \\\n     --header 'X-AppFolio-Developer-ID: a965e7d8-a17d-11ec-b909-0242ac120002'"
+}

package/dist/catalog-db/endpoints/get_inventories.json

@@ -0,0 +1,131 @@
+{
+  "operationId": "get_inventories",
+  "resource": "inventories",
+  "name": "List All Inventories",
+  "method": "GET",
+  "path": "/inventories",
+  "description": "Returns all inventory items that meet the filter criteria",
+  "deprecated": false,
+  "writeOperation": false,
+  "pagination": true,
+  "queryFilters": [
+    {
+      "name": "filters[LastUpdatedAtFrom]",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "Filter inventory items last updated at or after this date-time."
+    }
+  ],
+  "responseFields": [
+    {
+      "name": "data",
+      "type": "array",
+      "required": false,
+      "description": "Array of inventory item objects"
+    },
+    {
+      "name": "data[].Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the inventory item"
+    },
+    {
+      "name": "data[].Name",
+      "type": "string",
+      "required": false,
+      "description": "The name of the inventory item"
+    },
+    {
+      "name": "data[].Quantity",
+      "type": "string",
+      "required": false,
+      "description": "The current quantity of the inventory item"
+    },
+    {
+      "name": "data[].Reorder",
+      "type": "string",
+      "required": false,
+      "description": "The quantity threshold at which the inventory item should be reordered"
+    },
+    {
+      "name": "data[].Cost",
+      "type": "string",
+      "required": false,
+      "description": "The dollar amount cost of the inventory item"
+    },
+    {
+      "name": "data[].Description",
+      "type": "string",
+      "required": false,
+      "description": "A brief summary or description of the inventory item"
+    },
+    {
+      "name": "data[].PartNumber",
+      "type": "string",
+      "required": false,
+      "description": "The part number of the inventory item"
+    },
+    {
+      "name": "data[].Shelf",
+      "type": "string",
+      "required": false,
+      "description": "The shelf or bin location where the inventory item is stored"
+    },
+    {
+      "name": "data[].Category",
+      "type": "string",
+      "required": false,
+      "description": "The category of the inventory item"
+    },
+    {
+      "name": "data[].HiddenAt",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "The date and time the inventory item was hidden. Null if the item is not hidden."
+    },
+    {
+      "name": "data[].LocationId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the inventory location associated with the inventory item"
+    },
+    {
+      "name": "data[].VendorId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the vendor associated with the inventory item"
+    },
+    {
+      "name": "data[].GlAccountId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the general ledger account associated with the inventory item"
+    },
+    {
+      "name": "data[].MarkUpType",
+      "type": "string",
+      "required": false,
+      "description": "The type of markup applied to the inventory item. Valid values are Percentage or Fixed Amount.",
+      "enum": ["Percentage", "Fixed Amount"]
+    },
+    {
+      "name": "data[].MarkUp",
+      "type": "string",
+      "required": false,
+      "description": "The markup value applied to the inventory item"
+    },
+    {
+      "name": "data[].LastUpdatedAt",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "The date and time the inventory item was last updated"
+    },
+    {
+      "name": "next_page_path",
+      "type": "any",
+      "required": false,
+      "description": "The URL path to the next page of responses"
+    }
+  ],
+  "requestSample": "curl --location -g \\\n     --request GET 'https://api.appfolio.com/api/v0/inventories?filters[LastUpdatedAtFrom]=2020-12-15T16:30:46Z' \\\n     --header 'Authorization: Basic {Auth}' \\\n     --header 'X-AppFolio-Developer-ID: a965e7d8-a17d-11ec-b909-0242ac120002'"
+}

package/dist/catalog-db/endpoints/get_inventory_locations.json

@@ -0,0 +1,70 @@
+{
+  "operationId": "get_inventory_locations",
+  "resource": "inventory_locations",
+  "name": "List All Inventory Locations",
+  "method": "GET",
+  "path": "/inventory_locations",
+  "description": "Returns all inventory locations that meet the filter criteria",
+  "deprecated": false,
+  "writeOperation": false,
+  "pagination": true,
+  "queryFilters": [
+    {
+      "name": "filters[Id]",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Filter by unique identifier of the inventory location"
+    },
+    {
+      "name": "filters[LastUpdatedAtFrom]",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "Filter inventory locations last updated at or after this date-time"
+    }
+  ],
+  "responseFields": [
+    {
+      "name": "data",
+      "type": "array",
+      "required": false,
+      "description": "Array of inventory location objects"
+    },
+    {
+      "name": "data[].Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the inventory location"
+    },
+    {
+      "name": "data[].Name",
+      "type": "string",
+      "required": false,
+      "description": "The name of the inventory location"
+    },
+    {
+      "name": "data[].Description",
+      "type": "string",
+      "required": false,
+      "description": "A brief summary or description of the inventory location"
+    },
+    {
+      "name": "data[].LastUpdatedAt",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "The date and time the inventory location was last updated"
+    },
+    {
+      "name": "data[].PropertyId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the property associated with the inventory location"
+    },
+    {
+      "name": "next_page_path",
+      "type": "any",
+      "required": false,
+      "description": "The URL path to the next page of responses"
+    }
+  ],
+  "requestSample": "curl --location -g \\\n     --request GET 'https://api.appfolio.com/api/v0/inventory_locations?filters[Id]=1abcde23-c543-456e-abc9-123456789cba&filters[LastUpdatedAtFrom]=2020-12-15T16:30:46Z' \\\n     --header 'Authorization: Basic {Auth}' \\\n     --header 'X-AppFolio-Developer-ID: a965e7d8-a17d-11ec-b909-0242ac120002'"
+}

package/dist/catalog-db/endpoints/get_jobs.json

@@ -0,0 +1,79 @@
+{
+  "operationId": "get_jobs",
+  "resource": "jobs",
+  "name": "List All Jobs",
+  "method": "GET",
+  "path": "/jobs",
+  "description": "List endpoint to display all of the jobs related to bulk operations",
+  "deprecated": false,
+  "writeOperation": false,
+  "pagination": true,
+  "queryFilters": [
+    {
+      "name": "filters[Id]",
+      "type": "string",
+      "required": true,
+      "description": "Filters for jobs. Accepts one or more job UUIDs (comma-separated) to retrieve specific bulk operation jobs."
+    }
+  ],
+  "responseFields": [
+    {
+      "name": "data",
+      "type": "array",
+      "required": false,
+      "description": "Array of Job objects"
+    },
+    {
+      "name": "data[].Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the asynchronous bulk create job for the selected resource. This identifier tracks the bulk creation of general ledger accounts, and other supported resources."
+    },
+    {
+      "name": "data[].Status",
+      "type": "string",
+      "required": false,
+      "description": "Indicates the current status of the asynchronous job.",
+      "enum": ["new", "pending", "finished"]
+    },
+    {
+      "name": "data[].Result",
+      "type": "array",
+      "required": false,
+      "description": "The result of the bulk operation job. The result contains either an empty array during processing or the final results after completion, returning an array of objects with a ReferenceId, a Successful status, and a created resource Id. An Errors array will return with a message if the Successful status returns false.",
+      "attributes": [
+        {
+          "name": "ReferenceId",
+          "type": "string",
+          "required": false,
+          "description": "Unique identifier provided in the original bulk create request to track individual items"
+        },
+        {
+          "name": "ResourceId",
+          "type": "string",
+          "required": false,
+          "description": "Unique identifier of the item created. Example: GlAccountId"
+        },
+        {
+          "name": "successful",
+          "type": "boolean",
+          "required": false,
+          "description": "Indicates whether the individual item in the bulk operation was created successfully"
+        },
+        {
+          "name": "errors",
+          "type": "array",
+          "required": false,
+          "description": "An array of error messages that describes why the creation failed, only present when Successful is false"
+        }
+      ]
+    },
+    {
+      "name": "next_page_path",
+      "type": "any",
+      "required": false,
+      "description": "The URL path to the next page of responses"
+    }
+  ],
+  "requestSample": "curl --location -g \\\n     --request GET 'https://api.appfolio.com/api/v0/jobs?filters[Id]=1abcde23-c543-456e-abc9-123456789cee,3b5344d0-482b-4b50-b30f-2dd67412b517' \\\n     --header 'X-AppFolio-Developer-ID: a965e7d8-a17d-11ec-b909-0242ac120002' \\\n     --header 'Authorization: Basic {Auth}'"
+}