@nightsquawktech/appfolio-mcp-server 0.0.1

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

@@ -0,0 +1,115 @@
+{
+  "operationId": "post_late_fee_policies_bulk",
+  "resource": "late_fee_policies",
+  "name": "Bulk Create Late Fee Policies",
+  "method": "POST",
+  "path": "/late_fee_policies/bulk",
+  "description": "Create late fee policies in bulk",
+  "deprecated": false,
+  "writeOperation": true,
+  "pagination": false,
+  "requestBody": {
+    "required": true,
+    "description": "Late Fee Policy objects",
+    "attributes": [
+      {
+        "name": "data",
+        "type": "array",
+        "required": false,
+        "description": "Array of late fee policy objects to create in bulk",
+        "attributes": [
+          {
+            "name": "ReferenceId",
+            "type": "string",
+            "required": true,
+            "description": "Transient unique ID assigned by the developer. Used to reference individual late fee policy in the bulk-creation of late fee policies."
+          },
+          {
+            "name": "EligibleCharges",
+            "type": "string",
+            "required": true,
+            "description": "The specific charges to which the late fee will be applied",
+            "enum": ["Every Charge", "All Recurring Charges", "Only Recurring Rent"]
+          },
+          {
+            "name": "FeeType",
+            "type": "string",
+            "required": true,
+            "description": "The late fee type",
+            "enum": ["Flat", "Percentage"]
+          },
+          {
+            "name": "GracePeriodType",
+            "type": "string",
+            "required": true,
+            "description": "The type of Grace Period to enforce",
+            "enum": ["Fixed Period", "Fixed Day of Month"]
+          },
+          {
+            "name": "GracePeriodValue",
+            "type": "integer",
+            "required": true,
+            "description": "A number of days after the charge, or a number of days into the following month. Must be between 0 and 365 when GracePeriodType is Fixed Period. Must be between 1 and 28 when GracePeriodType is Fixed Day of Month."
+          },
+          {
+            "name": "LateFeeGraceBalance",
+            "type": "string <decimal>",
+            "required": true,
+            "description": "The late fee grace balance"
+          },
+          {
+            "name": "PolicyEffectiveOn",
+            "type": "string <date>",
+            "required": true,
+            "description": "The date at which the late fee policy will start. It must be in the future. There can only be one current and future late fee policy per property. If you try to create a late fee policy for a property that already has a future late fee policy, it should replace the existing future late fee policy."
+          },
+          {
+            "name": "FlatAmount",
+            "type": "string <decimal>",
+            "required": false,
+            "description": "The flat fee. Must be provided when FeeType is Flat. Must be greater than 0 when LateFeePerDay is not 0 and FeeType is Flat."
+          },
+          {
+            "name": "LateFeePerDay",
+            "type": "string <decimal>",
+            "required": false,
+            "description": "The daily late fees"
+          },
+          {
+            "name": "MaxDailyLateFeesAmount",
+            "type": "string <decimal>",
+            "required": false,
+            "description": "The maximum daily late fees"
+          },
+          {
+            "name": "OccupancyId",
+            "type": "string <uuid>",
+            "required": false,
+            "description": "When present, the Late Fee Policy belongs to a specific occupancy within a MFR property."
+          },
+          {
+            "name": "Percentage",
+            "type": "string <decimal>",
+            "required": false,
+            "description": "The percentage of late fee. Must be a number 0 or greater. Must be provided when FeeType is Percentage. Must be greater than 0 when LateFeePerDay is not 0 and FeeType is Percentage."
+          },
+          {
+            "name": "PropertyId",
+            "type": "string <uuid>",
+            "required": false,
+            "description": "It is filled for both property-based and occupancy-based policies. PropertyId can be used to tie an occupancy-based policy to its MFR building."
+          }
+        ]
+      }
+    ]
+  },
+  "responseFields": [
+    {
+      "name": "JobId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the bulk job accepted for processing"
+    }
+  ],
+  "requestSample": "{\n  \"data\": [\n    {},\n    {}\n  ]\n}"
+}

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

@@ -0,0 +1,204 @@
+{
+  "operationId": "post_leads",
+  "resource": "leads",
+  "name": "Create Leads",
+  "method": "POST",
+  "path": "/leads",
+  "description": "Create a lead",
+  "deprecated": false,
+  "writeOperation": true,
+  "pagination": false,
+  "requestBody": {
+    "required": true,
+    "description": "Lead object to create",
+    "attributes": [
+      {
+        "name": "FirstName",
+        "type": "string",
+        "required": true,
+        "description": "The first name of the interested person"
+      },
+      {
+        "name": "LastName",
+        "type": "string",
+        "required": true,
+        "description": "The last name of the interested person"
+      },
+      {
+        "name": "PropertyId",
+        "type": "string <uuid>",
+        "required": true,
+        "description": "Unique identifier of the property associated with the lead"
+      },
+      {
+        "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 responsible for the lead. 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": "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": "MaxRent",
+        "type": "string <decimal>",
+        "required": false,
+        "description": "The max amount the interested person is willing to pay monthly for rent"
+      },
+      {
+        "name": "Messages",
+        "type": "array",
+        "required": false,
+        "description": "Array of objects representing messages sent about a lead",
+        "attributes": [
+          {
+            "name": "PropertyId",
+            "type": "string <uuid>",
+            "required": false,
+            "description": "Unique identifier of the property associated with the message"
+          },
+          {
+            "name": "UnitId",
+            "type": "string <uuid>",
+            "required": false,
+            "description": "Unique identifier of the unit associated with the message"
+          },
+          {
+            "name": "Message",
+            "type": "string",
+            "required": false,
+            "description": "The content of the message sent by the lead"
+          },
+          {
+            "name": "Source",
+            "type": "string",
+            "required": false,
+            "description": "The source of the message"
+          },
+          {
+            "name": "Timestamp",
+            "type": "string <date-time>",
+            "required": false,
+            "description": "The date and time the message was sent, in Coordinated Universal Time (UTC)"
+          }
+        ]
+      },
+      {
+        "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",
+        "enum": ["active", "cold", "inactive", "waitlisted"]
+      },
+      {
+        "name": "UnitIds",
+        "type": "Array of strings",
+        "required": false,
+        "description": "Unique identifier of the unit(s) that the interested party is interested in"
+      }
+    ]
+  },
+  "responseFields": [
+    {
+      "name": "Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the created lead. If Duplicate is true, it is the unique identifier of the original lead that was updated."
+    },
+    {
+      "name": "Duplicate",
+      "type": "boolean",
+      "required": false,
+      "description": "Indicates whether or not the lead is a duplicate of an existing lead. Leads are marked as duplicates if a lead was submitted from a party with the same contact information (phone number or email) that is already associated with a lead with the same PropertyId. If Duplicate is true, the original lead will be updated rather than a new lead being created."
+    },
+    {
+      "name": "OriginalLeadId",
+      "type": "string <uuid>",
+      "required": false,
+      "deprecated": true,
+      "description": "ID of the existing lead this lead duplicates. The ID attribute of the newly created lead will be distinct from its duplicate."
+    }
+  ],
+  "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\": \"720 to 850\",\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  \"Messages\": [{}, {}],\n  \"PropertyId\": \"233cde23-c543-456e-abc9-123456789cba\",\n  \"Source\": \"Website\",\n  \"Status\": \"active\",\n  \"UnitIds\": [\"1abcde23-c543-456e-abc9-123456789cba\", \"234abcde-c543-456e-abc9-123456789abc\"]\n}"
+}

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

@@ -0,0 +1,40 @@
+{
+  "operationId": "post_leads_guestcardid_notes",
+  "resource": "leads",
+  "name": "Create Lead Note",
+  "method": "POST",
+  "path": "/leads/{GuestCardId}/notes",
+  "description": "Add 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."
+    }
+  ],
+  "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 lead note"
+    }
+  ],
+  "requestSample": "{\n  \"Body\": \"This rental application has been submitted on 11/11/2023\"\n}"
+}

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

@@ -0,0 +1,41 @@
+{
+  "operationId": "post_occupancies_occupancyid_attachments",
+  "resource": "occupancies",
+  "name": "Create Occupancy Attachment",
+  "method": "POST",
+  "path": "/occupancies/{OccupancyId}/attachments",
+  "description": "Add an attachment to an occupancy",
+  "deprecated": false,
+  "writeOperation": true,
+  "pagination": false,
+  "pathParams": [
+    {
+      "name": "OccupancyId",
+      "type": "string <uuid>",
+      "required": true,
+      "description": "The occupancy 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 occupancy attachment"
+    }
+  ],
+  "requestSample": "{\n  \"File\": \"/path/to/file.pdf\"\n}"
+}

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

@@ -0,0 +1,96 @@
+{
+  "operationId": "post_owner_groups",
+  "resource": "owner_groups",
+  "name": "Create Owner Group",
+  "method": "POST",
+  "path": "/owner_groups",
+  "description": "Create a Owner Group",
+  "deprecated": false,
+  "writeOperation": true,
+  "pagination": false,
+  "requestBody": {
+    "required": true,
+    "description": "Owner Group object",
+    "attributes": [
+      {
+        "name": "OwnerPacketBasis",
+        "type": "string",
+        "required": true,
+        "description": "The accounting method used for owner packet calculations. Valid values are \"Cash\" or \"Accrual\".",
+        "enum": ["Cash", "Accrual"]
+      },
+      {
+        "name": "PaymentType",
+        "type": "string",
+        "required": true,
+        "description": "The type of payment distribution for the owners. Valid values are \"Net Income\" or \"Flat\".",
+        "enum": ["Net Income", "Flat"]
+      },
+      {
+        "name": "ReserveFunds",
+        "type": "string <decimal>",
+        "required": true,
+        "description": "The amount of funds to maintain in reserve for the property"
+      },
+      {
+        "name": "FiscalYearEnd",
+        "type": "integer",
+        "required": true,
+        "description": "The month number representing the end of the fiscal year"
+      },
+      {
+        "name": "StartDate",
+        "type": "string <date>",
+        "required": true,
+        "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": "PropertyId",
+        "type": "string <uuid>",
+        "required": true,
+        "description": "Unique identifier of the property associated with all owners within the owner group"
+      },
+      {
+        "name": "Owners",
+        "type": "array",
+        "required": true,
+        "description": "Array of owners and their associated ownership details for the property",
+        "attributes": [
+          {
+            "name": "OwnerId",
+            "type": "string <uuid>",
+            "required": true,
+            "description": "Unique identifier of the owner"
+          },
+          {
+            "name": "PercentOwned",
+            "type": "string <decimal>",
+            "required": true,
+            "description": "The percentage of ownership assigned to this owner. The sum of PercentOwned across all owners must equal 100%."
+          },
+          {
+            "name": "ContractExpiration",
+            "type": "string <date>",
+            "required": false,
+            "description": "The date when the owner's contract expires. The date must be in YYYY-MM-DD format."
+          },
+          {
+            "name": "PaymentAmount",
+            "type": "string <decimal>",
+            "required": false,
+            "description": "The fixed payment amount to distribute to owners. This value is required when PaymentType is \"Flat\"."
+          }
+        ]
+      }
+    ]
+  },
+  "responseFields": [
+    {
+      "name": "Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the created owner group"
+    }
+  ],
+  "requestSample": "{\n  \"StartDate\": \"2022-02-01\",\n  \"FiscalYearEnd\": 2,\n  \"ReserveFunds\": 5000,\n  \"PropertyId\": \"71c5cb28-547f-11ec-bfa5-02975b268737\",\n  \"PaymentType\": \"Flat\",\n  \"PaymentAmount\": 2300,\n  \"OwnerPacketBasis\": \"Cash\",\n  \"Owners\": [\n    {},\n    {}\n  ]\n}"
+}