propertyware 1.0.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (392) hide show
  1. checksums.yaml +7 -0
  2. data/.github/workflows/ci.yml +27 -0
  3. data/.github/workflows/publish.yml +48 -0
  4. data/.gitignore +39 -0
  5. data/.openapi-generator/FILES +375 -0
  6. data/.openapi-generator/VERSION +1 -0
  7. data/.openapi-generator/templates/ruby-client/gemspec.mustache +37 -0
  8. data/.openapi-generator/templates/ruby-client/partial_model_generic.mustache +371 -0
  9. data/.openapi-generator/templates/ruby-client/rubocop.mustache +124 -0
  10. data/.openapi-generator-ignore +23 -0
  11. data/.rspec +2 -0
  12. data/.rubocop.yml +124 -0
  13. data/CUSTOMIZATIONS.md +11 -0
  14. data/DOCS.md +673 -0
  15. data/Gemfile +9 -0
  16. data/Gemfile.lock +76 -0
  17. data/README.md +93 -0
  18. data/Rakefile +10 -0
  19. data/bin/CUSTOMIZATIONS.md +11 -0
  20. data/bin/README.md +93 -0
  21. data/bin/config.yml +7 -0
  22. data/bin/fix_json.rb +59 -0
  23. data/bin/propertyware.json +1 -0
  24. data/bin/rebuild.sh +31 -0
  25. data/docs/Account.md +84 -0
  26. data/docs/AccountingApi.md +1235 -0
  27. data/docs/Address.md +28 -0
  28. data/docs/Amenity.md +24 -0
  29. data/docs/AutoJournalEntry.md +46 -0
  30. data/docs/AutoPayment.md +42 -0
  31. data/docs/Bank.md +52 -0
  32. data/docs/BankDeposit.md +32 -0
  33. data/docs/BasicVendor.md +40 -0
  34. data/docs/Bill.md +54 -0
  35. data/docs/BillPaid.md +24 -0
  36. data/docs/BillPay.md +20 -0
  37. data/docs/BillPayment.md +46 -0
  38. data/docs/BillSplit.md +42 -0
  39. data/docs/BillsApi.md +1391 -0
  40. data/docs/Building.md +116 -0
  41. data/docs/BuildingsApi.md +1037 -0
  42. data/docs/Campaign.md +60 -0
  43. data/docs/CampaignSource.md +26 -0
  44. data/docs/Charge.md +36 -0
  45. data/docs/ChargeTx.md +52 -0
  46. data/docs/Check.md +48 -0
  47. data/docs/CheckSplit.md +30 -0
  48. data/docs/Comment.md +28 -0
  49. data/docs/Contact.md +74 -0
  50. data/docs/ContactsApi.md +783 -0
  51. data/docs/Conversation.md +36 -0
  52. data/docs/CreditCardAccount.md +18 -0
  53. data/docs/CurrentAsset.md +30 -0
  54. data/docs/CurrentLiability.md +30 -0
  55. data/docs/CustomField.md +24 -0
  56. data/docs/Discount.md +40 -0
  57. data/docs/Document.md +40 -0
  58. data/docs/DocumentsApi.md +267 -0
  59. data/docs/Entry.md +34 -0
  60. data/docs/Equity.md +32 -0
  61. data/docs/ErrorResponse.md +22 -0
  62. data/docs/Expense.md +32 -0
  63. data/docs/GLItem.md +40 -0
  64. data/docs/HealthCheckApi.md +86 -0
  65. data/docs/Income.md +34 -0
  66. data/docs/Inspection.md +46 -0
  67. data/docs/InspectionArea.md +22 -0
  68. data/docs/InspectionItem.md +24 -0
  69. data/docs/InspectionsApi.md +193 -0
  70. data/docs/JournalEntry.md +36 -0
  71. data/docs/JournalEntrySplit.md +24 -0
  72. data/docs/JournalEntrySplitResponse.md +24 -0
  73. data/docs/LateFeeRule.md +26 -0
  74. data/docs/Lease.md +76 -0
  75. data/docs/LeaseClause.md +22 -0
  76. data/docs/LeaseContact.md +36 -0
  77. data/docs/LeasesApi.md +3319 -0
  78. data/docs/ManagementFee.md +30 -0
  79. data/docs/ManagementSettings.md +26 -0
  80. data/docs/Marketing.md +62 -0
  81. data/docs/NonCurrentAsset.md +26 -0
  82. data/docs/NonCurrentLiability.md +30 -0
  83. data/docs/NonOperatingExpense.md +32 -0
  84. data/docs/NonOperatingInome.md +32 -0
  85. data/docs/Note.md +28 -0
  86. data/docs/Owner.md +38 -0
  87. data/docs/OwnerContribution.md +44 -0
  88. data/docs/OwnerDraw.md +44 -0
  89. data/docs/Payment.md +50 -0
  90. data/docs/PaymentCharge.md +36 -0
  91. data/docs/Portfolio.md +60 -0
  92. data/docs/PortfoliosApi.md +701 -0
  93. data/docs/PropertyManager.md +26 -0
  94. data/docs/Prospect.md +114 -0
  95. data/docs/ProspectsApi.md +789 -0
  96. data/docs/RESTAPIBulkErrorResponse.md +22 -0
  97. data/docs/RESTAPIBulkSuccessResponse.md +18 -0
  98. data/docs/RESTAPIError.md +20 -0
  99. data/docs/Refund.md +44 -0
  100. data/docs/ResponseEntity.md +20 -0
  101. data/docs/SaveAccount.md +52 -0
  102. data/docs/SaveAddress.md +28 -0
  103. data/docs/SaveAdjustment.md +26 -0
  104. data/docs/SaveAutoCharge.md +28 -0
  105. data/docs/SaveBankDeposit.md +20 -0
  106. data/docs/SaveBill.md +42 -0
  107. data/docs/SaveBillPayment.md +30 -0
  108. data/docs/SaveBillSplit.md +36 -0
  109. data/docs/SaveBuilding.md +84 -0
  110. data/docs/SaveCharge.md +28 -0
  111. data/docs/SaveCheck.md +30 -0
  112. data/docs/SaveCheckSplit.md +30 -0
  113. data/docs/SaveComment.md +18 -0
  114. data/docs/SaveContact.md +60 -0
  115. data/docs/SaveConversation.md +20 -0
  116. data/docs/SaveCredit.md +26 -0
  117. data/docs/SaveDiscount.md +28 -0
  118. data/docs/SaveJournalEntrySplit.md +22 -0
  119. data/docs/SaveLease.md +50 -0
  120. data/docs/SaveLeaseJournalEntry.md +26 -0
  121. data/docs/SaveOwner.md +36 -0
  122. data/docs/SaveOwnerContribution.md +34 -0
  123. data/docs/SaveOwnerDraw.md +34 -0
  124. data/docs/SavePayment.md +34 -0
  125. data/docs/SavePortfolio.md +38 -0
  126. data/docs/SaveProspect.md +76 -0
  127. data/docs/SaveProspectContact.md +36 -0
  128. data/docs/SaveRefund.md +34 -0
  129. data/docs/SaveUnit.md +60 -0
  130. data/docs/SaveVendor.md +46 -0
  131. data/docs/SaveWorkOrder.md +36 -0
  132. data/docs/SaveWorkOrderTask.md +30 -0
  133. data/docs/SplitPaid.md +34 -0
  134. data/docs/SplitPay.md +20 -0
  135. data/docs/Task.md +42 -0
  136. data/docs/Transaction.md +54 -0
  137. data/docs/Unit.md +96 -0
  138. data/docs/UnitsApi.md +875 -0
  139. data/docs/UpdateLeaseJournalEntry.md +26 -0
  140. data/docs/Vendor.md +76 -0
  141. data/docs/VendorsApi.md +617 -0
  142. data/docs/WorkOrder.md +78 -0
  143. data/docs/WorkOrdersApi.md +883 -0
  144. data/lib/propertyware/api/accounting_api.rb +1041 -0
  145. data/lib/propertyware/api/bills_api.rb +1182 -0
  146. data/lib/propertyware/api/buildings_api.rb +863 -0
  147. data/lib/propertyware/api/contacts_api.rb +666 -0
  148. data/lib/propertyware/api/documents_api.rb +235 -0
  149. data/lib/propertyware/api/health_check_api.rb +79 -0
  150. data/lib/propertyware/api/inspections_api.rb +172 -0
  151. data/lib/propertyware/api/leases_api.rb +2787 -0
  152. data/lib/propertyware/api/portfolios_api.rb +599 -0
  153. data/lib/propertyware/api/prospects_api.rb +671 -0
  154. data/lib/propertyware/api/units_api.rb +740 -0
  155. data/lib/propertyware/api/vendors_api.rb +522 -0
  156. data/lib/propertyware/api/work_orders_api.rb +763 -0
  157. data/lib/propertyware/api_client.rb +428 -0
  158. data/lib/propertyware/api_error.rb +58 -0
  159. data/lib/propertyware/configuration.rb +392 -0
  160. data/lib/propertyware/models/account.rb +549 -0
  161. data/lib/propertyware/models/address.rb +269 -0
  162. data/lib/propertyware/models/amenity.rb +249 -0
  163. data/lib/propertyware/models/auto_journal_entry.rb +358 -0
  164. data/lib/propertyware/models/auto_payment.rb +338 -0
  165. data/lib/propertyware/models/bank.rb +389 -0
  166. data/lib/propertyware/models/bank_deposit.rb +289 -0
  167. data/lib/propertyware/models/basic_vendor.rb +330 -0
  168. data/lib/propertyware/models/bill.rb +401 -0
  169. data/lib/propertyware/models/bill_paid.rb +250 -0
  170. data/lib/propertyware/models/bill_pay.rb +230 -0
  171. data/lib/propertyware/models/bill_payment.rb +361 -0
  172. data/lib/propertyware/models/bill_split.rb +339 -0
  173. data/lib/propertyware/models/building.rb +782 -0
  174. data/lib/propertyware/models/campaign.rb +430 -0
  175. data/lib/propertyware/models/campaign_source.rb +258 -0
  176. data/lib/propertyware/models/charge.rb +318 -0
  177. data/lib/propertyware/models/charge_tx.rb +401 -0
  178. data/lib/propertyware/models/check.rb +425 -0
  179. data/lib/propertyware/models/check_split.rb +284 -0
  180. data/lib/propertyware/models/comment.rb +269 -0
  181. data/lib/propertyware/models/contact.rb +546 -0
  182. data/lib/propertyware/models/conversation.rb +345 -0
  183. data/lib/propertyware/models/credit_card_account.rb +219 -0
  184. data/lib/propertyware/models/current_asset.rb +279 -0
  185. data/lib/propertyware/models/current_liability.rb +279 -0
  186. data/lib/propertyware/models/custom_field.rb +249 -0
  187. data/lib/propertyware/models/discount.rb +339 -0
  188. data/lib/propertyware/models/document.rb +362 -0
  189. data/lib/propertyware/models/entry.rb +297 -0
  190. data/lib/propertyware/models/equity.rb +289 -0
  191. data/lib/propertyware/models/error_response.rb +237 -0
  192. data/lib/propertyware/models/expense.rb +289 -0
  193. data/lib/propertyware/models/gl_item.rb +330 -0
  194. data/lib/propertyware/models/income.rb +299 -0
  195. data/lib/propertyware/models/inspection.rb +361 -0
  196. data/lib/propertyware/models/inspection_area.rb +241 -0
  197. data/lib/propertyware/models/inspection_item.rb +249 -0
  198. data/lib/propertyware/models/journal_entry.rb +311 -0
  199. data/lib/propertyware/models/journal_entry_split.rb +264 -0
  200. data/lib/propertyware/models/journal_entry_split_response.rb +263 -0
  201. data/lib/propertyware/models/late_fee_rule.rb +258 -0
  202. data/lib/propertyware/models/lease.rb +515 -0
  203. data/lib/propertyware/models/lease_clause.rb +238 -0
  204. data/lib/propertyware/models/lease_contact.rb +309 -0
  205. data/lib/propertyware/models/management_fee.rb +279 -0
  206. data/lib/propertyware/models/management_settings.rb +261 -0
  207. data/lib/propertyware/models/marketing.rb +439 -0
  208. data/lib/propertyware/models/non_current_asset.rb +259 -0
  209. data/lib/propertyware/models/non_current_liability.rb +279 -0
  210. data/lib/propertyware/models/non_operating_expense.rb +289 -0
  211. data/lib/propertyware/models/non_operating_inome.rb +289 -0
  212. data/lib/propertyware/models/note.rb +267 -0
  213. data/lib/propertyware/models/owner.rb +318 -0
  214. data/lib/propertyware/models/owner_contribution.rb +418 -0
  215. data/lib/propertyware/models/owner_draw.rb +398 -0
  216. data/lib/propertyware/models/payment.rb +423 -0
  217. data/lib/propertyware/models/payment_charge.rb +358 -0
  218. data/lib/propertyware/models/portfolio.rb +479 -0
  219. data/lib/propertyware/models/property_manager.rb +259 -0
  220. data/lib/propertyware/models/prospect.rb +701 -0
  221. data/lib/propertyware/models/refund.rb +384 -0
  222. data/lib/propertyware/models/response_entity.rb +260 -0
  223. data/lib/propertyware/models/restapi_bulk_error_response.rb +237 -0
  224. data/lib/propertyware/models/restapi_bulk_success_response.rb +217 -0
  225. data/lib/propertyware/models/restapi_error.rb +226 -0
  226. data/lib/propertyware/models/save_account.rb +398 -0
  227. data/lib/propertyware/models/save_address.rb +274 -0
  228. data/lib/propertyware/models/save_adjustment.rb +269 -0
  229. data/lib/propertyware/models/save_auto_charge.rb +328 -0
  230. data/lib/propertyware/models/save_bank_deposit.rb +239 -0
  231. data/lib/propertyware/models/save_bill.rb +356 -0
  232. data/lib/propertyware/models/save_bill_payment.rb +314 -0
  233. data/lib/propertyware/models/save_bill_split.rb +319 -0
  234. data/lib/propertyware/models/save_building.rb +653 -0
  235. data/lib/propertyware/models/save_charge.rb +289 -0
  236. data/lib/propertyware/models/save_check.rb +291 -0
  237. data/lib/propertyware/models/save_check_split.rb +289 -0
  238. data/lib/propertyware/models/save_comment.rb +224 -0
  239. data/lib/propertyware/models/save_contact.rb +472 -0
  240. data/lib/propertyware/models/save_conversation.rb +273 -0
  241. data/lib/propertyware/models/save_credit.rb +271 -0
  242. data/lib/propertyware/models/save_discount.rb +289 -0
  243. data/lib/propertyware/models/save_journal_entry_split.rb +254 -0
  244. data/lib/propertyware/models/save_lease.rb +444 -0
  245. data/lib/propertyware/models/save_lease_journal_entry.rb +276 -0
  246. data/lib/propertyware/models/save_owner.rb +318 -0
  247. data/lib/propertyware/models/save_owner_contribution.rb +373 -0
  248. data/lib/propertyware/models/save_owner_draw.rb +334 -0
  249. data/lib/propertyware/models/save_payment.rb +373 -0
  250. data/lib/propertyware/models/save_portfolio.rb +379 -0
  251. data/lib/propertyware/models/save_prospect.rb +511 -0
  252. data/lib/propertyware/models/save_prospect_contact.rb +318 -0
  253. data/lib/propertyware/models/save_refund.rb +334 -0
  254. data/lib/propertyware/models/save_unit.rb +492 -0
  255. data/lib/propertyware/models/save_vendor.rb +379 -0
  256. data/lib/propertyware/models/save_work_order.rb +345 -0
  257. data/lib/propertyware/models/save_work_order_task.rb +284 -0
  258. data/lib/propertyware/models/split_paid.rb +298 -0
  259. data/lib/propertyware/models/split_pay.rb +228 -0
  260. data/lib/propertyware/models/task.rb +339 -0
  261. data/lib/propertyware/models/transaction.rb +433 -0
  262. data/lib/propertyware/models/unit.rb +670 -0
  263. data/lib/propertyware/models/update_lease_journal_entry.rb +276 -0
  264. data/lib/propertyware/models/vendor.rb +511 -0
  265. data/lib/propertyware/models/work_order.rb +557 -0
  266. data/lib/propertyware/version.rb +15 -0
  267. data/lib/propertyware.rb +158 -0
  268. data/openapitools.json +7 -0
  269. data/propertyware.gemspec +39 -0
  270. data/spec/api/accounting_api_spec.rb +239 -0
  271. data/spec/api/bills_api_spec.rb +260 -0
  272. data/spec/api/buildings_api_spec.rb +199 -0
  273. data/spec/api/contacts_api_spec.rb +159 -0
  274. data/spec/api/documents_api_spec.rb +77 -0
  275. data/spec/api/health_check_api_spec.rb +46 -0
  276. data/spec/api/inspections_api_spec.rb +68 -0
  277. data/spec/api/leases_api_spec.rb +579 -0
  278. data/spec/api/portfolios_api_spec.rb +147 -0
  279. data/spec/api/prospects_api_spec.rb +162 -0
  280. data/spec/api/units_api_spec.rb +176 -0
  281. data/spec/api/vendors_api_spec.rb +134 -0
  282. data/spec/api/work_orders_api_spec.rb +180 -0
  283. data/spec/api_client_spec.rb +223 -0
  284. data/spec/configuration_spec.rb +82 -0
  285. data/spec/models/account_spec.rb +232 -0
  286. data/spec/models/address_spec.rb +64 -0
  287. data/spec/models/amenity_spec.rb +52 -0
  288. data/spec/models/auto_journal_entry_spec.rb +118 -0
  289. data/spec/models/auto_payment_spec.rb +106 -0
  290. data/spec/models/bank_deposit_spec.rb +76 -0
  291. data/spec/models/bank_spec.rb +136 -0
  292. data/spec/models/basic_vendor_spec.rb +100 -0
  293. data/spec/models/bill_paid_spec.rb +52 -0
  294. data/spec/models/bill_pay_spec.rb +40 -0
  295. data/spec/models/bill_payment_spec.rb +118 -0
  296. data/spec/models/bill_spec.rb +142 -0
  297. data/spec/models/bill_split_spec.rb +106 -0
  298. data/spec/models/building_spec.rb +344 -0
  299. data/spec/models/campaign_source_spec.rb +58 -0
  300. data/spec/models/campaign_spec.rb +160 -0
  301. data/spec/models/charge_spec.rb +88 -0
  302. data/spec/models/charge_tx_spec.rb +136 -0
  303. data/spec/models/check_spec.rb +128 -0
  304. data/spec/models/check_split_spec.rb +70 -0
  305. data/spec/models/comment_spec.rb +64 -0
  306. data/spec/models/contact_spec.rb +210 -0
  307. data/spec/models/conversation_spec.rb +92 -0
  308. data/spec/models/credit_card_account_spec.rb +34 -0
  309. data/spec/models/current_asset_spec.rb +70 -0
  310. data/spec/models/current_liability_spec.rb +70 -0
  311. data/spec/models/custom_field_spec.rb +52 -0
  312. data/spec/models/discount_spec.rb +100 -0
  313. data/spec/models/document_spec.rb +104 -0
  314. data/spec/models/entry_spec.rb +82 -0
  315. data/spec/models/equity_spec.rb +76 -0
  316. data/spec/models/error_response_spec.rb +46 -0
  317. data/spec/models/expense_spec.rb +76 -0
  318. data/spec/models/gl_item_spec.rb +100 -0
  319. data/spec/models/income_spec.rb +82 -0
  320. data/spec/models/inspection_area_spec.rb +46 -0
  321. data/spec/models/inspection_item_spec.rb +52 -0
  322. data/spec/models/inspection_spec.rb +118 -0
  323. data/spec/models/journal_entry_spec.rb +88 -0
  324. data/spec/models/journal_entry_split_response_spec.rb +52 -0
  325. data/spec/models/journal_entry_split_spec.rb +52 -0
  326. data/spec/models/late_fee_rule_spec.rb +58 -0
  327. data/spec/models/lease_clause_spec.rb +46 -0
  328. data/spec/models/lease_contact_spec.rb +88 -0
  329. data/spec/models/lease_spec.rb +208 -0
  330. data/spec/models/management_fee_spec.rb +70 -0
  331. data/spec/models/management_settings_spec.rb +58 -0
  332. data/spec/models/marketing_spec.rb +166 -0
  333. data/spec/models/non_current_asset_spec.rb +58 -0
  334. data/spec/models/non_current_liability_spec.rb +70 -0
  335. data/spec/models/non_operating_expense_spec.rb +76 -0
  336. data/spec/models/non_operating_inome_spec.rb +76 -0
  337. data/spec/models/note_spec.rb +64 -0
  338. data/spec/models/owner_contribution_spec.rb +116 -0
  339. data/spec/models/owner_draw_spec.rb +116 -0
  340. data/spec/models/owner_spec.rb +94 -0
  341. data/spec/models/payment_charge_spec.rb +92 -0
  342. data/spec/models/payment_spec.rb +134 -0
  343. data/spec/models/portfolio_spec.rb +168 -0
  344. data/spec/models/property_manager_spec.rb +58 -0
  345. data/spec/models/prospect_spec.rb +322 -0
  346. data/spec/models/refund_spec.rb +112 -0
  347. data/spec/models/response_entity_spec.rb +44 -0
  348. data/spec/models/restapi_bulk_error_response_spec.rb +46 -0
  349. data/spec/models/restapi_bulk_success_response_spec.rb +34 -0
  350. data/spec/models/restapi_error_spec.rb +40 -0
  351. data/spec/models/save_account_spec.rb +136 -0
  352. data/spec/models/save_address_spec.rb +64 -0
  353. data/spec/models/save_adjustment_spec.rb +58 -0
  354. data/spec/models/save_auto_charge_spec.rb +68 -0
  355. data/spec/models/save_bank_deposit_spec.rb +40 -0
  356. data/spec/models/save_bill_payment_spec.rb +74 -0
  357. data/spec/models/save_bill_spec.rb +106 -0
  358. data/spec/models/save_bill_split_spec.rb +88 -0
  359. data/spec/models/save_building_spec.rb +248 -0
  360. data/spec/models/save_charge_spec.rb +64 -0
  361. data/spec/models/save_check_spec.rb +70 -0
  362. data/spec/models/save_check_split_spec.rb +70 -0
  363. data/spec/models/save_comment_spec.rb +34 -0
  364. data/spec/models/save_contact_spec.rb +164 -0
  365. data/spec/models/save_conversation_spec.rb +44 -0
  366. data/spec/models/save_credit_spec.rb +58 -0
  367. data/spec/models/save_discount_spec.rb +64 -0
  368. data/spec/models/save_journal_entry_split_spec.rb +46 -0
  369. data/spec/models/save_lease_journal_entry_spec.rb +58 -0
  370. data/spec/models/save_lease_spec.rb +134 -0
  371. data/spec/models/save_owner_contribution_spec.rb +86 -0
  372. data/spec/models/save_owner_draw_spec.rb +82 -0
  373. data/spec/models/save_owner_spec.rb +88 -0
  374. data/spec/models/save_payment_spec.rb +86 -0
  375. data/spec/models/save_portfolio_spec.rb +102 -0
  376. data/spec/models/save_prospect_contact_spec.rb +88 -0
  377. data/spec/models/save_prospect_spec.rb +208 -0
  378. data/spec/models/save_refund_spec.rb +82 -0
  379. data/spec/models/save_unit_spec.rb +164 -0
  380. data/spec/models/save_vendor_spec.rb +118 -0
  381. data/spec/models/save_work_order_spec.rb +92 -0
  382. data/spec/models/save_work_order_task_spec.rb +70 -0
  383. data/spec/models/split_paid_spec.rb +82 -0
  384. data/spec/models/split_pay_spec.rb +40 -0
  385. data/spec/models/task_spec.rb +106 -0
  386. data/spec/models/transaction_spec.rb +146 -0
  387. data/spec/models/unit_spec.rb +280 -0
  388. data/spec/models/update_lease_journal_entry_spec.rb +58 -0
  389. data/spec/models/vendor_spec.rb +208 -0
  390. data/spec/models/work_order_spec.rb +218 -0
  391. data/spec/spec_helper.rb +111 -0
  392. metadata +609 -0
data/DOCS.md ADDED
@@ -0,0 +1,673 @@
1
+ # propertyware
2
+
3
+ Propertyware - the Ruby gem for the Open API, powered by Propertyware
4
+
5
+ <script type=\"text/javascript\" src=\"https://buildium.atlassian.net/s/d41d8cd98f00b204e9800998ecf8427e-T/-raa8on/b/8/c95134bc67d3a521bb3f4331beb9b804/_/download/batch/com.atlassian.jira.collector.plugin.jira-issue-collector-plugin:issuecollector/com.atlassian.jira.collector.plugin.jira-issue-collector-plugin:issuecollector.js?locale=en-US&collectorId=e43cd15d\"></script>
6
+
7
+ # Introduction
8
+
9
+ Welcome to Propertyware’s API—a powerful, RESTful programming interface that lets you leverage valuable Propertyware data.
10
+
11
+ ## Account Configuration
12
+ Before you can use Propertyware’s API, you’ll need to make some tweaks to your account settings.
13
+
14
+ <br />
15
+
16
+ ### Enabling the API
17
+ In order to start creating your keys and making requests, you’ll need to enable the API.
18
+
19
+ > **Tip:** You’ll need an administrator user role with access to ***Administration Setup > API Keys*** to set things up properly.
20
+
21
+ **Let's Begin!**
22
+
23
+ 1. Sign in to your [Propertyware](https://app.propertyware.com/pw/login.jsp) account from your browser.
24
+
25
+ 2. Open the ***Setup*** page
26
+
27
+ 3. On the left navigation bar, expand ***Administration Setup*** and then click ***API Keys***.
28
+
29
+ If you are having issues accessing the API keys page within your account you can submit a [Support](#section/API-Overview/Support) request for assistance.
30
+
31
+ ## API Keys
32
+ Account-level API keys authenticate every request and keep things secure.
33
+
34
+ API keys have two components: a “client ID” and a “secret”.
35
+
36
+ * **Client IDs** are similar to usernames. They’re used to identify your Propertyware API key and are safe to share.
37
+ * **Secrets** are similar to passwords. They must be kept confidential.
38
+
39
+ Whenever you make a request, you’ll need the API key’s client ID and secret. If you forget it, make a mistake, or try to use information that’s linked to a deleted key, the API will return a `401` response code.
40
+
41
+ > **Tip:** We compiled a list of best practices that detail how securely store API keys. [Give it a read](#section/Getting-Started/Keeping-API-Keys-Safe)!
42
+
43
+ ## Creating API Keys
44
+
45
+ Now that the Open API is enabled, you’ll be able to create API keys. You’re almost there!
46
+
47
+ **How to create an API key**
48
+
49
+ 1. On the API Keys page, click ***Create API Key***. A modal will appear.
50
+
51
+ <p>
52
+ <img src=\"APIKey_Page.JPG\"/>
53
+ </p>
54
+
55
+ <p>
56
+ <img src=\"APIKey_New.JPG\"/>
57
+ </p>
58
+
59
+ 2. Enter a clear, memorable name and description for your API key. It’ll make it easier to locate the right key when you make a request.
60
+
61
+ 3. Now, choose which pieces of Propertyware data you want this API key to have access to by selecting the corresponding radio buttons. Once finished, click **GENERATE KEY**.
62
+
63
+ 4. You have successfully created an API key! The client id and secret associated to this key will be presented.
64
+
65
+ <p>
66
+ <img src=\"APIKey_Generate.JPG\"/>
67
+ </p>
68
+
69
+ > **Important:** This is your only chance to record the secret. Make sure it’s stored somewhere secure! If it’s forgotten, you’ll need to delete this key and start from scratch.
70
+
71
+
72
+ You have now successfully created an API key and have everything you need to send requests to the Propertyware API!
73
+
74
+ Before moving on to [making your first request](#section/Getting-Started/How-to-Make-a-Request) please review [Keeping API Keys Safe](#section/Getting-Started/Keeping-API-Keys-Safe) for an overview on securely storing your API keys.
75
+ <br />
76
+ If you are having issues creating API keys you can submit a [Support](#section/API-Overview/Support) request for assistance.
77
+
78
+ ## Keeping API Keys Safe
79
+
80
+ Based on their permissions, API keys could have full access to your account’s Propertyware data. It’s important that you only grant access to trusted applications, securely record secrets, and consider a password manager to stay organized.
81
+
82
+ ### Recommended Practices
83
+
84
+ - Avoid hard-coding client IDs and secrets inside source files.
85
+ - Avoid storing client IDs and secrets in any files that may be committed to source control, particularly cloud-based source control platforms.
86
+ - Apply restrictions to client IDs and secrets shared with your staff. You can restrict a key to particular Propertyware entities or to read-only access (GET resources only).
87
+ - Avoid sharing client IDs and secrets across public, insecure platforms.
88
+ - Establish a process to regularly recreate your client IDs and secrets from your Propertyware account.
89
+ <br />
90
+ <br />
91
+
92
+ ## How to Make a Request
93
+
94
+ You’ve done a great job setting up your account, Now, we’ll walk you through how to access your data. It’s very straightforward and should only take a few minutes!
95
+
96
+ > **Tip:** Looking for the right HTTP client? If you’re just getting started, we recommend Postman.
97
+
98
+ ### Let's Get Started!
99
+
100
+ #### Step 1: Get Your API Key
101
+
102
+ If you haven't yet done so, obtain your API key client ID and secret from your Propertyware account. Your API key is how the Propertyware API authenticates requests and ensures only you can access your data.
103
+
104
+ #### Step 2: Install a HTTP client
105
+
106
+ The Propertyware API supports any standard HTTP client. If you're looking for a user-friendly HTTP client application, we recommend [Postman](https://www.postman.com/product/api-client) – it allows you to access the Propertyware API without writing code. We’ll use Postman for our example below to demonstrate sending an API request.
107
+
108
+ #### Step 3: Make a Sample Request
109
+
110
+ Let's dive in and make a simple request to get all the [Buildings](#operation/getBuildingsUsingGET) in your account. This will confirm your connectivity to our platform and validate the keys you created on our website. Simply follow the instructions below.
111
+
112
+ 1. Open the Postman application.
113
+ 2. Open the *verb* menu and select **GET**.
114
+ 3. Enter the request endpoint in the field next to GET.
115
+ - Here’s the endpoint to get all buildings: https://api.propertyware.com/pw/api/rest/v1/buildings.
116
+ 4. To authenticate the request, enter your `client ID`, your `secret` and your `organization iD` respectively in these request headers:
117
+ - `x-propertyware-client-id`
118
+ - `x-propertyware-client-secret`
119
+ - `x-propertyware-system-id` _(organization id)_
120
+
121
+ The organization id uniquely identifies your Propertyware account and is an additional measure to enforce proper access to the correct data. ___Your client id and secret pair will only work with the organization it belongs to___.
122
+
123
+ Your full request should look similar to the image below.
124
+ <kbd><img src=\"request_example.png\" /></kbd>
125
+
126
+ 5. Review the parameters of your request on last time. Once finished, click **Send**.
127
+
128
+ 6. If successful, you should see a JSON response and a `200` HTTP status code. Congratulations! You've connected to the Propertyware API.
129
+
130
+ You now have the knowledge required to make requests for any of our resources.
131
+
132
+ If you've received an error response please review the JSON response message for a description of how to resolve the issue. You can also see more information about HTTP status codes in the [Response Codes](#section/API-Overview/Response-Codes) section. If you are still having trouble making a request after reviewing these sections please submit a [Support](#section/API-Overview/Support) request.
133
+
134
+ # API Overview
135
+ The Propertyware API is built upon standard REST conventions. It's designed to use consistent resource-oriented URLs, accept and return JSON-encoded messages, and use standard HTTP status codes and verbs.
136
+
137
+ ## Base URL
138
+ The base URL for production environment API requests is: `https://api.propertyware.com/pw/api/v1/rest`
139
+
140
+ In order to ensure all requests and responses are secure between the API consumer and Propertyware servers, requests must be made using the `https` protocol. Any requests not made with the `https` protocol will be refused by the Propertyware API platform.
141
+
142
+ > **Note:** URL paths are case-sensitive to stay consistent with common REST standards. If your request doesn’t align with the documented URL path, you’ll receive a `404` response code reminding you of this constraint.
143
+
144
+ ## API Versioning
145
+ The Propertyware API is version controlled. Versioning ensures backwards-incompatible changes to the API don’t impact any existing integrations.
146
+
147
+ Propertyware uses only a major version nomenclature to manage changes. The current version of the Propertyware API is version 1. By specifying a version in the resource request URL, you'll get expected responses regardless of future changes to the API. Here's an example of calling version 1 of the retrieve all leases resource:
148
+
149
+ `https://api.propertyware.com/pw/api/rest/v1/leases`
150
+
151
+ Any request submitted without the version in the URL path will result in a `404` error response code.
152
+
153
+ ### Releasing Changes to the API
154
+ The Propertyware API will continue to evolve to ensure it meets the needs of our customers. Changes will be defined as either backwards-compatible or backwards-incompatible.
155
+
156
+ We’ll provide advance notice for all API releases–regardless of the type of modifications being made.
157
+
158
+ #### Backward-compatible Changes
159
+ Backward-compatible changes are modifications to the API that shouldn't impact existing integrations. They'll apply to the current version of the API. Simply put: you won’t need to change the version to consume new changes like these.
160
+
161
+ It's important as you develop against the Propertyware API that you ensure these types of changes don't impact your integration. Here's are examples of backward-compatible modifications.
162
+
163
+ * Adding new API resources and/or endpoints.
164
+ * Adding new optional request parameters to existing API methods.
165
+ * Adding new properties to existing API responses and non-required properties for request messages.
166
+ * Changing property order in existing API responses.
167
+
168
+ All backward-compatible changes to the API will be documented in the [Changelog](#section/Changelog).
169
+
170
+ #### Backwards-incompatible Changes
171
+
172
+ When backwards-incompatible changes to the API occur, a new version of the API will be released. You’ll need to update the URL path to consume resources under the new API version.
173
+
174
+ Backwards-incompatible changes include:
175
+
176
+ * Removing a property from a request and/or response message.
177
+ * Changing the name of a property in a message.
178
+ * Adding a required parameter to a request message.
179
+ * Changing existing enumeration values.
180
+
181
+ New versions of the API will have full reference documentation and an upgrade guide.
182
+
183
+ ## Authentication
184
+
185
+ The Propertyware API uses API key’s client IDs and secrets to authenticate requests.
186
+
187
+ An organization ID, an API key client ID and secret must be passed in every request header using the following parameters:
188
+
189
+ - `x-propertyware-client-id`
190
+ - `x-propertyware-client-secret`
191
+ - `x-propertyware-system-id`
192
+
193
+ Failing to provide both of them in the request header will cause the API to return a `401` HTTP status code.
194
+ <!--
195
+ ## Rate Limiting (FUTURE)
196
+ Rate limits help us ensure consistent and reliable performance for all users, even during peak loads. That’s why we limit clients to **10 concurrent requests per second**.
197
+
198
+ If your request rate violates that limit, a response code of `429` is returned. Simply retry the request after a short interval (~200ms).
199
+ -->
200
+
201
+ ## Bulk Request Options
202
+ All top-level API resources support bulk fetches. For instance, you can retrieve all [Portfolios](#operation/getPortfoliosUsingGET). These resources also allow for filtering criteria. Each resource has descriptions of the filter criteria available.
203
+
204
+ In addition to filtering, our API gives you the ability to control the returned data’s pagination and the sort order.
205
+
206
+ ### Pagination
207
+ Endpoints that return result sets allow for pagination using `limit` and `offset` request parameters to reduce the amount of data returned.
208
+
209
+ The `limit` request parameter will cap the number of results that come back in the response. If you don't specify a `limit` value, a **default of 100 results** are returned. The maximum `limit` value is 500. If a `limit` value is specified greater than 500, it will be overridden to the default to 500.
210
+
211
+ The `offset` request parameter indicates the record position within the resultset to start at when returning the results. The `offset` is zero-based and is inclusive. If no `offset` value is submitted it will default to 0.
212
+
213
+
214
+ The total resultset count is returned in the HTTP Header `X-Total-Count`
215
+
216
+
217
+ #### Pagination Example
218
+
219
+ As an example, let's say we make a request to retrieve all rental properties with no paging parameters. Our response indicates in the `X-Total-Count` header that there are 150 total rental properties. We want to get only the last 50 results so we would submit a request with the `offset` set to 100 and the `limit` set to 50.
220
+
221
+ > **Note:** The `limit` and `offset` parameter names are case-sensitive. If they aren't formatted correctly, the API will return a `404` HTTP status code.
222
+
223
+ ### Sorting Results
224
+
225
+ You can specify the sort order of returned data by assigning properties from the returned object to the `orderby` parameter in the querystring. For example:
226
+ ```
227
+ orderby=name
228
+ ```
229
+ By default, the sort is performed in ascending order. To specify sort order, use \"asc\" for ascending or \"desc\" for descending. For example:
230
+ ```
231
+ orderby=name desc
232
+ ```
233
+ Additionally, you can sort by multiple properties by comma separating the properties. For example:
234
+ ```
235
+ orderby=abbreviation asc,name desc
236
+ ```
237
+
238
+ > **Note:** While the `orderby` parameter is case-sensitive, the properties specified in the `orderby` value aren't.
239
+
240
+ ## Response Codes
241
+ The Propertyware API supports standard HTTP status codes.
242
+
243
+ |Response Code |Description |
244
+ |--|--|
245
+ |200 OK | Everything worked as expected. |
246
+ |400 Bad Request | The request was unacceptable, often due to missing a required parameter.|
247
+ |401 Unauthorized|The API client ID and secret weren’t provided or they’re no longer valid. Be sure that the client ID and secret combination are correct and they are still active.|
248
+ |403 Forbidden|The API key doesn't have permission to perform the request. This could be due to authorization for the given endpoint or an inability to access given entities within the platform (e.g. properties).
249
+ |404 Not Found|The requested resource doesn't exist.|
250
+ |415 Unsupported Media Type |Ensure you have the appropriate content-type header value set on your request. Each resource is documented with media type(s) that are accepted.|
251
+ |429 Too Many Requests |Too many requests against the API too quickly. We recommend an exponential backoff of your requests.|
252
+ |500 and above - Server Errors|Something went wrong on Propertyware's end. Review the JSON response message for more details about the error.|
253
+
254
+ ## API Date Format
255
+ * For all request and response date fields allowing ISO date format: YYYY-MM-DD (e.g.2019-08-24).
256
+ * For all request and response dateAndTime fields format is allowing: YYYY-MM-dd'T'HH:mm:ssXXX (e.g.2022-06-28T08:47:13Z).
257
+
258
+ ## Support
259
+ If you are unable to resolve your issue after reviewing the API documentation our support team can assist you.
260
+
261
+ # Changelog
262
+ ### 2023-07-11
263
+ * Retrieve all documents
264
+ * Retrieve a document
265
+ * Download a document
266
+
267
+ ### 2023-06-10
268
+ * Lease contacts are included in Retrieve all leases API response
269
+ * Lease contacts are included in Retrieve a lease API response
270
+
271
+ ### 2023-04-24
272
+ * Bulk Insertion: Prospects
273
+ * Bulk Insertion: Bill Payments
274
+
275
+ ### 2023-04-11
276
+
277
+ * Bulk Insertion: Portfolios
278
+ * Bulk Insertion: Buildings
279
+ * Bulk Insertion: Units
280
+
281
+ ### 2023-03-19
282
+
283
+ * Bulk insertion: contacts
284
+
285
+ ### 2023-03-08
286
+
287
+ * Bulk insertion: bills
288
+
289
+ ### 2023-01-24
290
+
291
+ * Custom fields in \"Get all\" endpoints
292
+ * Prospect creation
293
+ * Bill removals
294
+
295
+ ### 2022-10-25
296
+
297
+ * API Read operations for non-financial data
298
+
299
+ ### 2022-09-21
300
+
301
+ * API Read operations available
302
+
303
+ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
304
+
305
+ - API version: 1.0
306
+ - Package version: 1.0.5
307
+ - Build package: org.openapitools.codegen.languages.RubyClientCodegen
308
+
309
+ ## Installation
310
+
311
+ ### Build a gem
312
+
313
+ To build the Ruby code into a gem:
314
+
315
+ ```shell
316
+ gem build propertyware.gemspec
317
+ ```
318
+
319
+ Then either install the gem locally:
320
+
321
+ ```shell
322
+ gem install ./propertyware-1.0.5.gem
323
+ ```
324
+
325
+ (for development, run `gem install --dev ./propertyware-1.0.5.gem` to install the development dependencies)
326
+
327
+ or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
328
+
329
+ Finally add this to the Gemfile:
330
+
331
+ gem 'propertyware', '~> 1.0.5'
332
+
333
+ ### Install from Git
334
+
335
+ If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
336
+
337
+ gem 'propertyware', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
338
+
339
+ ### Include the Ruby code directly
340
+
341
+ Include the Ruby code directly using `-I` as follows:
342
+
343
+ ```shell
344
+ ruby -Ilib script.rb
345
+ ```
346
+
347
+ ## Getting Started
348
+
349
+ Please follow the [installation](#installation) procedure and then run the following code:
350
+
351
+ ```ruby
352
+ # Load the gem
353
+ require 'propertyware'
354
+
355
+ # Setup authorization
356
+ Propertyware.configure do |config|
357
+ # Configure API key authorization: organizationId
358
+ config.api_key['organizationId'] = 'YOUR API KEY'
359
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
360
+ # config.api_key_prefix['organizationId'] = 'Bearer'
361
+ # Configure faraday connection
362
+ config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
363
+
364
+ # Configure API key authorization: clientId
365
+ config.api_key['clientId'] = 'YOUR API KEY'
366
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
367
+ # config.api_key_prefix['clientId'] = 'Bearer'
368
+ # Configure faraday connection
369
+ config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
370
+
371
+ # Configure API key authorization: clientSecret
372
+ config.api_key['clientSecret'] = 'YOUR API KEY'
373
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
374
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
375
+ # Configure faraday connection
376
+ config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
377
+ end
378
+
379
+ api_instance = Propertyware::AccountingApi.new
380
+ save_bank_deposit = Propertyware::SaveBankDeposit.new({bank_gl_account_id: 3.56, list_of_tx_ids: 'list_of_tx_ids_example'}) # SaveBankDeposit | saveBankDeposit
381
+
382
+ begin
383
+ #Create a bank deposit (BETA)
384
+ result = api_instance.create_bank_deposit(save_bank_deposit)
385
+ p result
386
+ rescue Propertyware::ApiError => e
387
+ puts "Exception when calling AccountingApi->create_bank_deposit: #{e}"
388
+ end
389
+
390
+ ```
391
+
392
+ ## Documentation for API Endpoints
393
+
394
+ All URIs are relative to *https://api.propertyware.com/pw/api/rest/v1*
395
+
396
+ Class | Method | HTTP request | Description
397
+ ------------ | ------------- | ------------- | -------------
398
+ *Propertyware::AccountingApi* | [**create_bank_deposit**](docs/AccountingApi.md#create_bank_deposit) | **POST** /accounting/bankdeposits | Create a bank deposit (BETA)
399
+ *Propertyware::AccountingApi* | [**create_bill_payments**](docs/AccountingApi.md#create_bill_payments) | **POST** /accounting/glaccounts/bulk | Create general ledger accounts in bulk (BETA)
400
+ *Propertyware::AccountingApi* | [**create_gl_account**](docs/AccountingApi.md#create_gl_account) | **POST** /accounting/glaccounts | Create a general ledger account (BETA)
401
+ *Propertyware::AccountingApi* | [**create_owner_contribution**](docs/AccountingApi.md#create_owner_contribution) | **POST** /accounting/ownercontributions | Create an owner contribution (BETA)
402
+ *Propertyware::AccountingApi* | [**create_owner_draw**](docs/AccountingApi.md#create_owner_draw) | **POST** /accounting/ownerdraws | Create an owner draw (BETA)
403
+ *Propertyware::AccountingApi* | [**delete_bank_deposit**](docs/AccountingApi.md#delete_bank_deposit) | **DELETE** /accounting/bankdeposits/{bankDepositID} | Delete a Bank Deposit (BETA)
404
+ *Propertyware::AccountingApi* | [**delete_gl_account**](docs/AccountingApi.md#delete_gl_account) | **DELETE** /accounting/glaccounts/{glAccount} | Delete a general ledger account (BETA)
405
+ *Propertyware::AccountingApi* | [**delete_owner_contribution**](docs/AccountingApi.md#delete_owner_contribution) | **DELETE** /accounting/ownercontributions/{ownerContributionID} | Delete Owner Contribution (BETA)
406
+ *Propertyware::AccountingApi* | [**get_accounts**](docs/AccountingApi.md#get_accounts) | **GET** /accounting/glaccounts | Retrieve all the general ledger accounts (BETA)
407
+ *Propertyware::AccountingApi* | [**get_general_ledger_transactions**](docs/AccountingApi.md#get_general_ledger_transactions) | **GET** /accounting/generalledger | Retrieve all general ledger transactions (BETA)
408
+ *Propertyware::AccountingApi* | [**get_owner_contributions**](docs/AccountingApi.md#get_owner_contributions) | **GET** /accounting/ownercontributions | Retrieve all the owner contributions (BETA)
409
+ *Propertyware::AccountingApi* | [**get_owner_draws**](docs/AccountingApi.md#get_owner_draws) | **GET** /accounting/ownerdraws | Retrieve all the owner draws (BETA)
410
+ *Propertyware::AccountingApi* | [**update_gl_account**](docs/AccountingApi.md#update_gl_account) | **PUT** /accounting/glaccounts/{glAccountID} | Update a general ledger account (BETA)
411
+ *Propertyware::AccountingApi* | [**update_owner_draw**](docs/AccountingApi.md#update_owner_draw) | **PUT** /accounting/ownerdraws/{drawID} | Update an owner draw (BETA)
412
+ *Propertyware::BillsApi* | [**create_bill**](docs/BillsApi.md#create_bill) | **POST** /bills | Create a bill (BETA)
413
+ *Propertyware::BillsApi* | [**create_bill_payment**](docs/BillsApi.md#create_bill_payment) | **POST** /bills/payment | Creates Bill Payment (BETA)
414
+ *Propertyware::BillsApi* | [**create_bill_payments_using_post1**](docs/BillsApi.md#create_bill_payments_using_post1) | **POST** /bills/payments/bulk | Create bill payments in bulk (BETA)
415
+ *Propertyware::BillsApi* | [**create_bills**](docs/BillsApi.md#create_bills) | **POST** /bills/bulk | Create bills in bulk (BETA)
416
+ *Propertyware::BillsApi* | [**create_credit**](docs/BillsApi.md#create_credit) | **POST** /bills/credit | Create a credit (BETA)
417
+ *Propertyware::BillsApi* | [**create_vendor_check**](docs/BillsApi.md#create_vendor_check) | **POST** /bills/vendorChecks | Create a Vendor check (BETA)
418
+ *Propertyware::BillsApi* | [**delete_bill**](docs/BillsApi.md#delete_bill) | **DELETE** /bills/{billID} | Delete a Bill (BETA)
419
+ *Propertyware::BillsApi* | [**get_bill**](docs/BillsApi.md#get_bill) | **GET** /bills/{billID} | Retrieve a bill (BETA)
420
+ *Propertyware::BillsApi* | [**get_bill_payment**](docs/BillsApi.md#get_bill_payment) | **GET** /bills/payments/{billPaymentID} | Retrieve a bill payment (BETA)
421
+ *Propertyware::BillsApi* | [**get_bill_payments**](docs/BillsApi.md#get_bill_payments) | **GET** /bills/payments | Retrieve all bill payments (BETA)
422
+ *Propertyware::BillsApi* | [**get_bills**](docs/BillsApi.md#get_bills) | **GET** /bills | Retrieve all bills (BETA)
423
+ *Propertyware::BillsApi* | [**get_vendor_checks**](docs/BillsApi.md#get_vendor_checks) | **GET** /bills/vendorChecks | Retrieve all Vendor checks (BETA)
424
+ *Propertyware::BillsApi* | [**update_bill**](docs/BillsApi.md#update_bill) | **PUT** /bills/{billId} | Update a Bill (BETA)
425
+ *Propertyware::BillsApi* | [**update_bill_payment**](docs/BillsApi.md#update_bill_payment) | **PUT** /bills/payment/{billPaymentID} | Update a Bill Payment (BETA)
426
+ *Propertyware::BillsApi* | [**update_credit**](docs/BillsApi.md#update_credit) | **PUT** /bills/credit/{creditID} | Update a Credit (BETA)
427
+ *Propertyware::BillsApi* | [**update_vendor_check**](docs/BillsApi.md#update_vendor_check) | **PUT** /bills/vendorChecks/{vendorCheckID} | Update a Vendor check (BETA)
428
+ *Propertyware::BuildingsApi* | [**create_building**](docs/BuildingsApi.md#create_building) | **POST** /buildings | Create a building (BETA)
429
+ *Propertyware::BuildingsApi* | [**create_contacts**](docs/BuildingsApi.md#create_contacts) | **POST** /buildings/bulk | Create buildings in bulk (BETA)
430
+ *Propertyware::BuildingsApi* | [**delete_building**](docs/BuildingsApi.md#delete_building) | **DELETE** /buildings/{buildingID} | Delete a building (BETA)
431
+ *Propertyware::BuildingsApi* | [**delete_building_conversation**](docs/BuildingsApi.md#delete_building_conversation) | **DELETE** /buildings/{buildingID}/conversations/{conversationID} | Delete a building conversation (BETA)
432
+ *Propertyware::BuildingsApi* | [**get_building**](docs/BuildingsApi.md#get_building) | **GET** /buildings/{buildingID} | Retrieve a building
433
+ *Propertyware::BuildingsApi* | [**get_building_conversation**](docs/BuildingsApi.md#get_building_conversation) | **GET** /buildings/{buildingID}/conversations/{conversationID} | Retrieve a building conversation
434
+ *Propertyware::BuildingsApi* | [**get_building_conversations**](docs/BuildingsApi.md#get_building_conversations) | **GET** /buildings/{buildingID}/conversations | Retrieve all building conversations
435
+ *Propertyware::BuildingsApi* | [**get_building_management_fee**](docs/BuildingsApi.md#get_building_management_fee) | **GET** /buildings/{buildingID}/managementfees | Retrieve all building management fees (BETA)
436
+ *Propertyware::BuildingsApi* | [**get_building_managers**](docs/BuildingsApi.md#get_building_managers) | **GET** /buildings/{buildingID}/managers | Retrieve all building property managers
437
+ *Propertyware::BuildingsApi* | [**get_building_notes**](docs/BuildingsApi.md#get_building_notes) | **GET** /buildings/{buildingID}/notes | Retrieve all building notes
438
+ *Propertyware::BuildingsApi* | [**get_buildings**](docs/BuildingsApi.md#get_buildings) | **GET** /buildings | Retrieve all buildings
439
+ *Propertyware::BuildingsApi* | [**update_building**](docs/BuildingsApi.md#update_building) | **PUT** /buildings/{buildingID} | Update a building (BETA)
440
+ *Propertyware::ContactsApi* | [**create_contact**](docs/ContactsApi.md#create_contact) | **POST** /contacts | Create a contact (BETA)
441
+ *Propertyware::ContactsApi* | [**create_contacts_using_post1**](docs/ContactsApi.md#create_contacts_using_post1) | **POST** /contacts/bulk | Create contacts in bulk (BETA)
442
+ *Propertyware::ContactsApi* | [**delete_contact**](docs/ContactsApi.md#delete_contact) | **DELETE** /contacts/{contactID} | Delete a contact (BETA)
443
+ *Propertyware::ContactsApi* | [**delete_contact_conversation**](docs/ContactsApi.md#delete_contact_conversation) | **DELETE** /contacts/{contactID}/conversations/{conversationID} | Delete a contact conversation (BETA)
444
+ *Propertyware::ContactsApi* | [**get_contact**](docs/ContactsApi.md#get_contact) | **GET** /contacts/{contactID} | Retrieve a contact
445
+ *Propertyware::ContactsApi* | [**get_contact_conversation**](docs/ContactsApi.md#get_contact_conversation) | **GET** /contacts/{contactID}/conversations/{conversationID} | Retrieve a contact conversation
446
+ *Propertyware::ContactsApi* | [**get_contact_conversations**](docs/ContactsApi.md#get_contact_conversations) | **GET** /contacts/{contactID}/conversations | Retrieve all contact conversations
447
+ *Propertyware::ContactsApi* | [**get_contacts**](docs/ContactsApi.md#get_contacts) | **GET** /contacts | Retrieve all contacts
448
+ *Propertyware::ContactsApi* | [**update_contact**](docs/ContactsApi.md#update_contact) | **PUT** /contacts/{contactID} | Update a contact (BETA)
449
+ *Propertyware::DocumentsApi* | [**download_document**](docs/DocumentsApi.md#download_document) | **GET** /docs/{documentId}/download | Download a document
450
+ *Propertyware::DocumentsApi* | [**retrieve_all_documents**](docs/DocumentsApi.md#retrieve_all_documents) | **GET** /docs | Retrieve all documents
451
+ *Propertyware::DocumentsApi* | [**retrieve_document**](docs/DocumentsApi.md#retrieve_document) | **GET** /docs/{documentId} | Retrieve a document
452
+ *Propertyware::HealthCheckApi* | [**health**](docs/HealthCheckApi.md#health) | **GET** /health | Health check
453
+ *Propertyware::InspectionsApi* | [**get_inspection**](docs/InspectionsApi.md#get_inspection) | **GET** /inspections/{inspectionId} | Retrieve a inspection
454
+ *Propertyware::InspectionsApi* | [**get_inspections**](docs/InspectionsApi.md#get_inspections) | **GET** /inspections | Retrieve all inspections
455
+ *Propertyware::LeasesApi* | [**add_comment_to_lease_conversation**](docs/LeasesApi.md#add_comment_to_lease_conversation) | **POST** /leases/{leaseID}/conversations/{conversationID}/comments | Add comment to a lease conversation (BETA)
456
+ *Propertyware::LeasesApi* | [**create_journal_entry**](docs/LeasesApi.md#create_journal_entry) | **POST** /leases/journalentries | Create a lease journal entry (BETA)
457
+ *Propertyware::LeasesApi* | [**create_lease**](docs/LeasesApi.md#create_lease) | **POST** /leases | Create a lease (BETA)
458
+ *Propertyware::LeasesApi* | [**create_lease_adjustment**](docs/LeasesApi.md#create_lease_adjustment) | **POST** /leases/adjustments | Create a lease adjustment (BETA)
459
+ *Propertyware::LeasesApi* | [**create_lease_charge**](docs/LeasesApi.md#create_lease_charge) | **POST** /leases/charges | Create a lease charge (BETA)
460
+ *Propertyware::LeasesApi* | [**create_lease_charges**](docs/LeasesApi.md#create_lease_charges) | **POST** /leases/charges/bulk | Create lease charges in bulk (BETA)
461
+ *Propertyware::LeasesApi* | [**create_lease_conversation**](docs/LeasesApi.md#create_lease_conversation) | **POST** /leases/{leaseID}/conversations | Create a lease conversation (BETA)
462
+ *Propertyware::LeasesApi* | [**create_lease_discount**](docs/LeasesApi.md#create_lease_discount) | **POST** /leases/discounts | Create a lease discount (BETA)
463
+ *Propertyware::LeasesApi* | [**create_lease_payment**](docs/LeasesApi.md#create_lease_payment) | **POST** /leases/payments | Create a lease payment (BETA)
464
+ *Propertyware::LeasesApi* | [**create_lease_refund**](docs/LeasesApi.md#create_lease_refund) | **POST** /leases/refunds | Create a lease refund (BETA)
465
+ *Propertyware::LeasesApi* | [**delete_lease**](docs/LeasesApi.md#delete_lease) | **DELETE** /leases/{leaseID} | Delete a lease (BETA)
466
+ *Propertyware::LeasesApi* | [**delete_lease_conversation**](docs/LeasesApi.md#delete_lease_conversation) | **DELETE** /leases/{leaseID}/conversations/{conversationID} | Delete a lease conversation (BETA)
467
+ *Propertyware::LeasesApi* | [**get_lease**](docs/LeasesApi.md#get_lease) | **GET** /leases/{leaseId} | Retrieve a lease
468
+ *Propertyware::LeasesApi* | [**get_lease_adjustments**](docs/LeasesApi.md#get_lease_adjustments) | **GET** /leases/adjustments | Retrieve all the adjustments
469
+ *Propertyware::LeasesApi* | [**get_lease_auto_charges**](docs/LeasesApi.md#get_lease_auto_charges) | **GET** /leases/{leaseId}/autocharges | Retrieve all lease auto charges
470
+ *Propertyware::LeasesApi* | [**get_lease_auto_e_payments**](docs/LeasesApi.md#get_lease_auto_e_payments) | **GET** /leases/{leaseId}/autoepayments | Retrieve all lease auto ePayments (BETA)
471
+ *Propertyware::LeasesApi* | [**get_lease_auto_journal_entries**](docs/LeasesApi.md#get_lease_auto_journal_entries) | **GET** /leases/{leaseId}/autojournalentries | Retrieve all lease auto journal entries (BETA)
472
+ *Propertyware::LeasesApi* | [**get_lease_charges**](docs/LeasesApi.md#get_lease_charges) | **GET** /leases/charges | Retrieve all the lease charges
473
+ *Propertyware::LeasesApi* | [**get_lease_contacts**](docs/LeasesApi.md#get_lease_contacts) | **GET** /leases/{leaseId}/contacts | Retrieve all lease contacts
474
+ *Propertyware::LeasesApi* | [**get_lease_conversation**](docs/LeasesApi.md#get_lease_conversation) | **GET** /leases/{leaseID}/conversations/{conversationID} | Retrieve a lease conversation
475
+ *Propertyware::LeasesApi* | [**get_lease_conversations**](docs/LeasesApi.md#get_lease_conversations) | **GET** /leases/{leaseID}/conversations | Retrieve all lease conversations
476
+ *Propertyware::LeasesApi* | [**get_lease_custom_fields**](docs/LeasesApi.md#get_lease_custom_fields) | **GET** /leases/{leaseId}/customfields | Retrieve all lease custom fields
477
+ *Propertyware::LeasesApi* | [**get_lease_discounts**](docs/LeasesApi.md#get_lease_discounts) | **GET** /leases/discounts | Retrieve all the lease discounts
478
+ *Propertyware::LeasesApi* | [**get_lease_documents**](docs/LeasesApi.md#get_lease_documents) | **GET** /leases/{leaseId}/document | Retrieve all lease documents
479
+ *Propertyware::LeasesApi* | [**get_lease_journal_entry**](docs/LeasesApi.md#get_lease_journal_entry) | **GET** /leases/journalentries/{leaseID} | Retrieve all lease journal entries
480
+ *Propertyware::LeasesApi* | [**get_lease_late_fee**](docs/LeasesApi.md#get_lease_late_fee) | **GET** /leases/{leaseId}/latefeerule | Retrieve the lease late fee rule
481
+ *Propertyware::LeasesApi* | [**get_lease_notes**](docs/LeasesApi.md#get_lease_notes) | **GET** /leases/{leaseId}/notes | Retrieve all lease notes
482
+ *Propertyware::LeasesApi* | [**get_lease_payments**](docs/LeasesApi.md#get_lease_payments) | **GET** /leases/payments | Retrieve all the lease payments
483
+ *Propertyware::LeasesApi* | [**get_lease_refunds**](docs/LeasesApi.md#get_lease_refunds) | **GET** /leases/refunds | Retrieve all the tenant refunds
484
+ *Propertyware::LeasesApi* | [**get_lease_work_orders**](docs/LeasesApi.md#get_lease_work_orders) | **GET** /leases/{leaseId}/workorders | Retrieve all lease work orders
485
+ *Propertyware::LeasesApi* | [**get_leases**](docs/LeasesApi.md#get_leases) | **GET** /leases | Retrieve all leases
486
+ *Propertyware::LeasesApi* | [**update_lease**](docs/LeasesApi.md#update_lease) | **PUT** /leases/{leaseId} | Update a lease (BETA)
487
+ *Propertyware::LeasesApi* | [**update_lease_adjustment**](docs/LeasesApi.md#update_lease_adjustment) | **PUT** /leases/adjustments/{adjustmentID} | Update a lease adjustment (BETA)
488
+ *Propertyware::LeasesApi* | [**update_lease_charge**](docs/LeasesApi.md#update_lease_charge) | **PUT** /leases/charges/{chargeID} | Update a lease charge (BETA)
489
+ *Propertyware::LeasesApi* | [**update_lease_discount**](docs/LeasesApi.md#update_lease_discount) | **PUT** /leases/discounts/{discountID} | Updates a lease Discount (BETA)
490
+ *Propertyware::LeasesApi* | [**update_lease_journal_entry**](docs/LeasesApi.md#update_lease_journal_entry) | **PUT** /leases/journalentries/{journalentryID} | Update a lease journal entry (BETA)
491
+ *Propertyware::LeasesApi* | [**update_lease_payment**](docs/LeasesApi.md#update_lease_payment) | **PUT** /leases/payments/{entityID} | Update a lease payment (BETA)
492
+ *Propertyware::LeasesApi* | [**update_lease_refund**](docs/LeasesApi.md#update_lease_refund) | **PUT** /leases/refunds/{refundID} | Update a lease refund (BETA)
493
+ *Propertyware::PortfoliosApi* | [**create_contacts_using_post2**](docs/PortfoliosApi.md#create_contacts_using_post2) | **POST** /portfolios/bulk | Create Portfolios in bulk (BETA)
494
+ *Propertyware::PortfoliosApi* | [**create_portfolio**](docs/PortfoliosApi.md#create_portfolio) | **POST** /portfolios | Create a portfolio (BETA)
495
+ *Propertyware::PortfoliosApi* | [**delete_portfolio_conversation**](docs/PortfoliosApi.md#delete_portfolio_conversation) | **DELETE** /portfolios/{portfolioID}/conversations/{conversationID} | Delete a portfolio conversation (BETA)
496
+ *Propertyware::PortfoliosApi* | [**get_portfolio**](docs/PortfoliosApi.md#get_portfolio) | **GET** /portfolios/{portfolioID} | Retrieve a portfolio
497
+ *Propertyware::PortfoliosApi* | [**get_portfolio_conversation**](docs/PortfoliosApi.md#get_portfolio_conversation) | **GET** /portfolios/{portfolioID}/conversations/{conversationID} | Retrieve a portfolio conversation
498
+ *Propertyware::PortfoliosApi* | [**get_portfolio_conversations**](docs/PortfoliosApi.md#get_portfolio_conversations) | **GET** /portfolios/{portfolioID}/conversations | Retrieve all portfolio conversations
499
+ *Propertyware::PortfoliosApi* | [**get_portfolios**](docs/PortfoliosApi.md#get_portfolios) | **GET** /portfolios | Retrieve all portfolios
500
+ *Propertyware::PortfoliosApi* | [**update_portfolio**](docs/PortfoliosApi.md#update_portfolio) | **PUT** /portfolios/{portfolioID} | Update a portfolio (BETA)
501
+ *Propertyware::ProspectsApi* | [**create_contacts_using_post3**](docs/ProspectsApi.md#create_contacts_using_post3) | **POST** /prospects/bulk | Create prospects in bulk (BETA)
502
+ *Propertyware::ProspectsApi* | [**create_prospect**](docs/ProspectsApi.md#create_prospect) | **POST** /prospects | Create a prospect (BETA)
503
+ *Propertyware::ProspectsApi* | [**create_prospect_conversation**](docs/ProspectsApi.md#create_prospect_conversation) | **POST** /prospects/{prospectID}/conversations | Create a prospect conversation (BETA)
504
+ *Propertyware::ProspectsApi* | [**delete_prospect_conversation**](docs/ProspectsApi.md#delete_prospect_conversation) | **DELETE** /prospects/{prospectID}/conversations/{conversationID} | Delete a prospect conversation (BETA)
505
+ *Propertyware::ProspectsApi* | [**get_prospect**](docs/ProspectsApi.md#get_prospect) | **GET** /prospects/{prospectID} | Retrieve a prospect
506
+ *Propertyware::ProspectsApi* | [**get_prospect_campaign**](docs/ProspectsApi.md#get_prospect_campaign) | **GET** /prospects/{prospectID}/campaign | Retrieve prospect campaign
507
+ *Propertyware::ProspectsApi* | [**get_prospect_conversation**](docs/ProspectsApi.md#get_prospect_conversation) | **GET** /prospects/{prospectID}/conversations/{conversationID} | Retrieve a prospect conversation
508
+ *Propertyware::ProspectsApi* | [**get_prospect_conversations**](docs/ProspectsApi.md#get_prospect_conversations) | **GET** /prospects/{prospectID}/conversations | Retrieve all prospect conversations
509
+ *Propertyware::ProspectsApi* | [**get_prospects**](docs/ProspectsApi.md#get_prospects) | **GET** /prospects | Retrieve all prospects
510
+ *Propertyware::UnitsApi* | [**create_contacts_using_post4**](docs/UnitsApi.md#create_contacts_using_post4) | **POST** /units/bulk | Create units in bulk (BETA)
511
+ *Propertyware::UnitsApi* | [**create_unit**](docs/UnitsApi.md#create_unit) | **POST** /units | Create a unit (BETA)
512
+ *Propertyware::UnitsApi* | [**delete_unit**](docs/UnitsApi.md#delete_unit) | **DELETE** /units/{unitID} | Delete a unit (BETA)
513
+ *Propertyware::UnitsApi* | [**delete_unit_conversation**](docs/UnitsApi.md#delete_unit_conversation) | **DELETE** /units/{unitID}/conversations/{conversationID} | Delete a unit conversation (BETA)
514
+ *Propertyware::UnitsApi* | [**get_lease_custom_fields_using_get1**](docs/UnitsApi.md#get_lease_custom_fields_using_get1) | **GET** /units/{unitID}/customFields | Retrieve all unit custom fields
515
+ *Propertyware::UnitsApi* | [**get_unit**](docs/UnitsApi.md#get_unit) | **GET** /units/{unitID} | Retrieve a unit
516
+ *Propertyware::UnitsApi* | [**get_unit_conversation**](docs/UnitsApi.md#get_unit_conversation) | **GET** /units/{unitID}/conversations/{conversationID} | Retrieve a unit conversation
517
+ *Propertyware::UnitsApi* | [**get_unit_conversations**](docs/UnitsApi.md#get_unit_conversations) | **GET** /units/{unitID}/conversations | Retrieve all unit conversations
518
+ *Propertyware::UnitsApi* | [**get_units**](docs/UnitsApi.md#get_units) | **GET** /units | Retrieve all units
519
+ *Propertyware::UnitsApi* | [**update_unit**](docs/UnitsApi.md#update_unit) | **PUT** /units/{unitID} | Update a unit (BETA)
520
+ *Propertyware::VendorsApi* | [**create_vendor**](docs/VendorsApi.md#create_vendor) | **POST** /vendors | Create a vendor (BETA)
521
+ *Propertyware::VendorsApi* | [**create_vendors**](docs/VendorsApi.md#create_vendors) | **POST** /vendors/bulk | Create Vendors in bulk (BETA)
522
+ *Propertyware::VendorsApi* | [**get_vendor**](docs/VendorsApi.md#get_vendor) | **GET** /vendors/{vendorID} | Retrieve a vendor
523
+ *Propertyware::VendorsApi* | [**get_vendor_account**](docs/VendorsApi.md#get_vendor_account) | **GET** /vendors/{vendorID}/account | Retrieve vendor GL account (BETA)
524
+ *Propertyware::VendorsApi* | [**get_vendor_conversation**](docs/VendorsApi.md#get_vendor_conversation) | **GET** /vendors/{vendorID}/conversations/{conversationID} | Retrieve a vendor conversation
525
+ *Propertyware::VendorsApi* | [**get_vendor_conversations**](docs/VendorsApi.md#get_vendor_conversations) | **GET** /vendors/{vendorID}/conversations | Retrieve all vendor conversations
526
+ *Propertyware::VendorsApi* | [**get_vendors**](docs/VendorsApi.md#get_vendors) | **GET** /vendors | Retrieve all vendors
527
+ *Propertyware::WorkOrdersApi* | [**create_work_order**](docs/WorkOrdersApi.md#create_work_order) | **POST** /workorders | Create a work order (BETA)
528
+ *Propertyware::WorkOrdersApi* | [**create_work_order_task**](docs/WorkOrdersApi.md#create_work_order_task) | **POST** /workorders/{workOrderId}/tasks | Create a task to workOrder (BETA)
529
+ *Propertyware::WorkOrdersApi* | [**create_work_orders**](docs/WorkOrdersApi.md#create_work_orders) | **POST** /workorders/bulk | Create work orders in bulk (BETA)
530
+ *Propertyware::WorkOrdersApi* | [**delete_work_order**](docs/WorkOrdersApi.md#delete_work_order) | **DELETE** /workorders/{workOrderID} | Delete a Work Order (BETA)
531
+ *Propertyware::WorkOrdersApi* | [**delete_work_order_task**](docs/WorkOrdersApi.md#delete_work_order_task) | **DELETE** /workorders/{workOrderID}/tasks/{taskID} | Delete a work order task (BETA)
532
+ *Propertyware::WorkOrdersApi* | [**get_work_order**](docs/WorkOrdersApi.md#get_work_order) | **GET** /workorders/{workOrderId} | Retrieve a work order
533
+ *Propertyware::WorkOrdersApi* | [**get_work_order_task**](docs/WorkOrdersApi.md#get_work_order_task) | **GET** /workorders/{workOrderID}/tasks/{taskID} | Retrieve a work order task
534
+ *Propertyware::WorkOrdersApi* | [**get_work_order_tasks**](docs/WorkOrdersApi.md#get_work_order_tasks) | **GET** /workorders/{workOrderId}/tasks | Retrieve all work order tasks
535
+ *Propertyware::WorkOrdersApi* | [**get_work_orders**](docs/WorkOrdersApi.md#get_work_orders) | **GET** /workorders | Retrieve all work orders
536
+ *Propertyware::WorkOrdersApi* | [**update_work_order_task**](docs/WorkOrdersApi.md#update_work_order_task) | **PUT** /workorders/{workOrderId}/tasks/{taskId} | Update a task in workOrder (BETA)
537
+
538
+
539
+ ## Documentation for Models
540
+
541
+ - [Propertyware::Account](docs/Account.md)
542
+ - [Propertyware::Address](docs/Address.md)
543
+ - [Propertyware::Amenity](docs/Amenity.md)
544
+ - [Propertyware::AutoJournalEntry](docs/AutoJournalEntry.md)
545
+ - [Propertyware::AutoPayment](docs/AutoPayment.md)
546
+ - [Propertyware::Bank](docs/Bank.md)
547
+ - [Propertyware::BankDeposit](docs/BankDeposit.md)
548
+ - [Propertyware::BasicVendor](docs/BasicVendor.md)
549
+ - [Propertyware::Bill](docs/Bill.md)
550
+ - [Propertyware::BillPaid](docs/BillPaid.md)
551
+ - [Propertyware::BillPay](docs/BillPay.md)
552
+ - [Propertyware::BillPayment](docs/BillPayment.md)
553
+ - [Propertyware::BillSplit](docs/BillSplit.md)
554
+ - [Propertyware::Building](docs/Building.md)
555
+ - [Propertyware::Campaign](docs/Campaign.md)
556
+ - [Propertyware::CampaignSource](docs/CampaignSource.md)
557
+ - [Propertyware::Charge](docs/Charge.md)
558
+ - [Propertyware::ChargeTx](docs/ChargeTx.md)
559
+ - [Propertyware::Check](docs/Check.md)
560
+ - [Propertyware::CheckSplit](docs/CheckSplit.md)
561
+ - [Propertyware::Comment](docs/Comment.md)
562
+ - [Propertyware::Contact](docs/Contact.md)
563
+ - [Propertyware::Conversation](docs/Conversation.md)
564
+ - [Propertyware::CreditCardAccount](docs/CreditCardAccount.md)
565
+ - [Propertyware::CurrentAsset](docs/CurrentAsset.md)
566
+ - [Propertyware::CurrentLiability](docs/CurrentLiability.md)
567
+ - [Propertyware::CustomField](docs/CustomField.md)
568
+ - [Propertyware::Discount](docs/Discount.md)
569
+ - [Propertyware::Document](docs/Document.md)
570
+ - [Propertyware::Entry](docs/Entry.md)
571
+ - [Propertyware::Equity](docs/Equity.md)
572
+ - [Propertyware::ErrorResponse](docs/ErrorResponse.md)
573
+ - [Propertyware::Expense](docs/Expense.md)
574
+ - [Propertyware::GLItem](docs/GLItem.md)
575
+ - [Propertyware::Income](docs/Income.md)
576
+ - [Propertyware::Inspection](docs/Inspection.md)
577
+ - [Propertyware::InspectionArea](docs/InspectionArea.md)
578
+ - [Propertyware::InspectionItem](docs/InspectionItem.md)
579
+ - [Propertyware::JournalEntry](docs/JournalEntry.md)
580
+ - [Propertyware::JournalEntrySplit](docs/JournalEntrySplit.md)
581
+ - [Propertyware::JournalEntrySplitResponse](docs/JournalEntrySplitResponse.md)
582
+ - [Propertyware::LateFeeRule](docs/LateFeeRule.md)
583
+ - [Propertyware::Lease](docs/Lease.md)
584
+ - [Propertyware::LeaseClause](docs/LeaseClause.md)
585
+ - [Propertyware::LeaseContact](docs/LeaseContact.md)
586
+ - [Propertyware::ManagementFee](docs/ManagementFee.md)
587
+ - [Propertyware::ManagementSettings](docs/ManagementSettings.md)
588
+ - [Propertyware::Marketing](docs/Marketing.md)
589
+ - [Propertyware::NonCurrentAsset](docs/NonCurrentAsset.md)
590
+ - [Propertyware::NonCurrentLiability](docs/NonCurrentLiability.md)
591
+ - [Propertyware::NonOperatingExpense](docs/NonOperatingExpense.md)
592
+ - [Propertyware::NonOperatingInome](docs/NonOperatingInome.md)
593
+ - [Propertyware::Note](docs/Note.md)
594
+ - [Propertyware::Owner](docs/Owner.md)
595
+ - [Propertyware::OwnerContribution](docs/OwnerContribution.md)
596
+ - [Propertyware::OwnerDraw](docs/OwnerDraw.md)
597
+ - [Propertyware::Payment](docs/Payment.md)
598
+ - [Propertyware::PaymentCharge](docs/PaymentCharge.md)
599
+ - [Propertyware::Portfolio](docs/Portfolio.md)
600
+ - [Propertyware::PropertyManager](docs/PropertyManager.md)
601
+ - [Propertyware::Prospect](docs/Prospect.md)
602
+ - [Propertyware::RESTAPIBulkErrorResponse](docs/RESTAPIBulkErrorResponse.md)
603
+ - [Propertyware::RESTAPIBulkSuccessResponse](docs/RESTAPIBulkSuccessResponse.md)
604
+ - [Propertyware::RESTAPIError](docs/RESTAPIError.md)
605
+ - [Propertyware::Refund](docs/Refund.md)
606
+ - [Propertyware::ResponseEntity](docs/ResponseEntity.md)
607
+ - [Propertyware::SaveAccount](docs/SaveAccount.md)
608
+ - [Propertyware::SaveAddress](docs/SaveAddress.md)
609
+ - [Propertyware::SaveAdjustment](docs/SaveAdjustment.md)
610
+ - [Propertyware::SaveAutoCharge](docs/SaveAutoCharge.md)
611
+ - [Propertyware::SaveBankDeposit](docs/SaveBankDeposit.md)
612
+ - [Propertyware::SaveBill](docs/SaveBill.md)
613
+ - [Propertyware::SaveBillPayment](docs/SaveBillPayment.md)
614
+ - [Propertyware::SaveBillSplit](docs/SaveBillSplit.md)
615
+ - [Propertyware::SaveBuilding](docs/SaveBuilding.md)
616
+ - [Propertyware::SaveCharge](docs/SaveCharge.md)
617
+ - [Propertyware::SaveCheck](docs/SaveCheck.md)
618
+ - [Propertyware::SaveCheckSplit](docs/SaveCheckSplit.md)
619
+ - [Propertyware::SaveComment](docs/SaveComment.md)
620
+ - [Propertyware::SaveContact](docs/SaveContact.md)
621
+ - [Propertyware::SaveConversation](docs/SaveConversation.md)
622
+ - [Propertyware::SaveCredit](docs/SaveCredit.md)
623
+ - [Propertyware::SaveDiscount](docs/SaveDiscount.md)
624
+ - [Propertyware::SaveJournalEntrySplit](docs/SaveJournalEntrySplit.md)
625
+ - [Propertyware::SaveLease](docs/SaveLease.md)
626
+ - [Propertyware::SaveLeaseJournalEntry](docs/SaveLeaseJournalEntry.md)
627
+ - [Propertyware::SaveOwner](docs/SaveOwner.md)
628
+ - [Propertyware::SaveOwnerContribution](docs/SaveOwnerContribution.md)
629
+ - [Propertyware::SaveOwnerDraw](docs/SaveOwnerDraw.md)
630
+ - [Propertyware::SavePayment](docs/SavePayment.md)
631
+ - [Propertyware::SavePortfolio](docs/SavePortfolio.md)
632
+ - [Propertyware::SaveProspect](docs/SaveProspect.md)
633
+ - [Propertyware::SaveProspectContact](docs/SaveProspectContact.md)
634
+ - [Propertyware::SaveRefund](docs/SaveRefund.md)
635
+ - [Propertyware::SaveUnit](docs/SaveUnit.md)
636
+ - [Propertyware::SaveVendor](docs/SaveVendor.md)
637
+ - [Propertyware::SaveWorkOrder](docs/SaveWorkOrder.md)
638
+ - [Propertyware::SaveWorkOrderTask](docs/SaveWorkOrderTask.md)
639
+ - [Propertyware::SplitPaid](docs/SplitPaid.md)
640
+ - [Propertyware::SplitPay](docs/SplitPay.md)
641
+ - [Propertyware::Task](docs/Task.md)
642
+ - [Propertyware::Transaction](docs/Transaction.md)
643
+ - [Propertyware::Unit](docs/Unit.md)
644
+ - [Propertyware::UpdateLeaseJournalEntry](docs/UpdateLeaseJournalEntry.md)
645
+ - [Propertyware::Vendor](docs/Vendor.md)
646
+ - [Propertyware::WorkOrder](docs/WorkOrder.md)
647
+
648
+
649
+ ## Documentation for Authorization
650
+
651
+
652
+ Authentication schemes defined for the API:
653
+ ### clientId
654
+
655
+
656
+ - **Type**: API key
657
+ - **API key parameter name**: x-propertyware-client-id
658
+ - **Location**: HTTP header
659
+
660
+ ### clientSecret
661
+
662
+
663
+ - **Type**: API key
664
+ - **API key parameter name**: x-propertyware-client-secret
665
+ - **Location**: HTTP header
666
+
667
+ ### organizationId
668
+
669
+
670
+ - **Type**: API key
671
+ - **API key parameter name**: x-propertyware-system-id
672
+ - **Location**: HTTP header
673
+