@nightsquawktech/appfolio-mcp-server 0.0.1

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

@@ -0,0 +1,77 @@
+{
+  "operationId": "patch_inspections_inspectionid",
+  "resource": "inspections",
+  "name": "Update Inspection",
+  "method": "PATCH",
+  "path": "/inspections/{InspectionId}",
+  "description": "Update an inspection record",
+  "deprecated": false,
+  "writeOperation": true,
+  "pagination": false,
+  "pathParams": [
+    {
+      "name": "InspectionId",
+      "type": "string <uuid>",
+      "required": true,
+      "description": "Unique identifier of the inspection to update"
+    }
+  ],
+  "requestBody": {
+    "required": true,
+    "description": "Attributes to update for the inspection",
+    "attributes": [
+      {
+        "name": "Name",
+        "type": "string",
+        "required": false,
+        "description": "The user-provided name of the inspection."
+      },
+      {
+        "name": "URL",
+        "type": "string",
+        "required": false,
+        "description": "The URL link to an external page hosted by the partner with additional details about the inspection."
+      },
+      {
+        "name": "InspectionDate",
+        "type": "string <date>",
+        "required": false,
+        "description": "The date the inspection was or is scheduled to be conducted. Valid format is \"YYYY-MM-DD\" e.g. \"2025-03-25\"."
+      },
+      {
+        "name": "Status",
+        "type": "string",
+        "required": false,
+        "description": "Indicates the current status of the inspection. Valid values for update include \"NEW\", \"IN PROGRESS\", \"DONE\", \"OUT FOR SIGNING\", or \"SIGNED\".",
+        "enum": ["NEW", "IN PROGRESS", "DONE", "OUT FOR SIGNING", "SIGNED"]
+      },
+      {
+        "name": "OccupancyId",
+        "type": "string <uuid>",
+        "required": false,
+        "description": "Unique identifier of the occupancy to associate with the inspection. Only one of OccupancyId, PropertyId, or UnitId may be specified."
+      },
+      {
+        "name": "PropertyId",
+        "type": "string <uuid>",
+        "required": false,
+        "description": "Unique identifier of the property to associate with the inspection. Only one of OccupancyId, PropertyId, or UnitId may be specified."
+      },
+      {
+        "name": "UnitId",
+        "type": "string <uuid>",
+        "required": false,
+        "description": "Unique identifier of the unit to associate with the inspection. Only one of OccupancyId, PropertyId, or UnitId may be specified."
+      }
+    ]
+  },
+  "responseFields": [
+    {
+      "name": "Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the updated inspection"
+    }
+  ],
+  "requestSample": "{\n  \"Name\": \"New Name\",\n  \"URL\": \"https://partner.com/inspections/updated-123\",\n  \"InspectionDate\": \"2025-06-10\",\n  \"Status\": \"DONE\"\n}"
+}

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

@@ -0,0 +1,113 @@
+{
+  "operationId": "patch_inventories_id",
+  "resource": "inventories",
+  "name": "Update Inventory",
+  "method": "PATCH",
+  "path": "/inventories/{Id}",
+  "description": "Update an inventory item. At least one attribute or relationship must be provided.",
+  "deprecated": false,
+  "writeOperation": true,
+  "pagination": false,
+  "pathParams": [
+    {
+      "name": "Id",
+      "type": "string <uuid>",
+      "required": true,
+      "description": "Unique identifier of the inventory item to update"
+    }
+  ],
+  "requestBody": {
+    "required": true,
+    "description": "Update inventory object. At least one attribute must be provided.",
+    "attributes": [
+      {
+        "name": "Name",
+        "type": "string",
+        "required": false,
+        "description": "The name of the inventory item."
+      },
+      {
+        "name": "Quantity",
+        "type": "number",
+        "required": false,
+        "description": "The quantity of the inventory item."
+      },
+      {
+        "name": "Reorder",
+        "type": "integer",
+        "required": false,
+        "description": "The reorder threshold for the inventory item."
+      },
+      {
+        "name": "Cost",
+        "type": "number",
+        "required": false,
+        "description": "The cost of the inventory item."
+      },
+      {
+        "name": "Description",
+        "type": "string",
+        "required": false,
+        "description": "A description of the inventory item."
+      },
+      {
+        "name": "PartNumber",
+        "type": "string",
+        "required": false,
+        "description": "The part number of the inventory item."
+      },
+      {
+        "name": "Shelf",
+        "type": "string",
+        "required": false,
+        "description": "The bin/shelf location of the inventory item."
+      },
+      {
+        "name": "Category",
+        "type": "string",
+        "required": false,
+        "description": "The category of the inventory item."
+      },
+      {
+        "name": "LocationId",
+        "type": "string <uuid>",
+        "required": false,
+        "description": "Unique identifier of the inventory location."
+      },
+      {
+        "name": "VendorId",
+        "type": "string <uuid>",
+        "required": false,
+        "description": "Unique identifier of the vendor."
+      },
+      {
+        "name": "GlAccountId",
+        "type": "string <uuid>",
+        "required": false,
+        "description": "Unique identifier of the GL account (must be expense type)."
+      },
+      {
+        "name": "MarkUpType",
+        "type": "string",
+        "required": false,
+        "description": "The markup type.",
+        "enum": ["Percentage", "Fixed Amount"]
+      },
+      {
+        "name": "MarkUp",
+        "type": "number",
+        "required": false,
+        "description": "The markup value."
+      }
+    ]
+  },
+  "responseFields": [
+    {
+      "name": "Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the updated inventory item"
+    }
+  ],
+  "requestSample": "{\n  \"Name\": \"Updated Inventory Item\",\n  \"Quantity\": 10,\n  \"Cost\": \"25.00\"\n}"
+}

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

@@ -0,0 +1,52 @@
+{
+  "operationId": "patch_inventory_locations_id",
+  "resource": "inventory_locations",
+  "name": "Update Inventory Location",
+  "method": "PATCH",
+  "path": "/inventory_locations/{Id}",
+  "description": "Update an inventory location. At least one attribute or relationship must be provided.",
+  "deprecated": false,
+  "writeOperation": true,
+  "pagination": false,
+  "pathParams": [
+    {
+      "name": "Id",
+      "type": "string <uuid>",
+      "required": true,
+      "description": "Unique identifier of the inventory location to update"
+    }
+  ],
+  "requestBody": {
+    "required": true,
+    "description": "Update inventory location object. At least one attribute must be provided.",
+    "attributes": [
+      {
+        "name": "Name",
+        "type": "string",
+        "required": false,
+        "description": "The name of the inventory location."
+      },
+      {
+        "name": "Description",
+        "type": "string",
+        "required": false,
+        "description": "A description of the inventory location."
+      },
+      {
+        "name": "PropertyId",
+        "type": "string <uuid>",
+        "required": false,
+        "description": "Unique identifier of the property associated with the inventory location."
+      }
+    ]
+  },
+  "responseFields": [
+    {
+      "name": "Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the updated inventory location"
+    }
+  ],
+  "requestSample": "{\n  \"Name\": \"Storage Room A\",\n  \"Description\": \"Main storage room on the first floor\",\n  \"PropertyId\": \"1abcde23-c543-456e-abc9-123456789cba\"\n}"
+}

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

@@ -0,0 +1,90 @@
+{
+  "operationId": "patch_journal_entries_journalentryid",
+  "resource": "journal_entries",
+  "name": "Update Journal Entries",
+  "method": "PATCH",
+  "path": "/journal_entries/{JournalEntryId}",
+  "description": "Update a journal entry",
+  "deprecated": false,
+  "writeOperation": true,
+  "pagination": false,
+  "pathParams": [
+    {
+      "name": "JournalEntryId",
+      "type": "string <uuid>",
+      "required": true,
+      "description": "Unique identifier of the journal entry to update"
+    }
+  ],
+  "requestBody": {
+    "required": true,
+    "description": "Journal Entry object",
+    "attributes": [
+      {
+        "name": "Id",
+        "type": "string <uuid>",
+        "required": false,
+        "description": "Unique identifier of the journal entry"
+      },
+      {
+        "name": "EntryDate",
+        "type": "string",
+        "required": false,
+        "description": "The date the journal entry was created. Valid format is \"YYYY-MM-DD\" e.g. \"2022-03-03\"."
+      },
+      {
+        "name": "LineItems",
+        "type": "array",
+        "required": false,
+        "description": "Array of line-item objects. Two or more line-item objects must be passed to create a journal entry. The sum of the total debits must equal the total credits for all line-item objects.",
+        "attributes": [
+          {
+            "name": "Credit",
+            "type": "string <decimal>",
+            "required": false,
+            "description": "The credit amount. Total debits and credits must be equal. For example, if line-item 1 has a credit of \"10.00\", line-item 2 must have a debit of \"10.00\"."
+          },
+          {
+            "name": "Debit",
+            "type": "string <decimal>",
+            "required": false,
+            "description": "The debit amount. Total debits and credits must be equal. For example, if line-item 1 has a credit of \"10.00\", line-item 2 must have a debit of \"10.00\"."
+          },
+          {
+            "name": "Description",
+            "type": "string",
+            "required": false,
+            "description": "A brief, informative description of the journal entry's line item"
+          },
+          {
+            "name": "GlAccountId",
+            "type": "string <uuid>",
+            "required": false,
+            "description": "Unique identifier of the general ledger account associated with the journal entry line item"
+          }
+        ]
+      },
+      {
+        "name": "PropertyId",
+        "type": "string <uuid>",
+        "required": false,
+        "description": "Unique identifier of the property or association related to the journal entry"
+      },
+      {
+        "name": "Remarks",
+        "type": "string",
+        "required": false,
+        "description": "A description or summary of the journal entry"
+      }
+    ]
+  },
+  "responseFields": [
+    {
+      "name": "Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the updated journal entry"
+    }
+  ],
+  "requestSample": "{\n  \"EntryDate\": \"2022-02-01\",\n  \"PropertyId\": \"71c5cb28-547f-11ec-bfa5-02975b268737\",\n  \"LineItems\": [\n    {},\n    {}\n  ],\n  \"Remarks\": \"Payroll November\"\n}"
+}

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

@@ -0,0 +1,46 @@
+{
+  "operationId": "patch_leads_guestcardid_notes_id",
+  "resource": "leads",
+  "name": "Update Lead Note",
+  "method": "PATCH",
+  "path": "/leads/{GuestCardId}/notes/{Id}",
+  "description": "Update a note to a lead",
+  "deprecated": false,
+  "writeOperation": true,
+  "pagination": false,
+  "pathParams": [
+    {
+      "name": "GuestCardId",
+      "type": "string <uuid>",
+      "required": true,
+      "description": "The unique identifier of the Guest Card to which the note will be attached. Guest Cards can be linked to multiple leads."
+    },
+    {
+      "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 lead note. A lead note cannot exceed 65,535 characters."
+      }
+    ]
+  },
+  "responseFields": [
+    {
+      "name": "Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the updated lead note"
+    }
+  ],
+  "requestSample": "{\n  \"Body\": \"This rental application has been submitted on 11/11/2023 - Updated\"\n}"
+}

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

@@ -0,0 +1,162 @@
+{
+  "operationId": "patch_leads_leadid",
+  "resource": "leads",
+  "name": "Update Lead",
+  "method": "PATCH",
+  "path": "/leads/{leadId}",
+  "description": "Update a lead",
+  "deprecated": false,
+  "writeOperation": true,
+  "pagination": false,
+  "pathParams": [
+    {
+      "name": "leadId",
+      "type": "string <uuid>",
+      "required": true,
+      "description": "Unique identifier of the lead to update"
+    }
+  ],
+  "requestBody": {
+    "required": true,
+    "description": "Lead fields to update. All attributes are optional; only provided fields will be updated.",
+    "attributes": [
+      {
+        "name": "AdditionalOccupants",
+        "type": "integer",
+        "required": false,
+        "description": "The number of other potential occupants of the residency"
+      },
+      {
+        "name": "AssignedUserId",
+        "type": "string <uuid>",
+        "required": false,
+        "description": "The AppFolio Property Manager user assigned to the lead. A null value passed to AssignedUserId will unassign the user previously assigned to the lead. Omitting AssignedUserId from the request body will not update the assigned user. Reference the Users endpoint for any necessary associations."
+      },
+      {
+        "name": "Bathrooms",
+        "type": "string <decimal>",
+        "required": false,
+        "description": "The number of desired bathrooms"
+      },
+      {
+        "name": "Bedrooms",
+        "type": "integer",
+        "required": false,
+        "description": "The number of desired bedrooms"
+      },
+      {
+        "name": "CreatedAt",
+        "type": "string <date-time>",
+        "required": false,
+        "description": "The date the lead was created. 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": "CreditScore",
+        "type": "string",
+        "required": false,
+        "description": "The self-reported credit score of the interested party"
+      },
+      {
+        "name": "DesiredMoveIn",
+        "type": "string <date>",
+        "required": false,
+        "description": "The date the prospective resident desires to move in"
+      },
+      {
+        "name": "FirstName",
+        "type": "string",
+        "required": false,
+        "description": "The first name of the interested person"
+      },
+      {
+        "name": "Email",
+        "type": "string",
+        "required": false,
+        "description": "The email address of the interested person"
+      },
+      {
+        "name": "HasCats",
+        "type": "boolean",
+        "required": false,
+        "description": "Indicates whether or not the interested person has cat(s)"
+      },
+      {
+        "name": "HasDogs",
+        "type": "boolean",
+        "required": false,
+        "description": "Indicates whether or not the interested person has dog(s)"
+      },
+      {
+        "name": "HasOtherPet",
+        "type": "boolean",
+        "required": false,
+        "description": "Indicates whether or not the interested person has other pet(s)"
+      },
+      {
+        "name": "InactiveReason",
+        "type": "string",
+        "required": false,
+        "description": "The reason why the lead was marked inactive",
+        "enum": ["price", "location", "amenities", "no_response", "decided_not_to_move", "leasing_criteria_not_met", "looking_for_move_in_special", "no_availability", "duplicate", "other"]
+      },
+      {
+        "name": "LastName",
+        "type": "string",
+        "required": false,
+        "description": "The last name of the interested person"
+      },
+      {
+        "name": "MaxRent",
+        "type": "string <decimal>",
+        "required": false,
+        "description": "The max amount the interested person is willing to pay monthly for rent"
+      },
+      {
+        "name": "MiddleInitial",
+        "type": "string",
+        "required": false,
+        "description": "The middle initial of the interested person"
+      },
+      {
+        "name": "MonthlyIncome",
+        "type": "string <decimal>",
+        "required": false,
+        "description": "The self-reported monthly income of interested person"
+      },
+      {
+        "name": "PhoneNumber",
+        "type": "string",
+        "required": false,
+        "description": "The phone number of the interested person"
+      },
+      {
+        "name": "Source",
+        "type": "string",
+        "required": false,
+        "description": "The mechanism through which this lead was submitted"
+      },
+      {
+        "name": "Status",
+        "type": "string",
+        "required": false,
+        "description": "Indicates the current phase of engagement with a prospective resident. If the status is set to inactive, you must specify the reason the lead was marked inactive by setting a value for InactiveReason.",
+        "enum": ["active", "cold", "inactive", "waitlisted"]
+      },
+      {
+        "name": "UnitIds",
+        "type": "Array of strings",
+        "required": false,
+        "description": "Array of UnitIds to update on the lead. To maintain a unit's association with a lead, pass in that unit's Id. Passing an empty array of UnitIds will drop all unit interests from the lead. Passing in null for this array or omitting it from the request will not change the units."
+      }
+    ]
+  },
+  "responseFields": [
+    {
+      "name": "Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the updated lead"
+    }
+  ],
+  "requestSample": "{\n  \"AdditionalOccupants\": 1,\n  \"AssignedUserId\": \"123cde23-c543-456e-abc9-123456789cba\",\n  \"Bathrooms\": \"2.5\",\n  \"Bedrooms\": 2,\n  \"CreatedAt\": \"2021-12-15T16:30:46Z\",\n  \"CreditScore\": \"650\",\n  \"DesiredMoveIn\": \"2021-12-31\",\n  \"Email\": \"sample@example.com\",\n  \"FirstName\": \"John\",\n  \"HasCats\": true,\n  \"HasDogs\": false,\n  \"HasOtherPet\": false,\n  \"LastName\": \"Doe\",\n  \"MaxRent\": \"2200.00\",\n  \"MiddleInitial\": \"\",\n  \"MonthlyIncome\": \"6600.00\",\n  \"PhoneNumber\": \"(310) 555-0194\",\n  \"Source\": \"Website\",\n  \"Status\": \"active\",\n  \"UnitIds\": [\"1abcde23-c543-456e-abc9-123456789cba\", \"234abcde-c543-456e-abc9-123456789abc\"]\n}"
+}

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

@@ -0,0 +1,52 @@
+{
+  "operationId": "patch_leases_leaseid",
+  "resource": "leases",
+  "name": "Update Lease",
+  "method": "PATCH",
+  "path": "/leases/{LeaseId}",
+  "description": "Update a lease. Note: IsMtm and EndOn are mutually exclusive and cannot be set in the same request.",
+  "deprecated": false,
+  "writeOperation": true,
+  "pagination": false,
+  "pathParams": [
+    {
+      "name": "LeaseId",
+      "type": "string <uuid>",
+      "required": true,
+      "description": "Unique identifier of the lease to update"
+    }
+  ],
+  "requestBody": {
+    "required": true,
+    "description": "Update lease object. At least one attribute must be provided. Note: IsMtm and EndOn are mutually exclusive and cannot be set in the same request.",
+    "attributes": [
+      {
+        "name": "EndOn",
+        "type": "string <date>",
+        "required": false,
+        "description": "The end date of the lease. The value must adhere to the ISO 8601 format YYYY-MM-DD. Cannot be set if IsMtm is true."
+      },
+      {
+        "name": "IsMtm",
+        "type": "boolean",
+        "required": false,
+        "description": "Indicates if the lease is month-to-month. Cannot be set to true if EndOn is provided."
+      },
+      {
+        "name": "RenewedOn",
+        "type": "string <date>",
+        "required": false,
+        "description": "The date the lease was renewed. The value must adhere to the ISO 8601 format YYYY-MM-DD."
+      }
+    ]
+  },
+  "responseFields": [
+    {
+      "name": "Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the updated lease"
+    }
+  ],
+  "requestSample": "{\n  \"EndOn\": \"2026-12-31\",\n  \"RenewedOn\": \"2026-01-15\"\n}"
+}

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

@@ -0,0 +1,72 @@
+{
+  "operationId": "patch_owner_groups_id",
+  "resource": "owner_groups",
+  "name": "Update Owner Group",
+  "method": "PATCH",
+  "path": "/owner_groups/{id}",
+  "description": "Update an existing Owner Group",
+  "deprecated": false,
+  "writeOperation": true,
+  "pagination": false,
+  "pathParams": [
+    {
+      "name": "id",
+      "type": "string <uuid>",
+      "required": true,
+      "description": "Unique identifier of the owner group to update"
+    }
+  ],
+  "requestBody": {
+    "required": true,
+    "description": "Owner Group update parameters",
+    "attributes": [
+      {
+        "name": "FiscalYearEnd",
+        "type": "integer",
+        "required": false,
+        "description": "The month number representing the end of the fiscal year"
+      },
+      {
+        "name": "OwnerPacketBasis",
+        "type": "string",
+        "required": false,
+        "description": "The accounting method used for owner packet calculations. Valid values are \"Cash\" or \"Accrual\".",
+        "enum": ["Cash", "Accrual"]
+      },
+      {
+        "name": "PaymentType",
+        "type": "string",
+        "required": false,
+        "description": "The type of payment distribution for the owners. Valid values are \"Net Income\" or \"Flat\".",
+        "enum": ["Net Income", "Flat"]
+      },
+      {
+        "name": "PaymentAmount",
+        "type": "string <decimal>",
+        "required": false,
+        "description": "The fixed payment amount to distribute to owners. This value is required when PaymentType is \"Flat\"."
+      },
+      {
+        "name": "StartDate",
+        "type": "string <date>",
+        "required": false,
+        "description": "The date when this ownership group becomes effective. The date must be in YYYY-MM-DD format and cannot be set in the future. When updating an existing property's ownership, this date must be later than the current ownership group's StartDate. Creating a new owner group will automatically set the previous owner group's EndDate to one day before this StartDate to maintain ownership continuity."
+      },
+      {
+        "name": "ReserveFunds",
+        "type": "string <decimal>",
+        "required": false,
+        "description": "The amount of funds to maintain in reserve for the property"
+      }
+    ]
+  },
+  "responseFields": [
+    {
+      "name": "Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the updated owner group"
+    }
+  ],
+  "requestSample": "{\n  \"FiscalYearEnd\": 4,\n  \"ReserveFunds\": \"2000.55\",\n  \"PaymentType\": \"Flat\",\n  \"PaymentAmount\": \"1000.00\",\n  \"OwnerPacketBasis\": \"Cash\",\n  \"StartDate\": \"2021-09-01\"\n}"
+}