@nightsquawktech/appfolio-mcp-server 0.0.1

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

@@ -0,0 +1,137 @@
+{
+  "operationId": "get_journal_entries",
+  "resource": "journal_entries",
+  "name": "List All Journal Entries",
+  "method": "GET",
+  "path": "/journal_entries",
+  "description": "Returns all journal entries that meet the filter criteria",
+  "deprecated": false,
+  "writeOperation": false,
+  "pagination": true,
+  "queryFilters": [
+    {
+      "name": "filters[Id]",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Filter by journal entry unique identifier"
+    },
+    {
+      "name": "filters[PropertyId]",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Filter by unique identifier of the property or association related to the journal entry"
+    },
+    {
+      "name": "filters[LastUpdatedAtFrom]",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "Filter journal entries last updated at or after this date-time. All GET requests must include a filter for [Id] (if available), or [LastUpdatedAtFrom]."
+    },
+    {
+      "name": "page[number]",
+      "type": "integer",
+      "required": false,
+      "description": "Page number for pagination. Default is 1."
+    },
+    {
+      "name": "page[size]",
+      "type": "integer",
+      "required": false,
+      "description": "Page size for pagination. Default is 1000."
+    }
+  ],
+  "responseFields": [
+    {
+      "name": "data",
+      "type": "array",
+      "required": false,
+      "description": "Array of journal entry objects"
+    },
+    {
+      "name": "data[].Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the journal entry"
+    },
+    {
+      "name": "data[].AccountingBasis",
+      "type": "string",
+      "required": false,
+      "description": "The accounting basis for the journal entry.",
+      "enum": ["All", "CashOnly", "AccrualOnly"]
+    },
+    {
+      "name": "data[].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": "data[].LastUpdatedAt",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "The date the journal entry's details were last updated"
+    },
+    {
+      "name": "data[].LineItems",
+      "type": "array",
+      "required": false,
+      "description": "Array of line-item objects"
+    },
+    {
+      "name": "data[].LineItems[].Credit",
+      "type": "string",
+      "required": false,
+      "description": "The credit amount"
+    },
+    {
+      "name": "data[].LineItems[].Debit",
+      "type": "string",
+      "required": false,
+      "description": "The debit amount"
+    },
+    {
+      "name": "data[].LineItems[].Description",
+      "type": "string",
+      "required": false,
+      "description": "A brief, informative description of the journal entry's line item"
+    },
+    {
+      "name": "data[].LineItems[].GlAccountId",
+      "type": "string",
+      "required": false,
+      "description": "Unique identifier of the general ledger account associated with the journal entry line item"
+    },
+    {
+      "name": "data[].PropertyId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the property or association related to the journal entry"
+    },
+    {
+      "name": "data[].ReferenceNumber",
+      "type": "string",
+      "required": false,
+      "description": "The reference number representing the transaction in your ledger. This will be automatically assigned unless provided."
+    },
+    {
+      "name": "data[].Remarks",
+      "type": "string",
+      "required": false,
+      "description": "A description or summary of the journal entry"
+    },
+    {
+      "name": "data[].ScheduledReversalDate",
+      "type": "string <date>",
+      "required": false,
+      "description": "The date on which this journal entry is scheduled to be automatically reversed."
+    },
+    {
+      "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/journal_entries?page[size]=10&page[number]=2&filters[Id]=1abcde23-c543-456e-abc9-123456789cbaZ&filters[PropertyId]=1abcde23-c543-456e-abc9-123456789cbaZ&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_late_fee_policies.json

@@ -0,0 +1,148 @@
+{
+  "operationId": "get_late_fee_policies",
+  "resource": "late_fee_policies",
+  "name": "List All Late Fee Policies",
+  "method": "GET",
+  "path": "/late_fee_policies",
+  "description": "Returns all late fee policies that meet the filter criteria",
+  "deprecated": false,
+  "writeOperation": false,
+  "pagination": true,
+  "queryFilters": [
+    {
+      "name": "filters[Id]",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Filter by the unique identifier of the late fee policy. All GET requests must include a filter for [Id] or [LastUpdatedAtFrom]."
+    },
+    {
+      "name": "filters[LastUpdatedAtFrom]",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "Filter by the date the late fee policy was last updated (from). All GET requests must include a filter for [Id] or [LastUpdatedAtFrom]."
+    },
+    {
+      "name": "filters[PropertyId]",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Filter by the unique identifier of the property."
+    },
+    {
+      "name": "filters[PartyType]",
+      "type": "string",
+      "required": false,
+      "description": "Filter by party type (e.g. Property)."
+    },
+    {
+      "name": "page[number]",
+      "type": "integer",
+      "required": false,
+      "description": "Page number for pagination. Default is 1."
+    },
+    {
+      "name": "page[size]",
+      "type": "integer",
+      "required": false,
+      "description": "Page size for pagination. Default is 1000."
+    }
+  ],
+  "responseFields": [
+    {
+      "name": "data",
+      "type": "array",
+      "required": false,
+      "description": "Array of late fee policy objects"
+    },
+    {
+      "name": "data[].Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the late fee policy"
+    },
+    {
+      "name": "data[].EligibleCharges",
+      "type": "string",
+      "required": false,
+      "description": "The specific charges to which the late fee will be applied"
+    },
+    {
+      "name": "data[].FeeType",
+      "type": "string",
+      "required": false,
+      "description": "The late fee type"
+    },
+    {
+      "name": "data[].FlatAmount",
+      "type": "string <decimal>",
+      "required": false,
+      "description": "The flat fee"
+    },
+    {
+      "name": "data[].GracePeriodType",
+      "type": "string",
+      "required": false,
+      "description": "The type of Grace Period to enforce"
+    },
+    {
+      "name": "data[].GracePeriodValue",
+      "type": "integer",
+      "required": false,
+      "description": "A number of days after the charge, or a number of days into the following month."
+    },
+    {
+      "name": "data[].LateFeePerDay",
+      "type": "string <decimal>",
+      "required": false,
+      "description": "The daily late fees"
+    },
+    {
+      "name": "data[].LateFeeGraceBalance",
+      "type": "string <decimal>",
+      "required": false,
+      "description": "The late fee grace balance"
+    },
+    {
+      "name": "data[].LastUpdatedAt",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "The date the late fee policy was last updated"
+    },
+    {
+      "name": "data[].MaxDailyLateFeesAmount",
+      "type": "string <decimal>",
+      "required": false,
+      "description": "The maximum daily late fees"
+    },
+    {
+      "name": "data[].OccupancyId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "When present, the Late Fee Policy belongs to a specific occupancy within a MFR property."
+    },
+    {
+      "name": "data[].Percentage",
+      "type": "string <decimal>",
+      "required": false,
+      "description": "The percentage of late fee"
+    },
+    {
+      "name": "data[].PolicyEffectiveOn",
+      "type": "string <date>",
+      "required": false,
+      "description": "The date at which the late fee policy will start"
+    },
+    {
+      "name": "data[].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."
+    },
+    {
+      "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/late_fee_policies?filters[Id]=fabcde23-c543-456e-abc9-123456789cba&filters[PropertyId]=12bcde23-c543-456e-abc9-123456789cba&filters[PartyType]=Property&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_leads.json

@@ -0,0 +1,248 @@
+{
+  "operationId": "get_leads",
+  "resource": "leads",
+  "name": "List All Leads",
+  "method": "GET",
+  "path": "/leads",
+  "description": "Returns all leads that meet the filter criteria",
+  "deprecated": false,
+  "writeOperation": false,
+  "pagination": true,
+  "queryFilters": [
+    {
+      "name": "filters[Id]",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Filter by lead Id. All GET requests must include a filter for [Id] (if available), or [LastUpdatedAtFrom]."
+    },
+    {
+      "name": "filters[PropertyId]",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Filter by property Id associated with the lead."
+    },
+    {
+      "name": "filters[LastUpdatedAtFrom]",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "Filter leads last updated at or after this date-time. All GET requests must include a filter for [Id] (if available), or [LastUpdatedAtFrom]."
+    },
+    {
+      "name": "page[number]",
+      "type": "integer",
+      "required": false,
+      "description": "Page number for pagination. Default is 1."
+    },
+    {
+      "name": "page[size]",
+      "type": "integer",
+      "required": false,
+      "description": "Page size for pagination. Default is 100."
+    }
+  ],
+  "responseFields": [
+    {
+      "name": "data",
+      "type": "Array of objects (Lead)",
+      "required": false,
+      "description": "Array of lead objects meeting the filter criteria"
+    },
+    {
+      "name": "data[].Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the lead"
+    },
+    {
+      "name": "data[].AdditionalOccupants",
+      "type": "integer",
+      "required": false,
+      "description": "The number of other potential occupants of the residency"
+    },
+    {
+      "name": "data[].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": "data[].Bathrooms",
+      "type": "string <decimal>",
+      "required": false,
+      "description": "The number of desired bathrooms"
+    },
+    {
+      "name": "data[].Bedrooms",
+      "type": "integer",
+      "required": false,
+      "description": "The number of desired bedrooms"
+    },
+    {
+      "name": "data[].CreatedAt",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "The date the lead was created"
+    },
+    {
+      "name": "data[].CreditScore",
+      "type": "string",
+      "required": false,
+      "description": "The self-reported credit score of the interested party"
+    },
+    {
+      "name": "data[].DesiredMoveIn",
+      "type": "string <date>",
+      "required": false,
+      "description": "The date the prospective resident desires to move in"
+    },
+    {
+      "name": "data[].Duplicate",
+      "type": "boolean",
+      "required": false,
+      "deprecated": true,
+      "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."
+    },
+    {
+      "name": "data[].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."
+    },
+    {
+      "name": "data[].Email",
+      "type": "string <email>",
+      "required": false,
+      "description": "The email address of the interested person"
+    },
+    {
+      "name": "data[].FirstName",
+      "type": "string",
+      "required": false,
+      "description": "The first name of the interested person"
+    },
+    {
+      "name": "data[].GuestCardId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "The unique identifier of the Guest Card, which may include multiple leads"
+    },
+    {
+      "name": "data[].HasCats",
+      "type": "boolean",
+      "required": false,
+      "description": "Indicates whether or not the interested person has cat(s)"
+    },
+    {
+      "name": "data[].HasDogs",
+      "type": "boolean",
+      "required": false,
+      "description": "Indicates whether or not the interested person has dog(s)"
+    },
+    {
+      "name": "data[].HasOtherPet",
+      "type": "boolean",
+      "required": false,
+      "description": "Indicates whether or not the interested person has other pet(s)"
+    },
+    {
+      "name": "data[].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": "data[].LastName",
+      "type": "string",
+      "required": false,
+      "description": "The last name of the interested person"
+    },
+    {
+      "name": "data[].Link",
+      "type": "string <uri>",
+      "required": false,
+      "description": "A link to the lead page in the AppFolio Property Manager"
+    },
+    {
+      "name": "data[].MaxRent",
+      "type": "string <decimal>",
+      "required": false,
+      "description": "The max amount the interested person is willing to pay monthly for rent"
+    },
+    {
+      "name": "data[].Messages",
+      "type": "Array of objects",
+      "required": false,
+      "description": "Array of objects representing messages sent about a lead"
+    },
+    {
+      "name": "data[].MiddleInitial",
+      "type": "string",
+      "required": false,
+      "description": "The middle initial of the interested person"
+    },
+    {
+      "name": "data[].MonthlyIncome",
+      "type": "string <decimal>",
+      "required": false,
+      "description": "The self-reported monthly income of the interested person"
+    },
+    {
+      "name": "data[].PhoneNumber",
+      "type": "string",
+      "required": false,
+      "description": "The phone number of the interested person"
+    },
+    {
+      "name": "data[].PropertyId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the property associated with the lead"
+    },
+    {
+      "name": "data[].RentalApplicationId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the rental application associated with the lead"
+    },
+    {
+      "name": "data[].RentalApplicationGroupId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the rental application group id associated with the lead if they applied as a group"
+    },
+    {
+      "name": "data[].Source",
+      "type": "string",
+      "required": false,
+      "description": "The mechanism through which this lead was submitted"
+    },
+    {
+      "name": "data[].Status",
+      "type": "string",
+      "required": false,
+      "description": "Indicates the current phase of engagement with a prospective resident",
+      "enum": ["active", "inactive", "cold", "waitlisted", "applied", "applied_review", "applied_approved", "applied_denied", "applied_canceled", "converting", "converted"]
+    },
+    {
+      "name": "data[].UnitIds",
+      "type": "Array of strings",
+      "required": false,
+      "description": "Unique identifier of the unit(s) that the interested party is interested in"
+    },
+    {
+      "name": "data[].LastUpdatedAt",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "The date the lead 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/leads?filters[Id]=fabcde23-c543-456e-abc9-123456789cba&filters[PropertyId]=12bcde23-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_leads_notes.json

@@ -0,0 +1,83 @@
+{
+  "operationId": "get_leads_notes",
+  "resource": "leads",
+  "name": "List All Leads Notes",
+  "method": "GET",
+  "path": "/leads/notes",
+  "description": "Returns all notes for a lead that meet the filter criteria",
+  "deprecated": false,
+  "writeOperation": false,
+  "pagination": true,
+  "queryFilters": [
+    {
+      "name": "filters[GuestCardId]",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Filter by GuestCardId. All GET requests must include a filter for [GuestCardId] or [LastUpdatedAtFrom]."
+    },
+    {
+      "name": "filters[LastUpdatedAtFrom]",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "Filter lead notes last updated at or after this date-time. All GET requests must include a filter for [GuestCardId] or [LastUpdatedAtFrom]."
+    },
+    {
+      "name": "page[number]",
+      "type": "integer",
+      "required": false,
+      "description": "Page number for pagination. Default is 1."
+    },
+    {
+      "name": "page[size]",
+      "type": "integer",
+      "required": false,
+      "description": "Page size for pagination. Default is 1000."
+    }
+  ],
+  "responseFields": [
+    {
+      "name": "data",
+      "type": "Array of objects (Lead.Note)",
+      "required": false,
+      "description": "Array of lead note objects meeting the filter criteria"
+    },
+    {
+      "name": "data[].Body",
+      "type": "string",
+      "required": false,
+      "description": "A brief informative message about the lead note. A lead note cannot exceed 63,535 characters."
+    },
+    {
+      "name": "data[].EntityId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "The unique identifier of the Guest Card to which the note will be attached"
+    },
+    {
+      "name": "data[].LastUpdatedAt",
+      "type": "string",
+      "required": false,
+      "description": "The date the lead note's details were last updated"
+    },
+    {
+      "name": "data[].Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the note associated with the guest card"
+    },
+    {
+      "name": "data[].NoteId",
+      "type": "string <uuid>",
+      "required": false,
+      "deprecated": true,
+      "description": "Unique identifier of the note associated with the guest card. Deprecated in favor of Id."
+    },
+    {
+      "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/leads/notes?filters[GuestCardId]=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_leases.json

@@ -0,0 +1,70 @@
+{
+  "operationId": "get_leases",
+  "resource": "leases",
+  "name": "List All Leases",
+  "method": "GET",
+  "path": "/leases",
+  "description": "Returns all leases that meet the filter criteria",
+  "deprecated": false,
+  "writeOperation": false,
+  "pagination": true,
+  "queryFilters": [
+    {
+      "name": "filters[LeaseId]",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Filter leases by lease identifier"
+    }
+  ],
+  "responseFields": [
+    {
+      "name": "Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Id of lease"
+    },
+    {
+      "name": "IsMtm",
+      "type": "boolean",
+      "required": false,
+      "description": "Indicates if the lease is month-to-month"
+    },
+    {
+      "name": "StartOn",
+      "type": "string",
+      "required": false,
+      "description": "Indicates the start date of the lease"
+    },
+    {
+      "name": "EndOn",
+      "type": "string",
+      "required": false,
+      "description": "Indicates the end date of the lease"
+    },
+    {
+      "name": "RenewedOn",
+      "type": "string",
+      "required": false,
+      "description": "Indicates the date the lease was renewed"
+    },
+    {
+      "name": "LastUpdatedAt",
+      "type": "string <date-time>",
+      "required": false,
+      "description": "Indicates the date the lease was last updated"
+    },
+    {
+      "name": "Status",
+      "type": "string",
+      "required": false,
+      "description": "Indicates the status of the lease"
+    },
+    {
+      "name": "OccupancyId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Id of associated occupancy"
+    }
+  ],
+  "requestSample": "curl --location -g \\\n     --request GET 'https://api.appfolio.com/api/v0/leases?filters[LeaseId]=1abcde23-c543-456e-abc9-123456789cba' \\\n     --header 'X-AppFolio-Developer-ID: a965e7d8-a17d-11ec-b909-0242ac120002' \\\n     --header 'Authorization: Basic {Auth}'"
+}