propertyware 1.0.5

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.
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
@@ -0,0 +1,1235 @@
1
+ # Propertyware::AccountingApi
2
+
3
+ All URIs are relative to *https://api.propertyware.com/pw/api/rest/v1*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_bank_deposit**](AccountingApi.md#create_bank_deposit) | **POST** /accounting/bankdeposits | Create a bank deposit (BETA) |
8
+ | [**create_bill_payments**](AccountingApi.md#create_bill_payments) | **POST** /accounting/glaccounts/bulk | Create general ledger accounts in bulk (BETA) |
9
+ | [**create_gl_account**](AccountingApi.md#create_gl_account) | **POST** /accounting/glaccounts | Create a general ledger account (BETA) |
10
+ | [**create_owner_contribution**](AccountingApi.md#create_owner_contribution) | **POST** /accounting/ownercontributions | Create an owner contribution (BETA) |
11
+ | [**create_owner_draw**](AccountingApi.md#create_owner_draw) | **POST** /accounting/ownerdraws | Create an owner draw (BETA) |
12
+ | [**delete_bank_deposit**](AccountingApi.md#delete_bank_deposit) | **DELETE** /accounting/bankdeposits/{bankDepositID} | Delete a Bank Deposit (BETA) |
13
+ | [**delete_gl_account**](AccountingApi.md#delete_gl_account) | **DELETE** /accounting/glaccounts/{glAccount} | Delete a general ledger account (BETA) |
14
+ | [**delete_owner_contribution**](AccountingApi.md#delete_owner_contribution) | **DELETE** /accounting/ownercontributions/{ownerContributionID} | Delete Owner Contribution (BETA) |
15
+ | [**get_accounts**](AccountingApi.md#get_accounts) | **GET** /accounting/glaccounts | Retrieve all the general ledger accounts (BETA) |
16
+ | [**get_general_ledger_transactions**](AccountingApi.md#get_general_ledger_transactions) | **GET** /accounting/generalledger | Retrieve all general ledger transactions (BETA) |
17
+ | [**get_owner_contributions**](AccountingApi.md#get_owner_contributions) | **GET** /accounting/ownercontributions | Retrieve all the owner contributions (BETA) |
18
+ | [**get_owner_draws**](AccountingApi.md#get_owner_draws) | **GET** /accounting/ownerdraws | Retrieve all the owner draws (BETA) |
19
+ | [**update_gl_account**](AccountingApi.md#update_gl_account) | **PUT** /accounting/glaccounts/{glAccountID} | Update a general ledger account (BETA) |
20
+ | [**update_owner_draw**](AccountingApi.md#update_owner_draw) | **PUT** /accounting/ownerdraws/{drawID} | Update an owner draw (BETA) |
21
+
22
+
23
+ ## create_bank_deposit
24
+
25
+ > <BankDeposit> create_bank_deposit(save_bank_deposit)
26
+
27
+ Create a bank deposit (BETA)
28
+
29
+ <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Creates a bank deposit.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">GENERAL LEDGER</span> - <code>Write</code>
30
+
31
+ ### Examples
32
+
33
+ ```ruby
34
+ require 'time'
35
+ require 'propertyware'
36
+ # setup authorization
37
+ Propertyware.configure do |config|
38
+ # Configure API key authorization: organizationId
39
+ config.api_key['organizationId'] = 'YOUR API KEY'
40
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
41
+ # config.api_key_prefix['organizationId'] = 'Bearer'
42
+
43
+ # Configure API key authorization: clientId
44
+ config.api_key['clientId'] = 'YOUR API KEY'
45
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
46
+ # config.api_key_prefix['clientId'] = 'Bearer'
47
+
48
+ # Configure API key authorization: clientSecret
49
+ config.api_key['clientSecret'] = 'YOUR API KEY'
50
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
51
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
52
+ end
53
+
54
+ api_instance = Propertyware::AccountingApi.new
55
+ save_bank_deposit = Propertyware::SaveBankDeposit.new({bank_gl_account_id: 3.56, list_of_tx_ids: 'list_of_tx_ids_example'}) # SaveBankDeposit | saveBankDeposit
56
+
57
+ begin
58
+ # Create a bank deposit (BETA)
59
+ result = api_instance.create_bank_deposit(save_bank_deposit)
60
+ p result
61
+ rescue Propertyware::ApiError => e
62
+ puts "Error when calling AccountingApi->create_bank_deposit: #{e}"
63
+ end
64
+ ```
65
+
66
+ #### Using the create_bank_deposit_with_http_info variant
67
+
68
+ This returns an Array which contains the response data, status code and headers.
69
+
70
+ > <Array(<BankDeposit>, Integer, Hash)> create_bank_deposit_with_http_info(save_bank_deposit)
71
+
72
+ ```ruby
73
+ begin
74
+ # Create a bank deposit (BETA)
75
+ data, status_code, headers = api_instance.create_bank_deposit_with_http_info(save_bank_deposit)
76
+ p status_code # => 2xx
77
+ p headers # => { ... }
78
+ p data # => <BankDeposit>
79
+ rescue Propertyware::ApiError => e
80
+ puts "Error when calling AccountingApi->create_bank_deposit_with_http_info: #{e}"
81
+ end
82
+ ```
83
+
84
+ ### Parameters
85
+
86
+ | Name | Type | Description | Notes |
87
+ | ---- | ---- | ----------- | ----- |
88
+ | **save_bank_deposit** | [**SaveBankDeposit**](SaveBankDeposit.md) | saveBankDeposit | |
89
+
90
+ ### Return type
91
+
92
+ [**BankDeposit**](BankDeposit.md)
93
+
94
+ ### Authorization
95
+
96
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
97
+
98
+ ### HTTP request headers
99
+
100
+ - **Content-Type**: application/json
101
+ - **Accept**: application/json
102
+
103
+
104
+ ## create_bill_payments
105
+
106
+ > <Array<RESTAPIBulkSuccessResponse>> create_bill_payments(save_account)
107
+
108
+ Create general ledger accounts in bulk (BETA)
109
+
110
+ <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Creates general ledger accounts in bulk.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">GL ACCOUNTS</span> - <code>Write</code>
111
+
112
+ ### Examples
113
+
114
+ ```ruby
115
+ require 'time'
116
+ require 'propertyware'
117
+ # setup authorization
118
+ Propertyware.configure do |config|
119
+ # Configure API key authorization: organizationId
120
+ config.api_key['organizationId'] = 'YOUR API KEY'
121
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
122
+ # config.api_key_prefix['organizationId'] = 'Bearer'
123
+
124
+ # Configure API key authorization: clientId
125
+ config.api_key['clientId'] = 'YOUR API KEY'
126
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
127
+ # config.api_key_prefix['clientId'] = 'Bearer'
128
+
129
+ # Configure API key authorization: clientSecret
130
+ config.api_key['clientSecret'] = 'YOUR API KEY'
131
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
132
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
133
+ end
134
+
135
+ api_instance = Propertyware::AccountingApi.new
136
+ save_account = [Propertyware::SaveAccount.new({account_number: 'account_number_example', account_type: 37, code: 'code_example', description: 'description_example'})] # Array<SaveAccount> | saveAccount
137
+
138
+ begin
139
+ # Create general ledger accounts in bulk (BETA)
140
+ result = api_instance.create_bill_payments(save_account)
141
+ p result
142
+ rescue Propertyware::ApiError => e
143
+ puts "Error when calling AccountingApi->create_bill_payments: #{e}"
144
+ end
145
+ ```
146
+
147
+ #### Using the create_bill_payments_with_http_info variant
148
+
149
+ This returns an Array which contains the response data, status code and headers.
150
+
151
+ > <Array(<Array<RESTAPIBulkSuccessResponse>>, Integer, Hash)> create_bill_payments_with_http_info(save_account)
152
+
153
+ ```ruby
154
+ begin
155
+ # Create general ledger accounts in bulk (BETA)
156
+ data, status_code, headers = api_instance.create_bill_payments_with_http_info(save_account)
157
+ p status_code # => 2xx
158
+ p headers # => { ... }
159
+ p data # => <Array<RESTAPIBulkSuccessResponse>>
160
+ rescue Propertyware::ApiError => e
161
+ puts "Error when calling AccountingApi->create_bill_payments_with_http_info: #{e}"
162
+ end
163
+ ```
164
+
165
+ ### Parameters
166
+
167
+ | Name | Type | Description | Notes |
168
+ | ---- | ---- | ----------- | ----- |
169
+ | **save_account** | [**Array&lt;SaveAccount&gt;**](SaveAccount.md) | saveAccount | |
170
+
171
+ ### Return type
172
+
173
+ [**Array&lt;RESTAPIBulkSuccessResponse&gt;**](RESTAPIBulkSuccessResponse.md)
174
+
175
+ ### Authorization
176
+
177
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
178
+
179
+ ### HTTP request headers
180
+
181
+ - **Content-Type**: application/json
182
+ - **Accept**: application/json
183
+
184
+
185
+ ## create_gl_account
186
+
187
+ > <Account> create_gl_account(save_account)
188
+
189
+ Create a general ledger account (BETA)
190
+
191
+ <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Create a general ledger account.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">GL ACCOUNTS</span> - <code>Write</code>
192
+
193
+ ### Examples
194
+
195
+ ```ruby
196
+ require 'time'
197
+ require 'propertyware'
198
+ # setup authorization
199
+ Propertyware.configure do |config|
200
+ # Configure API key authorization: organizationId
201
+ config.api_key['organizationId'] = 'YOUR API KEY'
202
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
203
+ # config.api_key_prefix['organizationId'] = 'Bearer'
204
+
205
+ # Configure API key authorization: clientId
206
+ config.api_key['clientId'] = 'YOUR API KEY'
207
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
208
+ # config.api_key_prefix['clientId'] = 'Bearer'
209
+
210
+ # Configure API key authorization: clientSecret
211
+ config.api_key['clientSecret'] = 'YOUR API KEY'
212
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
213
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
214
+ end
215
+
216
+ api_instance = Propertyware::AccountingApi.new
217
+ save_account = Propertyware::SaveAccount.new({account_number: 'account_number_example', account_type: 37, code: 'code_example', description: 'description_example'}) # SaveAccount | saveAccount
218
+
219
+ begin
220
+ # Create a general ledger account (BETA)
221
+ result = api_instance.create_gl_account(save_account)
222
+ p result
223
+ rescue Propertyware::ApiError => e
224
+ puts "Error when calling AccountingApi->create_gl_account: #{e}"
225
+ end
226
+ ```
227
+
228
+ #### Using the create_gl_account_with_http_info variant
229
+
230
+ This returns an Array which contains the response data, status code and headers.
231
+
232
+ > <Array(<Account>, Integer, Hash)> create_gl_account_with_http_info(save_account)
233
+
234
+ ```ruby
235
+ begin
236
+ # Create a general ledger account (BETA)
237
+ data, status_code, headers = api_instance.create_gl_account_with_http_info(save_account)
238
+ p status_code # => 2xx
239
+ p headers # => { ... }
240
+ p data # => <Account>
241
+ rescue Propertyware::ApiError => e
242
+ puts "Error when calling AccountingApi->create_gl_account_with_http_info: #{e}"
243
+ end
244
+ ```
245
+
246
+ ### Parameters
247
+
248
+ | Name | Type | Description | Notes |
249
+ | ---- | ---- | ----------- | ----- |
250
+ | **save_account** | [**SaveAccount**](SaveAccount.md) | saveAccount | |
251
+
252
+ ### Return type
253
+
254
+ [**Account**](Account.md)
255
+
256
+ ### Authorization
257
+
258
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
259
+
260
+ ### HTTP request headers
261
+
262
+ - **Content-Type**: application/json
263
+ - **Accept**: application/json
264
+
265
+
266
+ ## create_owner_contribution
267
+
268
+ > <OwnerContribution> create_owner_contribution(save_owner_contribution)
269
+
270
+ Create an owner contribution (BETA)
271
+
272
+ <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Creates an owner contribution for a specified owner contact.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">PORTFOLIOS</span> - <code>Write</code>
273
+
274
+ ### Examples
275
+
276
+ ```ruby
277
+ require 'time'
278
+ require 'propertyware'
279
+ # setup authorization
280
+ Propertyware.configure do |config|
281
+ # Configure API key authorization: organizationId
282
+ config.api_key['organizationId'] = 'YOUR API KEY'
283
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
284
+ # config.api_key_prefix['organizationId'] = 'Bearer'
285
+
286
+ # Configure API key authorization: clientId
287
+ config.api_key['clientId'] = 'YOUR API KEY'
288
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
289
+ # config.api_key_prefix['clientId'] = 'Bearer'
290
+
291
+ # Configure API key authorization: clientSecret
292
+ config.api_key['clientSecret'] = 'YOUR API KEY'
293
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
294
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
295
+ end
296
+
297
+ api_instance = Propertyware::AccountingApi.new
298
+ save_owner_contribution = Propertyware::SaveOwnerContribution.new({amount: 3.56, contact_id: 3.56, date: Date.today, destination_account_id: 3.56, gl_account_id: 3.56, payment_type: 'CHECK', portfolio_id: 3.56, ref_no: 'ref_no_example'}) # SaveOwnerContribution | saveOwnerContribution
299
+
300
+ begin
301
+ # Create an owner contribution (BETA)
302
+ result = api_instance.create_owner_contribution(save_owner_contribution)
303
+ p result
304
+ rescue Propertyware::ApiError => e
305
+ puts "Error when calling AccountingApi->create_owner_contribution: #{e}"
306
+ end
307
+ ```
308
+
309
+ #### Using the create_owner_contribution_with_http_info variant
310
+
311
+ This returns an Array which contains the response data, status code and headers.
312
+
313
+ > <Array(<OwnerContribution>, Integer, Hash)> create_owner_contribution_with_http_info(save_owner_contribution)
314
+
315
+ ```ruby
316
+ begin
317
+ # Create an owner contribution (BETA)
318
+ data, status_code, headers = api_instance.create_owner_contribution_with_http_info(save_owner_contribution)
319
+ p status_code # => 2xx
320
+ p headers # => { ... }
321
+ p data # => <OwnerContribution>
322
+ rescue Propertyware::ApiError => e
323
+ puts "Error when calling AccountingApi->create_owner_contribution_with_http_info: #{e}"
324
+ end
325
+ ```
326
+
327
+ ### Parameters
328
+
329
+ | Name | Type | Description | Notes |
330
+ | ---- | ---- | ----------- | ----- |
331
+ | **save_owner_contribution** | [**SaveOwnerContribution**](SaveOwnerContribution.md) | saveOwnerContribution | |
332
+
333
+ ### Return type
334
+
335
+ [**OwnerContribution**](OwnerContribution.md)
336
+
337
+ ### Authorization
338
+
339
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
340
+
341
+ ### HTTP request headers
342
+
343
+ - **Content-Type**: application/json
344
+ - **Accept**: application/json
345
+
346
+
347
+ ## create_owner_draw
348
+
349
+ > <OwnerDraw> create_owner_draw(save_owner_draw)
350
+
351
+ Create an owner draw (BETA)
352
+
353
+ <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Creates an owner draw for a specified owner contact.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">PORTFOLIOS</span> - <code>Write</code>
354
+
355
+ ### Examples
356
+
357
+ ```ruby
358
+ require 'time'
359
+ require 'propertyware'
360
+ # setup authorization
361
+ Propertyware.configure do |config|
362
+ # Configure API key authorization: organizationId
363
+ config.api_key['organizationId'] = 'YOUR API KEY'
364
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
365
+ # config.api_key_prefix['organizationId'] = 'Bearer'
366
+
367
+ # Configure API key authorization: clientId
368
+ config.api_key['clientId'] = 'YOUR API KEY'
369
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
370
+ # config.api_key_prefix['clientId'] = 'Bearer'
371
+
372
+ # Configure API key authorization: clientSecret
373
+ config.api_key['clientSecret'] = 'YOUR API KEY'
374
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
375
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
376
+ end
377
+
378
+ api_instance = Propertyware::AccountingApi.new
379
+ save_owner_draw = Propertyware::SaveOwnerDraw.new({amount: 3.56, contact_id: 3.56, date: Date.today, destination_account_id: 3.56, gl_account_id: 3.56, portfolio_id: 3.56, to_be_printed: false}) # SaveOwnerDraw | saveOwnerDraw
380
+
381
+ begin
382
+ # Create an owner draw (BETA)
383
+ result = api_instance.create_owner_draw(save_owner_draw)
384
+ p result
385
+ rescue Propertyware::ApiError => e
386
+ puts "Error when calling AccountingApi->create_owner_draw: #{e}"
387
+ end
388
+ ```
389
+
390
+ #### Using the create_owner_draw_with_http_info variant
391
+
392
+ This returns an Array which contains the response data, status code and headers.
393
+
394
+ > <Array(<OwnerDraw>, Integer, Hash)> create_owner_draw_with_http_info(save_owner_draw)
395
+
396
+ ```ruby
397
+ begin
398
+ # Create an owner draw (BETA)
399
+ data, status_code, headers = api_instance.create_owner_draw_with_http_info(save_owner_draw)
400
+ p status_code # => 2xx
401
+ p headers # => { ... }
402
+ p data # => <OwnerDraw>
403
+ rescue Propertyware::ApiError => e
404
+ puts "Error when calling AccountingApi->create_owner_draw_with_http_info: #{e}"
405
+ end
406
+ ```
407
+
408
+ ### Parameters
409
+
410
+ | Name | Type | Description | Notes |
411
+ | ---- | ---- | ----------- | ----- |
412
+ | **save_owner_draw** | [**SaveOwnerDraw**](SaveOwnerDraw.md) | saveOwnerDraw | |
413
+
414
+ ### Return type
415
+
416
+ [**OwnerDraw**](OwnerDraw.md)
417
+
418
+ ### Authorization
419
+
420
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
421
+
422
+ ### HTTP request headers
423
+
424
+ - **Content-Type**: application/json
425
+ - **Accept**: application/json
426
+
427
+
428
+ ## delete_bank_deposit
429
+
430
+ > <ResponseEntity> delete_bank_deposit(bank_deposit_id)
431
+
432
+ Delete a Bank Deposit (BETA)
433
+
434
+ <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Delete a Bank Deposit.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">GENERAL LEDGER</span> - <code>Delete</code>
435
+
436
+ ### Examples
437
+
438
+ ```ruby
439
+ require 'time'
440
+ require 'propertyware'
441
+ # setup authorization
442
+ Propertyware.configure do |config|
443
+ # Configure API key authorization: organizationId
444
+ config.api_key['organizationId'] = 'YOUR API KEY'
445
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
446
+ # config.api_key_prefix['organizationId'] = 'Bearer'
447
+
448
+ # Configure API key authorization: clientId
449
+ config.api_key['clientId'] = 'YOUR API KEY'
450
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
451
+ # config.api_key_prefix['clientId'] = 'Bearer'
452
+
453
+ # Configure API key authorization: clientSecret
454
+ config.api_key['clientSecret'] = 'YOUR API KEY'
455
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
456
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
457
+ end
458
+
459
+ api_instance = Propertyware::AccountingApi.new
460
+ bank_deposit_id = 789 # Integer | Bank Deposit ID
461
+
462
+ begin
463
+ # Delete a Bank Deposit (BETA)
464
+ result = api_instance.delete_bank_deposit(bank_deposit_id)
465
+ p result
466
+ rescue Propertyware::ApiError => e
467
+ puts "Error when calling AccountingApi->delete_bank_deposit: #{e}"
468
+ end
469
+ ```
470
+
471
+ #### Using the delete_bank_deposit_with_http_info variant
472
+
473
+ This returns an Array which contains the response data, status code and headers.
474
+
475
+ > <Array(<ResponseEntity>, Integer, Hash)> delete_bank_deposit_with_http_info(bank_deposit_id)
476
+
477
+ ```ruby
478
+ begin
479
+ # Delete a Bank Deposit (BETA)
480
+ data, status_code, headers = api_instance.delete_bank_deposit_with_http_info(bank_deposit_id)
481
+ p status_code # => 2xx
482
+ p headers # => { ... }
483
+ p data # => <ResponseEntity>
484
+ rescue Propertyware::ApiError => e
485
+ puts "Error when calling AccountingApi->delete_bank_deposit_with_http_info: #{e}"
486
+ end
487
+ ```
488
+
489
+ ### Parameters
490
+
491
+ | Name | Type | Description | Notes |
492
+ | ---- | ---- | ----------- | ----- |
493
+ | **bank_deposit_id** | **Integer** | Bank Deposit ID | |
494
+
495
+ ### Return type
496
+
497
+ [**ResponseEntity**](ResponseEntity.md)
498
+
499
+ ### Authorization
500
+
501
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
502
+
503
+ ### HTTP request headers
504
+
505
+ - **Content-Type**: Not defined
506
+ - **Accept**: application/json
507
+
508
+
509
+ ## delete_gl_account
510
+
511
+ > <ResponseEntity> delete_gl_account(gl_account)
512
+
513
+ Delete a general ledger account (BETA)
514
+
515
+ <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Delete a general ledger account.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">GL ACCOUNTS</span> - <code>Delete</code>
516
+
517
+ ### Examples
518
+
519
+ ```ruby
520
+ require 'time'
521
+ require 'propertyware'
522
+ # setup authorization
523
+ Propertyware.configure do |config|
524
+ # Configure API key authorization: organizationId
525
+ config.api_key['organizationId'] = 'YOUR API KEY'
526
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
527
+ # config.api_key_prefix['organizationId'] = 'Bearer'
528
+
529
+ # Configure API key authorization: clientId
530
+ config.api_key['clientId'] = 'YOUR API KEY'
531
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
532
+ # config.api_key_prefix['clientId'] = 'Bearer'
533
+
534
+ # Configure API key authorization: clientSecret
535
+ config.api_key['clientSecret'] = 'YOUR API KEY'
536
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
537
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
538
+ end
539
+
540
+ api_instance = Propertyware::AccountingApi.new
541
+ gl_account = 789 # Integer | GL Account ID
542
+
543
+ begin
544
+ # Delete a general ledger account (BETA)
545
+ result = api_instance.delete_gl_account(gl_account)
546
+ p result
547
+ rescue Propertyware::ApiError => e
548
+ puts "Error when calling AccountingApi->delete_gl_account: #{e}"
549
+ end
550
+ ```
551
+
552
+ #### Using the delete_gl_account_with_http_info variant
553
+
554
+ This returns an Array which contains the response data, status code and headers.
555
+
556
+ > <Array(<ResponseEntity>, Integer, Hash)> delete_gl_account_with_http_info(gl_account)
557
+
558
+ ```ruby
559
+ begin
560
+ # Delete a general ledger account (BETA)
561
+ data, status_code, headers = api_instance.delete_gl_account_with_http_info(gl_account)
562
+ p status_code # => 2xx
563
+ p headers # => { ... }
564
+ p data # => <ResponseEntity>
565
+ rescue Propertyware::ApiError => e
566
+ puts "Error when calling AccountingApi->delete_gl_account_with_http_info: #{e}"
567
+ end
568
+ ```
569
+
570
+ ### Parameters
571
+
572
+ | Name | Type | Description | Notes |
573
+ | ---- | ---- | ----------- | ----- |
574
+ | **gl_account** | **Integer** | GL Account ID | |
575
+
576
+ ### Return type
577
+
578
+ [**ResponseEntity**](ResponseEntity.md)
579
+
580
+ ### Authorization
581
+
582
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
583
+
584
+ ### HTTP request headers
585
+
586
+ - **Content-Type**: Not defined
587
+ - **Accept**: */*
588
+
589
+
590
+ ## delete_owner_contribution
591
+
592
+ > <ResponseEntity> delete_owner_contribution(owner_contribution_id)
593
+
594
+ Delete Owner Contribution (BETA)
595
+
596
+ <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Delete Owner Contribution.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">PORTFOLIOS</span> - <code>Delete</code>
597
+
598
+ ### Examples
599
+
600
+ ```ruby
601
+ require 'time'
602
+ require 'propertyware'
603
+ # setup authorization
604
+ Propertyware.configure do |config|
605
+ # Configure API key authorization: organizationId
606
+ config.api_key['organizationId'] = 'YOUR API KEY'
607
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
608
+ # config.api_key_prefix['organizationId'] = 'Bearer'
609
+
610
+ # Configure API key authorization: clientId
611
+ config.api_key['clientId'] = 'YOUR API KEY'
612
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
613
+ # config.api_key_prefix['clientId'] = 'Bearer'
614
+
615
+ # Configure API key authorization: clientSecret
616
+ config.api_key['clientSecret'] = 'YOUR API KEY'
617
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
618
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
619
+ end
620
+
621
+ api_instance = Propertyware::AccountingApi.new
622
+ owner_contribution_id = 789 # Integer | Owner Contribution ID
623
+
624
+ begin
625
+ # Delete Owner Contribution (BETA)
626
+ result = api_instance.delete_owner_contribution(owner_contribution_id)
627
+ p result
628
+ rescue Propertyware::ApiError => e
629
+ puts "Error when calling AccountingApi->delete_owner_contribution: #{e}"
630
+ end
631
+ ```
632
+
633
+ #### Using the delete_owner_contribution_with_http_info variant
634
+
635
+ This returns an Array which contains the response data, status code and headers.
636
+
637
+ > <Array(<ResponseEntity>, Integer, Hash)> delete_owner_contribution_with_http_info(owner_contribution_id)
638
+
639
+ ```ruby
640
+ begin
641
+ # Delete Owner Contribution (BETA)
642
+ data, status_code, headers = api_instance.delete_owner_contribution_with_http_info(owner_contribution_id)
643
+ p status_code # => 2xx
644
+ p headers # => { ... }
645
+ p data # => <ResponseEntity>
646
+ rescue Propertyware::ApiError => e
647
+ puts "Error when calling AccountingApi->delete_owner_contribution_with_http_info: #{e}"
648
+ end
649
+ ```
650
+
651
+ ### Parameters
652
+
653
+ | Name | Type | Description | Notes |
654
+ | ---- | ---- | ----------- | ----- |
655
+ | **owner_contribution_id** | **Integer** | Owner Contribution ID | |
656
+
657
+ ### Return type
658
+
659
+ [**ResponseEntity**](ResponseEntity.md)
660
+
661
+ ### Authorization
662
+
663
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
664
+
665
+ ### HTTP request headers
666
+
667
+ - **Content-Type**: Not defined
668
+ - **Accept**: application/json
669
+
670
+
671
+ ## get_accounts
672
+
673
+ > <Array<Account>> get_accounts(opts)
674
+
675
+ Retrieve all the general ledger accounts (BETA)
676
+
677
+ <p class=\"betaWarning\"><b>Note: </b>This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.</p> Retrieves a list of general ledger accounts.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">GL ACCOUNTS</span> - <code>Read</code> <br/><br/><b>Sortable by:</b> <code>accountcode</code>, <code>id</code>, <code>accountnumber</code>
678
+
679
+ ### Examples
680
+
681
+ ```ruby
682
+ require 'time'
683
+ require 'propertyware'
684
+ # setup authorization
685
+ Propertyware.configure do |config|
686
+ # Configure API key authorization: organizationId
687
+ config.api_key['organizationId'] = 'YOUR API KEY'
688
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
689
+ # config.api_key_prefix['organizationId'] = 'Bearer'
690
+
691
+ # Configure API key authorization: clientId
692
+ config.api_key['clientId'] = 'YOUR API KEY'
693
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
694
+ # config.api_key_prefix['clientId'] = 'Bearer'
695
+
696
+ # Configure API key authorization: clientSecret
697
+ config.api_key['clientSecret'] = 'YOUR API KEY'
698
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
699
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
700
+ end
701
+
702
+ api_instance = Propertyware::AccountingApi.new
703
+ opts = {
704
+ offset: 56, # Integer | `offset` indicates the position of the first record to return. The offset is zero-based and the default is 0.
705
+ limit: 56, # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 500 and the default is 100.
706
+ last_modified_date_time_start: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any item modified on or after the date time specified.
707
+ last_modified_date_time_end: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any item modified on or prior to the date time specified.
708
+ orderby: 'orderby_example', # String | Indicates the field(s) and direction to sort the results in the response.
709
+ account_number: 'account_number_example', # String | Filters results to accounts with a specific number.
710
+ include_deactivated: true, # Boolean | Include deactivated results if a `true` value is passed. If no value is specified, only active accounts will be returned.
711
+ account_code: 'account_code_example', # String | Filters results to accounts with a specific code.
712
+ parent_gl_account_id: 789 # Integer | Filters results to accounts that are a children of a specific parent account.
713
+ }
714
+
715
+ begin
716
+ # Retrieve all the general ledger accounts (BETA)
717
+ result = api_instance.get_accounts(opts)
718
+ p result
719
+ rescue Propertyware::ApiError => e
720
+ puts "Error when calling AccountingApi->get_accounts: #{e}"
721
+ end
722
+ ```
723
+
724
+ #### Using the get_accounts_with_http_info variant
725
+
726
+ This returns an Array which contains the response data, status code and headers.
727
+
728
+ > <Array(<Array<Account>>, Integer, Hash)> get_accounts_with_http_info(opts)
729
+
730
+ ```ruby
731
+ begin
732
+ # Retrieve all the general ledger accounts (BETA)
733
+ data, status_code, headers = api_instance.get_accounts_with_http_info(opts)
734
+ p status_code # => 2xx
735
+ p headers # => { ... }
736
+ p data # => <Array<Account>>
737
+ rescue Propertyware::ApiError => e
738
+ puts "Error when calling AccountingApi->get_accounts_with_http_info: #{e}"
739
+ end
740
+ ```
741
+
742
+ ### Parameters
743
+
744
+ | Name | Type | Description | Notes |
745
+ | ---- | ---- | ----------- | ----- |
746
+ | **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The offset is zero-based and the default is 0. | [optional] |
747
+ | **limit** | **Integer** | &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 500 and the default is 100. | [optional][default to 100] |
748
+ | **last_modified_date_time_start** | **Time** | Filters results to any item modified on or after the date time specified. | [optional] |
749
+ | **last_modified_date_time_end** | **Time** | Filters results to any item modified on or prior to the date time specified. | [optional] |
750
+ | **orderby** | **String** | Indicates the field(s) and direction to sort the results in the response. | [optional] |
751
+ | **account_number** | **String** | Filters results to accounts with a specific number. | [optional] |
752
+ | **include_deactivated** | **Boolean** | Include deactivated results if a &#x60;true&#x60; value is passed. If no value is specified, only active accounts will be returned. | [optional] |
753
+ | **account_code** | **String** | Filters results to accounts with a specific code. | [optional] |
754
+ | **parent_gl_account_id** | **Integer** | Filters results to accounts that are a children of a specific parent account. | [optional] |
755
+
756
+ ### Return type
757
+
758
+ [**Array&lt;Account&gt;**](Account.md)
759
+
760
+ ### Authorization
761
+
762
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
763
+
764
+ ### HTTP request headers
765
+
766
+ - **Content-Type**: Not defined
767
+ - **Accept**: application/json
768
+
769
+
770
+ ## get_general_ledger_transactions
771
+
772
+ > <Array<GLItem>> get_general_ledger_transactions(opts)
773
+
774
+ Retrieve all general ledger transactions (BETA)
775
+
776
+ <p class=\"betaWarning\"><b>Note: </b>This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.</p> Retrieves a list of general ledger transactions.<br /><br />At least of the following date ranges must be passed as a filter: * `lastModifiedDateStart`-`lastModifiedDateEnd` * `createdDateStart`-`createdDateEnd`<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">GENERAL LEDGER</span> - <code>Read</code>
777
+
778
+ ### Examples
779
+
780
+ ```ruby
781
+ require 'time'
782
+ require 'propertyware'
783
+ # setup authorization
784
+ Propertyware.configure do |config|
785
+ # Configure API key authorization: organizationId
786
+ config.api_key['organizationId'] = 'YOUR API KEY'
787
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
788
+ # config.api_key_prefix['organizationId'] = 'Bearer'
789
+
790
+ # Configure API key authorization: clientId
791
+ config.api_key['clientId'] = 'YOUR API KEY'
792
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
793
+ # config.api_key_prefix['clientId'] = 'Bearer'
794
+
795
+ # Configure API key authorization: clientSecret
796
+ config.api_key['clientSecret'] = 'YOUR API KEY'
797
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
798
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
799
+ end
800
+
801
+ api_instance = Propertyware::AccountingApi.new
802
+ opts = {
803
+ offset: 56, # Integer | `offset` indicates the position of the first record to return. The offset is zero-based and the default is 0.
804
+ limit: 56, # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 500 and the default is 100.
805
+ last_modified_date_time_start: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any item modified on or after the date time specified.
806
+ last_modified_date_time_end: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any item modified on or prior to the date time specified.
807
+ orderby: 'orderby_example', # String | Indicates the field(s) and direction to sort the results in the response.
808
+ lease_id: 789, # Integer | Filters results to transactions associated with a specific lease.
809
+ owner_id: 789, # Integer | Filters results to transactions associated with a specific owner.
810
+ vendor_id: 789, # Integer | Filters results to transactions associated with a specific vendor.
811
+ portfolio_id: 789, # Integer | Filters results to transactions associated with a specific Portfolio.
812
+ post_date_start: Date.parse('2013-10-20'), # Date | Filters results to any transaction with post date on or after to the date specified.
813
+ post_date_end: Date.parse('2013-10-20') # Date | Filters results to any transaction with post date on or prior to the date specified.
814
+ }
815
+
816
+ begin
817
+ # Retrieve all general ledger transactions (BETA)
818
+ result = api_instance.get_general_ledger_transactions(opts)
819
+ p result
820
+ rescue Propertyware::ApiError => e
821
+ puts "Error when calling AccountingApi->get_general_ledger_transactions: #{e}"
822
+ end
823
+ ```
824
+
825
+ #### Using the get_general_ledger_transactions_with_http_info variant
826
+
827
+ This returns an Array which contains the response data, status code and headers.
828
+
829
+ > <Array(<Array<GLItem>>, Integer, Hash)> get_general_ledger_transactions_with_http_info(opts)
830
+
831
+ ```ruby
832
+ begin
833
+ # Retrieve all general ledger transactions (BETA)
834
+ data, status_code, headers = api_instance.get_general_ledger_transactions_with_http_info(opts)
835
+ p status_code # => 2xx
836
+ p headers # => { ... }
837
+ p data # => <Array<GLItem>>
838
+ rescue Propertyware::ApiError => e
839
+ puts "Error when calling AccountingApi->get_general_ledger_transactions_with_http_info: #{e}"
840
+ end
841
+ ```
842
+
843
+ ### Parameters
844
+
845
+ | Name | Type | Description | Notes |
846
+ | ---- | ---- | ----------- | ----- |
847
+ | **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The offset is zero-based and the default is 0. | [optional] |
848
+ | **limit** | **Integer** | &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 500 and the default is 100. | [optional][default to 100] |
849
+ | **last_modified_date_time_start** | **Time** | Filters results to any item modified on or after the date time specified. | [optional] |
850
+ | **last_modified_date_time_end** | **Time** | Filters results to any item modified on or prior to the date time specified. | [optional] |
851
+ | **orderby** | **String** | Indicates the field(s) and direction to sort the results in the response. | [optional] |
852
+ | **lease_id** | **Integer** | Filters results to transactions associated with a specific lease. | [optional] |
853
+ | **owner_id** | **Integer** | Filters results to transactions associated with a specific owner. | [optional] |
854
+ | **vendor_id** | **Integer** | Filters results to transactions associated with a specific vendor. | [optional] |
855
+ | **portfolio_id** | **Integer** | Filters results to transactions associated with a specific Portfolio. | [optional] |
856
+ | **post_date_start** | **Date** | Filters results to any transaction with post date on or after to the date specified. | [optional] |
857
+ | **post_date_end** | **Date** | Filters results to any transaction with post date on or prior to the date specified. | [optional] |
858
+
859
+ ### Return type
860
+
861
+ [**Array&lt;GLItem&gt;**](GLItem.md)
862
+
863
+ ### Authorization
864
+
865
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
866
+
867
+ ### HTTP request headers
868
+
869
+ - **Content-Type**: Not defined
870
+ - **Accept**: application/json
871
+
872
+
873
+ ## get_owner_contributions
874
+
875
+ > <Array<OwnerContribution>> get_owner_contributions(opts)
876
+
877
+ Retrieve all the owner contributions (BETA)
878
+
879
+ <p class=\"betaWarning\"><b>Note: </b>This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.</p> Retrieves a list of owner contributions.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">PORTFOLIOS</span> - <code>Read</code> <br/><br/><b>Sortable by:</b> <code>postdate</code>, <code>createddate</code>, <code>lastmodifieddatetime</code>, <code>id</code>
880
+
881
+ ### Examples
882
+
883
+ ```ruby
884
+ require 'time'
885
+ require 'propertyware'
886
+ # setup authorization
887
+ Propertyware.configure do |config|
888
+ # Configure API key authorization: organizationId
889
+ config.api_key['organizationId'] = 'YOUR API KEY'
890
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
891
+ # config.api_key_prefix['organizationId'] = 'Bearer'
892
+
893
+ # Configure API key authorization: clientId
894
+ config.api_key['clientId'] = 'YOUR API KEY'
895
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
896
+ # config.api_key_prefix['clientId'] = 'Bearer'
897
+
898
+ # Configure API key authorization: clientSecret
899
+ config.api_key['clientSecret'] = 'YOUR API KEY'
900
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
901
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
902
+ end
903
+
904
+ api_instance = Propertyware::AccountingApi.new
905
+ opts = {
906
+ offset: 56, # Integer | `offset` indicates the position of the first record to return. The offset is zero-based and the default is 0.
907
+ limit: 56, # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 500 and the default is 100.
908
+ last_modified_date_time_start: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any item modified on or after the date time specified.
909
+ last_modified_date_time_end: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any item modified on or prior to the date time specified.
910
+ orderby: 'orderby_example', # String | Indicates the field(s) and direction to sort the results in the response.
911
+ post_date_start: Date.parse('2013-10-20'), # Date | Filters results to any transaction with a start date on or after the date specified.
912
+ post_date_end: Date.parse('2013-10-20'), # Date | Filters results to any transaction with a start date on or prior to the date specified.
913
+ portfolio_id: 789, # Integer | Filters results associated with a specific portfolio.
914
+ lease_id: 789, # Integer | Filters results with Lease ID.
915
+ status: 'status_example' # String | Filters results to with Lease Status.
916
+ }
917
+
918
+ begin
919
+ # Retrieve all the owner contributions (BETA)
920
+ result = api_instance.get_owner_contributions(opts)
921
+ p result
922
+ rescue Propertyware::ApiError => e
923
+ puts "Error when calling AccountingApi->get_owner_contributions: #{e}"
924
+ end
925
+ ```
926
+
927
+ #### Using the get_owner_contributions_with_http_info variant
928
+
929
+ This returns an Array which contains the response data, status code and headers.
930
+
931
+ > <Array(<Array<OwnerContribution>>, Integer, Hash)> get_owner_contributions_with_http_info(opts)
932
+
933
+ ```ruby
934
+ begin
935
+ # Retrieve all the owner contributions (BETA)
936
+ data, status_code, headers = api_instance.get_owner_contributions_with_http_info(opts)
937
+ p status_code # => 2xx
938
+ p headers # => { ... }
939
+ p data # => <Array<OwnerContribution>>
940
+ rescue Propertyware::ApiError => e
941
+ puts "Error when calling AccountingApi->get_owner_contributions_with_http_info: #{e}"
942
+ end
943
+ ```
944
+
945
+ ### Parameters
946
+
947
+ | Name | Type | Description | Notes |
948
+ | ---- | ---- | ----------- | ----- |
949
+ | **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The offset is zero-based and the default is 0. | [optional] |
950
+ | **limit** | **Integer** | &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 500 and the default is 100. | [optional][default to 100] |
951
+ | **last_modified_date_time_start** | **Time** | Filters results to any item modified on or after the date time specified. | [optional] |
952
+ | **last_modified_date_time_end** | **Time** | Filters results to any item modified on or prior to the date time specified. | [optional] |
953
+ | **orderby** | **String** | Indicates the field(s) and direction to sort the results in the response. | [optional] |
954
+ | **post_date_start** | **Date** | Filters results to any transaction with a start date on or after the date specified. | [optional] |
955
+ | **post_date_end** | **Date** | Filters results to any transaction with a start date on or prior to the date specified. | [optional] |
956
+ | **portfolio_id** | **Integer** | Filters results associated with a specific portfolio. | [optional] |
957
+ | **lease_id** | **Integer** | Filters results with Lease ID. | [optional] |
958
+ | **status** | **String** | Filters results to with Lease Status. | [optional] |
959
+
960
+ ### Return type
961
+
962
+ [**Array&lt;OwnerContribution&gt;**](OwnerContribution.md)
963
+
964
+ ### Authorization
965
+
966
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
967
+
968
+ ### HTTP request headers
969
+
970
+ - **Content-Type**: Not defined
971
+ - **Accept**: application/json
972
+
973
+
974
+ ## get_owner_draws
975
+
976
+ > <Array<OwnerDraw>> get_owner_draws(opts)
977
+
978
+ Retrieve all the owner draws (BETA)
979
+
980
+ <p class=\"betaWarning\"><b>Note: </b>This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.</p> Retrieves a list of owner draws.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">PORTFOLIOS</span> - <code>Read</code> <br/><br/><b>Sortable by:</b> <code>postdate</code>, <code>createddate</code>, <code>lastmodifieddatetime</code>, <code>portfolioid</code>, <code>id</code>
981
+
982
+ ### Examples
983
+
984
+ ```ruby
985
+ require 'time'
986
+ require 'propertyware'
987
+ # setup authorization
988
+ Propertyware.configure do |config|
989
+ # Configure API key authorization: organizationId
990
+ config.api_key['organizationId'] = 'YOUR API KEY'
991
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
992
+ # config.api_key_prefix['organizationId'] = 'Bearer'
993
+
994
+ # Configure API key authorization: clientId
995
+ config.api_key['clientId'] = 'YOUR API KEY'
996
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
997
+ # config.api_key_prefix['clientId'] = 'Bearer'
998
+
999
+ # Configure API key authorization: clientSecret
1000
+ config.api_key['clientSecret'] = 'YOUR API KEY'
1001
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1002
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
1003
+ end
1004
+
1005
+ api_instance = Propertyware::AccountingApi.new
1006
+ opts = {
1007
+ offset: 56, # Integer | `offset` indicates the position of the first record to return. The offset is zero-based and the default is 0.
1008
+ limit: 56, # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 500 and the default is 100.
1009
+ last_modified_date_time_start: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any item modified on or after the date time specified.
1010
+ last_modified_date_time_end: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any item modified on or prior to the date time specified.
1011
+ orderby: 'orderby_example', # String | Indicates the field(s) and direction to sort the results in the response.
1012
+ post_date_start: Date.parse('2013-10-20'), # Date | Filters results to any transaction with a start date on or after the date specified.
1013
+ post_date_end: Date.parse('2013-10-20'), # Date | Filters results to any transaction with a start date on or prior to the date specified.
1014
+ portfolio_id: 789 # Integer | Filters results to with portfolioID.
1015
+ }
1016
+
1017
+ begin
1018
+ # Retrieve all the owner draws (BETA)
1019
+ result = api_instance.get_owner_draws(opts)
1020
+ p result
1021
+ rescue Propertyware::ApiError => e
1022
+ puts "Error when calling AccountingApi->get_owner_draws: #{e}"
1023
+ end
1024
+ ```
1025
+
1026
+ #### Using the get_owner_draws_with_http_info variant
1027
+
1028
+ This returns an Array which contains the response data, status code and headers.
1029
+
1030
+ > <Array(<Array<OwnerDraw>>, Integer, Hash)> get_owner_draws_with_http_info(opts)
1031
+
1032
+ ```ruby
1033
+ begin
1034
+ # Retrieve all the owner draws (BETA)
1035
+ data, status_code, headers = api_instance.get_owner_draws_with_http_info(opts)
1036
+ p status_code # => 2xx
1037
+ p headers # => { ... }
1038
+ p data # => <Array<OwnerDraw>>
1039
+ rescue Propertyware::ApiError => e
1040
+ puts "Error when calling AccountingApi->get_owner_draws_with_http_info: #{e}"
1041
+ end
1042
+ ```
1043
+
1044
+ ### Parameters
1045
+
1046
+ | Name | Type | Description | Notes |
1047
+ | ---- | ---- | ----------- | ----- |
1048
+ | **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The offset is zero-based and the default is 0. | [optional] |
1049
+ | **limit** | **Integer** | &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 500 and the default is 100. | [optional][default to 100] |
1050
+ | **last_modified_date_time_start** | **Time** | Filters results to any item modified on or after the date time specified. | [optional] |
1051
+ | **last_modified_date_time_end** | **Time** | Filters results to any item modified on or prior to the date time specified. | [optional] |
1052
+ | **orderby** | **String** | Indicates the field(s) and direction to sort the results in the response. | [optional] |
1053
+ | **post_date_start** | **Date** | Filters results to any transaction with a start date on or after the date specified. | [optional] |
1054
+ | **post_date_end** | **Date** | Filters results to any transaction with a start date on or prior to the date specified. | [optional] |
1055
+ | **portfolio_id** | **Integer** | Filters results to with portfolioID. | [optional] |
1056
+
1057
+ ### Return type
1058
+
1059
+ [**Array&lt;OwnerDraw&gt;**](OwnerDraw.md)
1060
+
1061
+ ### Authorization
1062
+
1063
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1064
+
1065
+ ### HTTP request headers
1066
+
1067
+ - **Content-Type**: Not defined
1068
+ - **Accept**: application/json
1069
+
1070
+
1071
+ ## update_gl_account
1072
+
1073
+ > <Account> update_gl_account(gl_account_id, save_account)
1074
+
1075
+ Update a general ledger account (BETA)
1076
+
1077
+ <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Updates a general ledger account.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">GL ACCOUNTS</span> - <code>Write</code>
1078
+
1079
+ ### Examples
1080
+
1081
+ ```ruby
1082
+ require 'time'
1083
+ require 'propertyware'
1084
+ # setup authorization
1085
+ Propertyware.configure do |config|
1086
+ # Configure API key authorization: organizationId
1087
+ config.api_key['organizationId'] = 'YOUR API KEY'
1088
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1089
+ # config.api_key_prefix['organizationId'] = 'Bearer'
1090
+
1091
+ # Configure API key authorization: clientId
1092
+ config.api_key['clientId'] = 'YOUR API KEY'
1093
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1094
+ # config.api_key_prefix['clientId'] = 'Bearer'
1095
+
1096
+ # Configure API key authorization: clientSecret
1097
+ config.api_key['clientSecret'] = 'YOUR API KEY'
1098
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1099
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
1100
+ end
1101
+
1102
+ api_instance = Propertyware::AccountingApi.new
1103
+ gl_account_id = 789 # Integer | GL Account ID
1104
+ save_account = Propertyware::SaveAccount.new({account_number: 'account_number_example', account_type: 37, code: 'code_example', description: 'description_example'}) # SaveAccount | saveAccount
1105
+
1106
+ begin
1107
+ # Update a general ledger account (BETA)
1108
+ result = api_instance.update_gl_account(gl_account_id, save_account)
1109
+ p result
1110
+ rescue Propertyware::ApiError => e
1111
+ puts "Error when calling AccountingApi->update_gl_account: #{e}"
1112
+ end
1113
+ ```
1114
+
1115
+ #### Using the update_gl_account_with_http_info variant
1116
+
1117
+ This returns an Array which contains the response data, status code and headers.
1118
+
1119
+ > <Array(<Account>, Integer, Hash)> update_gl_account_with_http_info(gl_account_id, save_account)
1120
+
1121
+ ```ruby
1122
+ begin
1123
+ # Update a general ledger account (BETA)
1124
+ data, status_code, headers = api_instance.update_gl_account_with_http_info(gl_account_id, save_account)
1125
+ p status_code # => 2xx
1126
+ p headers # => { ... }
1127
+ p data # => <Account>
1128
+ rescue Propertyware::ApiError => e
1129
+ puts "Error when calling AccountingApi->update_gl_account_with_http_info: #{e}"
1130
+ end
1131
+ ```
1132
+
1133
+ ### Parameters
1134
+
1135
+ | Name | Type | Description | Notes |
1136
+ | ---- | ---- | ----------- | ----- |
1137
+ | **gl_account_id** | **Integer** | GL Account ID | |
1138
+ | **save_account** | [**SaveAccount**](SaveAccount.md) | saveAccount | |
1139
+
1140
+ ### Return type
1141
+
1142
+ [**Account**](Account.md)
1143
+
1144
+ ### Authorization
1145
+
1146
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1147
+
1148
+ ### HTTP request headers
1149
+
1150
+ - **Content-Type**: application/json
1151
+ - **Accept**: application/json
1152
+
1153
+
1154
+ ## update_owner_draw
1155
+
1156
+ > <OwnerDraw> update_owner_draw(draw_id, save_owner_draw)
1157
+
1158
+ Update an owner draw (BETA)
1159
+
1160
+ <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Updates an owner draw for a specified owner contact.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">PORTFOLIOS</span> - <code>Write</code>
1161
+
1162
+ ### Examples
1163
+
1164
+ ```ruby
1165
+ require 'time'
1166
+ require 'propertyware'
1167
+ # setup authorization
1168
+ Propertyware.configure do |config|
1169
+ # Configure API key authorization: organizationId
1170
+ config.api_key['organizationId'] = 'YOUR API KEY'
1171
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1172
+ # config.api_key_prefix['organizationId'] = 'Bearer'
1173
+
1174
+ # Configure API key authorization: clientId
1175
+ config.api_key['clientId'] = 'YOUR API KEY'
1176
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1177
+ # config.api_key_prefix['clientId'] = 'Bearer'
1178
+
1179
+ # Configure API key authorization: clientSecret
1180
+ config.api_key['clientSecret'] = 'YOUR API KEY'
1181
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1182
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
1183
+ end
1184
+
1185
+ api_instance = Propertyware::AccountingApi.new
1186
+ draw_id = 789 # Integer | Owner Draw ID
1187
+ save_owner_draw = Propertyware::SaveOwnerDraw.new({amount: 3.56, contact_id: 3.56, date: Date.today, destination_account_id: 3.56, gl_account_id: 3.56, portfolio_id: 3.56, to_be_printed: false}) # SaveOwnerDraw | saveOwnerDraw
1188
+
1189
+ begin
1190
+ # Update an owner draw (BETA)
1191
+ result = api_instance.update_owner_draw(draw_id, save_owner_draw)
1192
+ p result
1193
+ rescue Propertyware::ApiError => e
1194
+ puts "Error when calling AccountingApi->update_owner_draw: #{e}"
1195
+ end
1196
+ ```
1197
+
1198
+ #### Using the update_owner_draw_with_http_info variant
1199
+
1200
+ This returns an Array which contains the response data, status code and headers.
1201
+
1202
+ > <Array(<OwnerDraw>, Integer, Hash)> update_owner_draw_with_http_info(draw_id, save_owner_draw)
1203
+
1204
+ ```ruby
1205
+ begin
1206
+ # Update an owner draw (BETA)
1207
+ data, status_code, headers = api_instance.update_owner_draw_with_http_info(draw_id, save_owner_draw)
1208
+ p status_code # => 2xx
1209
+ p headers # => { ... }
1210
+ p data # => <OwnerDraw>
1211
+ rescue Propertyware::ApiError => e
1212
+ puts "Error when calling AccountingApi->update_owner_draw_with_http_info: #{e}"
1213
+ end
1214
+ ```
1215
+
1216
+ ### Parameters
1217
+
1218
+ | Name | Type | Description | Notes |
1219
+ | ---- | ---- | ----------- | ----- |
1220
+ | **draw_id** | **Integer** | Owner Draw ID | |
1221
+ | **save_owner_draw** | [**SaveOwnerDraw**](SaveOwnerDraw.md) | saveOwnerDraw | |
1222
+
1223
+ ### Return type
1224
+
1225
+ [**OwnerDraw**](OwnerDraw.md)
1226
+
1227
+ ### Authorization
1228
+
1229
+ [organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1230
+
1231
+ ### HTTP request headers
1232
+
1233
+ - **Content-Type**: application/json
1234
+ - **Accept**: application/json
1235
+