@nightsquawktech/appfolio-mcp-server 0.0.1

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

@@ -0,0 +1,245 @@
+{
+  "operationId": "post_properties_bulk",
+  "resource": "properties",
+  "name": "Bulk Create Properties",
+  "method": "POST",
+  "path": "/properties/bulk",
+  "description": "Create properties in bulk",
+  "deprecated": false,
+  "writeOperation": true,
+  "pagination": false,
+  "requestBody": {
+    "required": true,
+    "description": "Property objects",
+    "attributes": [
+      {
+        "name": "data",
+        "type": "array",
+        "required": false,
+        "description": "Array of property objects to create in bulk",
+        "attributes": [
+          {
+            "name": "Name",
+            "type": "string",
+            "required": true,
+            "description": "The name of the property"
+          },
+          {
+            "name": "ReferenceId",
+            "type": "string",
+            "required": true,
+            "description": "Transient unique ID assigned by the developer. Used to reference individual properties in the bulk-creation of properties."
+          },
+          {
+            "name": "PropertyType",
+            "type": "string",
+            "required": true,
+            "description": "The type of property",
+            "enum": ["Commercial", "Multi-Family", "Self-Storage", "Single-Family", "Student-Housing"]
+          },
+          {
+            "name": "Address1",
+            "type": "string",
+            "required": true,
+            "description": "The primary street address of the property"
+          },
+          {
+            "name": "City",
+            "type": "string",
+            "required": true,
+            "description": "The city where the property is located"
+          },
+          {
+            "name": "State",
+            "type": "string",
+            "required": true,
+            "description": "The state where the property is located"
+          },
+          {
+            "name": "Zip",
+            "type": "string",
+            "required": true,
+            "description": "The zip code where the property is located"
+          },
+          {
+            "name": "OperatingCashBankAccountId",
+            "type": "string <uuid>",
+            "required": true,
+            "description": "Unique identifier of the operating cash bank account associated with the property"
+          },
+          {
+            "name": "EscrowCashBankAccountId",
+            "type": "string <uuid>",
+            "required": true,
+            "description": "Unique identifier of the escrow cash bank account associated with the property"
+          },
+          {
+            "name": "ExpensesCashBankAccountId",
+            "type": "string <uuid>",
+            "required": false,
+            "description": "Unique identifier of the expenses cash bank account associated with the property. Used for Dual-Operating Bank Accounts."
+          },
+          {
+            "name": "AdditionalCashAccounts",
+            "type": "array",
+            "required": false,
+            "description": "Array of additional cash GL & bank account combinations associated with the property. Cash accounts can only be assigned once per property.",
+            "attributes": [
+              {
+                "name": "BankAccountId",
+                "type": "string <uuid>",
+                "required": false,
+                "description": "Unique identifier of the additional cash bank account associated with the property"
+              },
+              {
+                "name": "GlAccountId",
+                "type": "string <uuid>",
+                "required": false,
+                "description": "Unique identifier of the additional cash GL account associated with the property"
+              }
+            ]
+          },
+          {
+            "name": "CurrentManagementFeePolicy",
+            "type": "object",
+            "required": false,
+            "description": "Contains details about the property's management fee policy"
+          },
+          {
+            "name": "LeaseFeePolicy",
+            "type": "object",
+            "required": false,
+            "description": "Contains details about the property's lease fee policy"
+          },
+          {
+            "name": "HomeWarrantyInfo",
+            "type": "object",
+            "required": false,
+            "description": "Object containing information about the property's home warranty policy"
+          },
+          {
+            "name": "AdminFee",
+            "type": "number",
+            "required": false,
+            "description": "The admin fee associated with the property"
+          },
+          {
+            "name": "Amenities",
+            "type": "Array of strings",
+            "required": false,
+            "description": "The amenities associated with the property"
+          },
+          {
+            "name": "CatsAllowed",
+            "type": "string",
+            "required": false,
+            "description": "The property's cat policy. Valid values include \"Yes\", \"No\" or null.",
+            "enum": ["Yes", "No"]
+          },
+          {
+            "name": "Class",
+            "type": "string",
+            "required": false,
+            "description": "Indicates the type and quality of the property based on factors such as age, location, amenities, and overall condition.",
+            "enum": ["A+", "A", "A-", "B+", "B", "B-", "C+", "C", "C-"]
+          },
+          {
+            "name": "DogsAllowed",
+            "type": "string",
+            "required": false,
+            "description": "The property's dog policy.",
+            "enum": ["Large & Small", "Small Only", "No"]
+          },
+          {
+            "name": "InsuranceExpiration",
+            "type": "string <date>",
+            "required": false,
+            "description": "The date the property's insurance expires"
+          },
+          {
+            "name": "MaintenanceLimit",
+            "type": "string <decimal>",
+            "required": false,
+            "description": "The dollar amount limit to not exceed for maintenance"
+          },
+          {
+            "name": "MaintenanceNotes",
+            "type": "string",
+            "required": false,
+            "description": "A brief informative message about the property's maintenance"
+          },
+          {
+            "name": "ManagementEndDate",
+            "type": "string <date-time>",
+            "required": false,
+            "description": "The date when the current management of the property ended"
+          },
+          {
+            "name": "ManagementEndReason",
+            "type": "string",
+            "required": false,
+            "description": "The reason for the end of the current management of the property",
+            "enum": ["Foreclosure", "Maintenance", "Management Company Concerns", "Management Company Terminated", "Owner Moved In", "Owner Self-Managing", "Owner Sold", "Owner Terminated Management", "Property Uninhabitable/Demolition", "Tenant Placement", "Other"]
+          },
+          {
+            "name": "ManagementStartDate",
+            "type": "string <date-time>",
+            "required": false,
+            "description": "The date when the current management of the property began"
+          },
+          {
+            "name": "NsfFee",
+            "type": "number",
+            "required": false,
+            "description": "The non-sufficient funds (NSF) fee associated with the property"
+          },
+          {
+            "name": "SiteManager",
+            "type": "object",
+            "required": false,
+            "description": "Contains the property site manager's contact information and details"
+          },
+          {
+            "name": "UnitEntryPreAuthorized",
+            "type": "boolean",
+            "required": false,
+            "description": "Indicates whether or not entry to the unit was pre-authorized"
+          },
+          {
+            "name": "YearBuilt",
+            "type": "integer",
+            "required": false,
+            "description": "The year in which the property was constructed"
+          },
+          {
+            "name": "Address2",
+            "type": "string",
+            "required": false,
+            "description": "Additional street address information pertaining to the property"
+          }
+        ]
+      }
+    ]
+  },
+  "responseFields": [
+    {
+      "name": "data",
+      "type": "array",
+      "required": false,
+      "description": "Array of created property status objects"
+    },
+    {
+      "name": "data[].PropertyId",
+      "type": "string",
+      "required": false,
+      "description": "Unique identifier of the created property"
+    },
+    {
+      "name": "data[].ReferenceId",
+      "type": "string",
+      "required": false,
+      "description": "Transient unique ID assigned by the developer. Used to reference individual properties in the bulk-creation of properties."
+    }
+  ],
+  "requestSample": "{\n  \"data\": [\n    {}\n  ]\n}"
+}

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

@@ -0,0 +1,40 @@
+{
+  "operationId": "post_properties_propertyid_attachments",
+  "resource": "properties",
+  "name": "Create Property Attachment",
+  "method": "POST",
+  "path": "/properties/{PropertyId}/attachments",
+  "description": "Upload an attachment to a property",
+  "deprecated": false,
+  "writeOperation": true,
+  "pagination": false,
+  "pathParams": [
+    {
+      "name": "PropertyId",
+      "type": "string <uuid>",
+      "required": true,
+      "description": "The property to which the file will be attached"
+    }
+  ],
+  "requestBody": {
+    "required": true,
+    "description": "Attachment object (multipart/form-data)",
+    "attributes": [
+      {
+        "name": "File",
+        "type": "string",
+        "required": false,
+        "description": "The file to upload, specified as Filename.file-extension"
+      }
+    ]
+  },
+  "responseFields": [
+    {
+      "name": "Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the property attachment"
+    }
+  ],
+  "requestSample": "{\n  \"File\": \"/path/to/file.pdf\"\n}"
+}

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

@@ -0,0 +1,52 @@
+{
+  "operationId": "post_properties_propertyid_marketing_photos",
+  "resource": "properties",
+  "name": "Create Property Marketing Photo",
+  "method": "POST",
+  "path": "/properties/{PropertyId}/marketing_photos",
+  "description": "Upload a marketing photo to a multi-family residential property. Marketing photos are not available for single-family residential properties.",
+  "deprecated": false,
+  "writeOperation": true,
+  "pagination": false,
+  "pathParams": [
+    {
+      "name": "PropertyId",
+      "type": "string <uuid>",
+      "required": true,
+      "description": "The property to which the marketing photo will be attached"
+    }
+  ],
+  "requestBody": {
+    "required": true,
+    "description": "Marketing photo object",
+    "attributes": [
+      {
+        "name": "File",
+        "type": "string",
+        "required": false,
+        "description": "Filename.file-extension"
+      },
+      {
+        "name": "Position",
+        "type": "integer",
+        "required": false,
+        "description": "The position of the photo in the property marketing photo gallery. The position must be a non-negative integer. If multiple photos are associated with a property, the order of the remaining photos (positions 1 and above) will not change automatically if some photos are deleted."
+      },
+      {
+        "name": "MarketingCategory",
+        "type": "string",
+        "required": false,
+        "description": "The type of marketing photo"
+      }
+    ]
+  },
+  "responseFields": [
+    {
+      "name": "Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the property marketing photo"
+    }
+  ],
+  "requestSample": "{\n  \"File\": \"/path/to/file.pdf\",\n  \"Position\": 1\n}"
+}

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

@@ -0,0 +1,40 @@
+{
+  "operationId": "post_properties_propertyid_notes",
+  "resource": "properties",
+  "name": "Create Property Note",
+  "method": "POST",
+  "path": "/properties/{PropertyId}/notes",
+  "description": "Add a note to a property",
+  "deprecated": false,
+  "writeOperation": true,
+  "pagination": false,
+  "pathParams": [
+    {
+      "name": "PropertyId",
+      "type": "string <uuid>",
+      "required": true,
+      "description": "The property to which the note will be attached"
+    }
+  ],
+  "requestBody": {
+    "required": true,
+    "description": "Note object",
+    "attributes": [
+      {
+        "name": "Body",
+        "type": "string",
+        "required": false,
+        "description": "A brief informative message about the property note. A property note cannot exceed 65,535 characters."
+      }
+    ]
+  },
+  "responseFields": [
+    {
+      "name": "Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the property note"
+    }
+  ],
+  "requestSample": "{\n  \"Body\": \"This property has a scheduled cleaning service on 11/11/2023\"\n}"
+}

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

@@ -0,0 +1,40 @@
+{
+  "operationId": "post_properties_propertyid_photos",
+  "resource": "properties",
+  "name": "Create Property Photo",
+  "method": "POST",
+  "path": "/properties/{PropertyId}/photos",
+  "description": "Upload a photo to a property",
+  "deprecated": false,
+  "writeOperation": true,
+  "pagination": false,
+  "pathParams": [
+    {
+      "name": "PropertyId",
+      "type": "string <uuid>",
+      "required": true,
+      "description": "The property to which the photo will be attached"
+    }
+  ],
+  "requestBody": {
+    "required": true,
+    "description": "Photo object",
+    "attributes": [
+      {
+        "name": "File",
+        "type": "string",
+        "required": false,
+        "description": "Filename.file-extension"
+      }
+    ]
+  },
+  "responseFields": [
+    {
+      "name": "Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the property photo"
+    }
+  ],
+  "requestSample": "{\n  \"File\": \"/path/to/file.pdf\"\n}"
+}

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

@@ -0,0 +1,81 @@
+{
+  "operationId": "post_recurring_charges",
+  "resource": "recurring_charges",
+  "name": "Create Recurring Charges",
+  "method": "POST",
+  "path": "/recurring_charges",
+  "description": "Create a recurring charge",
+  "deprecated": false,
+  "writeOperation": true,
+  "pagination": false,
+  "requestBody": {
+    "required": true,
+    "description": "Recurring Charge object",
+    "attributes": [
+      {
+        "name": "Amount",
+        "type": "number <float>",
+        "required": true,
+        "description": "The amount of the recurring charge"
+      },
+      {
+        "name": "Frequency",
+        "type": "string",
+        "required": true,
+        "description": "The frequency that the recurring charge occurs",
+        "enum": ["Monthly", "Every 3 Months", "Every 6 Months", "Once a Year"]
+      },
+      {
+        "name": "StartDate",
+        "type": "string <date>",
+        "required": true,
+        "description": "The start date of the recurring charge"
+      },
+      {
+        "name": "OccupancyId",
+        "type": "string <uuid>",
+        "required": true,
+        "description": "Unique identifier of the occupancy associated with the recurring charge"
+      },
+      {
+        "name": "GlAccountId",
+        "type": "string <uuid>",
+        "required": true,
+        "description": "Unique identifier of the general ledger account associated with the recurring charge"
+      },
+      {
+        "name": "Description",
+        "type": "string",
+        "required": false,
+        "description": "A brief summary or description of the recurring charge"
+      },
+      {
+        "name": "EndDate",
+        "type": "string <date>",
+        "required": false,
+        "description": "The end date of the recurring charge"
+      },
+      {
+        "name": "ProrateFirstMonth",
+        "type": "boolean",
+        "required": false,
+        "description": "Determines if the first month's recurring charge should be prorated. When true, the charge amount will be adjusted based on the start date within the month. Proration requires all of the following conditions: The start date cannot be the first day of a month, must be after the first day of the current month, the charge frequency must be Monthly, the charge cannot be an insurance charge, the charge cannot start and end in the same month, and the first charge has not posted."
+      },
+      {
+        "name": "ProrateLastMonth",
+        "type": "boolean",
+        "required": false,
+        "description": "Determines if the final month's recurring charge should be prorated. When true, the charge amount will be adjusted based on the end date within the month. Proration requires all of the following conditions: The end date must exist and not fall on the last day of a month, must be a future date, the charge frequency must be Monthly, the charge cannot be an insurance charge, the charge cannot start and end in the same month, and final charge has not posted."
+      }
+    ]
+  },
+  "responseFields": [
+    {
+      "name": "Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the created recurring charge"
+    }
+  ],
+  "requestSample": "{\n  \"Amount\": \"235.79\",\n  \"Description\": \"Sample description of the recurring charge\",\n  \"Frequency\": \"Monthly\",\n  \"StartDate\": \"2022-12-25\",\n  \"EndDate\": \"2023-12-25\",\n  \"ProrateFirstMonth\": false,\n  \"ProrateLastMonth\": false,\n  \"OccupancyId\": \"71c5cb28-547f-11ec-bfa5-02975b268737\",\n  \"GlAccountId\": \"d9009724-9f32-11ec-bc31-d46a96ab9b08\"\n}"
+}

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

@@ -0,0 +1,95 @@
+{
+  "operationId": "post_recurring_charges_bulk",
+  "resource": "recurring_charges",
+  "name": "Bulk Create Recurring Charges",
+  "method": "POST",
+  "path": "/recurring_charges/bulk",
+  "description": "Create multiple recurring charges in bulk",
+  "deprecated": false,
+  "writeOperation": true,
+  "pagination": false,
+  "requestBody": {
+    "required": true,
+    "description": "Recurring Charge objects",
+    "attributes": [
+      {
+        "name": "data",
+        "type": "array",
+        "required": false,
+        "description": "Array of recurring charge objects to create in bulk",
+        "attributes": [
+          {
+            "name": "Amount",
+            "type": "number <float>",
+            "required": true,
+            "description": "The amount of the recurring charge"
+          },
+          {
+            "name": "Frequency",
+            "type": "string",
+            "required": true,
+            "description": "The frequency that the recurring charge occurs",
+            "enum": ["Monthly", "Every 3 Months", "Every 6 Months", "Once a Year"]
+          },
+          {
+            "name": "StartDate",
+            "type": "string <date>",
+            "required": true,
+            "description": "The start date of the recurring charge"
+          },
+          {
+            "name": "OccupancyId",
+            "type": "string <uuid>",
+            "required": true,
+            "description": "Unique identifier of the occupancy associated with the recurring charge"
+          },
+          {
+            "name": "GlAccountId",
+            "type": "string <uuid>",
+            "required": true,
+            "description": "Unique identifier of the general ledger account associated with the recurring charge"
+          },
+          {
+            "name": "ReferenceId",
+            "type": "string",
+            "required": true,
+            "description": "Transient unique ID assigned by the developer. Used to reference individual recurring charges in the bulk-creation of recurring charges."
+          },
+          {
+            "name": "Description",
+            "type": "string",
+            "required": false,
+            "description": "A brief summary or description of the recurring charge"
+          },
+          {
+            "name": "EndDate",
+            "type": "string <date>",
+            "required": false,
+            "description": "The end date of the recurring charge"
+          },
+          {
+            "name": "ProrateFirstMonth",
+            "type": "boolean",
+            "required": false,
+            "description": "Determines if the first month's recurring charge should be prorated. When true, the charge amount will be adjusted based on the start date within the month. Proration requires all of the following conditions: The start date cannot be the first day of a month, must be after the first day of the current month, the charge frequency must be Monthly, the charge cannot be an insurance charge, the charge cannot start and end in the same month, and the first charge has not posted."
+          },
+          {
+            "name": "ProrateLastMonth",
+            "type": "boolean",
+            "required": false,
+            "description": "Determines if the final month's recurring charge should be prorated. When true, the charge amount will be adjusted based on the end date within the month. Proration requires all of the following conditions: The end date must exist and not fall on the last day of a month, must be a future date, the charge frequency must be Monthly, the charge cannot be an insurance charge, the charge cannot start and end in the same month, and final charge has not posted."
+          }
+        ]
+      }
+    ]
+  },
+  "responseFields": [
+    {
+      "name": "JobId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the bulk creation job"
+    }
+  ],
+  "requestSample": "{\n  \"data\": [\n    {},\n    {}\n  ]\n}"
+}

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

@@ -0,0 +1,41 @@
+{
+  "operationId": "post_rental_applications_rentalapplicationid_attachments",
+  "resource": "rental_applications",
+  "name": "Create Rental Application Attachment",
+  "method": "POST",
+  "path": "/rental_applications/{RentalApplicationId}/attachments",
+  "description": "Add an attachment to a rental application",
+  "deprecated": false,
+  "writeOperation": true,
+  "pagination": false,
+  "pathParams": [
+    {
+      "name": "RentalApplicationId",
+      "type": "string <uuid>",
+      "required": true,
+      "description": "The rental application to which the file will be attached"
+    }
+  ],
+  "requestBody": {
+    "required": true,
+    "description": "Attachment object",
+    "attributes": [
+      {
+        "name": "File",
+        "type": "string",
+        "required": false,
+        "description": "Filename.file-extension",
+        "format": "multipart/form-data"
+      }
+    ]
+  },
+  "responseFields": [
+    {
+      "name": "Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the rental application attachment"
+    }
+  ],
+  "requestSample": "{\n  \"File\": \"/path/to/file.pdf\"\n}"
+}