@nightsquawktech/appfolio-mcp-server 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/COMMERCIAL.md +35 -0
- package/LICENSE +661 -0
- package/README.md +127 -0
- package/dist/catalog/index.json +1511 -0
- package/dist/catalog/report-spec.js +27 -0
- package/dist/catalog/reports/account_totals.json +112 -0
- package/dist/catalog/reports/additional_fees.json +73 -0
- package/dist/catalog/reports/aged_payables_summary.json +124 -0
- package/dist/catalog/reports/aged_receivables_detail.json +132 -0
- package/dist/catalog/reports/amenities_by_property.json +73 -0
- package/dist/catalog/reports/annual_budget_comparative.json +138 -0
- package/dist/catalog/reports/annual_budget_forecast.json +125 -0
- package/dist/catalog/reports/appfolio_stack_usage.json +112 -0
- package/dist/catalog/reports/association_work_order.json +232 -0
- package/dist/catalog/reports/balance_sheet.json +124 -0
- package/dist/catalog/reports/balance_sheet_comparative.json +126 -0
- package/dist/catalog/reports/balance_sheet_comparison.json +113 -0
- package/dist/catalog/reports/bank_account_association.json +94 -0
- package/dist/catalog/reports/bill_detail.json +183 -0
- package/dist/catalog/reports/board_of_directors.json +87 -0
- package/dist/catalog/reports/budget_comparative.json +162 -0
- package/dist/catalog/reports/budget_comparison.json +141 -0
- package/dist/catalog/reports/cancelled_processes.json +122 -0
- package/dist/catalog/reports/cash_flow.json +158 -0
- package/dist/catalog/reports/cash_flow_comparison.json +158 -0
- package/dist/catalog/reports/cash_flow_detail.json +129 -0
- package/dist/catalog/reports/charge_detail.json +198 -0
- package/dist/catalog/reports/chart_of_accounts.json +22 -0
- package/dist/catalog/reports/check_register.json +181 -0
- package/dist/catalog/reports/check_register_detail.json +181 -0
- package/dist/catalog/reports/completed_processes.json +117 -0
- package/dist/catalog/reports/delinquency.json +164 -0
- package/dist/catalog/reports/delinquency_as_of.json +155 -0
- package/dist/catalog/reports/deposit_register.json +51 -0
- package/dist/catalog/reports/dues_roll.json +89 -0
- package/dist/catalog/reports/dues_roll_itemized.json +113 -0
- package/dist/catalog/reports/eligible_debt_summary.json +73 -0
- package/dist/catalog/reports/email_delivery_errors.json +104 -0
- package/dist/catalog/reports/expense_distribution.json +109 -0
- package/dist/catalog/reports/expense_register.json +149 -0
- package/dist/catalog/reports/fixed_assets.json +111 -0
- package/dist/catalog/reports/flows_assigned_tasks.json +103 -0
- package/dist/catalog/reports/fund_balance_sheet.json +113 -0
- package/dist/catalog/reports/fund_balance_sheet_active_funds.json +113 -0
- package/dist/catalog/reports/fund_income_statement.json +132 -0
- package/dist/catalog/reports/general_ledger.json +166 -0
- package/dist/catalog/reports/gross_potential_rent_enhanced.json +102 -0
- package/dist/catalog/reports/guest_card_inquiries.json +177 -0
- package/dist/catalog/reports/guest_cards.json +161 -0
- package/dist/catalog/reports/historical_advertised_rent.json +92 -0
- package/dist/catalog/reports/homeowner_delinquency.json +143 -0
- package/dist/catalog/reports/homeowner_delinquency_as_of.json +161 -0
- package/dist/catalog/reports/homeowner_directory.json +126 -0
- package/dist/catalog/reports/homeowner_ledger.json +59 -0
- package/dist/catalog/reports/homeowner_prepayment_balance.json +127 -0
- package/dist/catalog/reports/homeowner_resale.json +107 -0
- package/dist/catalog/reports/homeowner_vehicle_info.json +104 -0
- package/dist/catalog/reports/import_variances.json +41 -0
- package/dist/catalog/reports/in_progress_workflows.json +181 -0
- package/dist/catalog/reports/inactive_guest_cards.json +134 -0
- package/dist/catalog/reports/income_register.json +131 -0
- package/dist/catalog/reports/income_statement.json +130 -0
- package/dist/catalog/reports/income_statement_comparative.json +140 -0
- package/dist/catalog/reports/income_statement_comparison.json +135 -0
- package/dist/catalog/reports/income_statement_date_range.json +134 -0
- package/dist/catalog/reports/inspection_detail.json +107 -0
- package/dist/catalog/reports/insurance_enforcement.json +22 -0
- package/dist/catalog/reports/insurance_usage.json +92 -0
- package/dist/catalog/reports/inventory_status.json +73 -0
- package/dist/catalog/reports/inventory_usage.json +131 -0
- package/dist/catalog/reports/keys_detail.json +131 -0
- package/dist/catalog/reports/late_fee_policy_comparison.json +135 -0
- package/dist/catalog/reports/lease_expiration_detail.json +147 -0
- package/dist/catalog/reports/lease_expiration_summary.json +95 -0
- package/dist/catalog/reports/lease_history.json +147 -0
- package/dist/catalog/reports/leasing_agent_performance.json +54 -0
- package/dist/catalog/reports/leasing_funnel_performance.json +113 -0
- package/dist/catalog/reports/leasing_summary.json +92 -0
- package/dist/catalog/reports/loans.json +95 -0
- package/dist/catalog/reports/occupancy_custom_fields.json +73 -0
- package/dist/catalog/reports/occupancy_summary.json +95 -0
- package/dist/catalog/reports/owner1099.json +135 -0
- package/dist/catalog/reports/owner1099_detail.json +156 -0
- package/dist/catalog/reports/owner_custom_fields.json +73 -0
- package/dist/catalog/reports/owner_directory.json +101 -0
- package/dist/catalog/reports/owner_leasing.json +115 -0
- package/dist/catalog/reports/owner_withholdings.json +170 -0
- package/dist/catalog/reports/payment_plans.json +128 -0
- package/dist/catalog/reports/premium_leads_billing_detail.json +70 -0
- package/dist/catalog/reports/project_budget_detail.json +56 -0
- package/dist/catalog/reports/project_directory.json +144 -0
- package/dist/catalog/reports/property_budget.json +83 -0
- package/dist/catalog/reports/property_custom_fields.json +73 -0
- package/dist/catalog/reports/property_directory.json +73 -0
- package/dist/catalog/reports/property_group_directory.json +85 -0
- package/dist/catalog/reports/property_performance.json +115 -0
- package/dist/catalog/reports/property_staff_assignments.json +73 -0
- package/dist/catalog/reports/prospect_source_tracking.json +92 -0
- package/dist/catalog/reports/purchase_order.json +163 -0
- package/dist/catalog/reports/receivables_activity.json +138 -0
- package/dist/catalog/reports/renewal_summary.json +134 -0
- package/dist/catalog/reports/rent_roll.json +114 -0
- package/dist/catalog/reports/rent_roll_commercial.json +106 -0
- package/dist/catalog/reports/rent_roll_itemized.json +125 -0
- package/dist/catalog/reports/rentable_items.json +97 -0
- package/dist/catalog/reports/rental_applications.json +118 -0
- package/dist/catalog/reports/renter_directory.json +60 -0
- package/dist/catalog/reports/resident_financial_activity.json +107 -0
- package/dist/catalog/reports/screening_assessments.json +104 -0
- package/dist/catalog/reports/screening_usage.json +92 -0
- package/dist/catalog/reports/security_deposit_funds_detail.json +141 -0
- package/dist/catalog/reports/showings.json +123 -0
- package/dist/catalog/reports/student_housing_rent_roll_by_bed.json +125 -0
- package/dist/catalog/reports/surveys_summary.json +118 -0
- package/dist/catalog/reports/tenant_debt_collections_status.json +90 -0
- package/dist/catalog/reports/tenant_directory.json +120 -0
- package/dist/catalog/reports/tenant_ledger.json +72 -0
- package/dist/catalog/reports/tenant_tickler.json +102 -0
- package/dist/catalog/reports/tenant_transactions_summary.json +97 -0
- package/dist/catalog/reports/tenant_unpaid_charges_summary.json +147 -0
- package/dist/catalog/reports/tenant_vehicle_info.json +107 -0
- package/dist/catalog/reports/trial_balance.json +104 -0
- package/dist/catalog/reports/trial_balance_by_property.json +104 -0
- package/dist/catalog/reports/trust_account_balance.json +116 -0
- package/dist/catalog/reports/trust_account_balance_detail.json +112 -0
- package/dist/catalog/reports/twelve_month_cash_flow.json +157 -0
- package/dist/catalog/reports/twelve_month_income_statement.json +147 -0
- package/dist/catalog/reports/unit_custom_fields.json +73 -0
- package/dist/catalog/reports/unit_directory.json +80 -0
- package/dist/catalog/reports/unit_inspection.json +95 -0
- package/dist/catalog/reports/unit_turn_detail.json +104 -0
- package/dist/catalog/reports/unit_vacancy.json +143 -0
- package/dist/catalog/reports/unpaid_balances_by_month.json +181 -0
- package/dist/catalog/reports/upcoming_activities.json +142 -0
- package/dist/catalog/reports/vendor1099.json +84 -0
- package/dist/catalog/reports/vendor_custom_fields.json +22 -0
- package/dist/catalog/reports/vendor_directory.json +134 -0
- package/dist/catalog/reports/vendor_ledger.json +122 -0
- package/dist/catalog/reports/vendor_ledger_enhanced.json +122 -0
- package/dist/catalog/reports/violation_detail.json +122 -0
- package/dist/catalog/reports/work_order.json +254 -0
- package/dist/catalog/reports/work_order_labor_summary.json +148 -0
- package/dist/catalog-db/endpoint-spec.js +22 -0
- package/dist/catalog-db/endpoints/delete_inspections_inspectionid.json +21 -0
- package/dist/catalog-db/endpoints/delete_inventories_id.json +21 -0
- package/dist/catalog-db/endpoints/delete_properties_propertyid_marketing_photos_marketingphotoid.json +27 -0
- package/dist/catalog-db/endpoints/delete_properties_propertyid_photos_photoid.json +27 -0
- package/dist/catalog-db/endpoints/delete_units_unitid_photos_photoid.json +27 -0
- package/dist/catalog-db/endpoints/delete_work_orders_workorderid_attachments_attachmentid.json +27 -0
- package/dist/catalog-db/endpoints/get_bank_accounts.json +58 -0
- package/dist/catalog-db/endpoints/get_bills.json +185 -0
- package/dist/catalog-db/endpoints/get_ca_associations.json +106 -0
- package/dist/catalog-db/endpoints/get_ca_bank_balances.json +101 -0
- package/dist/catalog-db/endpoints/get_ca_board_members.json +146 -0
- package/dist/catalog-db/endpoints/get_ca_homeowner_ledgers.json +70 -0
- package/dist/catalog-db/endpoints/get_ca_homeowners.json +151 -0
- package/dist/catalog-db/endpoints/get_ca_renters.json +132 -0
- package/dist/catalog-db/endpoints/get_ca_rules.json +76 -0
- package/dist/catalog-db/endpoints/get_ca_units.json +130 -0
- package/dist/catalog-db/endpoints/get_ca_violations.json +119 -0
- package/dist/catalog-db/endpoints/get_charges.json +76 -0
- package/dist/catalog-db/endpoints/get_corporate_entities.json +88 -0
- package/dist/catalog-db/endpoints/get_custom_fields.json +120 -0
- package/dist/catalog-db/endpoints/get_delinquent_charges.json +88 -0
- package/dist/catalog-db/endpoints/get_gl_accounts.json +115 -0
- package/dist/catalog-db/endpoints/get_gl_details.json +154 -0
- package/dist/catalog-db/endpoints/get_inventories.json +131 -0
- package/dist/catalog-db/endpoints/get_inventory_locations.json +70 -0
- package/dist/catalog-db/endpoints/get_jobs.json +79 -0
- package/dist/catalog-db/endpoints/get_journal_entries.json +137 -0
- package/dist/catalog-db/endpoints/get_late_fee_policies.json +148 -0
- package/dist/catalog-db/endpoints/get_leads.json +248 -0
- package/dist/catalog-db/endpoints/get_leads_notes.json +83 -0
- package/dist/catalog-db/endpoints/get_leases.json +70 -0
- package/dist/catalog-db/endpoints/get_leases_renewal_pricings.json +52 -0
- package/dist/catalog-db/endpoints/get_listings.json +259 -0
- package/dist/catalog-db/endpoints/get_occupancies_documents.json +70 -0
- package/dist/catalog-db/endpoints/get_owner_groups.json +230 -0
- package/dist/catalog-db/endpoints/get_owners.json +258 -0
- package/dist/catalog-db/endpoints/get_owners_attachments.json +82 -0
- package/dist/catalog-db/endpoints/get_owners_notes.json +71 -0
- package/dist/catalog-db/endpoints/get_owners_ownerid.json +247 -0
- package/dist/catalog-db/endpoints/get_payables.json +138 -0
- package/dist/catalog-db/endpoints/get_portfolios.json +70 -0
- package/dist/catalog-db/endpoints/get_properties.json +267 -0
- package/dist/catalog-db/endpoints/get_properties_attachments.json +76 -0
- package/dist/catalog-db/endpoints/get_properties_marketing_photos.json +76 -0
- package/dist/catalog-db/endpoints/get_properties_notes.json +71 -0
- package/dist/catalog-db/endpoints/get_properties_photos.json +76 -0
- package/dist/catalog-db/endpoints/get_property_groups.json +84 -0
- package/dist/catalog-db/endpoints/get_recurring_charges.json +106 -0
- package/dist/catalog-db/endpoints/get_rental_applications.json +186 -0
- package/dist/catalog-db/endpoints/get_rental_applications_notes.json +71 -0
- package/dist/catalog-db/endpoints/get_showings.json +99 -0
- package/dist/catalog-db/endpoints/get_tenant_ledgers.json +82 -0
- package/dist/catalog-db/endpoints/get_tenants.json +273 -0
- package/dist/catalog-db/endpoints/get_tenants_notes.json +71 -0
- package/dist/catalog-db/endpoints/get_unit_types.json +168 -0
- package/dist/catalog-db/endpoints/get_units.json +359 -0
- package/dist/catalog-db/endpoints/get_units_attachments.json +76 -0
- package/dist/catalog-db/endpoints/get_units_notes.json +71 -0
- package/dist/catalog-db/endpoints/get_units_photos.json +70 -0
- package/dist/catalog-db/endpoints/get_users.json +88 -0
- package/dist/catalog-db/endpoints/get_vendors.json +317 -0
- package/dist/catalog-db/endpoints/get_vendors_notes.json +71 -0
- package/dist/catalog-db/endpoints/get_work_orders.json +322 -0
- package/dist/catalog-db/endpoints/get_work_orders_attachments.json +83 -0
- package/dist/catalog-db/endpoints/patch_bills_billid.json +156 -0
- package/dist/catalog-db/endpoints/patch_ca_violations_violationid.json +71 -0
- package/dist/catalog-db/endpoints/patch_inspections_inspectionid.json +77 -0
- package/dist/catalog-db/endpoints/patch_inventories_id.json +113 -0
- package/dist/catalog-db/endpoints/patch_inventory_locations_id.json +52 -0
- package/dist/catalog-db/endpoints/patch_journal_entries_journalentryid.json +90 -0
- package/dist/catalog-db/endpoints/patch_leads_guestcardid_notes_id.json +46 -0
- package/dist/catalog-db/endpoints/patch_leads_leadid.json +162 -0
- package/dist/catalog-db/endpoints/patch_leases_leaseid.json +52 -0
- package/dist/catalog-db/endpoints/patch_owner_groups_id.json +72 -0
- package/dist/catalog-db/endpoints/patch_owners_ownerid.json +344 -0
- package/dist/catalog-db/endpoints/patch_owners_ownerid_notes_id.json +46 -0
- package/dist/catalog-db/endpoints/patch_portfolios_portfolioid.json +46 -0
- package/dist/catalog-db/endpoints/patch_properties_propertyid.json +333 -0
- package/dist/catalog-db/endpoints/patch_properties_propertyid_marketing_photos_marketingphotoid.json +46 -0
- package/dist/catalog-db/endpoints/patch_properties_propertyid_notes_id.json +46 -0
- package/dist/catalog-db/endpoints/patch_properties_propertyid_photos_photoid.json +46 -0
- package/dist/catalog-db/endpoints/patch_property_groups_propertygroupid.json +40 -0
- package/dist/catalog-db/endpoints/patch_recurring_charges_recurringchargeid.json +89 -0
- package/dist/catalog-db/endpoints/patch_rental_applications_rentalapplicationid.json +47 -0
- package/dist/catalog-db/endpoints/patch_rental_applications_rentalapplicationid_notes_id.json +46 -0
- package/dist/catalog-db/endpoints/patch_showings_showingid.json +69 -0
- package/dist/catalog-db/endpoints/patch_tenants_bulk.json +131 -0
- package/dist/catalog-db/endpoints/patch_tenants_tenantid.json +48 -0
- package/dist/catalog-db/endpoints/patch_tenants_tenantid_notes_id.json +46 -0
- package/dist/catalog-db/endpoints/patch_unit_types_unittypeid.json +126 -0
- package/dist/catalog-db/endpoints/patch_units_unitid.json +296 -0
- package/dist/catalog-db/endpoints/patch_units_unitid_notes_id.json +46 -0
- package/dist/catalog-db/endpoints/patch_units_unitid_photos_photoid.json +46 -0
- package/dist/catalog-db/endpoints/patch_vendors_vendorid.json +263 -0
- package/dist/catalog-db/endpoints/patch_vendors_vendorid_notes_id.json +46 -0
- package/dist/catalog-db/endpoints/patch_work_orders_workorderid.json +273 -0
- package/dist/catalog-db/endpoints/patch_work_orders_workorderid_notes_id.json +46 -0
- package/dist/catalog-db/endpoints/post_bank_accounts_bulk.json +167 -0
- package/dist/catalog-db/endpoints/post_bills.json +160 -0
- package/dist/catalog-db/endpoints/post_bills_billid_attachments.json +40 -0
- package/dist/catalog-db/endpoints/post_bills_bulk.json +185 -0
- package/dist/catalog-db/endpoints/post_bills_bulk_async.json +192 -0
- package/dist/catalog-db/endpoints/post_ca_violations.json +63 -0
- package/dist/catalog-db/endpoints/post_ca_violations_violationid_attachments.json +41 -0
- package/dist/catalog-db/endpoints/post_charges.json +56 -0
- package/dist/catalog-db/endpoints/post_charges_bulk.json +70 -0
- package/dist/catalog-db/endpoints/post_charges_bulk_async.json +70 -0
- package/dist/catalog-db/endpoints/post_charges_chargeid_attachments.json +40 -0
- package/dist/catalog-db/endpoints/post_corporate_gl_accounts_bulk.json +71 -0
- package/dist/catalog-db/endpoints/post_gl_accounts_bulk.json +77 -0
- package/dist/catalog-db/endpoints/post_inspections.json +70 -0
- package/dist/catalog-db/endpoints/post_inspections_bulk.json +76 -0
- package/dist/catalog-db/endpoints/post_inspections_inspectionid_attachments.json +41 -0
- package/dist/catalog-db/endpoints/post_inventories.json +105 -0
- package/dist/catalog-db/endpoints/post_inventories_bulk.json +119 -0
- package/dist/catalog-db/endpoints/post_inventory_locations.json +44 -0
- package/dist/catalog-db/endpoints/post_inventory_locations_bulk.json +58 -0
- package/dist/catalog-db/endpoints/post_journal_entries.json +101 -0
- package/dist/catalog-db/endpoints/post_journal_entries_bulk.json +115 -0
- package/dist/catalog-db/endpoints/post_journal_entries_journalentryid_attachments.json +41 -0
- package/dist/catalog-db/endpoints/post_late_fee_policies_bulk.json +115 -0
- package/dist/catalog-db/endpoints/post_leads.json +204 -0
- package/dist/catalog-db/endpoints/post_leads_guestcardid_notes.json +40 -0
- package/dist/catalog-db/endpoints/post_occupancies_occupancyid_attachments.json +41 -0
- package/dist/catalog-db/endpoints/post_owner_groups.json +96 -0
- package/dist/catalog-db/endpoints/post_owners.json +330 -0
- package/dist/catalog-db/endpoints/post_owners_bulk.json +203 -0
- package/dist/catalog-db/endpoints/post_owners_ownerid_attachments.json +40 -0
- package/dist/catalog-db/endpoints/post_owners_ownerid_notes.json +40 -0
- package/dist/catalog-db/endpoints/post_properties_bulk.json +245 -0
- package/dist/catalog-db/endpoints/post_properties_propertyid_attachments.json +40 -0
- package/dist/catalog-db/endpoints/post_properties_propertyid_marketing_photos.json +52 -0
- package/dist/catalog-db/endpoints/post_properties_propertyid_notes.json +40 -0
- package/dist/catalog-db/endpoints/post_properties_propertyid_photos.json +40 -0
- package/dist/catalog-db/endpoints/post_recurring_charges.json +81 -0
- package/dist/catalog-db/endpoints/post_recurring_charges_bulk.json +95 -0
- package/dist/catalog-db/endpoints/post_rental_applications_rentalapplicationid_attachments.json +41 -0
- package/dist/catalog-db/endpoints/post_rental_applications_rentalapplicationid_notes.json +40 -0
- package/dist/catalog-db/endpoints/post_showings.json +62 -0
- package/dist/catalog-db/endpoints/post_tenants_bulk.json +161 -0
- package/dist/catalog-db/endpoints/post_tenants_tenantid_notes.json +40 -0
- package/dist/catalog-db/endpoints/post_unit_types_bulk.json +138 -0
- package/dist/catalog-db/endpoints/post_units_bulk.json +236 -0
- package/dist/catalog-db/endpoints/post_units_unitid_attachments.json +40 -0
- package/dist/catalog-db/endpoints/post_units_unitid_notes.json +40 -0
- package/dist/catalog-db/endpoints/post_units_unitid_photos.json +40 -0
- package/dist/catalog-db/endpoints/post_vendors.json +279 -0
- package/dist/catalog-db/endpoints/post_vendors_bulk.json +279 -0
- package/dist/catalog-db/endpoints/post_vendors_vendorid_notes.json +40 -0
- package/dist/catalog-db/endpoints/post_work_orders.json +251 -0
- package/dist/catalog-db/endpoints/post_work_orders_workorderid_attachments.json +41 -0
- package/dist/catalog-db/endpoints/post_work_orders_workorderid_notes.json +40 -0
- package/dist/catalog-db/endpoints/put_leases_renewal_pricings_bulk.json +58 -0
- package/dist/catalog-db/endpoints/put_units_pricing_matrices_bulk.json +58 -0
- package/dist/catalog-db/endpoints/put_units_pricing_matrices_bulk_async.json +46 -0
- package/dist/catalog-db/endpoints/put_units_unitid_pricing_matrices.json +66 -0
- package/dist/catalog-db/index.json +1894 -0
- package/dist/clients/appfolio-client.js +131 -0
- package/dist/clients/appfolio-db-client.js +186 -0
- package/dist/helpers/register-db-tools.js +27 -0
- package/dist/helpers/register-report-tools.js +27 -0
- package/dist/index.js +10 -0
- package/dist/server/appfolio-mcp-server.js +18 -0
- package/dist/tools/call-endpoint.js +109 -0
- package/dist/tools/describe-endpoint.js +63 -0
- package/dist/tools/describe-report.js +55 -0
- package/dist/tools/list-endpoints.js +90 -0
- package/dist/tools/list-reports.js +58 -0
- package/dist/tools/run-report.js +102 -0
- package/package.json +42 -0
|
@@ -0,0 +1,1894 @@
|
|
|
1
|
+
{
|
|
2
|
+
"generatedFrom": "AppFolio Database API.txt",
|
|
3
|
+
"baseUrl": "https://api.appfolio.com/api/v0",
|
|
4
|
+
"endpointCount": 156,
|
|
5
|
+
"paginationParams": [
|
|
6
|
+
"page[number]",
|
|
7
|
+
"page[size]"
|
|
8
|
+
],
|
|
9
|
+
"categories": [
|
|
10
|
+
"Accounting",
|
|
11
|
+
"Community Associations",
|
|
12
|
+
"Corporate Accounting",
|
|
13
|
+
"Custom Fields",
|
|
14
|
+
"Leasing",
|
|
15
|
+
"Maintenance",
|
|
16
|
+
"People",
|
|
17
|
+
"Properties",
|
|
18
|
+
"System"
|
|
19
|
+
],
|
|
20
|
+
"endpoints": [
|
|
21
|
+
{
|
|
22
|
+
"operationId": "get_bank_accounts",
|
|
23
|
+
"resource": "bank_accounts",
|
|
24
|
+
"category": "Accounting",
|
|
25
|
+
"name": "List All Bank Accounts",
|
|
26
|
+
"method": "GET",
|
|
27
|
+
"path": "/bank_accounts",
|
|
28
|
+
"description": "Returns all bank accounts that meet the filter criteria. Hidden and corporate bank accounts are not returned.",
|
|
29
|
+
"writeOperation": false,
|
|
30
|
+
"pagination": true,
|
|
31
|
+
"deprecated": false
|
|
32
|
+
},
|
|
33
|
+
{
|
|
34
|
+
"operationId": "post_bank_accounts_bulk",
|
|
35
|
+
"resource": "bank_accounts",
|
|
36
|
+
"category": "Accounting",
|
|
37
|
+
"name": "Bulk Create Bank Accounts",
|
|
38
|
+
"method": "POST",
|
|
39
|
+
"path": "/bank_accounts/bulk",
|
|
40
|
+
"description": "Create bank accounts in bulk",
|
|
41
|
+
"writeOperation": true,
|
|
42
|
+
"pagination": false,
|
|
43
|
+
"deprecated": false
|
|
44
|
+
},
|
|
45
|
+
{
|
|
46
|
+
"operationId": "get_bills",
|
|
47
|
+
"resource": "bills",
|
|
48
|
+
"category": "Accounting",
|
|
49
|
+
"name": "List All Bills",
|
|
50
|
+
"method": "GET",
|
|
51
|
+
"path": "/bills",
|
|
52
|
+
"description": "Returns all bills that meet the filter criteria",
|
|
53
|
+
"writeOperation": false,
|
|
54
|
+
"pagination": true,
|
|
55
|
+
"deprecated": false
|
|
56
|
+
},
|
|
57
|
+
{
|
|
58
|
+
"operationId": "post_bills",
|
|
59
|
+
"resource": "bills",
|
|
60
|
+
"category": "Accounting",
|
|
61
|
+
"name": "Create Bill",
|
|
62
|
+
"method": "POST",
|
|
63
|
+
"path": "/bills",
|
|
64
|
+
"description": "Create a bill",
|
|
65
|
+
"writeOperation": true,
|
|
66
|
+
"pagination": false,
|
|
67
|
+
"deprecated": false
|
|
68
|
+
},
|
|
69
|
+
{
|
|
70
|
+
"operationId": "patch_bills_billid",
|
|
71
|
+
"resource": "bills",
|
|
72
|
+
"category": "Accounting",
|
|
73
|
+
"name": "Update Bill",
|
|
74
|
+
"method": "PATCH",
|
|
75
|
+
"path": "/bills/{billId}",
|
|
76
|
+
"description": "Update a bill",
|
|
77
|
+
"writeOperation": true,
|
|
78
|
+
"pagination": false,
|
|
79
|
+
"deprecated": false
|
|
80
|
+
},
|
|
81
|
+
{
|
|
82
|
+
"operationId": "post_bills_billid_attachments",
|
|
83
|
+
"resource": "bills",
|
|
84
|
+
"category": "Accounting",
|
|
85
|
+
"name": "Create Bill Attachment",
|
|
86
|
+
"method": "POST",
|
|
87
|
+
"path": "/bills/{BillId}/attachments",
|
|
88
|
+
"description": "Upload an attachment to a bill",
|
|
89
|
+
"writeOperation": true,
|
|
90
|
+
"pagination": false,
|
|
91
|
+
"deprecated": false
|
|
92
|
+
},
|
|
93
|
+
{
|
|
94
|
+
"operationId": "post_bills_bulk",
|
|
95
|
+
"resource": "bills",
|
|
96
|
+
"category": "Accounting",
|
|
97
|
+
"name": "Bulk Create Bills",
|
|
98
|
+
"method": "POST",
|
|
99
|
+
"path": "/bills/bulk",
|
|
100
|
+
"description": "Create multiple bills in bulk",
|
|
101
|
+
"writeOperation": true,
|
|
102
|
+
"pagination": false,
|
|
103
|
+
"deprecated": false
|
|
104
|
+
},
|
|
105
|
+
{
|
|
106
|
+
"operationId": "post_bills_bulk_async",
|
|
107
|
+
"resource": "bills",
|
|
108
|
+
"category": "Accounting",
|
|
109
|
+
"name": "Bulk Create Bills (Async)",
|
|
110
|
+
"method": "POST",
|
|
111
|
+
"path": "/bills/bulk/async",
|
|
112
|
+
"description": "Asynchronously create multiple bills in bulk",
|
|
113
|
+
"writeOperation": true,
|
|
114
|
+
"pagination": false,
|
|
115
|
+
"deprecated": false
|
|
116
|
+
},
|
|
117
|
+
{
|
|
118
|
+
"operationId": "get_charges",
|
|
119
|
+
"resource": "charges",
|
|
120
|
+
"category": "Accounting",
|
|
121
|
+
"name": "List All Charges",
|
|
122
|
+
"method": "GET",
|
|
123
|
+
"path": "/charges",
|
|
124
|
+
"description": "Returns all open charges for all occupants residing at the property.",
|
|
125
|
+
"writeOperation": false,
|
|
126
|
+
"pagination": true,
|
|
127
|
+
"deprecated": false
|
|
128
|
+
},
|
|
129
|
+
{
|
|
130
|
+
"operationId": "post_charges",
|
|
131
|
+
"resource": "charges",
|
|
132
|
+
"category": "Accounting",
|
|
133
|
+
"name": "Create Charges",
|
|
134
|
+
"method": "POST",
|
|
135
|
+
"path": "/charges",
|
|
136
|
+
"description": "Create a single charge.",
|
|
137
|
+
"writeOperation": true,
|
|
138
|
+
"pagination": false,
|
|
139
|
+
"deprecated": false
|
|
140
|
+
},
|
|
141
|
+
{
|
|
142
|
+
"operationId": "post_charges_chargeid_attachments",
|
|
143
|
+
"resource": "charges",
|
|
144
|
+
"category": "Accounting",
|
|
145
|
+
"name": "Create Charge Attachment",
|
|
146
|
+
"method": "POST",
|
|
147
|
+
"path": "/charges/{ChargeId}/attachments",
|
|
148
|
+
"description": "Upload an attachment to a charge.",
|
|
149
|
+
"writeOperation": true,
|
|
150
|
+
"pagination": false,
|
|
151
|
+
"deprecated": false
|
|
152
|
+
},
|
|
153
|
+
{
|
|
154
|
+
"operationId": "post_charges_bulk",
|
|
155
|
+
"resource": "charges",
|
|
156
|
+
"category": "Accounting",
|
|
157
|
+
"name": "Bulk Create Charges",
|
|
158
|
+
"method": "POST",
|
|
159
|
+
"path": "/charges/bulk",
|
|
160
|
+
"description": "Create multiple charges in bulk.",
|
|
161
|
+
"writeOperation": true,
|
|
162
|
+
"pagination": false,
|
|
163
|
+
"deprecated": false
|
|
164
|
+
},
|
|
165
|
+
{
|
|
166
|
+
"operationId": "post_charges_bulk_async",
|
|
167
|
+
"resource": "charges",
|
|
168
|
+
"category": "Accounting",
|
|
169
|
+
"name": "Bulk Create Charges (Async)",
|
|
170
|
+
"method": "POST",
|
|
171
|
+
"path": "/charges/bulk/async",
|
|
172
|
+
"description": "Create multiple charges in bulk asynchronously. Returns a Job ID that can be used to track the status of the job via the Jobs List endpoint.",
|
|
173
|
+
"writeOperation": true,
|
|
174
|
+
"pagination": false,
|
|
175
|
+
"deprecated": false
|
|
176
|
+
},
|
|
177
|
+
{
|
|
178
|
+
"operationId": "get_delinquent_charges",
|
|
179
|
+
"resource": "delinquent_charges",
|
|
180
|
+
"category": "Accounting",
|
|
181
|
+
"name": "List All Delinquent Charges",
|
|
182
|
+
"method": "GET",
|
|
183
|
+
"path": "/delinquent_charges",
|
|
184
|
+
"description": "Returns all delinquent charges that meet the filter criteria",
|
|
185
|
+
"writeOperation": false,
|
|
186
|
+
"pagination": true,
|
|
187
|
+
"deprecated": false
|
|
188
|
+
},
|
|
189
|
+
{
|
|
190
|
+
"operationId": "get_gl_accounts",
|
|
191
|
+
"resource": "gl_accounts",
|
|
192
|
+
"category": "Accounting",
|
|
193
|
+
"name": "List All General Ledger Accounts",
|
|
194
|
+
"method": "GET",
|
|
195
|
+
"path": "/gl_accounts",
|
|
196
|
+
"description": "Returns all General Ledger (GL) accounts that meet the filter criteria",
|
|
197
|
+
"writeOperation": false,
|
|
198
|
+
"pagination": true,
|
|
199
|
+
"deprecated": false
|
|
200
|
+
},
|
|
201
|
+
{
|
|
202
|
+
"operationId": "post_gl_accounts_bulk",
|
|
203
|
+
"resource": "gl_accounts",
|
|
204
|
+
"category": "Accounting",
|
|
205
|
+
"name": "Bulk Create General Ledger Accounts",
|
|
206
|
+
"method": "POST",
|
|
207
|
+
"path": "/gl_accounts/bulk",
|
|
208
|
+
"description": "Create General Ledger Account in bulk",
|
|
209
|
+
"writeOperation": true,
|
|
210
|
+
"pagination": false,
|
|
211
|
+
"deprecated": false
|
|
212
|
+
},
|
|
213
|
+
{
|
|
214
|
+
"operationId": "get_gl_details",
|
|
215
|
+
"resource": "gl_details",
|
|
216
|
+
"category": "Accounting",
|
|
217
|
+
"name": "List All General Ledger Details",
|
|
218
|
+
"method": "GET",
|
|
219
|
+
"path": "/gl_details",
|
|
220
|
+
"description": "Returns all General Ledger (GL) Details that meet the filter criteria",
|
|
221
|
+
"writeOperation": false,
|
|
222
|
+
"pagination": true,
|
|
223
|
+
"deprecated": false
|
|
224
|
+
},
|
|
225
|
+
{
|
|
226
|
+
"operationId": "get_journal_entries",
|
|
227
|
+
"resource": "journal_entries",
|
|
228
|
+
"category": "Accounting",
|
|
229
|
+
"name": "List All Journal Entries",
|
|
230
|
+
"method": "GET",
|
|
231
|
+
"path": "/journal_entries",
|
|
232
|
+
"description": "Returns all journal entries that meet the filter criteria",
|
|
233
|
+
"writeOperation": false,
|
|
234
|
+
"pagination": true,
|
|
235
|
+
"deprecated": false
|
|
236
|
+
},
|
|
237
|
+
{
|
|
238
|
+
"operationId": "post_journal_entries",
|
|
239
|
+
"resource": "journal_entries",
|
|
240
|
+
"category": "Accounting",
|
|
241
|
+
"name": "Create Journal Entries",
|
|
242
|
+
"method": "POST",
|
|
243
|
+
"path": "/journal_entries",
|
|
244
|
+
"description": "Create a journal entry",
|
|
245
|
+
"writeOperation": true,
|
|
246
|
+
"pagination": false,
|
|
247
|
+
"deprecated": false
|
|
248
|
+
},
|
|
249
|
+
{
|
|
250
|
+
"operationId": "patch_journal_entries_journalentryid",
|
|
251
|
+
"resource": "journal_entries",
|
|
252
|
+
"category": "Accounting",
|
|
253
|
+
"name": "Update Journal Entries",
|
|
254
|
+
"method": "PATCH",
|
|
255
|
+
"path": "/journal_entries/{JournalEntryId}",
|
|
256
|
+
"description": "Update a journal entry",
|
|
257
|
+
"writeOperation": true,
|
|
258
|
+
"pagination": false,
|
|
259
|
+
"deprecated": false
|
|
260
|
+
},
|
|
261
|
+
{
|
|
262
|
+
"operationId": "post_journal_entries_journalentryid_attachments",
|
|
263
|
+
"resource": "journal_entries",
|
|
264
|
+
"category": "Accounting",
|
|
265
|
+
"name": "Create Journal Entry Attachment",
|
|
266
|
+
"method": "POST",
|
|
267
|
+
"path": "/journal_entries/{JournalEntryId}/attachments",
|
|
268
|
+
"description": "Upload an attachment to a journal entry",
|
|
269
|
+
"writeOperation": true,
|
|
270
|
+
"pagination": false,
|
|
271
|
+
"deprecated": false
|
|
272
|
+
},
|
|
273
|
+
{
|
|
274
|
+
"operationId": "post_journal_entries_bulk",
|
|
275
|
+
"resource": "journal_entries",
|
|
276
|
+
"category": "Accounting",
|
|
277
|
+
"name": "Bulk Create Journal Entries",
|
|
278
|
+
"method": "POST",
|
|
279
|
+
"path": "/journal_entries/bulk",
|
|
280
|
+
"description": "Create journal entries in bulk",
|
|
281
|
+
"writeOperation": true,
|
|
282
|
+
"pagination": false,
|
|
283
|
+
"deprecated": false
|
|
284
|
+
},
|
|
285
|
+
{
|
|
286
|
+
"operationId": "get_late_fee_policies",
|
|
287
|
+
"resource": "late_fee_policies",
|
|
288
|
+
"category": "Accounting",
|
|
289
|
+
"name": "List All Late Fee Policies",
|
|
290
|
+
"method": "GET",
|
|
291
|
+
"path": "/late_fee_policies",
|
|
292
|
+
"description": "Returns all late fee policies that meet the filter criteria",
|
|
293
|
+
"writeOperation": false,
|
|
294
|
+
"pagination": true,
|
|
295
|
+
"deprecated": false
|
|
296
|
+
},
|
|
297
|
+
{
|
|
298
|
+
"operationId": "post_late_fee_policies_bulk",
|
|
299
|
+
"resource": "late_fee_policies",
|
|
300
|
+
"category": "Accounting",
|
|
301
|
+
"name": "Bulk Create Late Fee Policies",
|
|
302
|
+
"method": "POST",
|
|
303
|
+
"path": "/late_fee_policies/bulk",
|
|
304
|
+
"description": "Create late fee policies in bulk",
|
|
305
|
+
"writeOperation": true,
|
|
306
|
+
"pagination": false,
|
|
307
|
+
"deprecated": false
|
|
308
|
+
},
|
|
309
|
+
{
|
|
310
|
+
"operationId": "get_payables",
|
|
311
|
+
"resource": "payables",
|
|
312
|
+
"category": "Accounting",
|
|
313
|
+
"name": "List All Payables",
|
|
314
|
+
"method": "GET",
|
|
315
|
+
"path": "/payables",
|
|
316
|
+
"description": "Returns all payable bills that meet the filter criteria",
|
|
317
|
+
"writeOperation": false,
|
|
318
|
+
"pagination": true,
|
|
319
|
+
"deprecated": false
|
|
320
|
+
},
|
|
321
|
+
{
|
|
322
|
+
"operationId": "get_recurring_charges",
|
|
323
|
+
"resource": "recurring_charges",
|
|
324
|
+
"category": "Accounting",
|
|
325
|
+
"name": "List All Recurring Charges",
|
|
326
|
+
"method": "GET",
|
|
327
|
+
"path": "/recurring_charges",
|
|
328
|
+
"description": "Returns all recurring charges that meet the filter criteria",
|
|
329
|
+
"writeOperation": false,
|
|
330
|
+
"pagination": true,
|
|
331
|
+
"deprecated": false
|
|
332
|
+
},
|
|
333
|
+
{
|
|
334
|
+
"operationId": "post_recurring_charges",
|
|
335
|
+
"resource": "recurring_charges",
|
|
336
|
+
"category": "Accounting",
|
|
337
|
+
"name": "Create Recurring Charges",
|
|
338
|
+
"method": "POST",
|
|
339
|
+
"path": "/recurring_charges",
|
|
340
|
+
"description": "Create a recurring charge",
|
|
341
|
+
"writeOperation": true,
|
|
342
|
+
"pagination": false,
|
|
343
|
+
"deprecated": false
|
|
344
|
+
},
|
|
345
|
+
{
|
|
346
|
+
"operationId": "patch_recurring_charges_recurringchargeid",
|
|
347
|
+
"resource": "recurring_charges",
|
|
348
|
+
"category": "Accounting",
|
|
349
|
+
"name": "Update Recurring Charges",
|
|
350
|
+
"method": "PATCH",
|
|
351
|
+
"path": "/recurring_charges/{recurringChargeId}",
|
|
352
|
+
"description": "Update a recurring charge",
|
|
353
|
+
"writeOperation": true,
|
|
354
|
+
"pagination": false,
|
|
355
|
+
"deprecated": false
|
|
356
|
+
},
|
|
357
|
+
{
|
|
358
|
+
"operationId": "post_recurring_charges_bulk",
|
|
359
|
+
"resource": "recurring_charges",
|
|
360
|
+
"category": "Accounting",
|
|
361
|
+
"name": "Bulk Create Recurring Charges",
|
|
362
|
+
"method": "POST",
|
|
363
|
+
"path": "/recurring_charges/bulk",
|
|
364
|
+
"description": "Create multiple recurring charges in bulk",
|
|
365
|
+
"writeOperation": true,
|
|
366
|
+
"pagination": false,
|
|
367
|
+
"deprecated": false
|
|
368
|
+
},
|
|
369
|
+
{
|
|
370
|
+
"operationId": "get_tenant_ledgers",
|
|
371
|
+
"resource": "tenant_ledgers",
|
|
372
|
+
"category": "Accounting",
|
|
373
|
+
"name": "List All Tenant Ledgers",
|
|
374
|
+
"method": "GET",
|
|
375
|
+
"path": "/tenant_ledgers",
|
|
376
|
+
"description": "Returns all tenant ledgers that meet the filter criteria",
|
|
377
|
+
"writeOperation": false,
|
|
378
|
+
"pagination": true,
|
|
379
|
+
"deprecated": false
|
|
380
|
+
},
|
|
381
|
+
{
|
|
382
|
+
"operationId": "get_ca_associations",
|
|
383
|
+
"resource": "ca",
|
|
384
|
+
"category": "Community Associations",
|
|
385
|
+
"name": "List All Community Associations",
|
|
386
|
+
"method": "GET",
|
|
387
|
+
"path": "/ca/associations",
|
|
388
|
+
"description": "Returns all Community Associations that meet the filter criteria",
|
|
389
|
+
"writeOperation": false,
|
|
390
|
+
"pagination": true,
|
|
391
|
+
"deprecated": false
|
|
392
|
+
},
|
|
393
|
+
{
|
|
394
|
+
"operationId": "get_ca_bank_balances",
|
|
395
|
+
"resource": "ca",
|
|
396
|
+
"category": "Community Associations",
|
|
397
|
+
"name": "List All Community Association Bank Account Balances",
|
|
398
|
+
"method": "GET",
|
|
399
|
+
"path": "/ca/bank_balances",
|
|
400
|
+
"description": "Returns Community Association (CA) bank account balances that meet the filter criteria",
|
|
401
|
+
"writeOperation": false,
|
|
402
|
+
"pagination": true,
|
|
403
|
+
"deprecated": false
|
|
404
|
+
},
|
|
405
|
+
{
|
|
406
|
+
"operationId": "get_ca_board_members",
|
|
407
|
+
"resource": "ca",
|
|
408
|
+
"category": "Community Associations",
|
|
409
|
+
"name": "List All Community Association Board Members",
|
|
410
|
+
"method": "GET",
|
|
411
|
+
"path": "/ca/board_members",
|
|
412
|
+
"description": "Returns Community Association (CA) Board of Director Member's details that meet the filter criteria",
|
|
413
|
+
"writeOperation": false,
|
|
414
|
+
"pagination": true,
|
|
415
|
+
"deprecated": false
|
|
416
|
+
},
|
|
417
|
+
{
|
|
418
|
+
"operationId": "get_ca_homeowner_ledgers",
|
|
419
|
+
"resource": "ca",
|
|
420
|
+
"category": "Community Associations",
|
|
421
|
+
"name": "List All Community Association Homeowner Ledgers",
|
|
422
|
+
"method": "GET",
|
|
423
|
+
"path": "/ca/homeowner_ledgers",
|
|
424
|
+
"description": "Returns all Community Association ledgers that meet the filter criteria",
|
|
425
|
+
"writeOperation": false,
|
|
426
|
+
"pagination": true,
|
|
427
|
+
"deprecated": false
|
|
428
|
+
},
|
|
429
|
+
{
|
|
430
|
+
"operationId": "get_ca_homeowners",
|
|
431
|
+
"resource": "ca",
|
|
432
|
+
"category": "Community Associations",
|
|
433
|
+
"name": "List All Community Association Homeowners",
|
|
434
|
+
"method": "GET",
|
|
435
|
+
"path": "/ca/homeowners",
|
|
436
|
+
"description": "Returns Community Association (CA) homeowners that meet the filter criteria",
|
|
437
|
+
"writeOperation": false,
|
|
438
|
+
"pagination": true,
|
|
439
|
+
"deprecated": false
|
|
440
|
+
},
|
|
441
|
+
{
|
|
442
|
+
"operationId": "get_ca_renters",
|
|
443
|
+
"resource": "ca",
|
|
444
|
+
"category": "Community Associations",
|
|
445
|
+
"name": "List All Community Association Renters",
|
|
446
|
+
"method": "GET",
|
|
447
|
+
"path": "/ca/renters",
|
|
448
|
+
"description": "Returns Community Association (CA) renters that meet the filter criteria",
|
|
449
|
+
"writeOperation": false,
|
|
450
|
+
"pagination": true,
|
|
451
|
+
"deprecated": false
|
|
452
|
+
},
|
|
453
|
+
{
|
|
454
|
+
"operationId": "get_ca_rules",
|
|
455
|
+
"resource": "ca",
|
|
456
|
+
"category": "Community Associations",
|
|
457
|
+
"name": "List All Community Association Rules",
|
|
458
|
+
"method": "GET",
|
|
459
|
+
"path": "/ca/rules",
|
|
460
|
+
"description": "Returns Community Association (CA) rules that meet the filter criteria",
|
|
461
|
+
"writeOperation": false,
|
|
462
|
+
"pagination": true,
|
|
463
|
+
"deprecated": false
|
|
464
|
+
},
|
|
465
|
+
{
|
|
466
|
+
"operationId": "get_ca_units",
|
|
467
|
+
"resource": "ca",
|
|
468
|
+
"category": "Community Associations",
|
|
469
|
+
"name": "List All Community Association Units",
|
|
470
|
+
"method": "GET",
|
|
471
|
+
"path": "/ca/units",
|
|
472
|
+
"description": "Returns all Community Association (CA) units that meet the filter criteria",
|
|
473
|
+
"writeOperation": false,
|
|
474
|
+
"pagination": true,
|
|
475
|
+
"deprecated": false
|
|
476
|
+
},
|
|
477
|
+
{
|
|
478
|
+
"operationId": "get_ca_violations",
|
|
479
|
+
"resource": "ca",
|
|
480
|
+
"category": "Community Associations",
|
|
481
|
+
"name": "List All Community Association Violations",
|
|
482
|
+
"method": "GET",
|
|
483
|
+
"path": "/ca/violations",
|
|
484
|
+
"description": "Returns Community Association (CA) violations that meet the filter criteria",
|
|
485
|
+
"writeOperation": false,
|
|
486
|
+
"pagination": true,
|
|
487
|
+
"deprecated": false
|
|
488
|
+
},
|
|
489
|
+
{
|
|
490
|
+
"operationId": "post_ca_violations",
|
|
491
|
+
"resource": "ca",
|
|
492
|
+
"category": "Community Associations",
|
|
493
|
+
"name": "Create Community Association Violations",
|
|
494
|
+
"method": "POST",
|
|
495
|
+
"path": "/ca/violations",
|
|
496
|
+
"description": "Create a Community Association (CA) Violation",
|
|
497
|
+
"writeOperation": true,
|
|
498
|
+
"pagination": false,
|
|
499
|
+
"deprecated": false
|
|
500
|
+
},
|
|
501
|
+
{
|
|
502
|
+
"operationId": "patch_ca_violations_violationid",
|
|
503
|
+
"resource": "ca",
|
|
504
|
+
"category": "Community Associations",
|
|
505
|
+
"name": "Update Community Association Violations",
|
|
506
|
+
"method": "PATCH",
|
|
507
|
+
"path": "/ca/violations/{violationId}",
|
|
508
|
+
"description": "Update a Community Association (CA) Violation",
|
|
509
|
+
"writeOperation": true,
|
|
510
|
+
"pagination": false,
|
|
511
|
+
"deprecated": false
|
|
512
|
+
},
|
|
513
|
+
{
|
|
514
|
+
"operationId": "post_ca_violations_violationid_attachments",
|
|
515
|
+
"resource": "ca",
|
|
516
|
+
"category": "Community Associations",
|
|
517
|
+
"name": "Create Community Association Violations Attachment",
|
|
518
|
+
"method": "POST",
|
|
519
|
+
"path": "/ca/violations/{violationId}/attachments",
|
|
520
|
+
"description": "Create Community Association (CA) Violations Attachment",
|
|
521
|
+
"writeOperation": true,
|
|
522
|
+
"pagination": false,
|
|
523
|
+
"deprecated": false
|
|
524
|
+
},
|
|
525
|
+
{
|
|
526
|
+
"operationId": "post_corporate_gl_accounts_bulk",
|
|
527
|
+
"resource": "corporate",
|
|
528
|
+
"category": "Corporate Accounting",
|
|
529
|
+
"name": "Bulk Create Corporate General Ledger Accounts",
|
|
530
|
+
"method": "POST",
|
|
531
|
+
"path": "/corporate/gl_accounts/bulk",
|
|
532
|
+
"description": "Create Corporate General Ledger Account in bulk",
|
|
533
|
+
"writeOperation": true,
|
|
534
|
+
"pagination": false,
|
|
535
|
+
"deprecated": false
|
|
536
|
+
},
|
|
537
|
+
{
|
|
538
|
+
"operationId": "get_corporate_entities",
|
|
539
|
+
"resource": "corporate_entities",
|
|
540
|
+
"category": "Corporate Accounting",
|
|
541
|
+
"name": "List All Corporate Entities",
|
|
542
|
+
"method": "GET",
|
|
543
|
+
"path": "/corporate_entities",
|
|
544
|
+
"description": "Returns all corporate entities that meet the filter criteria. Corporate entities represent properties with PropertyType = \"Corporate\" used for corporate accounting purposes.",
|
|
545
|
+
"writeOperation": false,
|
|
546
|
+
"pagination": true,
|
|
547
|
+
"deprecated": false
|
|
548
|
+
},
|
|
549
|
+
{
|
|
550
|
+
"operationId": "get_custom_fields",
|
|
551
|
+
"resource": "custom_fields",
|
|
552
|
+
"category": "Custom Fields",
|
|
553
|
+
"name": "List All Custom Fields",
|
|
554
|
+
"method": "GET",
|
|
555
|
+
"path": "/custom_fields",
|
|
556
|
+
"description": "Returns all custom fields that meet the filter criteria",
|
|
557
|
+
"writeOperation": false,
|
|
558
|
+
"pagination": true,
|
|
559
|
+
"deprecated": false
|
|
560
|
+
},
|
|
561
|
+
{
|
|
562
|
+
"operationId": "get_leads",
|
|
563
|
+
"resource": "leads",
|
|
564
|
+
"category": "Leasing",
|
|
565
|
+
"name": "List All Leads",
|
|
566
|
+
"method": "GET",
|
|
567
|
+
"path": "/leads",
|
|
568
|
+
"description": "Returns all leads that meet the filter criteria",
|
|
569
|
+
"writeOperation": false,
|
|
570
|
+
"pagination": true,
|
|
571
|
+
"deprecated": false
|
|
572
|
+
},
|
|
573
|
+
{
|
|
574
|
+
"operationId": "post_leads",
|
|
575
|
+
"resource": "leads",
|
|
576
|
+
"category": "Leasing",
|
|
577
|
+
"name": "Create Leads",
|
|
578
|
+
"method": "POST",
|
|
579
|
+
"path": "/leads",
|
|
580
|
+
"description": "Create a lead",
|
|
581
|
+
"writeOperation": true,
|
|
582
|
+
"pagination": false,
|
|
583
|
+
"deprecated": false
|
|
584
|
+
},
|
|
585
|
+
{
|
|
586
|
+
"operationId": "post_leads_guestcardid_notes",
|
|
587
|
+
"resource": "leads",
|
|
588
|
+
"category": "Leasing",
|
|
589
|
+
"name": "Create Lead Note",
|
|
590
|
+
"method": "POST",
|
|
591
|
+
"path": "/leads/{GuestCardId}/notes",
|
|
592
|
+
"description": "Add a note to a lead",
|
|
593
|
+
"writeOperation": true,
|
|
594
|
+
"pagination": false,
|
|
595
|
+
"deprecated": false
|
|
596
|
+
},
|
|
597
|
+
{
|
|
598
|
+
"operationId": "patch_leads_guestcardid_notes_id",
|
|
599
|
+
"resource": "leads",
|
|
600
|
+
"category": "Leasing",
|
|
601
|
+
"name": "Update Lead Note",
|
|
602
|
+
"method": "PATCH",
|
|
603
|
+
"path": "/leads/{GuestCardId}/notes/{Id}",
|
|
604
|
+
"description": "Update a note to a lead",
|
|
605
|
+
"writeOperation": true,
|
|
606
|
+
"pagination": false,
|
|
607
|
+
"deprecated": false
|
|
608
|
+
},
|
|
609
|
+
{
|
|
610
|
+
"operationId": "patch_leads_leadid",
|
|
611
|
+
"resource": "leads",
|
|
612
|
+
"category": "Leasing",
|
|
613
|
+
"name": "Update Lead",
|
|
614
|
+
"method": "PATCH",
|
|
615
|
+
"path": "/leads/{leadId}",
|
|
616
|
+
"description": "Update a lead",
|
|
617
|
+
"writeOperation": true,
|
|
618
|
+
"pagination": false,
|
|
619
|
+
"deprecated": false
|
|
620
|
+
},
|
|
621
|
+
{
|
|
622
|
+
"operationId": "get_leads_notes",
|
|
623
|
+
"resource": "leads",
|
|
624
|
+
"category": "Leasing",
|
|
625
|
+
"name": "List All Leads Notes",
|
|
626
|
+
"method": "GET",
|
|
627
|
+
"path": "/leads/notes",
|
|
628
|
+
"description": "Returns all notes for a lead that meet the filter criteria",
|
|
629
|
+
"writeOperation": false,
|
|
630
|
+
"pagination": true,
|
|
631
|
+
"deprecated": false
|
|
632
|
+
},
|
|
633
|
+
{
|
|
634
|
+
"operationId": "get_leases",
|
|
635
|
+
"resource": "leases",
|
|
636
|
+
"category": "Leasing",
|
|
637
|
+
"name": "List All Leases",
|
|
638
|
+
"method": "GET",
|
|
639
|
+
"path": "/leases",
|
|
640
|
+
"description": "Returns all leases that meet the filter criteria",
|
|
641
|
+
"writeOperation": false,
|
|
642
|
+
"pagination": true,
|
|
643
|
+
"deprecated": false
|
|
644
|
+
},
|
|
645
|
+
{
|
|
646
|
+
"operationId": "patch_leases_leaseid",
|
|
647
|
+
"resource": "leases",
|
|
648
|
+
"category": "Leasing",
|
|
649
|
+
"name": "Update Lease",
|
|
650
|
+
"method": "PATCH",
|
|
651
|
+
"path": "/leases/{LeaseId}",
|
|
652
|
+
"description": "Update a lease. Note: IsMtm and EndOn are mutually exclusive and cannot be set in the same request.",
|
|
653
|
+
"writeOperation": true,
|
|
654
|
+
"pagination": false,
|
|
655
|
+
"deprecated": false
|
|
656
|
+
},
|
|
657
|
+
{
|
|
658
|
+
"operationId": "get_leases_renewal_pricings",
|
|
659
|
+
"resource": "leases",
|
|
660
|
+
"category": "Leasing",
|
|
661
|
+
"name": "List All Lease Renewal Pricings",
|
|
662
|
+
"method": "GET",
|
|
663
|
+
"path": "/leases/renewal_pricings",
|
|
664
|
+
"description": "Returns all lease renewal pricing options that meet the filter criteria",
|
|
665
|
+
"writeOperation": false,
|
|
666
|
+
"pagination": true,
|
|
667
|
+
"deprecated": false
|
|
668
|
+
},
|
|
669
|
+
{
|
|
670
|
+
"operationId": "put_leases_renewal_pricings_bulk",
|
|
671
|
+
"resource": "leases",
|
|
672
|
+
"category": "Leasing",
|
|
673
|
+
"name": "Bulk Put Lease Renewal Pricings",
|
|
674
|
+
"method": "PUT",
|
|
675
|
+
"path": "/leases/renewal_pricings/bulk",
|
|
676
|
+
"description": "Update approved renewal pricing options for leases in bulk",
|
|
677
|
+
"writeOperation": true,
|
|
678
|
+
"pagination": false,
|
|
679
|
+
"deprecated": false
|
|
680
|
+
},
|
|
681
|
+
{
|
|
682
|
+
"operationId": "get_listings",
|
|
683
|
+
"resource": "listings",
|
|
684
|
+
"category": "Leasing",
|
|
685
|
+
"name": "List All Listings",
|
|
686
|
+
"method": "GET",
|
|
687
|
+
"path": "/listings",
|
|
688
|
+
"description": "Returns all units that are not manually excluded, have no active occupancy with a move-out, notice, or move-in date, are currently advertised on the website or external listing platforms, and satisfy the filter criteria.",
|
|
689
|
+
"writeOperation": false,
|
|
690
|
+
"pagination": true,
|
|
691
|
+
"deprecated": false
|
|
692
|
+
},
|
|
693
|
+
{
|
|
694
|
+
"operationId": "get_rental_applications",
|
|
695
|
+
"resource": "rental_applications",
|
|
696
|
+
"category": "Leasing",
|
|
697
|
+
"name": "List All Rental Applications",
|
|
698
|
+
"method": "GET",
|
|
699
|
+
"path": "/rental_applications",
|
|
700
|
+
"description": "Returns all rental applications that meet the filter criteria",
|
|
701
|
+
"writeOperation": false,
|
|
702
|
+
"pagination": true,
|
|
703
|
+
"deprecated": false
|
|
704
|
+
},
|
|
705
|
+
{
|
|
706
|
+
"operationId": "patch_rental_applications_rentalapplicationid",
|
|
707
|
+
"resource": "rental_applications",
|
|
708
|
+
"category": "Leasing",
|
|
709
|
+
"name": "Update Rental Application",
|
|
710
|
+
"method": "PATCH",
|
|
711
|
+
"path": "/rental_applications/{rentalApplicationId}",
|
|
712
|
+
"description": "Update a rental application",
|
|
713
|
+
"writeOperation": true,
|
|
714
|
+
"pagination": false,
|
|
715
|
+
"deprecated": false
|
|
716
|
+
},
|
|
717
|
+
{
|
|
718
|
+
"operationId": "post_rental_applications_rentalapplicationid_attachments",
|
|
719
|
+
"resource": "rental_applications",
|
|
720
|
+
"category": "Leasing",
|
|
721
|
+
"name": "Create Rental Application Attachment",
|
|
722
|
+
"method": "POST",
|
|
723
|
+
"path": "/rental_applications/{RentalApplicationId}/attachments",
|
|
724
|
+
"description": "Add an attachment to a rental application",
|
|
725
|
+
"writeOperation": true,
|
|
726
|
+
"pagination": false,
|
|
727
|
+
"deprecated": false
|
|
728
|
+
},
|
|
729
|
+
{
|
|
730
|
+
"operationId": "post_rental_applications_rentalapplicationid_notes",
|
|
731
|
+
"resource": "rental_applications",
|
|
732
|
+
"category": "Leasing",
|
|
733
|
+
"name": "Create Rental Application Note",
|
|
734
|
+
"method": "POST",
|
|
735
|
+
"path": "/rental_applications/{RentalApplicationId}/notes",
|
|
736
|
+
"description": "Add a note to a rental application",
|
|
737
|
+
"writeOperation": true,
|
|
738
|
+
"pagination": false,
|
|
739
|
+
"deprecated": false
|
|
740
|
+
},
|
|
741
|
+
{
|
|
742
|
+
"operationId": "patch_rental_applications_rentalapplicationid_notes_id",
|
|
743
|
+
"resource": "rental_applications",
|
|
744
|
+
"category": "Leasing",
|
|
745
|
+
"name": "Update Rental Application Note",
|
|
746
|
+
"method": "PATCH",
|
|
747
|
+
"path": "/rental_applications/{RentalApplicationId}/notes/{Id}",
|
|
748
|
+
"description": "Update a note to a rental application",
|
|
749
|
+
"writeOperation": true,
|
|
750
|
+
"pagination": false,
|
|
751
|
+
"deprecated": false
|
|
752
|
+
},
|
|
753
|
+
{
|
|
754
|
+
"operationId": "get_rental_applications_notes",
|
|
755
|
+
"resource": "rental_applications",
|
|
756
|
+
"category": "Leasing",
|
|
757
|
+
"name": "List All Rental Applications Notes",
|
|
758
|
+
"method": "GET",
|
|
759
|
+
"path": "/rental_applications/notes",
|
|
760
|
+
"description": "Returns all rental applications notes that meet the filter criteria",
|
|
761
|
+
"writeOperation": false,
|
|
762
|
+
"pagination": true,
|
|
763
|
+
"deprecated": false
|
|
764
|
+
},
|
|
765
|
+
{
|
|
766
|
+
"operationId": "get_showings",
|
|
767
|
+
"resource": "showings",
|
|
768
|
+
"category": "Leasing",
|
|
769
|
+
"name": "List All Showings",
|
|
770
|
+
"method": "GET",
|
|
771
|
+
"path": "/showings",
|
|
772
|
+
"description": "Returns all showings that meet the filter criteria",
|
|
773
|
+
"writeOperation": false,
|
|
774
|
+
"pagination": true,
|
|
775
|
+
"deprecated": false
|
|
776
|
+
},
|
|
777
|
+
{
|
|
778
|
+
"operationId": "post_showings",
|
|
779
|
+
"resource": "showings",
|
|
780
|
+
"category": "Leasing",
|
|
781
|
+
"name": "Create Showings",
|
|
782
|
+
"method": "POST",
|
|
783
|
+
"path": "/showings",
|
|
784
|
+
"description": "Create a showing",
|
|
785
|
+
"writeOperation": true,
|
|
786
|
+
"pagination": false,
|
|
787
|
+
"deprecated": false
|
|
788
|
+
},
|
|
789
|
+
{
|
|
790
|
+
"operationId": "patch_showings_showingid",
|
|
791
|
+
"resource": "showings",
|
|
792
|
+
"category": "Leasing",
|
|
793
|
+
"name": "Update Showing",
|
|
794
|
+
"method": "PATCH",
|
|
795
|
+
"path": "/showings/{showingId}",
|
|
796
|
+
"description": "Update a showing",
|
|
797
|
+
"writeOperation": true,
|
|
798
|
+
"pagination": false,
|
|
799
|
+
"deprecated": false
|
|
800
|
+
},
|
|
801
|
+
{
|
|
802
|
+
"operationId": "post_inspections",
|
|
803
|
+
"resource": "inspections",
|
|
804
|
+
"category": "Maintenance",
|
|
805
|
+
"name": "Create Inspection",
|
|
806
|
+
"method": "POST",
|
|
807
|
+
"path": "/inspections",
|
|
808
|
+
"description": "Create a new inspection",
|
|
809
|
+
"writeOperation": true,
|
|
810
|
+
"pagination": false,
|
|
811
|
+
"deprecated": false
|
|
812
|
+
},
|
|
813
|
+
{
|
|
814
|
+
"operationId": "delete_inspections_inspectionid",
|
|
815
|
+
"resource": "inspections",
|
|
816
|
+
"category": "Maintenance",
|
|
817
|
+
"name": "Delete Inspection",
|
|
818
|
+
"method": "DELETE",
|
|
819
|
+
"path": "/inspections/{InspectionId}",
|
|
820
|
+
"description": "Delete an inspection record",
|
|
821
|
+
"writeOperation": true,
|
|
822
|
+
"pagination": false,
|
|
823
|
+
"deprecated": false
|
|
824
|
+
},
|
|
825
|
+
{
|
|
826
|
+
"operationId": "patch_inspections_inspectionid",
|
|
827
|
+
"resource": "inspections",
|
|
828
|
+
"category": "Maintenance",
|
|
829
|
+
"name": "Update Inspection",
|
|
830
|
+
"method": "PATCH",
|
|
831
|
+
"path": "/inspections/{InspectionId}",
|
|
832
|
+
"description": "Update an inspection record",
|
|
833
|
+
"writeOperation": true,
|
|
834
|
+
"pagination": false,
|
|
835
|
+
"deprecated": false
|
|
836
|
+
},
|
|
837
|
+
{
|
|
838
|
+
"operationId": "post_inspections_inspectionid_attachments",
|
|
839
|
+
"resource": "inspections",
|
|
840
|
+
"category": "Maintenance",
|
|
841
|
+
"name": "Create Inspection Attachment",
|
|
842
|
+
"method": "POST",
|
|
843
|
+
"path": "/inspections/{InspectionId}/attachments",
|
|
844
|
+
"description": "Upload an attachment to a inspection",
|
|
845
|
+
"writeOperation": true,
|
|
846
|
+
"pagination": false,
|
|
847
|
+
"deprecated": false
|
|
848
|
+
},
|
|
849
|
+
{
|
|
850
|
+
"operationId": "post_inspections_bulk",
|
|
851
|
+
"resource": "inspections",
|
|
852
|
+
"category": "Maintenance",
|
|
853
|
+
"name": "Bulk Create Inspections",
|
|
854
|
+
"method": "POST",
|
|
855
|
+
"path": "/inspections/bulk",
|
|
856
|
+
"description": "Create Inspection in bulk",
|
|
857
|
+
"writeOperation": true,
|
|
858
|
+
"pagination": false,
|
|
859
|
+
"deprecated": false
|
|
860
|
+
},
|
|
861
|
+
{
|
|
862
|
+
"operationId": "get_inventories",
|
|
863
|
+
"resource": "inventories",
|
|
864
|
+
"category": "Maintenance",
|
|
865
|
+
"name": "List All Inventories",
|
|
866
|
+
"method": "GET",
|
|
867
|
+
"path": "/inventories",
|
|
868
|
+
"description": "Returns all inventory items that meet the filter criteria",
|
|
869
|
+
"writeOperation": false,
|
|
870
|
+
"pagination": true,
|
|
871
|
+
"deprecated": false
|
|
872
|
+
},
|
|
873
|
+
{
|
|
874
|
+
"operationId": "post_inventories",
|
|
875
|
+
"resource": "inventories",
|
|
876
|
+
"category": "Maintenance",
|
|
877
|
+
"name": "Create Inventory",
|
|
878
|
+
"method": "POST",
|
|
879
|
+
"path": "/inventories",
|
|
880
|
+
"description": "Create a new inventory item",
|
|
881
|
+
"writeOperation": true,
|
|
882
|
+
"pagination": false,
|
|
883
|
+
"deprecated": false
|
|
884
|
+
},
|
|
885
|
+
{
|
|
886
|
+
"operationId": "delete_inventories_id",
|
|
887
|
+
"resource": "inventories",
|
|
888
|
+
"category": "Maintenance",
|
|
889
|
+
"name": "Delete Inventory",
|
|
890
|
+
"method": "DELETE",
|
|
891
|
+
"path": "/inventories/{Id}",
|
|
892
|
+
"description": "Delete an inventory item",
|
|
893
|
+
"writeOperation": true,
|
|
894
|
+
"pagination": false,
|
|
895
|
+
"deprecated": false
|
|
896
|
+
},
|
|
897
|
+
{
|
|
898
|
+
"operationId": "patch_inventories_id",
|
|
899
|
+
"resource": "inventories",
|
|
900
|
+
"category": "Maintenance",
|
|
901
|
+
"name": "Update Inventory",
|
|
902
|
+
"method": "PATCH",
|
|
903
|
+
"path": "/inventories/{Id}",
|
|
904
|
+
"description": "Update an inventory item. At least one attribute or relationship must be provided.",
|
|
905
|
+
"writeOperation": true,
|
|
906
|
+
"pagination": false,
|
|
907
|
+
"deprecated": false
|
|
908
|
+
},
|
|
909
|
+
{
|
|
910
|
+
"operationId": "post_inventories_bulk",
|
|
911
|
+
"resource": "inventories",
|
|
912
|
+
"category": "Maintenance",
|
|
913
|
+
"name": "Bulk Create Inventories",
|
|
914
|
+
"method": "POST",
|
|
915
|
+
"path": "/inventories/bulk",
|
|
916
|
+
"description": "Create inventory items in bulk. Returns a JobId that can be used to retrieve the results of the bulk creation.",
|
|
917
|
+
"writeOperation": true,
|
|
918
|
+
"pagination": false,
|
|
919
|
+
"deprecated": false
|
|
920
|
+
},
|
|
921
|
+
{
|
|
922
|
+
"operationId": "get_inventory_locations",
|
|
923
|
+
"resource": "inventory_locations",
|
|
924
|
+
"category": "Maintenance",
|
|
925
|
+
"name": "List All Inventory Locations",
|
|
926
|
+
"method": "GET",
|
|
927
|
+
"path": "/inventory_locations",
|
|
928
|
+
"description": "Returns all inventory locations that meet the filter criteria",
|
|
929
|
+
"writeOperation": false,
|
|
930
|
+
"pagination": true,
|
|
931
|
+
"deprecated": false
|
|
932
|
+
},
|
|
933
|
+
{
|
|
934
|
+
"operationId": "post_inventory_locations",
|
|
935
|
+
"resource": "inventory_locations",
|
|
936
|
+
"category": "Maintenance",
|
|
937
|
+
"name": "Create an Inventory Location",
|
|
938
|
+
"method": "POST",
|
|
939
|
+
"path": "/inventory_locations",
|
|
940
|
+
"description": "Creates a new inventory location",
|
|
941
|
+
"writeOperation": true,
|
|
942
|
+
"pagination": false,
|
|
943
|
+
"deprecated": false
|
|
944
|
+
},
|
|
945
|
+
{
|
|
946
|
+
"operationId": "patch_inventory_locations_id",
|
|
947
|
+
"resource": "inventory_locations",
|
|
948
|
+
"category": "Maintenance",
|
|
949
|
+
"name": "Update Inventory Location",
|
|
950
|
+
"method": "PATCH",
|
|
951
|
+
"path": "/inventory_locations/{Id}",
|
|
952
|
+
"description": "Update an inventory location. At least one attribute or relationship must be provided.",
|
|
953
|
+
"writeOperation": true,
|
|
954
|
+
"pagination": false,
|
|
955
|
+
"deprecated": false
|
|
956
|
+
},
|
|
957
|
+
{
|
|
958
|
+
"operationId": "post_inventory_locations_bulk",
|
|
959
|
+
"resource": "inventory_locations",
|
|
960
|
+
"category": "Maintenance",
|
|
961
|
+
"name": "Bulk Create Inventory Locations",
|
|
962
|
+
"method": "POST",
|
|
963
|
+
"path": "/inventory_locations/bulk",
|
|
964
|
+
"description": "Create inventory locations in bulk",
|
|
965
|
+
"writeOperation": true,
|
|
966
|
+
"pagination": false,
|
|
967
|
+
"deprecated": false
|
|
968
|
+
},
|
|
969
|
+
{
|
|
970
|
+
"operationId": "get_vendors",
|
|
971
|
+
"resource": "vendors",
|
|
972
|
+
"category": "Maintenance",
|
|
973
|
+
"name": "List All Vendors",
|
|
974
|
+
"method": "GET",
|
|
975
|
+
"path": "/vendors",
|
|
976
|
+
"description": "Returns all vendors that meet the filter criteria",
|
|
977
|
+
"writeOperation": false,
|
|
978
|
+
"pagination": true,
|
|
979
|
+
"deprecated": false
|
|
980
|
+
},
|
|
981
|
+
{
|
|
982
|
+
"operationId": "post_vendors",
|
|
983
|
+
"resource": "vendors",
|
|
984
|
+
"category": "Maintenance",
|
|
985
|
+
"name": "Create Vendor",
|
|
986
|
+
"method": "POST",
|
|
987
|
+
"path": "/vendors",
|
|
988
|
+
"description": "Create a vendor",
|
|
989
|
+
"writeOperation": true,
|
|
990
|
+
"pagination": false,
|
|
991
|
+
"deprecated": false
|
|
992
|
+
},
|
|
993
|
+
{
|
|
994
|
+
"operationId": "patch_vendors_vendorid",
|
|
995
|
+
"resource": "vendors",
|
|
996
|
+
"category": "Maintenance",
|
|
997
|
+
"name": "Update Vendor",
|
|
998
|
+
"method": "PATCH",
|
|
999
|
+
"path": "/vendors/{vendorId}",
|
|
1000
|
+
"description": "Update a vendor.",
|
|
1001
|
+
"writeOperation": true,
|
|
1002
|
+
"pagination": false,
|
|
1003
|
+
"deprecated": false
|
|
1004
|
+
},
|
|
1005
|
+
{
|
|
1006
|
+
"operationId": "post_vendors_vendorid_notes",
|
|
1007
|
+
"resource": "vendors",
|
|
1008
|
+
"category": "Maintenance",
|
|
1009
|
+
"name": "Create Vendor Note",
|
|
1010
|
+
"method": "POST",
|
|
1011
|
+
"path": "/vendors/{VendorId}/notes",
|
|
1012
|
+
"description": "Add a note to a vendor",
|
|
1013
|
+
"writeOperation": true,
|
|
1014
|
+
"pagination": false,
|
|
1015
|
+
"deprecated": false
|
|
1016
|
+
},
|
|
1017
|
+
{
|
|
1018
|
+
"operationId": "patch_vendors_vendorid_notes_id",
|
|
1019
|
+
"resource": "vendors",
|
|
1020
|
+
"category": "Maintenance",
|
|
1021
|
+
"name": "Update Vendor Note",
|
|
1022
|
+
"method": "PATCH",
|
|
1023
|
+
"path": "/vendors/{VendorId}/notes/{Id}",
|
|
1024
|
+
"description": "Update a note to a vendor",
|
|
1025
|
+
"writeOperation": true,
|
|
1026
|
+
"pagination": false,
|
|
1027
|
+
"deprecated": false
|
|
1028
|
+
},
|
|
1029
|
+
{
|
|
1030
|
+
"operationId": "post_vendors_bulk",
|
|
1031
|
+
"resource": "vendors",
|
|
1032
|
+
"category": "Maintenance",
|
|
1033
|
+
"name": "Bulk Create Vendors",
|
|
1034
|
+
"method": "POST",
|
|
1035
|
+
"path": "/vendors/bulk",
|
|
1036
|
+
"description": "Create vendors in bulk",
|
|
1037
|
+
"writeOperation": true,
|
|
1038
|
+
"pagination": false,
|
|
1039
|
+
"deprecated": false
|
|
1040
|
+
},
|
|
1041
|
+
{
|
|
1042
|
+
"operationId": "get_vendors_notes",
|
|
1043
|
+
"resource": "vendors",
|
|
1044
|
+
"category": "Maintenance",
|
|
1045
|
+
"name": "List All Vendors Notes",
|
|
1046
|
+
"method": "GET",
|
|
1047
|
+
"path": "/vendors/notes",
|
|
1048
|
+
"description": "Returns all vendor notes that meet the filter criteria",
|
|
1049
|
+
"writeOperation": false,
|
|
1050
|
+
"pagination": true,
|
|
1051
|
+
"deprecated": false
|
|
1052
|
+
},
|
|
1053
|
+
{
|
|
1054
|
+
"operationId": "get_work_orders",
|
|
1055
|
+
"resource": "work_orders",
|
|
1056
|
+
"category": "Maintenance",
|
|
1057
|
+
"name": "List All Work Orders",
|
|
1058
|
+
"method": "GET",
|
|
1059
|
+
"path": "/work_orders",
|
|
1060
|
+
"description": "Returns all work orders that meet the filter criteria",
|
|
1061
|
+
"writeOperation": false,
|
|
1062
|
+
"pagination": true,
|
|
1063
|
+
"deprecated": false
|
|
1064
|
+
},
|
|
1065
|
+
{
|
|
1066
|
+
"operationId": "post_work_orders",
|
|
1067
|
+
"resource": "work_orders",
|
|
1068
|
+
"category": "Maintenance",
|
|
1069
|
+
"name": "Create Work Orders",
|
|
1070
|
+
"method": "POST",
|
|
1071
|
+
"path": "/work_orders",
|
|
1072
|
+
"description": "Create a work order which belongs to a property, unit, occupancy, or inspection",
|
|
1073
|
+
"writeOperation": true,
|
|
1074
|
+
"pagination": false,
|
|
1075
|
+
"deprecated": false
|
|
1076
|
+
},
|
|
1077
|
+
{
|
|
1078
|
+
"operationId": "patch_work_orders_workorderid",
|
|
1079
|
+
"resource": "work_orders",
|
|
1080
|
+
"category": "Maintenance",
|
|
1081
|
+
"name": "Update Work Order",
|
|
1082
|
+
"method": "PATCH",
|
|
1083
|
+
"path": "/work_orders/{workOrderId}",
|
|
1084
|
+
"description": "Update a work order",
|
|
1085
|
+
"writeOperation": true,
|
|
1086
|
+
"pagination": false,
|
|
1087
|
+
"deprecated": false
|
|
1088
|
+
},
|
|
1089
|
+
{
|
|
1090
|
+
"operationId": "post_work_orders_workorderid_attachments",
|
|
1091
|
+
"resource": "work_orders",
|
|
1092
|
+
"category": "Maintenance",
|
|
1093
|
+
"name": "Create Work Order Attachment",
|
|
1094
|
+
"method": "POST",
|
|
1095
|
+
"path": "/work_orders/{WorkOrderId}/attachments",
|
|
1096
|
+
"description": "Upload an attachment to a work order",
|
|
1097
|
+
"writeOperation": true,
|
|
1098
|
+
"pagination": false,
|
|
1099
|
+
"deprecated": false
|
|
1100
|
+
},
|
|
1101
|
+
{
|
|
1102
|
+
"operationId": "delete_work_orders_workorderid_attachments_attachmentid",
|
|
1103
|
+
"resource": "work_orders",
|
|
1104
|
+
"category": "Maintenance",
|
|
1105
|
+
"name": "Delete Work Order Attachment",
|
|
1106
|
+
"method": "DELETE",
|
|
1107
|
+
"path": "/work_orders/{WorkOrderId}/attachments/{AttachmentId}",
|
|
1108
|
+
"description": "Delete an attachment from a work order",
|
|
1109
|
+
"writeOperation": true,
|
|
1110
|
+
"pagination": false,
|
|
1111
|
+
"deprecated": false
|
|
1112
|
+
},
|
|
1113
|
+
{
|
|
1114
|
+
"operationId": "post_work_orders_workorderid_notes",
|
|
1115
|
+
"resource": "work_orders",
|
|
1116
|
+
"category": "Maintenance",
|
|
1117
|
+
"name": "Create Work Order Note",
|
|
1118
|
+
"method": "POST",
|
|
1119
|
+
"path": "/work_orders/{WorkOrderId}/notes",
|
|
1120
|
+
"description": "Add a note to a work order",
|
|
1121
|
+
"writeOperation": true,
|
|
1122
|
+
"pagination": false,
|
|
1123
|
+
"deprecated": false
|
|
1124
|
+
},
|
|
1125
|
+
{
|
|
1126
|
+
"operationId": "patch_work_orders_workorderid_notes_id",
|
|
1127
|
+
"resource": "work_orders",
|
|
1128
|
+
"category": "Maintenance",
|
|
1129
|
+
"name": "Update Work Order Note",
|
|
1130
|
+
"method": "PATCH",
|
|
1131
|
+
"path": "/work_orders/{WorkOrderId}/notes/{Id}",
|
|
1132
|
+
"description": "Update a work order's note",
|
|
1133
|
+
"writeOperation": true,
|
|
1134
|
+
"pagination": false,
|
|
1135
|
+
"deprecated": false
|
|
1136
|
+
},
|
|
1137
|
+
{
|
|
1138
|
+
"operationId": "get_work_orders_attachments",
|
|
1139
|
+
"resource": "work_orders",
|
|
1140
|
+
"category": "Maintenance",
|
|
1141
|
+
"name": "List All Work Order Attachments",
|
|
1142
|
+
"method": "GET",
|
|
1143
|
+
"path": "/work_orders/attachments",
|
|
1144
|
+
"description": "Returns all attachments associated with a work order",
|
|
1145
|
+
"writeOperation": false,
|
|
1146
|
+
"pagination": true,
|
|
1147
|
+
"deprecated": false
|
|
1148
|
+
},
|
|
1149
|
+
{
|
|
1150
|
+
"operationId": "get_owner_groups",
|
|
1151
|
+
"resource": "owner_groups",
|
|
1152
|
+
"category": "People",
|
|
1153
|
+
"name": "List All Owner Groups",
|
|
1154
|
+
"method": "GET",
|
|
1155
|
+
"path": "/owner_groups",
|
|
1156
|
+
"description": "Returns all property owner groups that meet the filter criteria",
|
|
1157
|
+
"writeOperation": false,
|
|
1158
|
+
"pagination": true,
|
|
1159
|
+
"deprecated": false
|
|
1160
|
+
},
|
|
1161
|
+
{
|
|
1162
|
+
"operationId": "post_owner_groups",
|
|
1163
|
+
"resource": "owner_groups",
|
|
1164
|
+
"category": "People",
|
|
1165
|
+
"name": "Create Owner Group",
|
|
1166
|
+
"method": "POST",
|
|
1167
|
+
"path": "/owner_groups",
|
|
1168
|
+
"description": "Create a Owner Group",
|
|
1169
|
+
"writeOperation": true,
|
|
1170
|
+
"pagination": false,
|
|
1171
|
+
"deprecated": false
|
|
1172
|
+
},
|
|
1173
|
+
{
|
|
1174
|
+
"operationId": "patch_owner_groups_id",
|
|
1175
|
+
"resource": "owner_groups",
|
|
1176
|
+
"category": "People",
|
|
1177
|
+
"name": "Update Owner Group",
|
|
1178
|
+
"method": "PATCH",
|
|
1179
|
+
"path": "/owner_groups/{id}",
|
|
1180
|
+
"description": "Update an existing Owner Group",
|
|
1181
|
+
"writeOperation": true,
|
|
1182
|
+
"pagination": false,
|
|
1183
|
+
"deprecated": false
|
|
1184
|
+
},
|
|
1185
|
+
{
|
|
1186
|
+
"operationId": "get_owners",
|
|
1187
|
+
"resource": "owners",
|
|
1188
|
+
"category": "People",
|
|
1189
|
+
"name": "List All Owners",
|
|
1190
|
+
"method": "GET",
|
|
1191
|
+
"path": "/owners",
|
|
1192
|
+
"description": "Returns all owners that meet the filter criteria",
|
|
1193
|
+
"writeOperation": false,
|
|
1194
|
+
"pagination": true,
|
|
1195
|
+
"deprecated": false
|
|
1196
|
+
},
|
|
1197
|
+
{
|
|
1198
|
+
"operationId": "post_owners",
|
|
1199
|
+
"resource": "owners",
|
|
1200
|
+
"category": "People",
|
|
1201
|
+
"name": "Create Owner",
|
|
1202
|
+
"method": "POST",
|
|
1203
|
+
"path": "/owners",
|
|
1204
|
+
"description": "Create an owner",
|
|
1205
|
+
"writeOperation": true,
|
|
1206
|
+
"pagination": false,
|
|
1207
|
+
"deprecated": false
|
|
1208
|
+
},
|
|
1209
|
+
{
|
|
1210
|
+
"operationId": "get_owners_ownerid",
|
|
1211
|
+
"resource": "owners",
|
|
1212
|
+
"category": "People",
|
|
1213
|
+
"name": "Fetch an Owner by ID",
|
|
1214
|
+
"method": "GET",
|
|
1215
|
+
"path": "/owners/{ownerId}",
|
|
1216
|
+
"description": "Returns the owner",
|
|
1217
|
+
"writeOperation": false,
|
|
1218
|
+
"pagination": false,
|
|
1219
|
+
"deprecated": false
|
|
1220
|
+
},
|
|
1221
|
+
{
|
|
1222
|
+
"operationId": "patch_owners_ownerid",
|
|
1223
|
+
"resource": "owners",
|
|
1224
|
+
"category": "People",
|
|
1225
|
+
"name": "Update Owner",
|
|
1226
|
+
"method": "PATCH",
|
|
1227
|
+
"path": "/owners/{ownerId}",
|
|
1228
|
+
"description": "Update a Owner",
|
|
1229
|
+
"writeOperation": true,
|
|
1230
|
+
"pagination": false,
|
|
1231
|
+
"deprecated": false
|
|
1232
|
+
},
|
|
1233
|
+
{
|
|
1234
|
+
"operationId": "post_owners_ownerid_attachments",
|
|
1235
|
+
"resource": "owners",
|
|
1236
|
+
"category": "People",
|
|
1237
|
+
"name": "Create Owner Attachment",
|
|
1238
|
+
"method": "POST",
|
|
1239
|
+
"path": "/owners/{OwnerId}/attachments",
|
|
1240
|
+
"description": "Upload an attachment to an owner",
|
|
1241
|
+
"writeOperation": true,
|
|
1242
|
+
"pagination": false,
|
|
1243
|
+
"deprecated": false
|
|
1244
|
+
},
|
|
1245
|
+
{
|
|
1246
|
+
"operationId": "post_owners_ownerid_notes",
|
|
1247
|
+
"resource": "owners",
|
|
1248
|
+
"category": "People",
|
|
1249
|
+
"name": "Create Owner Note",
|
|
1250
|
+
"method": "POST",
|
|
1251
|
+
"path": "/owners/{OwnerId}/notes",
|
|
1252
|
+
"description": "Add a note to an owner.",
|
|
1253
|
+
"writeOperation": true,
|
|
1254
|
+
"pagination": false,
|
|
1255
|
+
"deprecated": false
|
|
1256
|
+
},
|
|
1257
|
+
{
|
|
1258
|
+
"operationId": "patch_owners_ownerid_notes_id",
|
|
1259
|
+
"resource": "owners",
|
|
1260
|
+
"category": "People",
|
|
1261
|
+
"name": "Update Owner Note",
|
|
1262
|
+
"method": "PATCH",
|
|
1263
|
+
"path": "/owners/{OwnerId}/notes/{Id}",
|
|
1264
|
+
"description": "Update a note to an owner.",
|
|
1265
|
+
"writeOperation": true,
|
|
1266
|
+
"pagination": false,
|
|
1267
|
+
"deprecated": false
|
|
1268
|
+
},
|
|
1269
|
+
{
|
|
1270
|
+
"operationId": "get_owners_attachments",
|
|
1271
|
+
"resource": "owners",
|
|
1272
|
+
"category": "People",
|
|
1273
|
+
"name": "List All Owner Attachments",
|
|
1274
|
+
"method": "GET",
|
|
1275
|
+
"path": "/owners/attachments",
|
|
1276
|
+
"description": "Returns all attachments associated with an owner",
|
|
1277
|
+
"writeOperation": false,
|
|
1278
|
+
"pagination": true,
|
|
1279
|
+
"deprecated": false
|
|
1280
|
+
},
|
|
1281
|
+
{
|
|
1282
|
+
"operationId": "post_owners_bulk",
|
|
1283
|
+
"resource": "owners",
|
|
1284
|
+
"category": "People",
|
|
1285
|
+
"name": "Bulk Create Owners",
|
|
1286
|
+
"method": "POST",
|
|
1287
|
+
"path": "/owners/bulk",
|
|
1288
|
+
"description": "Create owners in bulk",
|
|
1289
|
+
"writeOperation": true,
|
|
1290
|
+
"pagination": false,
|
|
1291
|
+
"deprecated": false
|
|
1292
|
+
},
|
|
1293
|
+
{
|
|
1294
|
+
"operationId": "get_owners_notes",
|
|
1295
|
+
"resource": "owners",
|
|
1296
|
+
"category": "People",
|
|
1297
|
+
"name": "List All Owners Notes",
|
|
1298
|
+
"method": "GET",
|
|
1299
|
+
"path": "/owners/notes",
|
|
1300
|
+
"description": "Returns all owner's notes that meet the filter criteria.",
|
|
1301
|
+
"writeOperation": false,
|
|
1302
|
+
"pagination": true,
|
|
1303
|
+
"deprecated": false
|
|
1304
|
+
},
|
|
1305
|
+
{
|
|
1306
|
+
"operationId": "get_tenants",
|
|
1307
|
+
"resource": "tenants",
|
|
1308
|
+
"category": "People",
|
|
1309
|
+
"name": "List All Tenants",
|
|
1310
|
+
"method": "GET",
|
|
1311
|
+
"path": "/tenants",
|
|
1312
|
+
"description": "Returns all tenants that meet the filter criteria",
|
|
1313
|
+
"writeOperation": false,
|
|
1314
|
+
"pagination": true,
|
|
1315
|
+
"deprecated": false
|
|
1316
|
+
},
|
|
1317
|
+
{
|
|
1318
|
+
"operationId": "patch_tenants_tenantid",
|
|
1319
|
+
"resource": "tenants",
|
|
1320
|
+
"category": "People",
|
|
1321
|
+
"name": "Update Tenant",
|
|
1322
|
+
"method": "PATCH",
|
|
1323
|
+
"path": "/tenants/{tenantId}",
|
|
1324
|
+
"description": "Update a Tenant",
|
|
1325
|
+
"writeOperation": true,
|
|
1326
|
+
"pagination": false,
|
|
1327
|
+
"deprecated": false
|
|
1328
|
+
},
|
|
1329
|
+
{
|
|
1330
|
+
"operationId": "post_tenants_tenantid_notes",
|
|
1331
|
+
"resource": "tenants",
|
|
1332
|
+
"category": "People",
|
|
1333
|
+
"name": "Create Tenant Note",
|
|
1334
|
+
"method": "POST",
|
|
1335
|
+
"path": "/tenants/{TenantId}/notes",
|
|
1336
|
+
"description": "Add a note to a tenant",
|
|
1337
|
+
"writeOperation": true,
|
|
1338
|
+
"pagination": false,
|
|
1339
|
+
"deprecated": false
|
|
1340
|
+
},
|
|
1341
|
+
{
|
|
1342
|
+
"operationId": "patch_tenants_tenantid_notes_id",
|
|
1343
|
+
"resource": "tenants",
|
|
1344
|
+
"category": "People",
|
|
1345
|
+
"name": "Update Tenant Note",
|
|
1346
|
+
"method": "PATCH",
|
|
1347
|
+
"path": "/tenants/{TenantId}/notes/{Id}",
|
|
1348
|
+
"description": "Update a note to a tenant",
|
|
1349
|
+
"writeOperation": true,
|
|
1350
|
+
"pagination": false,
|
|
1351
|
+
"deprecated": false
|
|
1352
|
+
},
|
|
1353
|
+
{
|
|
1354
|
+
"operationId": "patch_tenants_bulk",
|
|
1355
|
+
"resource": "tenants",
|
|
1356
|
+
"category": "People",
|
|
1357
|
+
"name": "Bulk Update Tenants",
|
|
1358
|
+
"method": "PATCH",
|
|
1359
|
+
"path": "/tenants/bulk",
|
|
1360
|
+
"description": "Update Tenants in bulk",
|
|
1361
|
+
"writeOperation": true,
|
|
1362
|
+
"pagination": false,
|
|
1363
|
+
"deprecated": false
|
|
1364
|
+
},
|
|
1365
|
+
{
|
|
1366
|
+
"operationId": "post_tenants_bulk",
|
|
1367
|
+
"resource": "tenants",
|
|
1368
|
+
"category": "People",
|
|
1369
|
+
"name": "Bulk Create Tenants",
|
|
1370
|
+
"method": "POST",
|
|
1371
|
+
"path": "/tenants/bulk",
|
|
1372
|
+
"description": "Create Tenants in bulk",
|
|
1373
|
+
"writeOperation": true,
|
|
1374
|
+
"pagination": false,
|
|
1375
|
+
"deprecated": false
|
|
1376
|
+
},
|
|
1377
|
+
{
|
|
1378
|
+
"operationId": "get_tenants_notes",
|
|
1379
|
+
"resource": "tenants",
|
|
1380
|
+
"category": "People",
|
|
1381
|
+
"name": "List All Tenants Notes",
|
|
1382
|
+
"method": "GET",
|
|
1383
|
+
"path": "/tenants/notes",
|
|
1384
|
+
"description": "Returns all tenant notes that meet the filter criteria",
|
|
1385
|
+
"writeOperation": false,
|
|
1386
|
+
"pagination": true,
|
|
1387
|
+
"deprecated": false
|
|
1388
|
+
},
|
|
1389
|
+
{
|
|
1390
|
+
"operationId": "get_users",
|
|
1391
|
+
"resource": "users",
|
|
1392
|
+
"category": "People",
|
|
1393
|
+
"name": "List All Users",
|
|
1394
|
+
"method": "GET",
|
|
1395
|
+
"path": "/users",
|
|
1396
|
+
"description": "Returns all users that meet the filter criteria",
|
|
1397
|
+
"writeOperation": false,
|
|
1398
|
+
"pagination": true,
|
|
1399
|
+
"deprecated": false
|
|
1400
|
+
},
|
|
1401
|
+
{
|
|
1402
|
+
"operationId": "post_occupancies_occupancyid_attachments",
|
|
1403
|
+
"resource": "occupancies",
|
|
1404
|
+
"category": "Properties",
|
|
1405
|
+
"name": "Create Occupancy Attachment",
|
|
1406
|
+
"method": "POST",
|
|
1407
|
+
"path": "/occupancies/{OccupancyId}/attachments",
|
|
1408
|
+
"description": "Add an attachment to an occupancy",
|
|
1409
|
+
"writeOperation": true,
|
|
1410
|
+
"pagination": false,
|
|
1411
|
+
"deprecated": false
|
|
1412
|
+
},
|
|
1413
|
+
{
|
|
1414
|
+
"operationId": "get_occupancies_documents",
|
|
1415
|
+
"resource": "occupancies",
|
|
1416
|
+
"category": "Properties",
|
|
1417
|
+
"name": "List All Occupancies Documents",
|
|
1418
|
+
"method": "GET",
|
|
1419
|
+
"path": "/occupancies/documents",
|
|
1420
|
+
"description": "Returns all occupancy's documents that meet the filter criteria",
|
|
1421
|
+
"writeOperation": false,
|
|
1422
|
+
"pagination": true,
|
|
1423
|
+
"deprecated": false
|
|
1424
|
+
},
|
|
1425
|
+
{
|
|
1426
|
+
"operationId": "get_portfolios",
|
|
1427
|
+
"resource": "portfolios",
|
|
1428
|
+
"category": "Properties",
|
|
1429
|
+
"name": "List All Portfolios",
|
|
1430
|
+
"method": "GET",
|
|
1431
|
+
"path": "/portfolios",
|
|
1432
|
+
"description": "Returns all portfolios that meet the filter criteria",
|
|
1433
|
+
"writeOperation": false,
|
|
1434
|
+
"pagination": true,
|
|
1435
|
+
"deprecated": false
|
|
1436
|
+
},
|
|
1437
|
+
{
|
|
1438
|
+
"operationId": "patch_portfolios_portfolioid",
|
|
1439
|
+
"resource": "portfolios",
|
|
1440
|
+
"category": "Properties",
|
|
1441
|
+
"name": "Update a Portfolio",
|
|
1442
|
+
"method": "PATCH",
|
|
1443
|
+
"path": "/portfolios/{portfolioId}",
|
|
1444
|
+
"description": "Update a portfolio",
|
|
1445
|
+
"writeOperation": true,
|
|
1446
|
+
"pagination": false,
|
|
1447
|
+
"deprecated": false
|
|
1448
|
+
},
|
|
1449
|
+
{
|
|
1450
|
+
"operationId": "get_properties",
|
|
1451
|
+
"resource": "properties",
|
|
1452
|
+
"category": "Properties",
|
|
1453
|
+
"name": "List All Properties",
|
|
1454
|
+
"method": "GET",
|
|
1455
|
+
"path": "/properties",
|
|
1456
|
+
"description": "Returns all properties that meet the filter criteria",
|
|
1457
|
+
"writeOperation": false,
|
|
1458
|
+
"pagination": true,
|
|
1459
|
+
"deprecated": false
|
|
1460
|
+
},
|
|
1461
|
+
{
|
|
1462
|
+
"operationId": "patch_properties_propertyid",
|
|
1463
|
+
"resource": "properties",
|
|
1464
|
+
"category": "Properties",
|
|
1465
|
+
"name": "Update Property",
|
|
1466
|
+
"method": "PATCH",
|
|
1467
|
+
"path": "/properties/{propertyId}",
|
|
1468
|
+
"description": "Update a property",
|
|
1469
|
+
"writeOperation": true,
|
|
1470
|
+
"pagination": false,
|
|
1471
|
+
"deprecated": false
|
|
1472
|
+
},
|
|
1473
|
+
{
|
|
1474
|
+
"operationId": "post_properties_propertyid_attachments",
|
|
1475
|
+
"resource": "properties",
|
|
1476
|
+
"category": "Properties",
|
|
1477
|
+
"name": "Create Property Attachment",
|
|
1478
|
+
"method": "POST",
|
|
1479
|
+
"path": "/properties/{PropertyId}/attachments",
|
|
1480
|
+
"description": "Upload an attachment to a property",
|
|
1481
|
+
"writeOperation": true,
|
|
1482
|
+
"pagination": false,
|
|
1483
|
+
"deprecated": false
|
|
1484
|
+
},
|
|
1485
|
+
{
|
|
1486
|
+
"operationId": "post_properties_propertyid_marketing_photos",
|
|
1487
|
+
"resource": "properties",
|
|
1488
|
+
"category": "Properties",
|
|
1489
|
+
"name": "Create Property Marketing Photo",
|
|
1490
|
+
"method": "POST",
|
|
1491
|
+
"path": "/properties/{PropertyId}/marketing_photos",
|
|
1492
|
+
"description": "Upload a marketing photo to a multi-family residential property. Marketing photos are not available for single-family residential properties.",
|
|
1493
|
+
"writeOperation": true,
|
|
1494
|
+
"pagination": false,
|
|
1495
|
+
"deprecated": false
|
|
1496
|
+
},
|
|
1497
|
+
{
|
|
1498
|
+
"operationId": "delete_properties_propertyid_marketing_photos_marketingphotoid",
|
|
1499
|
+
"resource": "properties",
|
|
1500
|
+
"category": "Properties",
|
|
1501
|
+
"name": "Delete Property Marketing Photo",
|
|
1502
|
+
"method": "DELETE",
|
|
1503
|
+
"path": "/properties/{PropertyId}/marketing_photos/{MarketingPhotoId}",
|
|
1504
|
+
"description": "Delete a marketing photo from a property",
|
|
1505
|
+
"writeOperation": true,
|
|
1506
|
+
"pagination": false,
|
|
1507
|
+
"deprecated": false
|
|
1508
|
+
},
|
|
1509
|
+
{
|
|
1510
|
+
"operationId": "patch_properties_propertyid_marketing_photos_marketingphotoid",
|
|
1511
|
+
"resource": "properties",
|
|
1512
|
+
"category": "Properties",
|
|
1513
|
+
"name": "Update Property Marketing Photo",
|
|
1514
|
+
"method": "PATCH",
|
|
1515
|
+
"path": "/properties/{PropertyId}/marketing_photos/{MarketingPhotoId}",
|
|
1516
|
+
"description": "Update a property marketing photo",
|
|
1517
|
+
"writeOperation": true,
|
|
1518
|
+
"pagination": false,
|
|
1519
|
+
"deprecated": false
|
|
1520
|
+
},
|
|
1521
|
+
{
|
|
1522
|
+
"operationId": "post_properties_propertyid_notes",
|
|
1523
|
+
"resource": "properties",
|
|
1524
|
+
"category": "Properties",
|
|
1525
|
+
"name": "Create Property Note",
|
|
1526
|
+
"method": "POST",
|
|
1527
|
+
"path": "/properties/{PropertyId}/notes",
|
|
1528
|
+
"description": "Add a note to a property",
|
|
1529
|
+
"writeOperation": true,
|
|
1530
|
+
"pagination": false,
|
|
1531
|
+
"deprecated": false
|
|
1532
|
+
},
|
|
1533
|
+
{
|
|
1534
|
+
"operationId": "patch_properties_propertyid_notes_id",
|
|
1535
|
+
"resource": "properties",
|
|
1536
|
+
"category": "Properties",
|
|
1537
|
+
"name": "Update Property Note",
|
|
1538
|
+
"method": "PATCH",
|
|
1539
|
+
"path": "/properties/{PropertyId}/notes/{Id}",
|
|
1540
|
+
"description": "Update a property note",
|
|
1541
|
+
"writeOperation": true,
|
|
1542
|
+
"pagination": false,
|
|
1543
|
+
"deprecated": false
|
|
1544
|
+
},
|
|
1545
|
+
{
|
|
1546
|
+
"operationId": "post_properties_propertyid_photos",
|
|
1547
|
+
"resource": "properties",
|
|
1548
|
+
"category": "Properties",
|
|
1549
|
+
"name": "Create Property Photo",
|
|
1550
|
+
"method": "POST",
|
|
1551
|
+
"path": "/properties/{PropertyId}/photos",
|
|
1552
|
+
"description": "Upload a photo to a property",
|
|
1553
|
+
"writeOperation": true,
|
|
1554
|
+
"pagination": false,
|
|
1555
|
+
"deprecated": false
|
|
1556
|
+
},
|
|
1557
|
+
{
|
|
1558
|
+
"operationId": "delete_properties_propertyid_photos_photoid",
|
|
1559
|
+
"resource": "properties",
|
|
1560
|
+
"category": "Properties",
|
|
1561
|
+
"name": "Delete Property Photo",
|
|
1562
|
+
"method": "DELETE",
|
|
1563
|
+
"path": "/properties/{PropertyId}/photos/{PhotoId}",
|
|
1564
|
+
"description": "Delete a photo from a property",
|
|
1565
|
+
"writeOperation": true,
|
|
1566
|
+
"pagination": false,
|
|
1567
|
+
"deprecated": false
|
|
1568
|
+
},
|
|
1569
|
+
{
|
|
1570
|
+
"operationId": "patch_properties_propertyid_photos_photoid",
|
|
1571
|
+
"resource": "properties",
|
|
1572
|
+
"category": "Properties",
|
|
1573
|
+
"name": "Update Property Photo",
|
|
1574
|
+
"method": "PATCH",
|
|
1575
|
+
"path": "/properties/{PropertyId}/photos/{PhotoId}",
|
|
1576
|
+
"description": "Update a property photo",
|
|
1577
|
+
"writeOperation": true,
|
|
1578
|
+
"pagination": false,
|
|
1579
|
+
"deprecated": false
|
|
1580
|
+
},
|
|
1581
|
+
{
|
|
1582
|
+
"operationId": "get_properties_attachments",
|
|
1583
|
+
"resource": "properties",
|
|
1584
|
+
"category": "Properties",
|
|
1585
|
+
"name": "List All Property Attachments",
|
|
1586
|
+
"method": "GET",
|
|
1587
|
+
"path": "/properties/attachments",
|
|
1588
|
+
"description": "Returns all attachments associated with a property",
|
|
1589
|
+
"writeOperation": false,
|
|
1590
|
+
"pagination": true,
|
|
1591
|
+
"deprecated": false
|
|
1592
|
+
},
|
|
1593
|
+
{
|
|
1594
|
+
"operationId": "post_properties_bulk",
|
|
1595
|
+
"resource": "properties",
|
|
1596
|
+
"category": "Properties",
|
|
1597
|
+
"name": "Bulk Create Properties",
|
|
1598
|
+
"method": "POST",
|
|
1599
|
+
"path": "/properties/bulk",
|
|
1600
|
+
"description": "Create properties in bulk",
|
|
1601
|
+
"writeOperation": true,
|
|
1602
|
+
"pagination": false,
|
|
1603
|
+
"deprecated": false
|
|
1604
|
+
},
|
|
1605
|
+
{
|
|
1606
|
+
"operationId": "get_properties_marketing_photos",
|
|
1607
|
+
"resource": "properties",
|
|
1608
|
+
"category": "Properties",
|
|
1609
|
+
"name": "List All Properties Marketing Photos",
|
|
1610
|
+
"method": "GET",
|
|
1611
|
+
"path": "/properties/marketing_photos",
|
|
1612
|
+
"description": "Returns all multi-family residential properties' marketing photos that meet the specified filter criteria. Marketing photos are not available for single-family residential properties.",
|
|
1613
|
+
"writeOperation": false,
|
|
1614
|
+
"pagination": true,
|
|
1615
|
+
"deprecated": false
|
|
1616
|
+
},
|
|
1617
|
+
{
|
|
1618
|
+
"operationId": "get_properties_notes",
|
|
1619
|
+
"resource": "properties",
|
|
1620
|
+
"category": "Properties",
|
|
1621
|
+
"name": "List All Properties Notes",
|
|
1622
|
+
"method": "GET",
|
|
1623
|
+
"path": "/properties/notes",
|
|
1624
|
+
"description": "Returns all properties' notes that meet the filter criteria",
|
|
1625
|
+
"writeOperation": false,
|
|
1626
|
+
"pagination": true,
|
|
1627
|
+
"deprecated": false
|
|
1628
|
+
},
|
|
1629
|
+
{
|
|
1630
|
+
"operationId": "get_properties_photos",
|
|
1631
|
+
"resource": "properties",
|
|
1632
|
+
"category": "Properties",
|
|
1633
|
+
"name": "List All Properties Photos",
|
|
1634
|
+
"method": "GET",
|
|
1635
|
+
"path": "/properties/photos",
|
|
1636
|
+
"description": "Returns all properties' photos that meet the filter criteria",
|
|
1637
|
+
"writeOperation": false,
|
|
1638
|
+
"pagination": true,
|
|
1639
|
+
"deprecated": false
|
|
1640
|
+
},
|
|
1641
|
+
{
|
|
1642
|
+
"operationId": "get_property_groups",
|
|
1643
|
+
"resource": "property_groups",
|
|
1644
|
+
"category": "Properties",
|
|
1645
|
+
"name": "List All Property Groups",
|
|
1646
|
+
"method": "GET",
|
|
1647
|
+
"path": "/property_groups",
|
|
1648
|
+
"description": "Returns all property groups that meet the filter criteria",
|
|
1649
|
+
"writeOperation": false,
|
|
1650
|
+
"pagination": true,
|
|
1651
|
+
"deprecated": false
|
|
1652
|
+
},
|
|
1653
|
+
{
|
|
1654
|
+
"operationId": "patch_property_groups_propertygroupid",
|
|
1655
|
+
"resource": "property_groups",
|
|
1656
|
+
"category": "Properties",
|
|
1657
|
+
"name": "Update a Property Group",
|
|
1658
|
+
"method": "PATCH",
|
|
1659
|
+
"path": "/property_groups/{propertyGroupId}",
|
|
1660
|
+
"description": "Update a property group",
|
|
1661
|
+
"writeOperation": true,
|
|
1662
|
+
"pagination": false,
|
|
1663
|
+
"deprecated": false
|
|
1664
|
+
},
|
|
1665
|
+
{
|
|
1666
|
+
"operationId": "get_unit_types",
|
|
1667
|
+
"resource": "unit_types",
|
|
1668
|
+
"category": "Properties",
|
|
1669
|
+
"name": "List All Unit Types",
|
|
1670
|
+
"method": "GET",
|
|
1671
|
+
"path": "/unit_types",
|
|
1672
|
+
"description": "Returns all unit types that meet the filter criteria.",
|
|
1673
|
+
"writeOperation": false,
|
|
1674
|
+
"pagination": true,
|
|
1675
|
+
"deprecated": false
|
|
1676
|
+
},
|
|
1677
|
+
{
|
|
1678
|
+
"operationId": "patch_unit_types_unittypeid",
|
|
1679
|
+
"resource": "unit_types",
|
|
1680
|
+
"category": "Properties",
|
|
1681
|
+
"name": "Update Unit Type",
|
|
1682
|
+
"method": "PATCH",
|
|
1683
|
+
"path": "/unit_types/{unitTypeId}",
|
|
1684
|
+
"description": "Update a unit Type.",
|
|
1685
|
+
"writeOperation": true,
|
|
1686
|
+
"pagination": false,
|
|
1687
|
+
"deprecated": false
|
|
1688
|
+
},
|
|
1689
|
+
{
|
|
1690
|
+
"operationId": "post_unit_types_bulk",
|
|
1691
|
+
"resource": "unit_types",
|
|
1692
|
+
"category": "Properties",
|
|
1693
|
+
"name": "Bulk Create Unit Types",
|
|
1694
|
+
"method": "POST",
|
|
1695
|
+
"path": "/unit_types/bulk",
|
|
1696
|
+
"description": "Create unit types in bulk.",
|
|
1697
|
+
"writeOperation": true,
|
|
1698
|
+
"pagination": false,
|
|
1699
|
+
"deprecated": false
|
|
1700
|
+
},
|
|
1701
|
+
{
|
|
1702
|
+
"operationId": "get_units",
|
|
1703
|
+
"resource": "units",
|
|
1704
|
+
"category": "Properties",
|
|
1705
|
+
"name": "List All Units",
|
|
1706
|
+
"method": "GET",
|
|
1707
|
+
"path": "/units",
|
|
1708
|
+
"description": "Returns all units that meet the filter criteria",
|
|
1709
|
+
"writeOperation": false,
|
|
1710
|
+
"pagination": true,
|
|
1711
|
+
"deprecated": false
|
|
1712
|
+
},
|
|
1713
|
+
{
|
|
1714
|
+
"operationId": "patch_units_unitid",
|
|
1715
|
+
"resource": "units",
|
|
1716
|
+
"category": "Properties",
|
|
1717
|
+
"name": "Update Unit",
|
|
1718
|
+
"method": "PATCH",
|
|
1719
|
+
"path": "/units/{unitId}",
|
|
1720
|
+
"description": "Update a unit",
|
|
1721
|
+
"writeOperation": true,
|
|
1722
|
+
"pagination": false,
|
|
1723
|
+
"deprecated": false
|
|
1724
|
+
},
|
|
1725
|
+
{
|
|
1726
|
+
"operationId": "post_units_unitid_attachments",
|
|
1727
|
+
"resource": "units",
|
|
1728
|
+
"category": "Properties",
|
|
1729
|
+
"name": "Create Unit Attachment",
|
|
1730
|
+
"method": "POST",
|
|
1731
|
+
"path": "/units/{UnitId}/attachments",
|
|
1732
|
+
"description": "Upload an attachment to a unit",
|
|
1733
|
+
"writeOperation": true,
|
|
1734
|
+
"pagination": false,
|
|
1735
|
+
"deprecated": false
|
|
1736
|
+
},
|
|
1737
|
+
{
|
|
1738
|
+
"operationId": "post_units_unitid_notes",
|
|
1739
|
+
"resource": "units",
|
|
1740
|
+
"category": "Properties",
|
|
1741
|
+
"name": "Create Unit Note",
|
|
1742
|
+
"method": "POST",
|
|
1743
|
+
"path": "/units/{UnitId}/notes",
|
|
1744
|
+
"description": "Add a note to a unit",
|
|
1745
|
+
"writeOperation": true,
|
|
1746
|
+
"pagination": false,
|
|
1747
|
+
"deprecated": false
|
|
1748
|
+
},
|
|
1749
|
+
{
|
|
1750
|
+
"operationId": "patch_units_unitid_notes_id",
|
|
1751
|
+
"resource": "units",
|
|
1752
|
+
"category": "Properties",
|
|
1753
|
+
"name": "Update Unit Note",
|
|
1754
|
+
"method": "PATCH",
|
|
1755
|
+
"path": "/units/{UnitId}/notes/{Id}",
|
|
1756
|
+
"description": "Update a note to a unit",
|
|
1757
|
+
"writeOperation": true,
|
|
1758
|
+
"pagination": false,
|
|
1759
|
+
"deprecated": false
|
|
1760
|
+
},
|
|
1761
|
+
{
|
|
1762
|
+
"operationId": "post_units_unitid_photos",
|
|
1763
|
+
"resource": "units",
|
|
1764
|
+
"category": "Properties",
|
|
1765
|
+
"name": "Create Unit Photo",
|
|
1766
|
+
"method": "POST",
|
|
1767
|
+
"path": "/units/{UnitId}/photos",
|
|
1768
|
+
"description": "Upload a photo to a unit.",
|
|
1769
|
+
"writeOperation": true,
|
|
1770
|
+
"pagination": false,
|
|
1771
|
+
"deprecated": false
|
|
1772
|
+
},
|
|
1773
|
+
{
|
|
1774
|
+
"operationId": "delete_units_unitid_photos_photoid",
|
|
1775
|
+
"resource": "units",
|
|
1776
|
+
"category": "Properties",
|
|
1777
|
+
"name": "Delete Unit Photo",
|
|
1778
|
+
"method": "DELETE",
|
|
1779
|
+
"path": "/units/{UnitId}/photos/{PhotoId}",
|
|
1780
|
+
"description": "Delete a photo from a unit",
|
|
1781
|
+
"writeOperation": true,
|
|
1782
|
+
"pagination": false,
|
|
1783
|
+
"deprecated": false
|
|
1784
|
+
},
|
|
1785
|
+
{
|
|
1786
|
+
"operationId": "patch_units_unitid_photos_photoid",
|
|
1787
|
+
"resource": "units",
|
|
1788
|
+
"category": "Properties",
|
|
1789
|
+
"name": "Update Unit Photo",
|
|
1790
|
+
"method": "PATCH",
|
|
1791
|
+
"path": "/units/{UnitId}/photos/{PhotoId}",
|
|
1792
|
+
"description": "Update a unit photo",
|
|
1793
|
+
"writeOperation": true,
|
|
1794
|
+
"pagination": false,
|
|
1795
|
+
"deprecated": false
|
|
1796
|
+
},
|
|
1797
|
+
{
|
|
1798
|
+
"operationId": "put_units_unitid_pricing_matrices",
|
|
1799
|
+
"resource": "units",
|
|
1800
|
+
"category": "Properties",
|
|
1801
|
+
"name": "Put Unit Pricing Matrix",
|
|
1802
|
+
"method": "PUT",
|
|
1803
|
+
"path": "/units/{UnitId}/pricing_matrices",
|
|
1804
|
+
"description": "Manage the rent pricing structure for a specific unit",
|
|
1805
|
+
"writeOperation": true,
|
|
1806
|
+
"pagination": false,
|
|
1807
|
+
"deprecated": false
|
|
1808
|
+
},
|
|
1809
|
+
{
|
|
1810
|
+
"operationId": "get_units_attachments",
|
|
1811
|
+
"resource": "units",
|
|
1812
|
+
"category": "Properties",
|
|
1813
|
+
"name": "List All Unit Attachments",
|
|
1814
|
+
"method": "GET",
|
|
1815
|
+
"path": "/units/attachments",
|
|
1816
|
+
"description": "Returns all attachments associated with a unit",
|
|
1817
|
+
"writeOperation": false,
|
|
1818
|
+
"pagination": true,
|
|
1819
|
+
"deprecated": false
|
|
1820
|
+
},
|
|
1821
|
+
{
|
|
1822
|
+
"operationId": "post_units_bulk",
|
|
1823
|
+
"resource": "units",
|
|
1824
|
+
"category": "Properties",
|
|
1825
|
+
"name": "Bulk Create Units",
|
|
1826
|
+
"method": "POST",
|
|
1827
|
+
"path": "/units/bulk",
|
|
1828
|
+
"description": "Create units in bulk",
|
|
1829
|
+
"writeOperation": true,
|
|
1830
|
+
"pagination": false,
|
|
1831
|
+
"deprecated": false
|
|
1832
|
+
},
|
|
1833
|
+
{
|
|
1834
|
+
"operationId": "get_units_notes",
|
|
1835
|
+
"resource": "units",
|
|
1836
|
+
"category": "Properties",
|
|
1837
|
+
"name": "List All Units Notes",
|
|
1838
|
+
"method": "GET",
|
|
1839
|
+
"path": "/units/notes",
|
|
1840
|
+
"description": "Returns all notes for a unit that meet the filter criteria",
|
|
1841
|
+
"writeOperation": false,
|
|
1842
|
+
"pagination": true,
|
|
1843
|
+
"deprecated": false
|
|
1844
|
+
},
|
|
1845
|
+
{
|
|
1846
|
+
"operationId": "get_units_photos",
|
|
1847
|
+
"resource": "units",
|
|
1848
|
+
"category": "Properties",
|
|
1849
|
+
"name": "List All Units Photos",
|
|
1850
|
+
"method": "GET",
|
|
1851
|
+
"path": "/units/photos",
|
|
1852
|
+
"description": "Returns all Multi-Family Unit photos that meet the filter criteria. For Single-Family property photos see /Properties/Photos. Photos may be attached directly to a unit or inherited from the unit's unit type — when inherited, UnitTypeId will be populated and the photo cannot be created, updated, or deleted via these endpoints.",
|
|
1853
|
+
"writeOperation": false,
|
|
1854
|
+
"pagination": true,
|
|
1855
|
+
"deprecated": false
|
|
1856
|
+
},
|
|
1857
|
+
{
|
|
1858
|
+
"operationId": "put_units_pricing_matrices_bulk",
|
|
1859
|
+
"resource": "units",
|
|
1860
|
+
"category": "Properties",
|
|
1861
|
+
"name": "Bulk Put Unit Pricing Matrix",
|
|
1862
|
+
"method": "PUT",
|
|
1863
|
+
"path": "/units/pricing_matrices/bulk",
|
|
1864
|
+
"description": "Manage the rent pricing structure for units",
|
|
1865
|
+
"writeOperation": true,
|
|
1866
|
+
"pagination": false,
|
|
1867
|
+
"deprecated": false
|
|
1868
|
+
},
|
|
1869
|
+
{
|
|
1870
|
+
"operationId": "put_units_pricing_matrices_bulk_async",
|
|
1871
|
+
"resource": "units",
|
|
1872
|
+
"category": "Properties",
|
|
1873
|
+
"name": "Bulk Put Unit Pricing Matrix (Async)",
|
|
1874
|
+
"method": "PUT",
|
|
1875
|
+
"path": "/units/pricing_matrices/bulk/async",
|
|
1876
|
+
"description": "Asynchronously manage the rent pricing structure for units",
|
|
1877
|
+
"writeOperation": true,
|
|
1878
|
+
"pagination": false,
|
|
1879
|
+
"deprecated": false
|
|
1880
|
+
},
|
|
1881
|
+
{
|
|
1882
|
+
"operationId": "get_jobs",
|
|
1883
|
+
"resource": "jobs",
|
|
1884
|
+
"category": "System",
|
|
1885
|
+
"name": "List All Jobs",
|
|
1886
|
+
"method": "GET",
|
|
1887
|
+
"path": "/jobs",
|
|
1888
|
+
"description": "List endpoint to display all of the jobs related to bulk operations",
|
|
1889
|
+
"writeOperation": false,
|
|
1890
|
+
"pagination": true,
|
|
1891
|
+
"deprecated": false
|
|
1892
|
+
}
|
|
1893
|
+
]
|
|
1894
|
+
}
|