@nightsquawktech/appfolio-mcp-server 0.0.1

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

@@ -0,0 +1,279 @@
+{
+  "operationId": "post_vendors_bulk",
+  "resource": "vendors",
+  "name": "Bulk Create Vendors",
+  "method": "POST",
+  "path": "/vendors/bulk",
+  "description": "Create vendors in bulk",
+  "deprecated": false,
+  "writeOperation": true,
+  "pagination": false,
+  "requestBody": {
+    "required": true,
+    "description": "Vendor objects",
+    "attributes": [
+      {
+        "name": "data",
+        "type": "array",
+        "required": false,
+        "description": "Array of Vendor objects to create in bulk",
+        "attributes": [
+          {
+            "name": "ReferenceId",
+            "type": "string",
+            "required": true,
+            "description": "Transient unique ID assigned by the developer. Used to reference individual vendors in the bulk-creation of vendors."
+          },
+          {
+            "name": "IsCompany",
+            "type": "boolean",
+            "required": true,
+            "description": "Indicates whether or not the vendor identifies as a company"
+          },
+          {
+            "name": "UseCompanyNameAsTaxpayerName",
+            "type": "boolean",
+            "required": true,
+            "description": "Indicates whether or not to use the company name for tax paying purposes"
+          },
+          {
+            "name": "TaxpayerName",
+            "type": "string",
+            "required": false,
+            "description": "The taxpayer name of the vendor. If UseCompanyNameAsTaxpayerName is true, then TaxpayerName will be CompanyName. If IsCompany is true, and TaxpayerName is not provided, then TaxpayerName will be set to CompanyName. If IsCompany is false, and TaxpayerName is not provided, then TaxpayerName will be set to the concatenation of FirstName and LastName. If TaxpayerName is provided, and UseCompanyNameAsTaxpayerName is false, then TaxpayerName will be set as provided value."
+          },
+          {
+            "name": "TaxpayerId",
+            "type": "string",
+            "required": false,
+            "description": "The tax identification number of the vendor. This field accepts either a Employer Identification Number (EIN), a Social Security Number (SSN), or an Individual Taxpayer Identification Number (ITIN)."
+          },
+          {
+            "name": "CompanyName",
+            "type": "string",
+            "required": false,
+            "description": "The display name of a vendor's company. If IsCompany is true, this field is required."
+          },
+          {
+            "name": "Send1099",
+            "type": "boolean",
+            "required": false,
+            "description": "Indicates whether or not the vendor needs a 1099 tax form from the management company"
+          },
+          {
+            "name": "FirstName",
+            "type": "string",
+            "required": false,
+            "description": "The vendor's first name. If IsCompany is false, this field is required."
+          },
+          {
+            "name": "LastName",
+            "type": "string",
+            "required": false,
+            "description": "The vendor's last name. If IsCompany is false, this field is required."
+          },
+          {
+            "name": "Address1",
+            "type": "string",
+            "required": false,
+            "description": "The primary street address of the vendor. If provided, City and CountryCode must also be provided. A primary address is required when UseOnlinePayables is true."
+          },
+          {
+            "name": "Address2",
+            "type": "string",
+            "required": false,
+            "description": "Additional street information pertaining to the vendor. If provided, Address1, City and CountryCode must also be provided."
+          },
+          {
+            "name": "City",
+            "type": "string",
+            "required": false,
+            "description": "The city where the vendor is located. If provided, Address1 and CountryCode must also be provided. This attribute is required when UseOnlinePayables is true."
+          },
+          {
+            "name": "State",
+            "type": "string",
+            "required": false,
+            "description": "The state where the vendor is located (e.g. \"CA\" for California). If provided, Address1, City and CountryCode must also be provided. This attribute is required when UseOnlinePayables is true. This value must not be an unincorporated US territory (AS, FM, MH, MP, or VI) for primary address when UseOnlinePayables and VendorPaidByACH are both true."
+          },
+          {
+            "name": "Zip",
+            "type": "string",
+            "required": false,
+            "description": "The zip code where the vendor is located. Must be a valid 5-digit ZIP code (e.g., 93013) or ZIP+4 format (e.g., 93013-0429). If provided, Address1, City and CountryCode must also be provided. This attribute is required for primary address when UseOnlinePayables is true."
+          },
+          {
+            "name": "CountryCode",
+            "type": "string",
+            "required": false,
+            "description": "The country code of the vendor (e.g. \"US\" for United States). If provided, Address1 and City must also be provided. This attribute is required when UseOnlinePayables is true. This value must be \"US\" for primary address when UseOnlinePayables and VendorPaidByAch are both true."
+          },
+          {
+            "name": "PhoneNumbers",
+            "type": "array",
+            "required": false,
+            "description": "The vendor's phone number(s)",
+            "attributes": [
+              {
+                "name": "Number",
+                "type": "string",
+                "required": true,
+                "description": "The vendor's phone number"
+              },
+              {
+                "name": "AdditionalDetails",
+                "type": "string",
+                "required": false,
+                "description": "Additional detailed information pertaining to the phone number"
+              },
+              {
+                "name": "IsPrimary",
+                "type": "boolean",
+                "required": false,
+                "description": "Indicates whether the phone number provided is the vendor's main contact number"
+              },
+              {
+                "name": "Label",
+                "type": "string",
+                "required": false,
+                "description": "The label of the phone number",
+                "enum": ["Fax", "Home", "Mobile", "Office"]
+              }
+            ]
+          },
+          {
+            "name": "Emails",
+            "type": "array",
+            "required": false,
+            "description": "The vendor's email address(es)",
+            "attributes": [
+              {
+                "name": "EmailAddress",
+                "type": "string",
+                "required": true,
+                "description": "The vendor's email address"
+              },
+              {
+                "name": "IsPrimary",
+                "type": "boolean",
+                "required": false,
+                "description": "Indicates whether the email address provided is the vendor's primary email address"
+              }
+            ]
+          },
+          {
+            "name": "CompanyURL",
+            "type": "string",
+            "required": false,
+            "description": "The internet address of the vendor's website"
+          },
+          {
+            "name": "LiabilityInsuranceExpiration",
+            "type": "string <date>",
+            "required": false,
+            "description": "The expiration date of the vendor's liability insurance"
+          },
+          {
+            "name": "AutoInsuranceExpiration",
+            "type": "string <date>",
+            "required": false,
+            "description": "The expiration date of the vendor's automobile insurance"
+          },
+          {
+            "name": "WorkersCompExpiration",
+            "type": "string <date>",
+            "required": false,
+            "description": "The expiration date of the vendor's worker's compensation insurance"
+          },
+          {
+            "name": "ContractExpiration",
+            "type": "string <date>",
+            "required": false,
+            "description": "The expiration date of the contract"
+          },
+          {
+            "name": "UmbrellaInsuranceExpiration",
+            "type": "string <date>",
+            "required": false,
+            "description": "The expiration date of the vendor's umbrella insurance"
+          },
+          {
+            "name": "CompliantStatus",
+            "type": "boolean",
+            "required": false,
+            "description": "Indicates whether or not the vendor meets compliance"
+          },
+          {
+            "name": "NetVendorId",
+            "type": "string",
+            "required": false,
+            "description": "The vendor's NetVendor ID"
+          },
+          {
+            "name": "PaymentTerms",
+            "type": "integer",
+            "required": false,
+            "description": "Represents the number of days the payment is due after the invoice date. A null value indicates that no payment terms were defined. A value of 0 indicates the payment is due on receipt. Required value of 1-31 if UsingEomTerms is true."
+          },
+          {
+            "name": "UsingEomTerms",
+            "type": "boolean",
+            "required": false,
+            "description": "Indicates whether or not the payment terms include an end-of-month (EOM) stipulation. If a null value passed to UsingEomTerms or no value is provided, UsingEomTerms will default to false."
+          },
+          {
+            "name": "DefaultAutoAcceptWorkOrders",
+            "type": "boolean",
+            "required": false,
+            "description": "Indicates whether the vendor is ineligible for auto-accept work order assignments. When set to true, this vendor will auto-accept all work orders assigned to them."
+          },
+          {
+            "name": "Tags",
+            "type": "Array of strings",
+            "required": false,
+            "description": "User-defined tag(s) that categorize the vendor"
+          },
+          {
+            "name": "VendorPaidByACH",
+            "type": "boolean",
+            "required": false,
+            "description": "Indicates whether or not the vendor is paid via ACH (Automated Clearing House) transfer."
+          },
+          {
+            "name": "UseOnlinePayables",
+            "type": "boolean",
+            "required": false,
+            "description": "Indicates whether or not the vendor uses Online Payables for receiving payments."
+          },
+          {
+            "name": "BankAccountRoutingNumber",
+            "type": "string",
+            "required": false,
+            "description": "The vendor's bank account routing number. Must be a valid 9-digit ABA routing number. This attribute is required when both UseOnlinePayables and VendorPaidByACH are true. Will be ignored if online payables is enabled and vendor is not paid by ACH."
+          },
+          {
+            "name": "BankAccountNumber",
+            "type": "string",
+            "required": false,
+            "description": "The vendor's bank account number. Must be 4-17 characters and can only contain numbers and hyphens. This attribute is required when both UseOnlinePayables and VendorPaidByACH are true. Will be ignored if online payables is enabled and vendor is not paid by ACH."
+          },
+          {
+            "name": "SavingsAccount",
+            "type": "boolean",
+            "required": false,
+            "description": "Indicates whether or not the bank account is a savings account. If false or not provided, the account is assumed to be a checking account. Will be ignored if online payables is enabled and vendor is not paid by ACH."
+          }
+        ]
+      }
+    ]
+  },
+  "responseFields": [
+    {
+      "name": "JobId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the asynchronous bulk create job"
+    }
+  ],
+  "requestSample": "{\n  \"data\": [{}]\n}"
+}

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

@@ -0,0 +1,40 @@
+{
+  "operationId": "post_vendors_vendorid_notes",
+  "resource": "vendors",
+  "name": "Create Vendor Note",
+  "method": "POST",
+  "path": "/vendors/{VendorId}/notes",
+  "description": "Add 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"
+    }
+  ],
+  "requestBody": {
+    "required": true,
+    "description": "Note object",
+    "attributes": [
+      {
+        "name": "Body",
+        "type": "string",
+        "required": false,
+        "description": "A brief informative message related to the vendor. A vendor note cannot exceed 65,535 characters."
+      }
+    ]
+  },
+  "responseFields": [
+    {
+      "name": "Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the vendor note"
+    }
+  ],
+  "requestSample": "{\n  \"Body\": \"This vendor completed maintenance on 11/11/2023\"\n}"
+}

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

@@ -0,0 +1,251 @@
+{
+  "operationId": "post_work_orders",
+  "resource": "work_orders",
+  "name": "Create Work Orders",
+  "method": "POST",
+  "path": "/work_orders",
+  "description": "Create a work order which belongs to a property, unit, occupancy, or inspection",
+  "deprecated": false,
+  "writeOperation": true,
+  "pagination": false,
+  "requestBody": {
+    "required": true,
+    "description": "Created work order object. One of PropertyId, UnitId, OccupancyId, InspectionId, or ServiceRequestId must be provided.",
+    "attributes": [
+      {
+        "name": "JobDescription",
+        "type": "string",
+        "required": true,
+        "description": "A brief description of the work order to be performed"
+      },
+      {
+        "name": "PropertyId",
+        "type": "string <uuid>",
+        "required": false,
+        "description": "Unique identifier of the property associated with the work order"
+      },
+      {
+        "name": "AssignedUsers",
+        "type": "Array of arrays",
+        "required": false,
+        "description": "Array of AssignedUsers to create the work order with"
+      },
+      {
+        "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. Estimates created via API are not automatically sent to Vendors or Owners, but are visible to assigned Vendors in the Vendor Portal.",
+        "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": "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 true, VendorId must be null or omitted."
+      },
+      {
+        "name": "PermissionToEnter",
+        "type": "boolean or string",
+        "required": false,
+        "description": "Indicates whether or not the occupancy has given permission to enter the 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. 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. The value must adhere to the ISO 8601 format: YYYY-MM-DDThh:mm:ssZ."
+      },
+      {
+        "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. If the management company is the vendor, this should be null or omitted."
+      },
+      {
+        "name": "VendorTrade",
+        "type": "string",
+        "required": false,
+        "description": "The type of service offered by the vendor"
+      },
+      {
+        "name": "WorkCompletedOn",
+        "type": "string <date>",
+        "required": false,
+        "description": "The date the work order was completed"
+      },
+      {
+        "name": "UnitTurnCategory",
+        "type": "string",
+        "required": false,
+        "description": "The category of the unit turn work order. This field requires a valid UnitId or OccupancyId if provided."
+      }
+    ]
+  },
+  "responseFields": [
+    {
+      "name": "Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the created work order"
+    },
+    {
+      "name": "Link",
+      "type": "string <uri>",
+      "required": false,
+      "description": "A link to the work order page in the AppFolio Property Manager."
+    }
+  ],
+  "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  \"LaborItems\": [\n    {},\n    {}\n  ],\n  \"JobDescription\": \"Fix leaky sink.\",\n  \"ManagementCompanyAsVendor\": false,\n  \"PermissionToEnter\": true,\n  \"Priority\": \"Normal\",\n  \"PropertyId\": \"8eb28538-c8f5-41e7-ac82-3f9609cceec9\",\n  \"ScheduledEnd\": \"2021-01-15T20:30:46Z\",\n  \"ScheduledStart\": \"2021-01-15T16:30:46Z\",\n  \"Status\": \"Scheduled\",\n  \"VendorId\": \"8eb28538-c8f5-41e7-ac82-3f9609ccee10\",\n  \"VendorTrade\": \"Appliances\",\n  \"UnitTurnCategory\": \"Paint\"\n}"
+}

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

@@ -0,0 +1,41 @@
+{
+  "operationId": "post_work_orders_workorderid_attachments",
+  "resource": "work_orders",
+  "name": "Create Work Order Attachment",
+  "method": "POST",
+  "path": "/work_orders/{WorkOrderId}/attachments",
+  "description": "Upload an attachment to a work order",
+  "deprecated": false,
+  "writeOperation": true,
+  "pagination": false,
+  "pathParams": [
+    {
+      "name": "WorkOrderId",
+      "type": "string <uuid>",
+      "required": true,
+      "description": "The work order to which the file will be attached"
+    }
+  ],
+  "requestBody": {
+    "required": true,
+    "description": "Attachment object (multipart/form-data)",
+    "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 work order attachment"
+    }
+  ],
+  "requestSample": "{\n  \"File\": \"/path/to/file.pdf\"\n}"
+}

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

@@ -0,0 +1,40 @@
+{
+  "operationId": "post_work_orders_workorderid_notes",
+  "resource": "work_orders",
+  "name": "Create Work Order Note",
+  "method": "POST",
+  "path": "/work_orders/{WorkOrderId}/notes",
+  "description": "Add a note to a work order",
+  "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"
+    }
+  ],
+  "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 work order note"
+    }
+  ],
+  "requestSample": "{\n  \"Body\": \"This work order have scheduled a maintenance service on 11/11/2022\"\n}"
+}