@nightsquawktech/appfolio-mcp-server 0.0.1

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

@@ -0,0 +1,330 @@
+{
+  "operationId": "post_owners",
+  "resource": "owners",
+  "name": "Create Owner",
+  "method": "POST",
+  "path": "/owners",
+  "description": "Create an owner",
+  "deprecated": false,
+  "writeOperation": true,
+  "pagination": false,
+  "requestBody": {
+    "required": true,
+    "description": "Owner object",
+    "attributes": [
+      {
+        "name": "FirstName",
+        "type": "string",
+        "required": false,
+        "description": "The first name of the owner. This value is required when CompanyName is not provided."
+      },
+      {
+        "name": "LastName",
+        "type": "string",
+        "required": false,
+        "description": "The last name of the owner. This value is required when CompanyName is not provided."
+      },
+      {
+        "name": "CompanyName",
+        "type": "string",
+        "required": false,
+        "description": "The company name associated with the owner. This value is required when FirstName or LastName is not provided."
+      },
+      {
+        "name": "Email",
+        "type": "string",
+        "required": false,
+        "deprecated": true,
+        "description": "The primary email address of the owner"
+      },
+      {
+        "name": "PhoneNumber",
+        "type": "string",
+        "required": false,
+        "deprecated": true,
+        "description": "The owner's primary phone number"
+      },
+      {
+        "name": "Address1",
+        "type": "string",
+        "required": false,
+        "deprecated": true,
+        "description": "The primary street address of the owner"
+      },
+      {
+        "name": "Address2",
+        "type": "string",
+        "required": false,
+        "deprecated": true,
+        "description": "Additional street address information pertaining to the owner"
+      },
+      {
+        "name": "City",
+        "type": "string",
+        "required": false,
+        "deprecated": true,
+        "description": "The city where the owner is located"
+      },
+      {
+        "name": "State",
+        "type": "string",
+        "required": false,
+        "deprecated": true,
+        "description": "The state where the owner is located. This attribute must not be an unincorporated US territory, i.e., (AS, FM, MH, MP, or VI) for primary address when UseOnlinePayables and OwnerPaidByACH are both true. This value must be valid when UseOnlinePayables is true, OwnerPaidByACH and UseAlternatePayee are both false or not provided."
+      },
+      {
+        "name": "Zip",
+        "type": "string",
+        "required": false,
+        "deprecated": true,
+        "description": "The zip code where the owner is located. Must be a string in 5-digit ZIP code format (e.g., 93013) or ZIP+4 format (e.g., 93013-0429). This attribute is required for primary address when UseOnlinePayables and OwnerPaidByACH are both true or when UseOnlinePayables is true, OwnerPaidByACH and UseAlternatePayee are both false or not provided."
+      },
+      {
+        "name": "CountryCode",
+        "type": "string",
+        "required": false,
+        "deprecated": true,
+        "description": "The country code of the owner (e.g. US for United states). This attribute must be US for primary address when UseOnlinePayables and OwnerPaidByACH are both true or when UseOnlinePayables is true, OwnerPaidByACH and UseAlternatePayee are both false or not provided."
+      },
+      {
+        "name": "OwnerPaidByACH",
+        "type": "boolean",
+        "required": false,
+        "description": "Indicates whether the owner is paid via ACH (Automated Clearing House) transfer"
+      },
+      {
+        "name": "UseOnlinePayables",
+        "type": "boolean",
+        "required": false,
+        "description": "Indicates whether the owner is paid via online payables"
+      },
+      {
+        "name": "BankAccountRoutingNumber",
+        "type": "string",
+        "required": false,
+        "description": "The owner's bank account routing number. This attribute is required when UseOnlinePayables and OwnerPaidByACH are both true."
+      },
+      {
+        "name": "BankAccountNumber",
+        "type": "string",
+        "required": false,
+        "description": "The owner's bank account number. This attribute is required when UseOnlinePayables and OwnerPaidByACH are both true."
+      },
+      {
+        "name": "SavingsAccount",
+        "type": "boolean",
+        "required": false,
+        "description": "Indicates whether the owner's bank account is a checking or savings account. If true, the owner is using a savings account; otherwise, the bank account in use is a checking account."
+      },
+      {
+        "name": "TaxpayerName",
+        "type": "string",
+        "required": false,
+        "description": "The name of the taxpayer associated with the owner's account"
+      },
+      {
+        "name": "TaxpayerId",
+        "type": "string",
+        "required": false,
+        "description": "The tax identification number of the taxpayer associated with the owner's account"
+      },
+      {
+        "name": "Send1099",
+        "type": "boolean",
+        "required": false,
+        "description": "Indicates whether a 1099 form is sent to the owner. Note: If Send1099 is set to false, only Send1099 will be considered in the request. The OwnerConsentedToReceiveElectronic1099 and Sending1099Preference values will not be processed."
+      },
+      {
+        "name": "OwnerConsentedToReceiveElectronic1099",
+        "type": "boolean",
+        "required": false,
+        "description": "Indicates whether the owner has consented to receive the 1099 tax form electronically. If true, the owner's Email must be provided in the request."
+      },
+      {
+        "name": "Sending1099Preference",
+        "type": "string",
+        "required": false,
+        "enum": ["Paper", "Electronic", "PaperAndElectronic"],
+        "description": "Indicates the owner's 1099 sending preference. Valid values include \"Paper\", \"Electronic\" or \"PaperAndElectronic\"."
+      },
+      {
+        "name": "EmailEcheckReceipt",
+        "type": "boolean",
+        "required": false,
+        "description": "Indicates whether or not to send a notification to the owner after an eCheck payment is made. It can only be set when Owner Vendor eCheck is enabled and the owner has a primary email address. Additionally, OwnerPaidByACH must be true. If Online Payables is enabled, UseOnlinePayables must also be true."
+      },
+      {
+        "name": "HoldPayments",
+        "type": "boolean",
+        "required": false,
+        "description": "When set to true, bills created for the owner through the Pay Owner or Owner Draw function will not be available in the Pay Bills flow."
+      },
+      {
+        "name": "Tags",
+        "type": "Array of strings",
+        "required": false,
+        "description": "User-defined tag(s) that categorize the owner"
+      },
+      {
+        "name": "UseAlternatePayee",
+        "type": "boolean",
+        "required": false,
+        "description": "Indicates whether or not the owner payments are submitted to an alternate person other than what is listed for Owner First, Last and/or Company Name"
+      },
+      {
+        "name": "AlternatePayeeName",
+        "type": "string",
+        "required": false,
+        "description": "The name of the alternate payee. This attribute can be provided only when UseAlternatePayee is true."
+      },
+      {
+        "name": "AlternatePaymentAddress1",
+        "type": "string",
+        "required": false,
+        "description": "The street address of the Alternate Payee. This attribute must be provided when UseAlternatePayee is true."
+      },
+      {
+        "name": "AlternatePaymentAddress2",
+        "type": "string",
+        "required": false,
+        "description": "Additional street address information pertaining to the alternate payee. This attribute can be provided only when UseAlternatePayee is true."
+      },
+      {
+        "name": "AlternatePaymentCity",
+        "type": "string",
+        "required": false,
+        "description": "The city where the alternate payee is located. This attribute must be provided when UseAlternatePayee is true."
+      },
+      {
+        "name": "AlternatePaymentState",
+        "type": "string",
+        "required": false,
+        "description": "The state where the alternate payee is located. This attribute can be provided only when UseAlternatePayee is true. This attribute is required and must be valid when UseOnlinePayables is true and OwnerPaidByACH is false or not provided."
+      },
+      {
+        "name": "AlternatePaymentPostalCode",
+        "type": "string",
+        "required": false,
+        "description": "The zip code where the alternate payee is located. This attribute can be provided only when UseAlternatePayee is true. Must be a string in 5-digit ZIP code format (e.g., 93013) or ZIP+4 format (e.g., 93013-0429). This attribute is required when UseOnlinePayables is true and OwnerPaidByACH is false or not provided."
+      },
+      {
+        "name": "AlternatePaymentCountryCode",
+        "type": "string",
+        "required": false,
+        "description": "The country code of the alternate payee (e.g. US for United states). This attribute must be provided when UseAlternatePayee is true. This attribute must be US when UseOnlinePayables is true and OwnerPaidByACH is false or not provided."
+      },
+      {
+        "name": "Emails",
+        "type": "array",
+        "required": false,
+        "description": "The owner's emails. This attribute must not be provided together with Email.",
+        "attributes": [
+          {
+            "name": "EmailAddress",
+            "type": "string",
+            "required": true,
+            "description": "The owner's email address"
+          },
+          {
+            "name": "IsPrimary",
+            "type": "boolean",
+            "required": false,
+            "description": "Indicates whether the email address provided is the owner's primary email address"
+          }
+        ]
+      },
+      {
+        "name": "PhoneNumbers",
+        "type": "array",
+        "required": false,
+        "description": "The owner's phone number(s). This attribute must not be provided together with PhoneNumber.",
+        "attributes": [
+          {
+            "name": "Number",
+            "type": "string",
+            "required": true,
+            "description": "The owner's phone number"
+          },
+          {
+            "name": "AdditionalDetails",
+            "type": "string",
+            "required": false,
+            "description": "Additional detailed information pertaining to the phone number associated with the owner"
+          },
+          {
+            "name": "IsPrimary",
+            "type": "boolean",
+            "required": false,
+            "description": "Indicates whether the phone number provided is the owner's main contact number"
+          },
+          {
+            "name": "Label",
+            "type": "string",
+            "required": false,
+            "enum": ["Fax", "Home", "Mobile", "Office"],
+            "description": "The label of the phone number, e.g. 'Home'"
+          }
+        ]
+      },
+      {
+        "name": "Addresses",
+        "type": "array",
+        "required": false,
+        "description": "The owner's address(es). This attribute must not be provided together with Address1, Address2, City, State, Zip, or CountryCode. The primary address is required when UseOnlinePayables and OwnerPaidByACH are both true, or when UseOnlinePayables is true, OwnerPaidByACH and UseAlternatePayee are both false or not provided.",
+        "attributes": [
+          {
+            "name": "Address1",
+            "type": "string",
+            "required": true,
+            "description": "The primary street address of the owner"
+          },
+          {
+            "name": "City",
+            "type": "string",
+            "required": true,
+            "description": "The city where the owner resides"
+          },
+          {
+            "name": "CountryCode",
+            "type": "string",
+            "required": true,
+            "description": "The country code of the owner (e.g. \"US\" for United States). This attribute must be US for primary address when UseOnlinePayables and OwnerPaidByACH are both true or when UseOnlinePayables is true, OwnerPaidByACH and UseAlternatePayee are both false or not provided."
+          },
+          {
+            "name": "Address2",
+            "type": "string",
+            "required": false,
+            "description": "The secondary street address of the owner"
+          },
+          {
+            "name": "State",
+            "type": "string",
+            "required": false,
+            "description": "The state where the owner resides. This attribute must not be an unincorporated US territory, i.e., (AS, FM, MH, MP, or VI) for primary address when UseOnlinePayables and OwnerPaidByACH are both true. This value must be valid when UseOnlinePayables is true, OwnerPaidByACH and UseAlternatePayee are both false or not provided."
+          },
+          {
+            "name": "PostalCode",
+            "type": "string",
+            "required": false,
+            "description": "The postal code where the owner resides. Must be a string in 5-digit ZIP code format (e.g., 93013) or ZIP+4 format (e.g., 93013-0429). This attribute is required for primary address when UseOnlinePayables and OwnerPaidByACH are both true or when UseOnlinePayables is true, OwnerPaidByACH and UseAlternatePayee are both false or not provided."
+          },
+          {
+            "name": "IsPrimary",
+            "type": "boolean",
+            "required": false,
+            "description": "Indicates whether the address provided is the owner's primary address"
+          }
+        ]
+      }
+    ]
+  },
+  "responseFields": [
+    {
+      "name": "Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the created owner"
+    }
+  ],
+  "requestSample": "{\n  \"Address1\": \"123 Alpine St\",\n  \"Address2\": \"Unit A\",\n  \"City\": \"Santa Barbara\",\n  \"State\": \"CA\",\n  \"Zip\": \"93101\",\n  \"CountryCode\": \"US\",\n  \"FirstName\": \"Joe\",\n  \"LastName\": \"Owner\",\n  \"CompanyName\": \"OwnerComp\",\n  \"Email\": \"joe@owners.com\",\n  \"PhoneNumber\": \"(310) 555-0194\",\n  \"OwnerPaidByACH\": true,\n  \"UseOnlinePayables\": true,\n  \"BankAccountRoutingNumber\": \"121042882\",\n  \"BankAccountNumber\": \"23438791498723\",\n  \"SavingsAccount\": true,\n  \"TaxpayerName\": \"OwnerComp\",\n  \"TaxpayerId\": \"999-99-9999\",\n  \"Send1099\": true,\n  \"OwnerConsentedToReceiveElectronic1099\": false,\n  \"Sending1099Preference\": \"Paper\",\n  \"PhoneNumbers\": [{}],\n  \"Emails\": [{}],\n  \"Addresses\": [{}],\n  \"Tags\": [\"Tag Name\"],\n  \"UseAlternatePayee\": true,\n  \"AlternatePayeeName\": \"John Smith\",\n  \"AlternatePaymentAddress1\": \"123 Highland Avenue\",\n  \"AlternatePaymentAddress2\": \"Unit C\",\n  \"AlternatePaymentCity\": \"Santa Barbara\",\n  \"AlternatePaymentState\": \"CA\",\n  \"AlternatePaymentPostalCode\": \"93117\",\n  \"AlternatePaymentCountryCode\": \"US\",\n  \"EmailEcheckReceipt\": false,\n  \"HoldPayments\": true\n}"
+}

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

@@ -0,0 +1,203 @@
+{
+  "operationId": "post_owners_bulk",
+  "resource": "owners",
+  "name": "Bulk Create Owners",
+  "method": "POST",
+  "path": "/owners/bulk",
+  "description": "Create owners in bulk",
+  "deprecated": false,
+  "writeOperation": true,
+  "pagination": false,
+  "requestBody": {
+    "required": true,
+    "description": "Owner objects",
+    "attributes": [
+      {
+        "name": "data",
+        "type": "array",
+        "required": false,
+        "description": "Array of owner objects to create in bulk",
+        "attributes": [
+          {
+            "name": "ReferenceId",
+            "type": "string",
+            "required": true,
+            "description": "Transient unique ID assigned by the developer. Used to reference individual owner in the bulk-creation of owners."
+          },
+          {
+            "name": "FirstName",
+            "type": "string",
+            "required": false,
+            "description": "The first name of the owner. This value is required when CompanyName is not provided."
+          },
+          {
+            "name": "LastName",
+            "type": "string",
+            "required": false,
+            "description": "The last name of the owner. This value is required when CompanyName is not provided."
+          },
+          {
+            "name": "CompanyName",
+            "type": "string",
+            "required": false,
+            "description": "The company name associated with the owner. This value is required when FirstName or LastName is not provided."
+          },
+          {
+            "name": "OwnerPaidByACH",
+            "type": "boolean",
+            "required": false,
+            "description": "Indicates whether the owner is paid via ACH (Automated Clearing House) transfer"
+          },
+          {
+            "name": "UseOnlinePayables",
+            "type": "boolean",
+            "required": false,
+            "description": "Indicates whether the owner is paid via online payables"
+          },
+          {
+            "name": "BankAccountRoutingNumber",
+            "type": "string",
+            "required": false,
+            "description": "The owner's bank account routing number. This attribute is required when UseOnlinePayables and OwnerPaidByACH are both true."
+          },
+          {
+            "name": "BankAccountNumber",
+            "type": "string",
+            "required": false,
+            "description": "The owner's bank account number. This attribute is required when UseOnlinePayables and OwnerPaidByACH are both true."
+          },
+          {
+            "name": "SavingsAccount",
+            "type": "boolean",
+            "required": false,
+            "description": "Indicates whether the owner's bank account is a checking or savings account. If true, the owner is using a savings account; otherwise, the bank account in use is a checking account."
+          },
+          {
+            "name": "TaxpayerName",
+            "type": "string",
+            "required": false,
+            "description": "The name of the taxpayer associated with the owner's account"
+          },
+          {
+            "name": "TaxpayerId",
+            "type": "string",
+            "required": false,
+            "description": "The tax identification number of the taxpayer associated with the owner's account"
+          },
+          {
+            "name": "Send1099",
+            "type": "boolean",
+            "required": false,
+            "description": "Indicates whether a 1099 form is sent to the owner. Note: If Send1099 is set to false, only Send1099 will be considered in the request. The OwnerConsentedToReceiveElectronic1099 and Sending1099Preference values will not be processed."
+          },
+          {
+            "name": "OwnerConsentedToReceiveElectronic1099",
+            "type": "boolean",
+            "required": false,
+            "description": "Indicates whether the owner has consented to receive the 1099 tax form electronically. If true, the owner's Email must be provided in the request."
+          },
+          {
+            "name": "Sending1099Preference",
+            "type": "string",
+            "required": false,
+            "enum": ["Paper", "Electronic", "PaperAndElectronic"],
+            "description": "Indicates the owner's 1099 sending preference. Valid values include \"Paper\", \"Electronic\" or \"PaperAndElectronic\"."
+          },
+          {
+            "name": "EmailEcheckReceipt",
+            "type": "boolean",
+            "required": false,
+            "description": "Indicates whether or not to send a notification to the owner after an eCheck payment is made. It can only be set when Owner Vendor eCheck is enabled and the owner has a primary email address. Additionally, OwnerPaidByACH must be true. If Online Payables is enabled, UseOnlinePayables must also be true."
+          },
+          {
+            "name": "HoldPayments",
+            "type": "boolean",
+            "required": false,
+            "description": "When set to true, bills created for the owner through the Pay Owner or Owner Draw function will not be available in the Pay Bills flow."
+          },
+          {
+            "name": "Tags",
+            "type": "Array of strings",
+            "required": false,
+            "description": "User-defined tag(s) that categorize the owner"
+          },
+          {
+            "name": "UseAlternatePayee",
+            "type": "boolean",
+            "required": false,
+            "description": "Indicates whether or not the owner payments are submitted to an alternate person other than what is listed for Owner First, Last and/or Company Name"
+          },
+          {
+            "name": "AlternatePayeeName",
+            "type": "string",
+            "required": false,
+            "description": "The name of the alternate payee. This attribute can be provided only when UseAlternatePayee is true."
+          },
+          {
+            "name": "AlternatePaymentAddress1",
+            "type": "string",
+            "required": false,
+            "description": "The street address of the Alternate Payee. This attribute must be provided when UseAlternatePayee is true."
+          },
+          {
+            "name": "AlternatePaymentAddress2",
+            "type": "string",
+            "required": false,
+            "description": "Additional street address information pertaining to the alternate payee. This attribute can be provided only when UseAlternatePayee is true."
+          },
+          {
+            "name": "AlternatePaymentCity",
+            "type": "string",
+            "required": false,
+            "description": "The city where the alternate payee is located. This attribute must be provided when UseAlternatePayee is true."
+          },
+          {
+            "name": "AlternatePaymentState",
+            "type": "string",
+            "required": false,
+            "description": "The state where the alternate payee is located. This attribute can be provided only when UseAlternatePayee is true. This attribute is required and must be valid when UseOnlinePayables is true and OwnerPaidByACH is false or not provided."
+          },
+          {
+            "name": "AlternatePaymentPostalCode",
+            "type": "string",
+            "required": false,
+            "description": "The zip code where the alternate payee is located. This attribute can be provided only when UseAlternatePayee is true. Must be a string in 5-digit ZIP code format (e.g., 93013) or ZIP+4 format (e.g., 93013-0429). This attribute is required when UseOnlinePayables is true and OwnerPaidByACH is false or not provided."
+          },
+          {
+            "name": "AlternatePaymentCountryCode",
+            "type": "string",
+            "required": false,
+            "description": "The country code of the alternate payee (e.g. US for United states). This attribute must be provided when UseAlternatePayee is true. This attribute must be US when UseOnlinePayables is true and OwnerPaidByACH is false or not provided."
+          },
+          {
+            "name": "Emails",
+            "type": "array",
+            "required": false,
+            "description": "The owner's emails."
+          },
+          {
+            "name": "PhoneNumbers",
+            "type": "array",
+            "required": false,
+            "description": "The owner's phone number(s)."
+          },
+          {
+            "name": "Addresses",
+            "type": "array",
+            "required": false,
+            "description": "The owner's address(es). The primary address is required when UseOnlinePayables and OwnerPaidByACH are both true, or when UseOnlinePayables is true, OwnerPaidByACH and UseAlternatePayee are both false or not provided."
+          }
+        ]
+      }
+    ]
+  },
+  "responseFields": [
+    {
+      "name": "JobId",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "The job identifier for the bulk create operation"
+    }
+  ],
+  "requestSample": "{\n  \"data\": [\n    {}\n  ]\n}"
+}

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

@@ -0,0 +1,40 @@
+{
+  "operationId": "post_owners_ownerid_attachments",
+  "resource": "owners",
+  "name": "Create Owner Attachment",
+  "method": "POST",
+  "path": "/owners/{OwnerId}/attachments",
+  "description": "Upload an attachment to an owner",
+  "deprecated": false,
+  "writeOperation": true,
+  "pagination": false,
+  "pathParams": [
+    {
+      "name": "OwnerId",
+      "type": "string <uuid>",
+      "required": true,
+      "description": "The owner 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"
+      }
+    ]
+  },
+  "responseFields": [
+    {
+      "name": "Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the owner attachment"
+    }
+  ],
+  "requestSample": "{\n  \"File\": \"/path/to/file.pdf\"\n}"
+}

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

@@ -0,0 +1,40 @@
+{
+  "operationId": "post_owners_ownerid_notes",
+  "resource": "owners",
+  "name": "Create Owner Note",
+  "method": "POST",
+  "path": "/owners/{OwnerId}/notes",
+  "description": "Add a note to an owner.",
+  "deprecated": false,
+  "writeOperation": true,
+  "pagination": false,
+  "pathParams": [
+    {
+      "name": "OwnerId",
+      "type": "string <uuid>",
+      "required": true,
+      "description": "The owner 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 owner note. An owner note cannot exceed 65,535 characters."
+      }
+    ]
+  },
+  "responseFields": [
+    {
+      "name": "Id",
+      "type": "string <uuid>",
+      "required": false,
+      "description": "Unique identifier of the owner note."
+    }
+  ],
+  "requestSample": "{\n  \"Body\": \"This owner have scheduled a cleaning service on 11/11/2023\"\n}"
+}