@nightsquawktech/appfolio-mcp-server 0.0.1

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

@@ -0,0 +1,46 @@
+{
+  "operationId": "patch_vendors_vendorid_notes_id",
+  "resource": "vendors",
+  "name": "Update Vendor Note",
+  "method": "PATCH",
+  "path": "/vendors/{VendorId}/notes/{Id}",
+  "description": "Update a note to a vendor",
+  "deprecated": false,
+  "writeOperation": true,
+  "pagination": false,
+  "pathParams": [
+    {
+      "name": "VendorId",
+      "type": "string <uuid>",
+      "required": true,
+      "description": "The vendor to which the note will be attached"
+    },
+    {
+      "name": "Id",
+      "type": "string <uuid>",
+      "required": true,
+      "description": "Unique identifier of the note to update"
+    }
+  ],
+  "requestBody": {
+    "required": true,
+    "description": "Note object",
+    "attributes": [
+      {
+        "name": "Body",
+        "type": "string",
+        "required": false,
+        "description": "A brief informative message about the vendor note. A vendor note cannot exceed 65,535 characters."
+      }
+    ]
+  },
+  "responseFields": [
+    {
+      "name": "Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the updated vendor note"
+    }
+  ],
+  "requestSample": "{\n  \"Body\": \"This vendor completed maintenance on 11/30/2022 - Updated\"\n}"
+}

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

@@ -0,0 +1,273 @@
+{
+  "operationId": "patch_work_orders_workorderid",
+  "resource": "work_orders",
+  "name": "Update Work Order",
+  "method": "PATCH",
+  "path": "/work_orders/{workOrderId}",
+  "description": "Update a work order",
+  "deprecated": false,
+  "writeOperation": true,
+  "pagination": false,
+  "pathParams": [
+    {
+      "name": "workOrderId",
+      "type": "string <uuid>",
+      "required": true,
+      "description": "Unique identifier of the work order to update"
+    }
+  ],
+  "requestBody": {
+    "required": true,
+    "description": "Work order update object. At least one attribute must be provided.",
+    "attributes": [
+      {
+        "name": "AssignedUsers",
+        "type": "Array of arrays",
+        "required": false,
+        "description": "Array of AssignedUsers IDs to be updated. Pass in all the assigned users you want to keep. When this is empty, it will drop all assigned users. When this is null or not passed in, it will not change the assigned users."
+      },
+      {
+        "name": "BillableItems",
+        "type": "array",
+        "required": false,
+        "description": "Array of billable line item attributes present on a work order",
+        "attributes": [
+          {
+            "name": "Description",
+            "type": "string",
+            "required": false,
+            "description": "A brief informative message about the billable line item"
+          },
+          {
+            "name": "GlAccountId",
+            "type": "string",
+            "required": false,
+            "description": "Unique identifier of the General Ledger account associated with the billable line item"
+          },
+          {
+            "name": "Quantity",
+            "type": "string <uuid>",
+            "required": false,
+            "description": "The number of services or goods utilized. Quantity must be a positive number."
+          },
+          {
+            "name": "Rate",
+            "type": "string",
+            "required": false,
+            "description": "The rate (cost) of the goods or services provided. Valid format is \"DD.CC\", e.g. \"23.33\""
+          }
+        ]
+      },
+      {
+        "name": "CanceledOn",
+        "type": "string <date>",
+        "required": false,
+        "description": "The date the work order status changed to canceled"
+      },
+      {
+        "name": "CompletedOn",
+        "type": "string <date>",
+        "required": false,
+        "description": "The date the work order status changed to Completed"
+      },
+      {
+        "name": "Description",
+        "type": "string",
+        "required": false,
+        "description": "The top-level description for a grouping of work orders in AppFolio"
+      },
+      {
+        "name": "Estimates",
+        "type": "array",
+        "required": false,
+        "description": "Use estimates to track anticipated costs for Work Orders. DO NOT INCLUDE Estimates unless one or more estimates have changed. Passing any number of estimates will replace all existing estimates for the work order. Passing an empty array [] will remove all existing estimates for the work order.",
+        "attributes": [
+          {
+            "name": "VendorId",
+            "type": "string <uuid>",
+            "required": false,
+            "description": "The unique identifier of the vendor who submitted this estimate. If provided, ManagementCompanyAsVendor must be false or omitted."
+          },
+          {
+            "name": "ManagementCompanyAsVendor",
+            "type": "boolean",
+            "required": false,
+            "description": "Indicates whether or not the management company is acting as the vendor for the estimate. If true, VendorId must be null or omitted."
+          },
+          {
+            "name": "Amount",
+            "type": "number <decimal>",
+            "required": false,
+            "description": "The total estimated cost in dollars for completing the work order as quoted by the vendor."
+          },
+          {
+            "name": "Status",
+            "type": "string",
+            "required": false,
+            "description": "The current approval status of the estimate. Only one estimate can have Approved status at a time per work order. Enum: \"Pending\" \"Approved\" \"Not Approved\"",
+            "enum": ["Pending", "Approved", "Not Approved"]
+          },
+          {
+            "name": "InternalNotes",
+            "type": "string",
+            "required": false,
+            "description": "Internal notes or comments attached to the estimate. These notes are for internal use only and not visible to vendors or owners."
+          },
+          {
+            "name": "EstimateRequestedDate",
+            "type": "string <date>",
+            "required": false,
+            "description": "The date the estimate was requested from the Vendor."
+          },
+          {
+            "name": "EstimateReceivedDate",
+            "type": "string <date>",
+            "required": false,
+            "description": "The date the estimate was received from the Vendor. If Amount is provided but EstimateReceivedDate is not specified, it will automatically default to today's date."
+          }
+        ]
+      },
+      {
+        "name": "InventoryDetails",
+        "type": "array",
+        "required": false,
+        "description": "Array of InventoryDetails objects to be updated. Pass in all the inventory details you want to keep. When this is empty, it will drop all inventory details. When this is null or not passed in, it will not change the inventory details.",
+        "attributes": [
+          {
+            "name": "InventoryId",
+            "type": "string <uuid>",
+            "required": true,
+            "description": "Unique identifier of the inventory item"
+          },
+          {
+            "name": "GlAccountId",
+            "type": "string <uuid>",
+            "required": false,
+            "description": "Unique identifier of the GL account associated with the inventory detail"
+          },
+          {
+            "name": "Quantity",
+            "type": "number",
+            "required": false,
+            "description": "The quantity of the inventory item used"
+          },
+          {
+            "name": "Rate",
+            "type": "number",
+            "required": false,
+            "description": "The rate of the inventory item"
+          }
+        ]
+      },
+      {
+        "name": "JobDescription",
+        "type": "string",
+        "required": false,
+        "description": "A brief description of the work order to be performed"
+      },
+      {
+        "name": "LaborItems",
+        "type": "array",
+        "required": false,
+        "description": "Array of labor line item attributes present on a work order",
+        "attributes": [
+          {
+            "name": "Date",
+            "type": "string <date>",
+            "required": false,
+            "description": "The date the labor was completed. Valid format is \"YYYY-MM-DD\" e.g. \"2020-12-01\"."
+          },
+          {
+            "name": "Description",
+            "type": "string",
+            "required": false,
+            "description": "A brief informative message about the labor performed"
+          },
+          {
+            "name": "HoursWorked",
+            "type": "string <decimal>",
+            "required": false,
+            "description": "The number of hours worked by the maintenance tech"
+          },
+          {
+            "name": "HoursBillable",
+            "type": "string <decimal>",
+            "required": false,
+            "description": "The number of hours worked by the maintenance tech that are billable, used to create the work order bill"
+          },
+          {
+            "name": "UserId",
+            "type": "string <uuid>",
+            "required": false,
+            "description": "Unique identifier of the maintenance tech assigned to the work order"
+          }
+        ]
+      },
+      {
+        "name": "ManagementCompanyAsVendor",
+        "type": "boolean",
+        "required": false,
+        "description": "Indicates whether or not the management company is the vendor for the work order. If false, the assigned vendor company will be dropped."
+      },
+      {
+        "name": "PermissionToEnter",
+        "type": "boolean or string",
+        "required": false,
+        "description": "Occupancy has given permission to enter unit"
+      },
+      {
+        "name": "Priority",
+        "type": "string",
+        "required": false,
+        "description": "The priority of the work order. Enum: \"Urgent\" \"Normal\" \"Low\"",
+        "enum": ["Urgent", "Normal", "Low"]
+      },
+      {
+        "name": "ScheduledEnd",
+        "type": "string <date-time>",
+        "required": false,
+        "description": "When the work order is scheduled to be completed. If ScheduledEnd is null, it will be considered scheduled for 'all day'. The value must adhere to the ISO 8601 format YYYY-MM-DDThh:mm:ssZ and the default time zone is Coordinated Universal Time (UTC)."
+      },
+      {
+        "name": "ScheduledStart",
+        "type": "string <date-time>",
+        "required": false,
+        "description": "When the work order is scheduled to start. Set this value together with ScheduledEnd. The time difference between ScheduledStart and ScheduledEnd should not exceed 12 hours unless it is scheduled for 'all day'. The value must adhere to the ISO 8601 format YYYY-MM-DDThh:mm:ssZ and the default time zone is Coordinated Universal Time (UTC)."
+      },
+      {
+        "name": "Status",
+        "type": "string",
+        "required": false,
+        "description": "The status of the work order. Enum: \"Assigned\" \"Canceled\" \"Completed\" \"New\" \"Scheduled\" \"Waiting\" \"Work Completed\"",
+        "enum": ["Assigned", "Canceled", "Completed", "New", "Scheduled", "Waiting", "Work Completed"]
+      },
+      {
+        "name": "VendorId",
+        "type": "string <uuid>",
+        "required": false,
+        "description": "Unique identifier of the vendor associated with the work order. When the value of this attribute is null, it will drop the assigned vendor. When present, ManagementCompanyAsVendor cannot be true."
+      },
+      {
+        "name": "VendorTrade",
+        "type": "string",
+        "required": false,
+        "description": "The type of service offered by the vendor. Pass \"\" to remove the vendor trade."
+      },
+      {
+        "name": "WorkCompletedOn",
+        "type": "string <date>",
+        "required": false,
+        "description": "The date the work order was completed"
+      }
+    ]
+  },
+  "responseFields": [
+    {
+      "name": "Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the updated work order"
+    }
+  ],
+  "requestSample": "{\n  \"AssignedUsers\": [\n    \"1091593d-613b-43d0-b8f1-1cd0eac704e4\",\n    \"4897dd96-7479-44ec-83a0-99b19936d607\"\n  ],\n  \"BillableItems\": [\n    {},\n    {}\n  ],\n  \"Description\": \"Something to fix.\",\n  \"Estimates\": [\n    {},\n    {}\n  ],\n  \"InventoryDetails\": [\n    {},\n    {}\n  ],\n  \"LaborItems\": [\n    {},\n    {}\n  ],\n  \"ManagementCompanyAsVendor\": false,\n  \"PermissionToEnter\": true,\n  \"Priority\": \"Normal\",\n  \"ScheduledEnd\": \"2021-01-15T20:30:46Z\",\n  \"ScheduledStart\": \"2021-01-15T16:30:46Z\",\n  \"VendorId\": \"8eb28538-c8f5-41e7-ac82-3f9609cceec9\",\n  \"VendorTrade\": \"Appliances\"\n}"
+}

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

@@ -0,0 +1,46 @@
+{
+  "operationId": "patch_work_orders_workorderid_notes_id",
+  "resource": "work_orders",
+  "name": "Update Work Order Note",
+  "method": "PATCH",
+  "path": "/work_orders/{WorkOrderId}/notes/{Id}",
+  "description": "Update a work order's note",
+  "deprecated": false,
+  "writeOperation": true,
+  "pagination": false,
+  "pathParams": [
+    {
+      "name": "WorkOrderId",
+      "type": "string <uuid>",
+      "required": true,
+      "description": "The work order to which the note will be attached"
+    },
+    {
+      "name": "Id",
+      "type": "string <uuid>",
+      "required": true,
+      "description": "Unique identifier of the note to update"
+    }
+  ],
+  "requestBody": {
+    "required": true,
+    "description": "Note object",
+    "attributes": [
+      {
+        "name": "Body",
+        "type": "string",
+        "required": false,
+        "description": "A brief informative message about the work order. A work order note cannot exceed 65,535 characters."
+      }
+    ]
+  },
+  "responseFields": [
+    {
+      "name": "Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the updated work order note"
+    }
+  ],
+  "requestSample": "{\n\"Body\": \"This work order have scheduled a maintenance service on 11/30/2022 - Updated\"\n}"
+}

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

@@ -0,0 +1,167 @@
+{
+  "operationId": "post_bank_accounts_bulk",
+  "resource": "bank_accounts",
+  "name": "Bulk Create Bank Accounts",
+  "method": "POST",
+  "path": "/bank_accounts/bulk",
+  "description": "Create bank accounts in bulk",
+  "deprecated": false,
+  "writeOperation": true,
+  "pagination": false,
+  "requestBody": {
+    "required": true,
+    "description": "Bank Account objects",
+    "attributes": [
+      {
+        "name": "data",
+        "type": "array",
+        "required": false,
+        "description": "Array of bank account objects to create in bulk",
+        "attributes": [
+          {
+            "name": "ReferenceId",
+            "type": "string",
+            "required": true,
+            "description": "Transient unique ID assigned by the developer. Used to reference individual bank accounts in the bulk-creation process."
+          },
+          {
+            "name": "AccountNumber",
+            "type": "string",
+            "required": true,
+            "description": "Account number of the bank account"
+          },
+          {
+            "name": "AccountName",
+            "type": "string",
+            "required": true,
+            "description": "The user-provided name for the bank account"
+          },
+          {
+            "name": "AccountType",
+            "type": "string",
+            "required": true,
+            "description": "The type of bank account",
+            "enum": [
+              "Personal Checking",
+              "Personal Savings",
+              "Business Checking",
+              "Business Saving",
+              "Other"
+            ]
+          },
+          {
+            "name": "BankName",
+            "type": "string",
+            "required": true,
+            "description": "Name of the bank associated with the bank account"
+          },
+          {
+            "name": "RoutingNumber",
+            "type": "string",
+            "required": true,
+            "description": "The routing number of the bank associated with the bank account"
+          },
+          {
+            "name": "BankAddress1",
+            "type": "string",
+            "required": true,
+            "description": "The primary street address of the bank associated with the bank account"
+          },
+          {
+            "name": "BankCity",
+            "type": "string",
+            "required": true,
+            "description": "The city where the bank associated with the bank account is located"
+          },
+          {
+            "name": "NextCheckNumber",
+            "type": "integer",
+            "required": false,
+            "description": "The number checks for this bank account should start at. Must be a positive integer (not zero)"
+          },
+          {
+            "name": "BankAddress2",
+            "type": "string",
+            "required": false,
+            "description": "Additional street address information pertaining to the bank associated with the bank account"
+          },
+          {
+            "name": "BankState",
+            "type": "string",
+            "required": false,
+            "description": "The state where the bank associated with the bank account is located"
+          },
+          {
+            "name": "BankZip",
+            "type": "string",
+            "required": false,
+            "description": "The zip code where the bank associated with the bank account is located"
+          },
+          {
+            "name": "CompanyAddress1",
+            "type": "string",
+            "required": false,
+            "description": "The primary street address of the company. Will be printed on any blank checkstock"
+          },
+          {
+            "name": "CompanyAddress2",
+            "type": "string",
+            "required": false,
+            "description": "Additional street address information of the company"
+          },
+          {
+            "name": "CompanyCity",
+            "type": "string",
+            "required": false,
+            "description": "The city where the company is located. Must be provided if entering a company address"
+          },
+          {
+            "name": "CompanyState",
+            "type": "string",
+            "required": false,
+            "description": "The state where the company is located. Must be provided if entering a company address"
+          },
+          {
+            "name": "CompanyZip",
+            "type": "string",
+            "required": false,
+            "description": "The zip code where the company is located. Must be provided if entering a company address"
+          },
+          {
+            "name": "CompanyNameOnChecks",
+            "type": "string",
+            "required": false,
+            "description": "The company name printed on checks issued from this bank account"
+          }
+        ]
+      }
+    ]
+  },
+  "responseFields": [
+    {
+      "name": "data",
+      "type": "array",
+      "required": false,
+      "description": "Array of results for each bank account creation attempt"
+    },
+    {
+      "name": "data[].ReferenceId",
+      "type": "string",
+      "required": false,
+      "description": "Transient unique ID assigned by the developer. Used to reference individual bank accounts in the bulk-creation process."
+    },
+    {
+      "name": "data[].successful",
+      "type": "boolean",
+      "required": false,
+      "description": "Indication of successful creation"
+    },
+    {
+      "name": "data[].BankAccountId",
+      "type": "string",
+      "required": false,
+      "description": "Unique identifier of the created bank account"
+    }
+  ],
+  "requestSample": "{\n  \"data\": [\n    {}\n  ]\n}"
+}