buildium-ruby 2.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (1229) 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 +1215 -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 +26 -0
  11. data/.rspec +2 -0
  12. data/.rubocop.yml +124 -0
  13. data/CUSTOMIZATIONS.md +11 -0
  14. data/DOCS.md +811 -0
  15. data/Gemfile +9 -0
  16. data/Gemfile.lock +75 -0
  17. data/README.md +118 -0
  18. data/Rakefile +10 -0
  19. data/bin/CUSTOMIZATIONS.md +11 -0
  20. data/bin/README.md +118 -0
  21. data/bin/config.yml +9 -0
  22. data/bin/rebuild.sh +49 -0
  23. data/bin/swagger.json +52218 -0
  24. data/buildium-ruby.gemspec +39 -0
  25. data/docs/AccountInfoMessage.md +26 -0
  26. data/docs/AccountingApi.md +2041 -0
  27. data/docs/AccountingEntityMessage.md +22 -0
  28. data/docs/AccountingEntitySaveMessage.md +20 -0
  29. data/docs/AccountingLockPeriodMessage.md +22 -0
  30. data/docs/AccountingSettingsMessage.md +28 -0
  31. data/docs/AddressMessage.md +30 -0
  32. data/docs/AdministrationApi.md +485 -0
  33. data/docs/AllTasksMessage.md +46 -0
  34. data/docs/AnnouncementMessage.md +30 -0
  35. data/docs/AnnouncementPostMessage.md +28 -0
  36. data/docs/AnnouncementSearchMessage.md +26 -0
  37. data/docs/AnnouncementSenderMessage.md +22 -0
  38. data/docs/ApiError.md +20 -0
  39. data/docs/ApiErrorResponse.md +22 -0
  40. data/docs/ApplianceMessage.md +26 -0
  41. data/docs/ApplicantApplicationMessage.md +24 -0
  42. data/docs/ApplicantGroupMessage.md +26 -0
  43. data/docs/ApplicantGroupPostMessage.md +20 -0
  44. data/docs/ApplicantGroupPutMessage.md +22 -0
  45. data/docs/ApplicantGroupSearchMessage.md +26 -0
  46. data/docs/ApplicantMessage.md +36 -0
  47. data/docs/ApplicantPostMessage.md +28 -0
  48. data/docs/ApplicantPutMessage.md +26 -0
  49. data/docs/ApplicantSearchMessage.md +32 -0
  50. data/docs/ApplicantsApi.md +1489 -0
  51. data/docs/ApplicationMessage.md +26 -0
  52. data/docs/ApplicationPutMessage.md +18 -0
  53. data/docs/ApplicationResponseFieldMessage.md +24 -0
  54. data/docs/ApplicationResponseMessage.md +22 -0
  55. data/docs/ApplicationSectionResponseMessage.md +18 -0
  56. data/docs/AssociationApplianceMessage.md +32 -0
  57. data/docs/AssociationAppliancePostMessage.md +32 -0
  58. data/docs/AssociationAppliancePutMessage.md +28 -0
  59. data/docs/AssociationApplianceSearchMessage.md +20 -0
  60. data/docs/AssociationApplianceServiceHistoryMessage.md +24 -0
  61. data/docs/AssociationApplianceServiceHistoryPostMessage.md +22 -0
  62. data/docs/AssociationAppliancesApi.md +646 -0
  63. data/docs/AssociationBoardMemberMessage.md +36 -0
  64. data/docs/AssociationBoardMemberPostMessage.md +24 -0
  65. data/docs/AssociationBoardMemberPutMessage.md +22 -0
  66. data/docs/AssociationBoardMemberSearchMessage.md +24 -0
  67. data/docs/AssociationMessage.md +40 -0
  68. data/docs/AssociationOwnerBoardTermMessage.md +28 -0
  69. data/docs/AssociationOwnerBoardTermPostMessage.md +22 -0
  70. data/docs/AssociationOwnerMessage.md +52 -0
  71. data/docs/AssociationOwnerPostMessage.md +44 -0
  72. data/docs/AssociationOwnerPutMessage.md +38 -0
  73. data/docs/AssociationOwnerToExistingOwnershipAccountPostMessage.md +48 -0
  74. data/docs/AssociationOwnerUnitOccupancyPutMessage.md +18 -0
  75. data/docs/AssociationOwnerUnitOccupancyStatusMessage.md +20 -0
  76. data/docs/AssociationOwnersApi.md +916 -0
  77. data/docs/AssociationOwnershipAccountMessage.md +34 -0
  78. data/docs/AssociationOwnershipAccountPostMessage.md +32 -0
  79. data/docs/AssociationOwnershipAccountPutMessage.md +18 -0
  80. data/docs/AssociationOwnershipAccountSearchMessage.md +28 -0
  81. data/docs/AssociationOwnershipAccountsApi.md +2042 -0
  82. data/docs/AssociationPostMessage.md +32 -0
  83. data/docs/AssociationPreferredVendorMessage.md +34 -0
  84. data/docs/AssociationPreferredVendorPutMessage.md +18 -0
  85. data/docs/AssociationPutMessage.md +34 -0
  86. data/docs/AssociationSearchMessage.md +24 -0
  87. data/docs/AssociationTenantMessage.md +44 -0
  88. data/docs/AssociationTenantPostMessage.md +42 -0
  89. data/docs/AssociationTenantPutMessage.md +38 -0
  90. data/docs/AssociationTenantsApi.md +671 -0
  91. data/docs/AssociationUnitMessage.md +32 -0
  92. data/docs/AssociationUnitPutMessage.md +26 -0
  93. data/docs/AssociationUnitSearchMessage.md +22 -0
  94. data/docs/AssociationUnitsApi.md +659 -0
  95. data/docs/AssociationUnitsPostMessage.md +28 -0
  96. data/docs/AssociationUserSearchMessage.md +34 -0
  97. data/docs/AssociationsApi.md +1235 -0
  98. data/docs/BankAccountCheckAccountingEntitySaveMessage.md +20 -0
  99. data/docs/BankAccountCheckLineMessage.md +28 -0
  100. data/docs/BankAccountCheckLineSaveMessage.md +26 -0
  101. data/docs/BankAccountCheckMessage.md +30 -0
  102. data/docs/BankAccountCheckPayeeMessage.md +22 -0
  103. data/docs/BankAccountCheckPayeeSaveMessage.md +20 -0
  104. data/docs/BankAccountCheckPostMessage.md +26 -0
  105. data/docs/BankAccountCheckPutMessage.md +26 -0
  106. data/docs/BankAccountCheckSearchMessage.md +20 -0
  107. data/docs/BankAccountDepositLineMessage.md +28 -0
  108. data/docs/BankAccountDepositLineSaveMessage.md +26 -0
  109. data/docs/BankAccountDepositMessage.md +28 -0
  110. data/docs/BankAccountDepositPostMessage.md +24 -0
  111. data/docs/BankAccountDepositPutMessage.md +22 -0
  112. data/docs/BankAccountDepositSearchMessage.md +20 -0
  113. data/docs/BankAccountMessage.md +40 -0
  114. data/docs/BankAccountPostMessage.md +30 -0
  115. data/docs/BankAccountPutMessage.md +30 -0
  116. data/docs/BankAccountQuickDepositMessage.md +28 -0
  117. data/docs/BankAccountQuickDepositSaveMessage.md +26 -0
  118. data/docs/BankAccountQuickDepositSearchMessage.md +20 -0
  119. data/docs/BankAccountSearchMessage.md +20 -0
  120. data/docs/BankAccountTransactionMessage.md +36 -0
  121. data/docs/BankAccountTransactionSearchMessage.md +24 -0
  122. data/docs/BankAccountTransferAccountingEntitySaveMessage.md +20 -0
  123. data/docs/BankAccountTransferMessage.md +28 -0
  124. data/docs/BankAccountTransferSaveMessage.md +26 -0
  125. data/docs/BankAccountTransferSearchMessage.md +20 -0
  126. data/docs/BankAccountWithdrawalMessage.md +28 -0
  127. data/docs/BankAccountWithdrawalSaveMessage.md +26 -0
  128. data/docs/BankAccountWithdrawalSearchMessage.md +20 -0
  129. data/docs/BankAccountsApi.md +2224 -0
  130. data/docs/BillFileMessage.md +28 -0
  131. data/docs/BillLineMessage.md +28 -0
  132. data/docs/BillLinePostMessage.md +26 -0
  133. data/docs/BillLinePutMessage.md +28 -0
  134. data/docs/BillMarkupMessage.md +20 -0
  135. data/docs/BillMarkupSaveMessage.md +20 -0
  136. data/docs/BillMessage.md +36 -0
  137. data/docs/BillPaymentAccountingEntityMessage.md +20 -0
  138. data/docs/BillPaymentLineMessage.md +22 -0
  139. data/docs/BillPaymentLinePostMessage.md +20 -0
  140. data/docs/BillPaymentMessage.md +28 -0
  141. data/docs/BillPaymentPostMessage.md +26 -0
  142. data/docs/BillPostMessage.md +30 -0
  143. data/docs/BillPutMessage.md +28 -0
  144. data/docs/BillSearchMessage.md +32 -0
  145. data/docs/BudgetDetailsMessage.md +24 -0
  146. data/docs/BudgetDetailsSaveMessage.md +20 -0
  147. data/docs/BudgetMessage.md +28 -0
  148. data/docs/BudgetMonthlyAmountsMessage.md +40 -0
  149. data/docs/BudgetMonthlyAmountsSaveMessage.md +40 -0
  150. data/docs/BudgetPostMessage.md +26 -0
  151. data/docs/BudgetPutMessage.md +20 -0
  152. data/docs/BudgetSearchMessage.md +22 -0
  153. data/docs/ChargeRecurringTransactionPostMessage.md +32 -0
  154. data/docs/ChargeRecurringTransactionPutMessage.md +34 -0
  155. data/docs/CheckPrintingInfoMessage.md +46 -0
  156. data/docs/CheckPrintingInfoPostMessage.md +46 -0
  157. data/docs/CheckPrintingInfoPutMessage.md +46 -0
  158. data/docs/ClientLeadCreditRequestMessage.md +24 -0
  159. data/docs/ClientLeadMessage.md +38 -0
  160. data/docs/ClientLeadSearchMessage.md +26 -0
  161. data/docs/ClientLeadsApi.md +177 -0
  162. data/docs/CommunicationsApi.md +1238 -0
  163. data/docs/ContactDetailMessage.md +24 -0
  164. data/docs/ContactDetailPhoneMessage.md +22 -0
  165. data/docs/ContactDetailSaveMessage.md +24 -0
  166. data/docs/ContactDetailSavePhoneMessage.md +22 -0
  167. data/docs/ContactInfoMessage.md +24 -0
  168. data/docs/ContactRequestTaskMessage.md +42 -0
  169. data/docs/ContactRequestTaskPostMessage.md +38 -0
  170. data/docs/ContactRequestTaskPutMessage.md +38 -0
  171. data/docs/ContactRequestTaskSearchMessage.md +40 -0
  172. data/docs/CosignerMessage.md +36 -0
  173. data/docs/CreatedByUserMessage.md +24 -0
  174. data/docs/CreditRecurringTransactionPostMessage.md +36 -0
  175. data/docs/DepositDetailMessage.md +20 -0
  176. data/docs/ElectronicPaymentsMessage.md +32 -0
  177. data/docs/EmailMessage.md +24 -0
  178. data/docs/EmailPostMessage.md +30 -0
  179. data/docs/EmailRecipientMessage.md +26 -0
  180. data/docs/EmailSearchMessage.md +26 -0
  181. data/docs/EmailSenderMessage.md +24 -0
  182. data/docs/EmergencyContactMessage.md +24 -0
  183. data/docs/FileCategoryMessage.md +22 -0
  184. data/docs/FileCategoryPostMessage.md +18 -0
  185. data/docs/FileCategoryPutMessage.md +18 -0
  186. data/docs/FileDownloadMessage.md +18 -0
  187. data/docs/FileEntityMessage.md +22 -0
  188. data/docs/FileMessage.md +34 -0
  189. data/docs/FileNamePostMessage.md +18 -0
  190. data/docs/FilePutMessage.md +22 -0
  191. data/docs/FileSearchMessage.md +30 -0
  192. data/docs/FileUploadPostMessage.md +28 -0
  193. data/docs/FileUploadTicketMessage.md +22 -0
  194. data/docs/FilesApi.md +730 -0
  195. data/docs/GLAccountBalanceItemMessage.md +20 -0
  196. data/docs/GLAccountBalanceMessage.md +22 -0
  197. data/docs/GLAccountBalanceSearchMessage.md +26 -0
  198. data/docs/GLAccountMessage.md +46 -0
  199. data/docs/GLAccountPostMessage.md +32 -0
  200. data/docs/GLAccountPutMessage.md +32 -0
  201. data/docs/GLAccountsSearchMessage.md +18 -0
  202. data/docs/GLTransactionMessageV1.md +26 -0
  203. data/docs/GeneralJournalEntryLineSaveMessage.md +24 -0
  204. data/docs/GeneralJournalEntryPostMessage.md +24 -0
  205. data/docs/GeneralJournalEntryPutMessage.md +24 -0
  206. data/docs/GeneralLedgerJournalLineMessage.md +28 -0
  207. data/docs/GeneralLedgerJournalMessage.md +20 -0
  208. data/docs/GeneralLedgerTransactionMessage.md +38 -0
  209. data/docs/GeneralLedgerTransactionSearchMessage.md +26 -0
  210. data/docs/InternalTransactionStatusMessage.md +22 -0
  211. data/docs/JournalLineMessage.md +28 -0
  212. data/docs/JournalMessage.md +20 -0
  213. data/docs/LastUpdatedByUserMessage.md +26 -0
  214. data/docs/LeaseAccountDetailMessage.md +20 -0
  215. data/docs/LeaseChargeLineSaveMessage.md +22 -0
  216. data/docs/LeaseChargePostMessage.md +22 -0
  217. data/docs/LeaseChargePutMessage.md +22 -0
  218. data/docs/LeaseChargeRecurringTransactionMessage.md +40 -0
  219. data/docs/LeaseCosignerPostMessage.md +32 -0
  220. data/docs/LeaseLedgerCreditLinePostMessage.md +20 -0
  221. data/docs/LeaseLedgerCreditPostMessage.md +26 -0
  222. data/docs/LeaseLedgerDepositWithholdingLinePostMessage.md +20 -0
  223. data/docs/LeaseLedgerDepositWithholdingPostMessage.md +24 -0
  224. data/docs/LeaseLedgerPaymentLineSaveMessage.md +20 -0
  225. data/docs/LeaseLedgerPaymentPostMessage.md +30 -0
  226. data/docs/LeaseLedgerRefundLineMessage.md +20 -0
  227. data/docs/LeaseLedgerRefundLinePostMessage.md +20 -0
  228. data/docs/LeaseLedgerRefundMessage.md +34 -0
  229. data/docs/LeaseLedgerRefundPostMessage.md +30 -0
  230. data/docs/LeaseLedgerReversePaymentNSFChargePostMessage.md +20 -0
  231. data/docs/LeaseLedgerReversePaymentOtherBankChargePostMessage.md +20 -0
  232. data/docs/LeaseLedgerReversePaymentPostMessage.md +24 -0
  233. data/docs/LeaseMessage.md +58 -0
  234. data/docs/LeaseMoveOutDataMessage.md +22 -0
  235. data/docs/LeaseMoveOutDataPostMessage.md +22 -0
  236. data/docs/LeaseOutstandingBalanceMessage.md +40 -0
  237. data/docs/LeaseOutstandingBalanceSearchMessage.md +30 -0
  238. data/docs/LeasePostMessage.md +38 -0
  239. data/docs/LeasePutMessage.md +28 -0
  240. data/docs/LeaseRecurringCreditMessage.md +44 -0
  241. data/docs/LeaseRecurringPaymentMessage.md +42 -0
  242. data/docs/LeaseRenewalMessage.md +32 -0
  243. data/docs/LeaseRenewalPostMessage.md +38 -0
  244. data/docs/LeaseRentChargeMessage.md +30 -0
  245. data/docs/LeaseRentChargePostMessage.md +24 -0
  246. data/docs/LeaseRentMessage.md +34 -0
  247. data/docs/LeaseRentPostMessage.md +20 -0
  248. data/docs/LeaseSearchMessage.md +40 -0
  249. data/docs/LeaseSecurityDepositPostMessage.md +20 -0
  250. data/docs/LeaseTenantMessage.md +20 -0
  251. data/docs/LeaseTransactionMessage.md +34 -0
  252. data/docs/LeaseTransactionSearchMessage.md +22 -0
  253. data/docs/LeasesApi.md +2865 -0
  254. data/docs/ListingContactMessage.md +26 -0
  255. data/docs/ListingContactSaveMessage.md +24 -0
  256. data/docs/ListingFileMessage.md +22 -0
  257. data/docs/ListingMessage.md +36 -0
  258. data/docs/ListingPropertyMessage.md +34 -0
  259. data/docs/ListingPutMessage.md +28 -0
  260. data/docs/ListingSearchMessage.md +20 -0
  261. data/docs/ListingUnitMessage.md +36 -0
  262. data/docs/ListingsApi.md +642 -0
  263. data/docs/LockPeriodSettingsGlobalMessage.md +18 -0
  264. data/docs/LockPeriodSettingsOverridesMessage.md +20 -0
  265. data/docs/LoggedByStaffUserMessage.md +24 -0
  266. data/docs/LookupMessage.md +20 -0
  267. data/docs/MailingTemplateMessage.md +24 -0
  268. data/docs/NoteMessage.md +22 -0
  269. data/docs/NotePostMessage.md +18 -0
  270. data/docs/NotePutMessage.md +18 -0
  271. data/docs/NoteSearchMessage.md +22 -0
  272. data/docs/OutstandingBalancesLineMessage.md +20 -0
  273. data/docs/OwnershipAccountChargeRecurringTransactionMessage.md +40 -0
  274. data/docs/OwnershipAccountCreditLinePostMessage.md +20 -0
  275. data/docs/OwnershipAccountCreditPostMessage.md +26 -0
  276. data/docs/OwnershipAccountDepositWithholdingLinePostMessage.md +20 -0
  277. data/docs/OwnershipAccountDepositWithholdingPostMessage.md +24 -0
  278. data/docs/OwnershipAccountLedgerChargeLinesPutMessage.md +22 -0
  279. data/docs/OwnershipAccountLedgerChargeLinesSaveMessage.md +20 -0
  280. data/docs/OwnershipAccountLedgerChargePostMessage.md +22 -0
  281. data/docs/OwnershipAccountLedgerChargePutMessage.md +22 -0
  282. data/docs/OwnershipAccountLedgerPaymentLineSaveMessage.md +20 -0
  283. data/docs/OwnershipAccountLedgerPaymentPostMessage.md +30 -0
  284. data/docs/OwnershipAccountOutstandingBalanceMessage.md +36 -0
  285. data/docs/OwnershipAccountOutstandingBalanceSearchMessage.md +26 -0
  286. data/docs/OwnershipAccountRecurringCreditMessage.md +44 -0
  287. data/docs/OwnershipAccountRecurringPaymentMessage.md +42 -0
  288. data/docs/OwnershipAccountRefundLineMessage.md +20 -0
  289. data/docs/OwnershipAccountRefundLinesPostMessage.md +20 -0
  290. data/docs/OwnershipAccountRefundMessage.md +34 -0
  291. data/docs/OwnershipAccountRefundPostMessage.md +30 -0
  292. data/docs/OwnershipAccountTransactionMessage.md +34 -0
  293. data/docs/PaidByMessage.md +20 -0
  294. data/docs/ParticipantMessage.md +22 -0
  295. data/docs/ParticipantResourceMessage.md +20 -0
  296. data/docs/PayeeMessage.md +24 -0
  297. data/docs/PaymentDetailMessage.md +24 -0
  298. data/docs/PaymentRecurringTransactionPostMessage.md +34 -0
  299. data/docs/PaymentTransactionsMessage.md +22 -0
  300. data/docs/PhoneLogMessage.md +28 -0
  301. data/docs/PhoneLogParticipantPostMessage.md +22 -0
  302. data/docs/PhoneLogParticipantUnitAgreementPostMessage.md +20 -0
  303. data/docs/PhoneLogPostMessage.md +24 -0
  304. data/docs/PhoneLogPutMessage.md +22 -0
  305. data/docs/PhoneLogSearchMessage.md +32 -0
  306. data/docs/PhoneNumberMessage.md +20 -0
  307. data/docs/PhoneNumbersMessage.md +24 -0
  308. data/docs/PropertyGroupMessage.md +26 -0
  309. data/docs/PropertyGroupPostMessage.md +22 -0
  310. data/docs/PropertyGroupPutMessage.md +22 -0
  311. data/docs/PropertyGroupSearchMessage.md +20 -0
  312. data/docs/PropertyGroupsApi.md +327 -0
  313. data/docs/PropertyManagerMessage.md +32 -0
  314. data/docs/PropertyMessage.md +22 -0
  315. data/docs/RecurringTransactionLineMessage.md +20 -0
  316. data/docs/RecurringTransactionLinePostMessage.md +20 -0
  317. data/docs/RecurringTransactionMessage.md +40 -0
  318. data/docs/RentalApplianceMessage.md +32 -0
  319. data/docs/RentalAppliancePostMessage.md +32 -0
  320. data/docs/RentalAppliancePutMessage.md +28 -0
  321. data/docs/RentalApplianceSearchMessage.md +20 -0
  322. data/docs/RentalApplianceServiceHistoryMessage.md +24 -0
  323. data/docs/RentalApplianceServiceHistoryPostMessage.md +22 -0
  324. data/docs/RentalAppliancesApi.md +646 -0
  325. data/docs/RentalFeaturesMessage.md +20 -0
  326. data/docs/RentalFeaturesPutMessage.md +20 -0
  327. data/docs/RentalMessage.md +40 -0
  328. data/docs/RentalOwnerMessage.md +46 -0
  329. data/docs/RentalOwnerPostMessage.md +44 -0
  330. data/docs/RentalOwnerPutMessage.md +42 -0
  331. data/docs/RentalOwnerRequestTaskMessage.md +42 -0
  332. data/docs/RentalOwnerRequestTaskPostMessage.md +38 -0
  333. data/docs/RentalOwnerRequestTaskPutMessage.md +36 -0
  334. data/docs/RentalOwnerRequestTaskSearchMessage.md +40 -0
  335. data/docs/RentalOwnerTaxInformationMessage.md +28 -0
  336. data/docs/RentalOwnersApi.md +667 -0
  337. data/docs/RentalOwnersSearchMessage.md +30 -0
  338. data/docs/RentalPreferredVendorMessage.md +34 -0
  339. data/docs/RentalPreferredVendorPutMessage.md +18 -0
  340. data/docs/RentalPropertiesApi.md +989 -0
  341. data/docs/RentalPropertyPostMessage.md +36 -0
  342. data/docs/RentalPropertyPutMessage.md +32 -0
  343. data/docs/RentalPropertyUnitPostMessage.md +30 -0
  344. data/docs/RentalSearchMessage.md +32 -0
  345. data/docs/RentalTenantPostMessage.md +42 -0
  346. data/docs/RentalTenantPutMessage.md +40 -0
  347. data/docs/RentalTenantRenewalPostMessage.md +40 -0
  348. data/docs/RentalTenantsApi.md +673 -0
  349. data/docs/RentalUnitFeaturesMessage.md +18 -0
  350. data/docs/RentalUnitFeaturesPutMessage.md +18 -0
  351. data/docs/RentalUnitMessage.md +40 -0
  352. data/docs/RentalUnitPutMessage.md +30 -0
  353. data/docs/RentalUnitSearchMessage.md +22 -0
  354. data/docs/RentalUnitsApi.md +815 -0
  355. data/docs/RentalUnitsPostMessage.md +32 -0
  356. data/docs/RequestedByUserEntityMessage.md +28 -0
  357. data/docs/ResidentCenterApi.md +100 -0
  358. data/docs/ResidentCenterUserMessage.md +24 -0
  359. data/docs/ResidentCenterUserReferenceMessage.md +26 -0
  360. data/docs/ResidentCenterUserSearchMessage.md +26 -0
  361. data/docs/ResidentRequestTaskMessage.md +52 -0
  362. data/docs/ResidentRequestTaskPostMessage.md +42 -0
  363. data/docs/ResidentRequestTaskPutMessage.md +32 -0
  364. data/docs/ResidentRequestTaskSearchMessage.md +42 -0
  365. data/docs/SaveAddressMessage.md +30 -0
  366. data/docs/SaveEmergencyContactMessage.md +24 -0
  367. data/docs/TaskCategoryMessage.md +24 -0
  368. data/docs/TaskCategoryPutMessage.md +18 -0
  369. data/docs/TaskCategoryResponseMessage.md +24 -0
  370. data/docs/TaskCategorySaveMessage.md +18 -0
  371. data/docs/TaskHistoryFileMessage.md +28 -0
  372. data/docs/TaskHistoryFileUploadPostMessage.md +18 -0
  373. data/docs/TaskHistoryMessage.md +40 -0
  374. data/docs/TaskHistoryPutMessage.md +18 -0
  375. data/docs/TaskHistoryUserMessage.md +24 -0
  376. data/docs/TaskSearchMessage.md +44 -0
  377. data/docs/TaskSubCategoryMessage.md +20 -0
  378. data/docs/TasksApi.md +2528 -0
  379. data/docs/TaxInformationPostMessage.md +26 -0
  380. data/docs/TaxInformationSaveMessage.md +28 -0
  381. data/docs/TenantMessage.md +48 -0
  382. data/docs/TenantSearchMessage.md +36 -0
  383. data/docs/ToDoTaskMessage.md +40 -0
  384. data/docs/ToDoTaskPostMessage.md +36 -0
  385. data/docs/ToDoTaskPutMessage.md +36 -0
  386. data/docs/ToDoTaskSearchMessage.md +40 -0
  387. data/docs/UndepositedFundsMessage.md +18 -0
  388. data/docs/UnitAgreementMessage.md +22 -0
  389. data/docs/UserMessage.md +40 -0
  390. data/docs/UserRoleMessage.md +24 -0
  391. data/docs/UserSearchMessage.md +26 -0
  392. data/docs/VehicleMessage.md +24 -0
  393. data/docs/VendorCategoryMessage.md +22 -0
  394. data/docs/VendorCategorySaveMessage.md +18 -0
  395. data/docs/VendorCreditLineItemMessage.md +26 -0
  396. data/docs/VendorCreditLineItemPostMessage.md +24 -0
  397. data/docs/VendorCreditMessage.md +26 -0
  398. data/docs/VendorCreditPostMessage.md +24 -0
  399. data/docs/VendorInsuranceMessage.md +22 -0
  400. data/docs/VendorInsuranceSaveMessage.md +22 -0
  401. data/docs/VendorMessage.md +50 -0
  402. data/docs/VendorPostMessage.md +46 -0
  403. data/docs/VendorPutMessage.md +46 -0
  404. data/docs/VendorRefundLineMessage.md +26 -0
  405. data/docs/VendorRefundLinePostMessage.md +24 -0
  406. data/docs/VendorRefundMessage.md +30 -0
  407. data/docs/VendorRefundPostMessage.md +28 -0
  408. data/docs/VendorSearchMessage.md +32 -0
  409. data/docs/VendorTaxInformationMessage.md +28 -0
  410. data/docs/VendorTransactionMessage.md +28 -0
  411. data/docs/VendorTransactionSearchMessage.md +26 -0
  412. data/docs/VendorsApi.md +1396 -0
  413. data/docs/WorkOrderEntryContactMessage.md +20 -0
  414. data/docs/WorkOrderEntryContactResourceMessage.md +20 -0
  415. data/docs/WorkOrderLineItemMessage.md +24 -0
  416. data/docs/WorkOrderLineItemSaveMessage.md +24 -0
  417. data/docs/WorkOrderMessage.md +42 -0
  418. data/docs/WorkOrderPostMessage.md +38 -0
  419. data/docs/WorkOrderPutMessage.md +34 -0
  420. data/docs/WorkOrderSearchMessage.md +54 -0
  421. data/docs/WorkOrderTaskMessage.md +32 -0
  422. data/docs/WorkOrderTaskPostMessage.md +30 -0
  423. data/docs/WorkOrdersApi.md +361 -0
  424. data/lib/buildium-ruby/api/accounting_api.rb +1855 -0
  425. data/lib/buildium-ruby/api/administration_api.rb +417 -0
  426. data/lib/buildium-ruby/api/applicants_api.rb +1368 -0
  427. data/lib/buildium-ruby/api/association_appliances_api.rb +577 -0
  428. data/lib/buildium-ruby/api/association_owners_api.rb +849 -0
  429. data/lib/buildium-ruby/api/association_ownership_accounts_api.rb +1890 -0
  430. data/lib/buildium-ruby/api/association_tenants_api.rb +628 -0
  431. data/lib/buildium-ruby/api/association_units_api.rb +606 -0
  432. data/lib/buildium-ruby/api/associations_api.rb +1143 -0
  433. data/lib/buildium-ruby/api/bank_accounts_api.rb +2085 -0
  434. data/lib/buildium-ruby/api/client_leads_api.rb +174 -0
  435. data/lib/buildium-ruby/api/communications_api.rb +1097 -0
  436. data/lib/buildium-ruby/api/files_api.rb +652 -0
  437. data/lib/buildium-ruby/api/leases_api.rb +2636 -0
  438. data/lib/buildium-ruby/api/listings_api.rb +569 -0
  439. data/lib/buildium-ruby/api/property_groups_api.rb +299 -0
  440. data/lib/buildium-ruby/api/rental_appliances_api.rb +577 -0
  441. data/lib/buildium-ruby/api/rental_owners_api.rb +622 -0
  442. data/lib/buildium-ruby/api/rental_properties_api.rb +916 -0
  443. data/lib/buildium-ruby/api/rental_tenants_api.rb +635 -0
  444. data/lib/buildium-ruby/api/rental_units_api.rb +743 -0
  445. data/lib/buildium-ruby/api/resident_center_api.rb +111 -0
  446. data/lib/buildium-ruby/api/tasks_api.rb +2363 -0
  447. data/lib/buildium-ruby/api/vendors_api.rb +1285 -0
  448. data/lib/buildium-ruby/api/work_orders_api.rb +366 -0
  449. data/lib/buildium-ruby/api_client.rb +426 -0
  450. data/lib/buildium-ruby/api_error.rb +57 -0
  451. data/lib/buildium-ruby/configuration.rb +319 -0
  452. data/lib/buildium-ruby/models/account_info_message.rb +257 -0
  453. data/lib/buildium-ruby/models/accounting_entity_message.rb +273 -0
  454. data/lib/buildium-ruby/models/accounting_entity_save_message.rb +273 -0
  455. data/lib/buildium-ruby/models/accounting_lock_period_message.rb +242 -0
  456. data/lib/buildium-ruby/models/accounting_settings_message.rb +314 -0
  457. data/lib/buildium-ruby/models/address_message.rb +313 -0
  458. data/lib/buildium-ruby/models/all_tasks_message.rb +413 -0
  459. data/lib/buildium-ruby/models/announcement_message.rb +301 -0
  460. data/lib/buildium-ruby/models/announcement_post_message.rb +295 -0
  461. data/lib/buildium-ruby/models/announcement_search_message.rb +292 -0
  462. data/lib/buildium-ruby/models/announcement_sender_message.rb +239 -0
  463. data/lib/buildium-ruby/models/api_error_response.rb +237 -0
  464. data/lib/buildium-ruby/models/appliance_message.rb +259 -0
  465. data/lib/buildium-ruby/models/applicant_application_message.rb +282 -0
  466. data/lib/buildium-ruby/models/applicant_group_message.rb +294 -0
  467. data/lib/buildium-ruby/models/applicant_group_post_message.rb +235 -0
  468. data/lib/buildium-ruby/models/applicant_group_put_message.rb +284 -0
  469. data/lib/buildium-ruby/models/applicant_group_search_message.rb +296 -0
  470. data/lib/buildium-ruby/models/applicant_message.rb +312 -0
  471. data/lib/buildium-ruby/models/applicant_post_message.rb +283 -0
  472. data/lib/buildium-ruby/models/applicant_put_message.rb +267 -0
  473. data/lib/buildium-ruby/models/applicant_search_message.rb +326 -0
  474. data/lib/buildium-ruby/models/application_message.rb +294 -0
  475. data/lib/buildium-ruby/models/application_put_message.rb +257 -0
  476. data/lib/buildium-ruby/models/application_response_field_message.rb +294 -0
  477. data/lib/buildium-ruby/models/application_response_message.rb +274 -0
  478. data/lib/buildium-ruby/models/application_section_response_message.rb +219 -0
  479. data/lib/buildium-ruby/models/association_appliance_message.rb +288 -0
  480. data/lib/buildium-ruby/models/association_appliance_post_message.rb +298 -0
  481. data/lib/buildium-ruby/models/association_appliance_put_message.rb +273 -0
  482. data/lib/buildium-ruby/models/association_appliance_search_message.rb +232 -0
  483. data/lib/buildium-ruby/models/association_appliance_service_history_message.rb +282 -0
  484. data/lib/buildium-ruby/models/association_appliance_service_history_post_message.rb +282 -0
  485. data/lib/buildium-ruby/models/association_board_member_message.rb +344 -0
  486. data/lib/buildium-ruby/models/association_board_member_post_message.rb +293 -0
  487. data/lib/buildium-ruby/models/association_board_member_put_message.rb +278 -0
  488. data/lib/buildium-ruby/models/association_board_member_search_message.rb +274 -0
  489. data/lib/buildium-ruby/models/association_message.rb +327 -0
  490. data/lib/buildium-ruby/models/association_owner_board_term_message.rb +303 -0
  491. data/lib/buildium-ruby/models/association_owner_board_term_post_message.rb +278 -0
  492. data/lib/buildium-ruby/models/association_owner_message.rb +440 -0
  493. data/lib/buildium-ruby/models/association_owner_post_message.rb +398 -0
  494. data/lib/buildium-ruby/models/association_owner_put_message.rb +363 -0
  495. data/lib/buildium-ruby/models/association_owner_to_existing_ownership_account_post_message.rb +428 -0
  496. data/lib/buildium-ruby/models/association_owner_unit_occupancy_put_message.rb +223 -0
  497. data/lib/buildium-ruby/models/association_owner_unit_occupancy_status_message.rb +228 -0
  498. data/lib/buildium-ruby/models/association_ownership_account_message.rb +347 -0
  499. data/lib/buildium-ruby/models/association_ownership_account_post_message.rb +346 -0
  500. data/lib/buildium-ruby/models/association_ownership_account_put_message.rb +223 -0
  501. data/lib/buildium-ruby/models/association_ownership_account_search_message.rb +296 -0
  502. data/lib/buildium-ruby/models/association_post_message.rb +302 -0
  503. data/lib/buildium-ruby/models/association_preferred_vendor_message.rb +300 -0
  504. data/lib/buildium-ruby/models/association_preferred_vendor_put_message.rb +225 -0
  505. data/lib/buildium-ruby/models/association_put_message.rb +322 -0
  506. data/lib/buildium-ruby/models/association_search_message.rb +283 -0
  507. data/lib/buildium-ruby/models/association_tenant_message.rb +350 -0
  508. data/lib/buildium-ruby/models/association_tenant_post_message.rb +354 -0
  509. data/lib/buildium-ruby/models/association_tenant_put_message.rb +329 -0
  510. data/lib/buildium-ruby/models/association_unit_message.rb +334 -0
  511. data/lib/buildium-ruby/models/association_unit_put_message.rb +313 -0
  512. data/lib/buildium-ruby/models/association_unit_search_message.rb +241 -0
  513. data/lib/buildium-ruby/models/association_units_post_message.rb +328 -0
  514. data/lib/buildium-ruby/models/association_user_search_message.rb +324 -0
  515. data/lib/buildium-ruby/models/bank_account_check_accounting_entity_save_message.rb +272 -0
  516. data/lib/buildium-ruby/models/bank_account_check_line_message.rb +267 -0
  517. data/lib/buildium-ruby/models/bank_account_check_line_save_message.rb +272 -0
  518. data/lib/buildium-ruby/models/bank_account_check_message.rb +279 -0
  519. data/lib/buildium-ruby/models/bank_account_check_payee_message.rb +272 -0
  520. data/lib/buildium-ruby/models/bank_account_check_payee_save_message.rb +272 -0
  521. data/lib/buildium-ruby/models/bank_account_check_post_message.rb +274 -0
  522. data/lib/buildium-ruby/models/bank_account_check_put_message.rb +274 -0
  523. data/lib/buildium-ruby/models/bank_account_check_search_message.rb +238 -0
  524. data/lib/buildium-ruby/models/bank_account_deposit_line_message.rb +267 -0
  525. data/lib/buildium-ruby/models/bank_account_deposit_line_save_message.rb +257 -0
  526. data/lib/buildium-ruby/models/bank_account_deposit_message.rb +272 -0
  527. data/lib/buildium-ruby/models/bank_account_deposit_post_message.rb +257 -0
  528. data/lib/buildium-ruby/models/bank_account_deposit_put_message.rb +250 -0
  529. data/lib/buildium-ruby/models/bank_account_deposit_search_message.rb +238 -0
  530. data/lib/buildium-ruby/models/bank_account_message.rb +360 -0
  531. data/lib/buildium-ruby/models/bank_account_post_message.rb +338 -0
  532. data/lib/buildium-ruby/models/bank_account_put_message.rb +343 -0
  533. data/lib/buildium-ruby/models/bank_account_quick_deposit_message.rb +267 -0
  534. data/lib/buildium-ruby/models/bank_account_quick_deposit_save_message.rb +277 -0
  535. data/lib/buildium-ruby/models/bank_account_quick_deposit_search_message.rb +238 -0
  536. data/lib/buildium-ruby/models/bank_account_search_message.rb +263 -0
  537. data/lib/buildium-ruby/models/bank_account_transaction_message.rb +359 -0
  538. data/lib/buildium-ruby/models/bank_account_transaction_search_message.rb +292 -0
  539. data/lib/buildium-ruby/models/bank_account_transfer_accounting_entity_save_message.rb +272 -0
  540. data/lib/buildium-ruby/models/bank_account_transfer_message.rb +267 -0
  541. data/lib/buildium-ruby/models/bank_account_transfer_save_message.rb +277 -0
  542. data/lib/buildium-ruby/models/bank_account_transfer_search_message.rb +238 -0
  543. data/lib/buildium-ruby/models/bank_account_withdrawal_message.rb +267 -0
  544. data/lib/buildium-ruby/models/bank_account_withdrawal_save_message.rb +277 -0
  545. data/lib/buildium-ruby/models/bank_account_withdrawal_search_message.rb +238 -0
  546. data/lib/buildium-ruby/models/bill_file_message.rb +268 -0
  547. data/lib/buildium-ruby/models/bill_line_message.rb +266 -0
  548. data/lib/buildium-ruby/models/bill_line_post_message.rb +272 -0
  549. data/lib/buildium-ruby/models/bill_line_put_message.rb +282 -0
  550. data/lib/buildium-ruby/models/bill_markup_message.rb +263 -0
  551. data/lib/buildium-ruby/models/bill_markup_save_message.rb +273 -0
  552. data/lib/buildium-ruby/models/bill_message.rb +344 -0
  553. data/lib/buildium-ruby/models/bill_payment_accounting_entity_message.rb +263 -0
  554. data/lib/buildium-ruby/models/bill_payment_line_message.rb +238 -0
  555. data/lib/buildium-ruby/models/bill_payment_line_post_message.rb +238 -0
  556. data/lib/buildium-ruby/models/bill_payment_message.rb +270 -0
  557. data/lib/buildium-ruby/models/bill_payment_post_message.rb +275 -0
  558. data/lib/buildium-ruby/models/bill_post_message.rb +301 -0
  559. data/lib/buildium-ruby/models/bill_put_message.rb +286 -0
  560. data/lib/buildium-ruby/models/bill_search_message.rb +336 -0
  561. data/lib/buildium-ruby/models/budget_details_message.rb +281 -0
  562. data/lib/buildium-ruby/models/budget_details_save_message.rb +237 -0
  563. data/lib/buildium-ruby/models/budget_message.rb +269 -0
  564. data/lib/buildium-ruby/models/budget_monthly_amounts_message.rb +328 -0
  565. data/lib/buildium-ruby/models/budget_monthly_amounts_save_message.rb +388 -0
  566. data/lib/buildium-ruby/models/budget_post_message.rb +319 -0
  567. data/lib/buildium-ruby/models/budget_put_message.rb +240 -0
  568. data/lib/buildium-ruby/models/budget_search_message.rb +240 -0
  569. data/lib/buildium-ruby/models/charge_recurring_transaction_post_message.rb +359 -0
  570. data/lib/buildium-ruby/models/charge_recurring_transaction_put_message.rb +374 -0
  571. data/lib/buildium-ruby/models/check_printing_info_message.rb +392 -0
  572. data/lib/buildium-ruby/models/check_printing_info_post_message.rb +392 -0
  573. data/lib/buildium-ruby/models/check_printing_info_put_message.rb +407 -0
  574. data/lib/buildium-ruby/models/client_lead_credit_request_message.rb +295 -0
  575. data/lib/buildium-ruby/models/client_lead_message.rb +363 -0
  576. data/lib/buildium-ruby/models/client_lead_search_message.rb +285 -0
  577. data/lib/buildium-ruby/models/contact_detail_message.rb +248 -0
  578. data/lib/buildium-ruby/models/contact_detail_phone_message.rb +239 -0
  579. data/lib/buildium-ruby/models/contact_detail_save_message.rb +253 -0
  580. data/lib/buildium-ruby/models/contact_detail_save_phone_message.rb +239 -0
  581. data/lib/buildium-ruby/models/contact_info_message.rb +248 -0
  582. data/lib/buildium-ruby/models/contact_request_task_message.rb +381 -0
  583. data/lib/buildium-ruby/models/contact_request_task_post_message.rb +388 -0
  584. data/lib/buildium-ruby/models/contact_request_task_put_message.rb +388 -0
  585. data/lib/buildium-ruby/models/contact_request_task_search_message.rb +366 -0
  586. data/lib/buildium-ruby/models/cosigner_message.rb +343 -0
  587. data/lib/buildium-ruby/models/created_by_user_message.rb +248 -0
  588. data/lib/buildium-ruby/models/credit_recurring_transaction_post_message.rb +388 -0
  589. data/lib/buildium-ruby/models/deposit_detail_message.rb +231 -0
  590. data/lib/buildium-ruby/models/electronic_payments_message.rb +288 -0
  591. data/lib/buildium-ruby/models/email_message.rb +247 -0
  592. data/lib/buildium-ruby/models/email_post_message.rb +307 -0
  593. data/lib/buildium-ruby/models/email_recipient_message.rb +292 -0
  594. data/lib/buildium-ruby/models/email_search_message.rb +268 -0
  595. data/lib/buildium-ruby/models/email_sender_message.rb +248 -0
  596. data/lib/buildium-ruby/models/emergency_contact_message.rb +249 -0
  597. data/lib/buildium-ruby/models/file_category_message.rb +239 -0
  598. data/lib/buildium-ruby/models/file_category_post_message.rb +224 -0
  599. data/lib/buildium-ruby/models/file_category_put_message.rb +224 -0
  600. data/lib/buildium-ruby/models/file_download_message.rb +218 -0
  601. data/lib/buildium-ruby/models/file_entity_message.rb +273 -0
  602. data/lib/buildium-ruby/models/file_message.rb +297 -0
  603. data/lib/buildium-ruby/models/file_name_post_message.rb +223 -0
  604. data/lib/buildium-ruby/models/file_put_message.rb +248 -0
  605. data/lib/buildium-ruby/models/file_search_message.rb +315 -0
  606. data/lib/buildium-ruby/models/file_upload_post_message.rb +322 -0
  607. data/lib/buildium-ruby/models/file_upload_ticket_message.rb +240 -0
  608. data/lib/buildium-ruby/models/general_journal_entry_line_save_message.rb +297 -0
  609. data/lib/buildium-ruby/models/general_journal_entry_post_message.rb +264 -0
  610. data/lib/buildium-ruby/models/general_journal_entry_put_message.rb +264 -0
  611. data/lib/buildium-ruby/models/general_ledger_journal_line_message.rb +267 -0
  612. data/lib/buildium-ruby/models/general_ledger_journal_message.rb +230 -0
  613. data/lib/buildium-ruby/models/general_ledger_transaction_message.rb +349 -0
  614. data/lib/buildium-ruby/models/general_ledger_transaction_search_message.rb +310 -0
  615. data/lib/buildium-ruby/models/gl_account_balance_item_message.rb +228 -0
  616. data/lib/buildium-ruby/models/gl_account_balance_message.rb +240 -0
  617. data/lib/buildium-ruby/models/gl_account_balance_search_message.rb +317 -0
  618. data/lib/buildium-ruby/models/gl_account_message.rb +419 -0
  619. data/lib/buildium-ruby/models/gl_account_post_message.rb +349 -0
  620. data/lib/buildium-ruby/models/gl_account_put_message.rb +344 -0
  621. data/lib/buildium-ruby/models/gl_accounts_search_message.rb +243 -0
  622. data/lib/buildium-ruby/models/gl_transaction_message_v1.rb +258 -0
  623. data/lib/buildium-ruby/models/internal_transaction_status_message.rb +239 -0
  624. data/lib/buildium-ruby/models/journal_line_message.rb +268 -0
  625. data/lib/buildium-ruby/models/journal_message.rb +230 -0
  626. data/lib/buildium-ruby/models/last_updated_by_user_message.rb +259 -0
  627. data/lib/buildium-ruby/models/lease_account_detail_message.rb +229 -0
  628. data/lib/buildium-ruby/models/lease_charge_line_save_message.rb +249 -0
  629. data/lib/buildium-ruby/models/lease_charge_post_message.rb +241 -0
  630. data/lib/buildium-ruby/models/lease_charge_put_message.rb +250 -0
  631. data/lib/buildium-ruby/models/lease_charge_recurring_transaction_message.rb +374 -0
  632. data/lib/buildium-ruby/models/lease_cosigner_post_message.rb +330 -0
  633. data/lib/buildium-ruby/models/lease_ledger_credit_line_post_message.rb +239 -0
  634. data/lib/buildium-ruby/models/lease_ledger_credit_post_message.rb +309 -0
  635. data/lib/buildium-ruby/models/lease_ledger_deposit_withholding_line_post_message.rb +238 -0
  636. data/lib/buildium-ruby/models/lease_ledger_deposit_withholding_post_message.rb +260 -0
  637. data/lib/buildium-ruby/models/lease_ledger_payment_line_save_message.rb +239 -0
  638. data/lib/buildium-ruby/models/lease_ledger_payment_post_message.rb +335 -0
  639. data/lib/buildium-ruby/models/lease_ledger_refund_line_message.rb +228 -0
  640. data/lib/buildium-ruby/models/lease_ledger_refund_line_post_message.rb +238 -0
  641. data/lib/buildium-ruby/models/lease_ledger_refund_message.rb +301 -0
  642. data/lib/buildium-ruby/models/lease_ledger_refund_post_message.rb +306 -0
  643. data/lib/buildium-ruby/models/lease_ledger_reverse_payment_nsf_charge_post_message.rb +239 -0
  644. data/lib/buildium-ruby/models/lease_ledger_reverse_payment_other_bank_charge_post_message.rb +239 -0
  645. data/lib/buildium-ruby/models/lease_ledger_reverse_payment_post_message.rb +256 -0
  646. data/lib/buildium-ruby/models/lease_message.rb +496 -0
  647. data/lib/buildium-ruby/models/lease_move_out_data_message.rb +238 -0
  648. data/lib/buildium-ruby/models/lease_move_out_data_post_message.rb +248 -0
  649. data/lib/buildium-ruby/models/lease_outstanding_balance_message.rb +330 -0
  650. data/lib/buildium-ruby/models/lease_outstanding_balance_search_message.rb +345 -0
  651. data/lib/buildium-ruby/models/lease_post_message.rb +379 -0
  652. data/lib/buildium-ruby/models/lease_put_message.rb +322 -0
  653. data/lib/buildium-ruby/models/lease_recurring_credit_message.rb +408 -0
  654. data/lib/buildium-ruby/models/lease_recurring_payment_message.rb +397 -0
  655. data/lib/buildium-ruby/models/lease_renewal_message.rb +336 -0
  656. data/lib/buildium-ruby/models/lease_renewal_post_message.rb +378 -0
  657. data/lib/buildium-ruby/models/lease_rent_charge_message.rb +278 -0
  658. data/lib/buildium-ruby/models/lease_rent_charge_post_message.rb +263 -0
  659. data/lib/buildium-ruby/models/lease_rent_message.rb +334 -0
  660. data/lib/buildium-ruby/models/lease_rent_post_message.rb +275 -0
  661. data/lib/buildium-ruby/models/lease_search_message.rb +359 -0
  662. data/lib/buildium-ruby/models/lease_security_deposit_post_message.rb +239 -0
  663. data/lib/buildium-ruby/models/lease_tenant_message.rb +262 -0
  664. data/lib/buildium-ruby/models/lease_transaction_message.rb +298 -0
  665. data/lib/buildium-ruby/models/lease_transaction_search_message.rb +263 -0
  666. data/lib/buildium-ruby/models/listing_contact_message.rb +259 -0
  667. data/lib/buildium-ruby/models/listing_contact_save_message.rb +253 -0
  668. data/lib/buildium-ruby/models/listing_file_message.rb +272 -0
  669. data/lib/buildium-ruby/models/listing_message.rb +305 -0
  670. data/lib/buildium-ruby/models/listing_property_message.rb +326 -0
  671. data/lib/buildium-ruby/models/listing_put_message.rb +283 -0
  672. data/lib/buildium-ruby/models/listing_search_message.rb +262 -0
  673. data/lib/buildium-ruby/models/listing_unit_message.rb +358 -0
  674. data/lib/buildium-ruby/models/lock_period_settings_global_message.rb +218 -0
  675. data/lib/buildium-ruby/models/lock_period_settings_overrides_message.rb +227 -0
  676. data/lib/buildium-ruby/models/logged_by_staff_user_message.rb +249 -0
  677. data/lib/buildium-ruby/models/lookup_message.rb +226 -0
  678. data/lib/buildium-ruby/models/mailing_template_message.rb +282 -0
  679. data/lib/buildium-ruby/models/note_message.rb +237 -0
  680. data/lib/buildium-ruby/models/note_post_message.rb +223 -0
  681. data/lib/buildium-ruby/models/note_put_message.rb +223 -0
  682. data/lib/buildium-ruby/models/note_search_message.rb +238 -0
  683. data/lib/buildium-ruby/models/outstanding_balances_line_message.rb +228 -0
  684. data/lib/buildium-ruby/models/ownership_account_charge_recurring_transaction_message.rb +374 -0
  685. data/lib/buildium-ruby/models/ownership_account_credit_line_post_message.rb +238 -0
  686. data/lib/buildium-ruby/models/ownership_account_credit_post_message.rb +309 -0
  687. data/lib/buildium-ruby/models/ownership_account_deposit_withholding_line_post_message.rb +238 -0
  688. data/lib/buildium-ruby/models/ownership_account_deposit_withholding_post_message.rb +260 -0
  689. data/lib/buildium-ruby/models/ownership_account_ledger_charge_lines_put_message.rb +248 -0
  690. data/lib/buildium-ruby/models/ownership_account_ledger_charge_lines_save_message.rb +238 -0
  691. data/lib/buildium-ruby/models/ownership_account_ledger_charge_post_message.rb +250 -0
  692. data/lib/buildium-ruby/models/ownership_account_ledger_charge_put_message.rb +250 -0
  693. data/lib/buildium-ruby/models/ownership_account_ledger_payment_line_save_message.rb +239 -0
  694. data/lib/buildium-ruby/models/ownership_account_ledger_payment_post_message.rb +335 -0
  695. data/lib/buildium-ruby/models/ownership_account_outstanding_balance_message.rb +310 -0
  696. data/lib/buildium-ruby/models/ownership_account_outstanding_balance_search_message.rb +308 -0
  697. data/lib/buildium-ruby/models/ownership_account_recurring_credit_message.rb +408 -0
  698. data/lib/buildium-ruby/models/ownership_account_recurring_payment_message.rb +397 -0
  699. data/lib/buildium-ruby/models/ownership_account_refund_line_message.rb +228 -0
  700. data/lib/buildium-ruby/models/ownership_account_refund_lines_post_message.rb +238 -0
  701. data/lib/buildium-ruby/models/ownership_account_refund_message.rb +301 -0
  702. data/lib/buildium-ruby/models/ownership_account_refund_post_message.rb +306 -0
  703. data/lib/buildium-ruby/models/ownership_account_transaction_message.rb +298 -0
  704. data/lib/buildium-ruby/models/paid_by_message.rb +228 -0
  705. data/lib/buildium-ruby/models/participant_message.rb +240 -0
  706. data/lib/buildium-ruby/models/participant_resource_message.rb +263 -0
  707. data/lib/buildium-ruby/models/payee_message.rb +283 -0
  708. data/lib/buildium-ruby/models/payment_detail_message.rb +281 -0
  709. data/lib/buildium-ruby/models/payment_recurring_transaction_post_message.rb +378 -0
  710. data/lib/buildium-ruby/models/payment_transactions_message.rb +237 -0
  711. data/lib/buildium-ruby/models/phone_log_message.rb +266 -0
  712. data/lib/buildium-ruby/models/phone_log_participant_post_message.rb +282 -0
  713. data/lib/buildium-ruby/models/phone_log_participant_unit_agreement_post_message.rb +263 -0
  714. data/lib/buildium-ruby/models/phone_log_post_message.rb +267 -0
  715. data/lib/buildium-ruby/models/phone_log_put_message.rb +253 -0
  716. data/lib/buildium-ruby/models/phone_log_search_message.rb +336 -0
  717. data/lib/buildium-ruby/models/phone_number_message.rb +263 -0
  718. data/lib/buildium-ruby/models/phone_numbers_message.rb +249 -0
  719. data/lib/buildium-ruby/models/property_group_message.rb +259 -0
  720. data/lib/buildium-ruby/models/property_group_post_message.rb +250 -0
  721. data/lib/buildium-ruby/models/property_group_put_message.rb +250 -0
  722. data/lib/buildium-ruby/models/property_group_search_message.rb +230 -0
  723. data/lib/buildium-ruby/models/property_manager_message.rb +291 -0
  724. data/lib/buildium-ruby/models/property_message.rb +273 -0
  725. data/lib/buildium-ruby/models/recurring_transaction_line_message.rb +228 -0
  726. data/lib/buildium-ruby/models/recurring_transaction_line_post_message.rb +238 -0
  727. data/lib/buildium-ruby/models/recurring_transaction_message.rb +388 -0
  728. data/lib/buildium-ruby/models/rental_appliance_message.rb +288 -0
  729. data/lib/buildium-ruby/models/rental_appliance_post_message.rb +298 -0
  730. data/lib/buildium-ruby/models/rental_appliance_put_message.rb +273 -0
  731. data/lib/buildium-ruby/models/rental_appliance_search_message.rb +232 -0
  732. data/lib/buildium-ruby/models/rental_appliance_service_history_message.rb +282 -0
  733. data/lib/buildium-ruby/models/rental_appliance_service_history_post_message.rb +282 -0
  734. data/lib/buildium-ruby/models/rental_features_message.rb +255 -0
  735. data/lib/buildium-ruby/models/rental_features_put_message.rb +254 -0
  736. data/lib/buildium-ruby/models/rental_message.rb +373 -0
  737. data/lib/buildium-ruby/models/rental_owner_message.rb +361 -0
  738. data/lib/buildium-ruby/models/rental_owner_post_message.rb +363 -0
  739. data/lib/buildium-ruby/models/rental_owner_put_message.rb +354 -0
  740. data/lib/buildium-ruby/models/rental_owner_request_task_message.rb +381 -0
  741. data/lib/buildium-ruby/models/rental_owner_request_task_post_message.rb +384 -0
  742. data/lib/buildium-ruby/models/rental_owner_request_task_put_message.rb +369 -0
  743. data/lib/buildium-ruby/models/rental_owner_request_task_search_message.rb +366 -0
  744. data/lib/buildium-ruby/models/rental_owner_tax_information_message.rb +302 -0
  745. data/lib/buildium-ruby/models/rental_owners_search_message.rb +314 -0
  746. data/lib/buildium-ruby/models/rental_preferred_vendor_message.rb +300 -0
  747. data/lib/buildium-ruby/models/rental_preferred_vendor_put_message.rb +225 -0
  748. data/lib/buildium-ruby/models/rental_property_post_message.rb +365 -0
  749. data/lib/buildium-ruby/models/rental_property_put_message.rb +341 -0
  750. data/lib/buildium-ruby/models/rental_property_unit_post_message.rb +333 -0
  751. data/lib/buildium-ruby/models/rental_search_message.rb +330 -0
  752. data/lib/buildium-ruby/models/rental_tenant_post_message.rb +388 -0
  753. data/lib/buildium-ruby/models/rental_tenant_put_message.rb +373 -0
  754. data/lib/buildium-ruby/models/rental_tenant_renewal_post_message.rb +373 -0
  755. data/lib/buildium-ruby/models/rental_unit_features_message.rb +243 -0
  756. data/lib/buildium-ruby/models/rental_unit_features_put_message.rb +242 -0
  757. data/lib/buildium-ruby/models/rental_unit_message.rb +374 -0
  758. data/lib/buildium-ruby/models/rental_unit_put_message.rb +333 -0
  759. data/lib/buildium-ruby/models/rental_unit_search_message.rb +240 -0
  760. data/lib/buildium-ruby/models/rental_units_post_message.rb +348 -0
  761. data/lib/buildium-ruby/models/requested_by_user_entity_message.rb +303 -0
  762. data/lib/buildium-ruby/models/resident_center_user_message.rb +280 -0
  763. data/lib/buildium-ruby/models/resident_center_user_reference_message.rb +292 -0
  764. data/lib/buildium-ruby/models/resident_center_user_search_message.rb +288 -0
  765. data/lib/buildium-ruby/models/resident_request_task_message.rb +429 -0
  766. data/lib/buildium-ruby/models/resident_request_task_post_message.rb +409 -0
  767. data/lib/buildium-ruby/models/resident_request_task_put_message.rb +349 -0
  768. data/lib/buildium-ruby/models/resident_request_task_search_message.rb +376 -0
  769. data/lib/buildium-ruby/models/save_address_message.rb +323 -0
  770. data/lib/buildium-ruby/models/save_emergency_contact_message.rb +248 -0
  771. data/lib/buildium-ruby/models/task_category_message.rb +251 -0
  772. data/lib/buildium-ruby/models/task_category_put_message.rb +224 -0
  773. data/lib/buildium-ruby/models/task_category_response_message.rb +248 -0
  774. data/lib/buildium-ruby/models/task_category_save_message.rb +224 -0
  775. data/lib/buildium-ruby/models/task_history_file_message.rb +268 -0
  776. data/lib/buildium-ruby/models/task_history_file_upload_post_message.rb +223 -0
  777. data/lib/buildium-ruby/models/task_history_message.rb +376 -0
  778. data/lib/buildium-ruby/models/task_history_put_message.rb +223 -0
  779. data/lib/buildium-ruby/models/task_history_user_message.rb +249 -0
  780. data/lib/buildium-ruby/models/task_search_message.rb +398 -0
  781. data/lib/buildium-ruby/models/task_sub_category_message.rb +229 -0
  782. data/lib/buildium-ruby/models/tax_information_post_message.rb +292 -0
  783. data/lib/buildium-ruby/models/tax_information_save_message.rb +307 -0
  784. data/lib/buildium-ruby/models/tenant_message.rb +404 -0
  785. data/lib/buildium-ruby/models/tenant_search_message.rb +339 -0
  786. data/lib/buildium-ruby/models/to_do_task_message.rb +372 -0
  787. data/lib/buildium-ruby/models/to_do_task_post_message.rb +374 -0
  788. data/lib/buildium-ruby/models/to_do_task_put_message.rb +374 -0
  789. data/lib/buildium-ruby/models/to_do_task_search_message.rb +366 -0
  790. data/lib/buildium-ruby/models/undeposited_funds_message.rb +217 -0
  791. data/lib/buildium-ruby/models/unit_agreement_message.rb +273 -0
  792. data/lib/buildium-ruby/models/user_message.rb +354 -0
  793. data/lib/buildium-ruby/models/user_role_message.rb +249 -0
  794. data/lib/buildium-ruby/models/user_search_message.rb +297 -0
  795. data/lib/buildium-ruby/models/vehicle_message.rb +249 -0
  796. data/lib/buildium-ruby/models/vendor_category_message.rb +239 -0
  797. data/lib/buildium-ruby/models/vendor_category_save_message.rb +223 -0
  798. data/lib/buildium-ruby/models/vendor_credit_line_item_message.rb +257 -0
  799. data/lib/buildium-ruby/models/vendor_credit_line_item_post_message.rb +262 -0
  800. data/lib/buildium-ruby/models/vendor_credit_message.rb +260 -0
  801. data/lib/buildium-ruby/models/vendor_credit_post_message.rb +260 -0
  802. data/lib/buildium-ruby/models/vendor_insurance_message.rb +239 -0
  803. data/lib/buildium-ruby/models/vendor_insurance_save_message.rb +239 -0
  804. data/lib/buildium-ruby/models/vendor_message.rb +377 -0
  805. data/lib/buildium-ruby/models/vendor_post_message.rb +364 -0
  806. data/lib/buildium-ruby/models/vendor_put_message.rb +364 -0
  807. data/lib/buildium-ruby/models/vendor_refund_line_message.rb +257 -0
  808. data/lib/buildium-ruby/models/vendor_refund_line_post_message.rb +262 -0
  809. data/lib/buildium-ruby/models/vendor_refund_message.rb +314 -0
  810. data/lib/buildium-ruby/models/vendor_refund_post_message.rb +324 -0
  811. data/lib/buildium-ruby/models/vendor_search_message.rb +334 -0
  812. data/lib/buildium-ruby/models/vendor_tax_information_message.rb +302 -0
  813. data/lib/buildium-ruby/models/vendor_transaction_message.rb +302 -0
  814. data/lib/buildium-ruby/models/vendor_transaction_search_message.rb +292 -0
  815. data/lib/buildium-ruby/models/work_order_entry_contact_message.rb +231 -0
  816. data/lib/buildium-ruby/models/work_order_entry_contact_resource_message.rb +263 -0
  817. data/lib/buildium-ruby/models/work_order_line_item_message.rb +249 -0
  818. data/lib/buildium-ruby/models/work_order_line_item_save_message.rb +258 -0
  819. data/lib/buildium-ruby/models/work_order_message.rb +372 -0
  820. data/lib/buildium-ruby/models/work_order_post_message.rb +363 -0
  821. data/lib/buildium-ruby/models/work_order_put_message.rb +344 -0
  822. data/lib/buildium-ruby/models/work_order_search_message.rb +452 -0
  823. data/lib/buildium-ruby/models/work_order_task_message.rb +346 -0
  824. data/lib/buildium-ruby/models/work_order_task_post_message.rb +345 -0
  825. data/lib/buildium-ruby/version.rb +15 -0
  826. data/lib/buildium-ruby.rb +438 -0
  827. data/openapitools.json +7 -0
  828. data/spec/api/accounting_api_spec.rb +383 -0
  829. data/spec/api/administration_api_spec.rb +114 -0
  830. data/spec/api/applicants_api_spec.rb +294 -0
  831. data/spec/api/association_appliances_api_spec.rb +141 -0
  832. data/spec/api/association_owners_api_spec.rb +195 -0
  833. data/spec/api/association_ownership_accounts_api_spec.rb +385 -0
  834. data/spec/api/association_tenants_api_spec.rb +153 -0
  835. data/spec/api/association_units_api_spec.rb +147 -0
  836. data/spec/api/associations_api_spec.rb +248 -0
  837. data/spec/api/bank_accounts_api_spec.rb +420 -0
  838. data/spec/api/client_leads_api_spec.rb +66 -0
  839. data/spec/api/communications_api_spec.rb +248 -0
  840. data/spec/api/files_api_spec.rb +156 -0
  841. data/spec/api/leases_api_spec.rb +529 -0
  842. data/spec/api/listings_api_spec.rb +139 -0
  843. data/spec/api/property_groups_api_spec.rb +88 -0
  844. data/spec/api/rental_appliances_api_spec.rb +141 -0
  845. data/spec/api/rental_owners_api_spec.rb +151 -0
  846. data/spec/api/rental_properties_api_spec.rb +205 -0
  847. data/spec/api/rental_tenants_api_spec.rb +154 -0
  848. data/spec/api/rental_units_api_spec.rb +172 -0
  849. data/spec/api/resident_center_api_spec.rb +54 -0
  850. data/spec/api/tasks_api_spec.rb +493 -0
  851. data/spec/api/vendors_api_spec.rb +275 -0
  852. data/spec/api/work_orders_api_spec.rb +105 -0
  853. data/spec/api_client_spec.rb +188 -0
  854. data/spec/configuration_spec.rb +42 -0
  855. data/spec/models/account_info_message_spec.rb +58 -0
  856. data/spec/models/accounting_entity_message_spec.rb +50 -0
  857. data/spec/models/accounting_entity_save_message_spec.rb +44 -0
  858. data/spec/models/accounting_lock_period_message_spec.rb +46 -0
  859. data/spec/models/accounting_settings_message_spec.rb +72 -0
  860. data/spec/models/address_message_spec.rb +74 -0
  861. data/spec/models/all_tasks_message_spec.rb +130 -0
  862. data/spec/models/announcement_message_spec.rb +74 -0
  863. data/spec/models/announcement_post_message_spec.rb +64 -0
  864. data/spec/models/announcement_search_message_spec.rb +62 -0
  865. data/spec/models/announcement_sender_message_spec.rb +46 -0
  866. data/spec/models/api_error_response_spec.rb +46 -0
  867. data/spec/models/appliance_message_spec.rb +58 -0
  868. data/spec/models/applicant_application_message_spec.rb +56 -0
  869. data/spec/models/applicant_group_message_spec.rb +62 -0
  870. data/spec/models/applicant_group_post_message_spec.rb +40 -0
  871. data/spec/models/applicant_group_put_message_spec.rb +50 -0
  872. data/spec/models/applicant_group_search_message_spec.rb +66 -0
  873. data/spec/models/applicant_message_spec.rb +88 -0
  874. data/spec/models/applicant_post_message_spec.rb +64 -0
  875. data/spec/models/applicant_put_message_spec.rb +58 -0
  876. data/spec/models/applicant_search_message_spec.rb +84 -0
  877. data/spec/models/application_message_spec.rb +62 -0
  878. data/spec/models/application_put_message_spec.rb +38 -0
  879. data/spec/models/application_response_field_message_spec.rb +60 -0
  880. data/spec/models/application_response_message_spec.rb +50 -0
  881. data/spec/models/application_section_response_message_spec.rb +34 -0
  882. data/spec/models/association_appliance_message_spec.rb +76 -0
  883. data/spec/models/association_appliance_post_message_spec.rb +76 -0
  884. data/spec/models/association_appliance_put_message_spec.rb +64 -0
  885. data/spec/models/association_appliance_search_message_spec.rb +40 -0
  886. data/spec/models/association_appliance_service_history_message_spec.rb +56 -0
  887. data/spec/models/association_appliance_service_history_post_message_spec.rb +50 -0
  888. data/spec/models/association_board_member_message_spec.rb +92 -0
  889. data/spec/models/association_board_member_post_message_spec.rb +56 -0
  890. data/spec/models/association_board_member_put_message_spec.rb +50 -0
  891. data/spec/models/association_board_member_search_message_spec.rb +60 -0
  892. data/spec/models/association_message_spec.rb +100 -0
  893. data/spec/models/association_owner_board_term_message_spec.rb +68 -0
  894. data/spec/models/association_owner_board_term_post_message_spec.rb +50 -0
  895. data/spec/models/association_owner_message_spec.rb +144 -0
  896. data/spec/models/association_owner_post_message_spec.rb +116 -0
  897. data/spec/models/association_owner_put_message_spec.rb +98 -0
  898. data/spec/models/association_owner_to_existing_ownership_account_post_message_spec.rb +128 -0
  899. data/spec/models/association_owner_unit_occupancy_put_message_spec.rb +34 -0
  900. data/spec/models/association_owner_unit_occupancy_status_message_spec.rb +40 -0
  901. data/spec/models/association_ownership_account_message_spec.rb +90 -0
  902. data/spec/models/association_ownership_account_post_message_spec.rb +80 -0
  903. data/spec/models/association_ownership_account_put_message_spec.rb +34 -0
  904. data/spec/models/association_ownership_account_search_message_spec.rb +72 -0
  905. data/spec/models/association_post_message_spec.rb +76 -0
  906. data/spec/models/association_preferred_vendor_message_spec.rb +82 -0
  907. data/spec/models/association_preferred_vendor_put_message_spec.rb +34 -0
  908. data/spec/models/association_put_message_spec.rb +82 -0
  909. data/spec/models/association_search_message_spec.rb +56 -0
  910. data/spec/models/association_tenant_message_spec.rb +112 -0
  911. data/spec/models/association_tenant_post_message_spec.rb +106 -0
  912. data/spec/models/association_tenant_put_message_spec.rb +94 -0
  913. data/spec/models/association_unit_message_spec.rb +84 -0
  914. data/spec/models/association_unit_put_message_spec.rb +66 -0
  915. data/spec/models/association_unit_search_message_spec.rb +46 -0
  916. data/spec/models/association_units_post_message_spec.rb +72 -0
  917. data/spec/models/association_user_search_message_spec.rb +86 -0
  918. data/spec/models/bank_account_check_accounting_entity_save_message_spec.rb +44 -0
  919. data/spec/models/bank_account_check_line_message_spec.rb +64 -0
  920. data/spec/models/bank_account_check_line_save_message_spec.rb +58 -0
  921. data/spec/models/bank_account_check_message_spec.rb +70 -0
  922. data/spec/models/bank_account_check_payee_message_spec.rb +50 -0
  923. data/spec/models/bank_account_check_payee_save_message_spec.rb +44 -0
  924. data/spec/models/bank_account_check_post_message_spec.rb +58 -0
  925. data/spec/models/bank_account_check_put_message_spec.rb +58 -0
  926. data/spec/models/bank_account_check_search_message_spec.rb +40 -0
  927. data/spec/models/bank_account_deposit_line_message_spec.rb +64 -0
  928. data/spec/models/bank_account_deposit_line_save_message_spec.rb +58 -0
  929. data/spec/models/bank_account_deposit_message_spec.rb +64 -0
  930. data/spec/models/bank_account_deposit_post_message_spec.rb +52 -0
  931. data/spec/models/bank_account_deposit_put_message_spec.rb +46 -0
  932. data/spec/models/bank_account_deposit_search_message_spec.rb +40 -0
  933. data/spec/models/bank_account_message_spec.rb +104 -0
  934. data/spec/models/bank_account_post_message_spec.rb +78 -0
  935. data/spec/models/bank_account_put_message_spec.rb +78 -0
  936. data/spec/models/bank_account_quick_deposit_message_spec.rb +64 -0
  937. data/spec/models/bank_account_quick_deposit_save_message_spec.rb +58 -0
  938. data/spec/models/bank_account_quick_deposit_search_message_spec.rb +40 -0
  939. data/spec/models/bank_account_search_message_spec.rb +44 -0
  940. data/spec/models/bank_account_transaction_message_spec.rb +96 -0
  941. data/spec/models/bank_account_transaction_search_message_spec.rb +56 -0
  942. data/spec/models/bank_account_transfer_accounting_entity_save_message_spec.rb +44 -0
  943. data/spec/models/bank_account_transfer_message_spec.rb +64 -0
  944. data/spec/models/bank_account_transfer_save_message_spec.rb +58 -0
  945. data/spec/models/bank_account_transfer_search_message_spec.rb +40 -0
  946. data/spec/models/bank_account_withdrawal_message_spec.rb +64 -0
  947. data/spec/models/bank_account_withdrawal_save_message_spec.rb +58 -0
  948. data/spec/models/bank_account_withdrawal_search_message_spec.rb +40 -0
  949. data/spec/models/bill_file_message_spec.rb +64 -0
  950. data/spec/models/bill_line_message_spec.rb +64 -0
  951. data/spec/models/bill_line_post_message_spec.rb +58 -0
  952. data/spec/models/bill_line_put_message_spec.rb +64 -0
  953. data/spec/models/bill_markup_message_spec.rb +44 -0
  954. data/spec/models/bill_markup_save_message_spec.rb +44 -0
  955. data/spec/models/bill_message_spec.rb +92 -0
  956. data/spec/models/bill_payment_accounting_entity_message_spec.rb +44 -0
  957. data/spec/models/bill_payment_line_message_spec.rb +46 -0
  958. data/spec/models/bill_payment_line_post_message_spec.rb +40 -0
  959. data/spec/models/bill_payment_message_spec.rb +64 -0
  960. data/spec/models/bill_payment_post_message_spec.rb +58 -0
  961. data/spec/models/bill_post_message_spec.rb +70 -0
  962. data/spec/models/bill_put_message_spec.rb +64 -0
  963. data/spec/models/bill_search_message_spec.rb +88 -0
  964. data/spec/models/budget_details_message_spec.rb +56 -0
  965. data/spec/models/budget_details_save_message_spec.rb +40 -0
  966. data/spec/models/budget_message_spec.rb +64 -0
  967. data/spec/models/budget_monthly_amounts_message_spec.rb +100 -0
  968. data/spec/models/budget_monthly_amounts_save_message_spec.rb +100 -0
  969. data/spec/models/budget_post_message_spec.rb +62 -0
  970. data/spec/models/budget_put_message_spec.rb +40 -0
  971. data/spec/models/budget_search_message_spec.rb +46 -0
  972. data/spec/models/charge_recurring_transaction_post_message_spec.rb +84 -0
  973. data/spec/models/charge_recurring_transaction_put_message_spec.rb +90 -0
  974. data/spec/models/check_printing_info_message_spec.rb +122 -0
  975. data/spec/models/check_printing_info_post_message_spec.rb +122 -0
  976. data/spec/models/check_printing_info_put_message_spec.rb +122 -0
  977. data/spec/models/client_lead_credit_request_message_spec.rb +60 -0
  978. data/spec/models/client_lead_message_spec.rb +102 -0
  979. data/spec/models/client_lead_search_message_spec.rb +66 -0
  980. data/spec/models/contact_detail_message_spec.rb +52 -0
  981. data/spec/models/contact_detail_phone_message_spec.rb +46 -0
  982. data/spec/models/contact_detail_save_message_spec.rb +52 -0
  983. data/spec/models/contact_detail_save_phone_message_spec.rb +46 -0
  984. data/spec/models/contact_info_message_spec.rb +52 -0
  985. data/spec/models/contact_request_task_message_spec.rb +114 -0
  986. data/spec/models/contact_request_task_post_message_spec.rb +102 -0
  987. data/spec/models/contact_request_task_put_message_spec.rb +102 -0
  988. data/spec/models/contact_request_task_search_message_spec.rb +112 -0
  989. data/spec/models/cosigner_message_spec.rb +92 -0
  990. data/spec/models/created_by_user_message_spec.rb +52 -0
  991. data/spec/models/credit_recurring_transaction_post_message_spec.rb +100 -0
  992. data/spec/models/deposit_detail_message_spec.rb +40 -0
  993. data/spec/models/electronic_payments_message_spec.rb +76 -0
  994. data/spec/models/email_message_spec.rb +52 -0
  995. data/spec/models/email_post_message_spec.rb +70 -0
  996. data/spec/models/email_recipient_message_spec.rb +62 -0
  997. data/spec/models/email_search_message_spec.rb +58 -0
  998. data/spec/models/email_sender_message_spec.rb +52 -0
  999. data/spec/models/emergency_contact_message_spec.rb +52 -0
  1000. data/spec/models/file_category_message_spec.rb +46 -0
  1001. data/spec/models/file_category_post_message_spec.rb +34 -0
  1002. data/spec/models/file_category_put_message_spec.rb +34 -0
  1003. data/spec/models/file_download_message_spec.rb +34 -0
  1004. data/spec/models/file_entity_message_spec.rb +50 -0
  1005. data/spec/models/file_message_spec.rb +82 -0
  1006. data/spec/models/file_name_post_message_spec.rb +34 -0
  1007. data/spec/models/file_put_message_spec.rb +46 -0
  1008. data/spec/models/file_search_message_spec.rb +74 -0
  1009. data/spec/models/file_upload_post_message_spec.rb +68 -0
  1010. data/spec/models/file_upload_ticket_message_spec.rb +46 -0
  1011. data/spec/models/general_journal_entry_line_save_message_spec.rb +56 -0
  1012. data/spec/models/general_journal_entry_post_message_spec.rb +52 -0
  1013. data/spec/models/general_journal_entry_put_message_spec.rb +52 -0
  1014. data/spec/models/general_ledger_journal_line_message_spec.rb +64 -0
  1015. data/spec/models/general_ledger_journal_message_spec.rb +40 -0
  1016. data/spec/models/general_ledger_transaction_message_spec.rb +98 -0
  1017. data/spec/models/general_ledger_transaction_search_message_spec.rb +62 -0
  1018. data/spec/models/gl_account_balance_item_message_spec.rb +40 -0
  1019. data/spec/models/gl_account_balance_message_spec.rb +46 -0
  1020. data/spec/models/gl_account_balance_search_message_spec.rb +66 -0
  1021. data/spec/models/gl_account_message_spec.rb +130 -0
  1022. data/spec/models/gl_account_post_message_spec.rb +84 -0
  1023. data/spec/models/gl_account_put_message_spec.rb +84 -0
  1024. data/spec/models/gl_accounts_search_message_spec.rb +38 -0
  1025. data/spec/models/gl_transaction_message_v1_spec.rb +58 -0
  1026. data/spec/models/internal_transaction_status_message_spec.rb +46 -0
  1027. data/spec/models/journal_line_message_spec.rb +64 -0
  1028. data/spec/models/journal_message_spec.rb +40 -0
  1029. data/spec/models/last_updated_by_user_message_spec.rb +58 -0
  1030. data/spec/models/lease_account_detail_message_spec.rb +40 -0
  1031. data/spec/models/lease_charge_line_save_message_spec.rb +46 -0
  1032. data/spec/models/lease_charge_post_message_spec.rb +46 -0
  1033. data/spec/models/lease_charge_put_message_spec.rb +46 -0
  1034. data/spec/models/lease_charge_recurring_transaction_message_spec.rb +108 -0
  1035. data/spec/models/lease_cosigner_post_message_spec.rb +80 -0
  1036. data/spec/models/lease_ledger_credit_line_post_message_spec.rb +40 -0
  1037. data/spec/models/lease_ledger_credit_post_message_spec.rb +62 -0
  1038. data/spec/models/lease_ledger_deposit_withholding_line_post_message_spec.rb +40 -0
  1039. data/spec/models/lease_ledger_deposit_withholding_post_message_spec.rb +52 -0
  1040. data/spec/models/lease_ledger_payment_line_save_message_spec.rb +40 -0
  1041. data/spec/models/lease_ledger_payment_post_message_spec.rb +74 -0
  1042. data/spec/models/lease_ledger_refund_line_message_spec.rb +40 -0
  1043. data/spec/models/lease_ledger_refund_line_post_message_spec.rb +40 -0
  1044. data/spec/models/lease_ledger_refund_message_spec.rb +82 -0
  1045. data/spec/models/lease_ledger_refund_post_message_spec.rb +70 -0
  1046. data/spec/models/lease_ledger_reverse_payment_nsf_charge_post_message_spec.rb +40 -0
  1047. data/spec/models/lease_ledger_reverse_payment_other_bank_charge_post_message_spec.rb +40 -0
  1048. data/spec/models/lease_ledger_reverse_payment_post_message_spec.rb +52 -0
  1049. data/spec/models/lease_message_spec.rb +170 -0
  1050. data/spec/models/lease_move_out_data_message_spec.rb +46 -0
  1051. data/spec/models/lease_move_out_data_post_message_spec.rb +46 -0
  1052. data/spec/models/lease_outstanding_balance_message_spec.rb +100 -0
  1053. data/spec/models/lease_outstanding_balance_search_message_spec.rb +90 -0
  1054. data/spec/models/lease_post_message_spec.rb +98 -0
  1055. data/spec/models/lease_put_message_spec.rb +68 -0
  1056. data/spec/models/lease_recurring_credit_message_spec.rb +124 -0
  1057. data/spec/models/lease_recurring_payment_message_spec.rb +118 -0
  1058. data/spec/models/lease_renewal_message_spec.rb +84 -0
  1059. data/spec/models/lease_renewal_post_message_spec.rb +98 -0
  1060. data/spec/models/lease_rent_charge_message_spec.rb +70 -0
  1061. data/spec/models/lease_rent_charge_post_message_spec.rb +52 -0
  1062. data/spec/models/lease_rent_message_spec.rb +86 -0
  1063. data/spec/models/lease_rent_post_message_spec.rb +44 -0
  1064. data/spec/models/lease_search_message_spec.rb +108 -0
  1065. data/spec/models/lease_security_deposit_post_message_spec.rb +40 -0
  1066. data/spec/models/lease_tenant_message_spec.rb +44 -0
  1067. data/spec/models/lease_transaction_message_spec.rb +82 -0
  1068. data/spec/models/lease_transaction_search_message_spec.rb +50 -0
  1069. data/spec/models/listing_contact_message_spec.rb +58 -0
  1070. data/spec/models/listing_contact_save_message_spec.rb +52 -0
  1071. data/spec/models/listing_file_message_spec.rb +50 -0
  1072. data/spec/models/listing_message_spec.rb +88 -0
  1073. data/spec/models/listing_property_message_spec.rb +90 -0
  1074. data/spec/models/listing_put_message_spec.rb +64 -0
  1075. data/spec/models/listing_search_message_spec.rb +44 -0
  1076. data/spec/models/listing_unit_message_spec.rb +100 -0
  1077. data/spec/models/lock_period_settings_global_message_spec.rb +34 -0
  1078. data/spec/models/lock_period_settings_overrides_message_spec.rb +40 -0
  1079. data/spec/models/logged_by_staff_user_message_spec.rb +52 -0
  1080. data/spec/models/lookup_message_spec.rb +40 -0
  1081. data/spec/models/mailing_template_message_spec.rb +56 -0
  1082. data/spec/models/note_message_spec.rb +46 -0
  1083. data/spec/models/note_post_message_spec.rb +34 -0
  1084. data/spec/models/note_put_message_spec.rb +34 -0
  1085. data/spec/models/note_search_message_spec.rb +46 -0
  1086. data/spec/models/outstanding_balances_line_message_spec.rb +40 -0
  1087. data/spec/models/ownership_account_charge_recurring_transaction_message_spec.rb +108 -0
  1088. data/spec/models/ownership_account_credit_line_post_message_spec.rb +40 -0
  1089. data/spec/models/ownership_account_credit_post_message_spec.rb +62 -0
  1090. data/spec/models/ownership_account_deposit_withholding_line_post_message_spec.rb +40 -0
  1091. data/spec/models/ownership_account_deposit_withholding_post_message_spec.rb +52 -0
  1092. data/spec/models/ownership_account_ledger_charge_lines_put_message_spec.rb +46 -0
  1093. data/spec/models/ownership_account_ledger_charge_lines_save_message_spec.rb +40 -0
  1094. data/spec/models/ownership_account_ledger_charge_post_message_spec.rb +46 -0
  1095. data/spec/models/ownership_account_ledger_charge_put_message_spec.rb +46 -0
  1096. data/spec/models/ownership_account_ledger_payment_line_save_message_spec.rb +40 -0
  1097. data/spec/models/ownership_account_ledger_payment_post_message_spec.rb +74 -0
  1098. data/spec/models/ownership_account_outstanding_balance_message_spec.rb +88 -0
  1099. data/spec/models/ownership_account_outstanding_balance_search_message_spec.rb +70 -0
  1100. data/spec/models/ownership_account_recurring_credit_message_spec.rb +124 -0
  1101. data/spec/models/ownership_account_recurring_payment_message_spec.rb +118 -0
  1102. data/spec/models/ownership_account_refund_line_message_spec.rb +40 -0
  1103. data/spec/models/ownership_account_refund_lines_post_message_spec.rb +40 -0
  1104. data/spec/models/ownership_account_refund_message_spec.rb +82 -0
  1105. data/spec/models/ownership_account_refund_post_message_spec.rb +70 -0
  1106. data/spec/models/ownership_account_transaction_message_spec.rb +82 -0
  1107. data/spec/models/paid_by_message_spec.rb +40 -0
  1108. data/spec/models/participant_message_spec.rb +46 -0
  1109. data/spec/models/participant_resource_message_spec.rb +44 -0
  1110. data/spec/models/payee_message_spec.rb +56 -0
  1111. data/spec/models/payment_detail_message_spec.rb +56 -0
  1112. data/spec/models/payment_recurring_transaction_post_message_spec.rb +94 -0
  1113. data/spec/models/payment_transactions_message_spec.rb +46 -0
  1114. data/spec/models/phone_log_message_spec.rb +64 -0
  1115. data/spec/models/phone_log_participant_post_message_spec.rb +50 -0
  1116. data/spec/models/phone_log_participant_unit_agreement_post_message_spec.rb +44 -0
  1117. data/spec/models/phone_log_post_message_spec.rb +52 -0
  1118. data/spec/models/phone_log_put_message_spec.rb +46 -0
  1119. data/spec/models/phone_log_search_message_spec.rb +84 -0
  1120. data/spec/models/phone_number_message_spec.rb +44 -0
  1121. data/spec/models/phone_numbers_message_spec.rb +52 -0
  1122. data/spec/models/property_group_message_spec.rb +58 -0
  1123. data/spec/models/property_group_post_message_spec.rb +46 -0
  1124. data/spec/models/property_group_put_message_spec.rb +46 -0
  1125. data/spec/models/property_group_search_message_spec.rb +40 -0
  1126. data/spec/models/property_manager_message_spec.rb +76 -0
  1127. data/spec/models/property_message_spec.rb +50 -0
  1128. data/spec/models/recurring_transaction_line_message_spec.rb +40 -0
  1129. data/spec/models/recurring_transaction_line_post_message_spec.rb +40 -0
  1130. data/spec/models/recurring_transaction_message_spec.rb +112 -0
  1131. data/spec/models/rental_appliance_message_spec.rb +76 -0
  1132. data/spec/models/rental_appliance_post_message_spec.rb +76 -0
  1133. data/spec/models/rental_appliance_put_message_spec.rb +64 -0
  1134. data/spec/models/rental_appliance_search_message_spec.rb +40 -0
  1135. data/spec/models/rental_appliance_service_history_message_spec.rb +56 -0
  1136. data/spec/models/rental_appliance_service_history_post_message_spec.rb +50 -0
  1137. data/spec/models/rental_features_message_spec.rb +48 -0
  1138. data/spec/models/rental_features_put_message_spec.rb +48 -0
  1139. data/spec/models/rental_message_spec.rb +108 -0
  1140. data/spec/models/rental_owner_message_spec.rb +118 -0
  1141. data/spec/models/rental_owner_post_message_spec.rb +112 -0
  1142. data/spec/models/rental_owner_put_message_spec.rb +106 -0
  1143. data/spec/models/rental_owner_request_task_message_spec.rb +114 -0
  1144. data/spec/models/rental_owner_request_task_post_message_spec.rb +102 -0
  1145. data/spec/models/rental_owner_request_task_put_message_spec.rb +96 -0
  1146. data/spec/models/rental_owner_request_task_search_message_spec.rb +112 -0
  1147. data/spec/models/rental_owner_tax_information_message_spec.rb +68 -0
  1148. data/spec/models/rental_owners_search_message_spec.rb +74 -0
  1149. data/spec/models/rental_preferred_vendor_message_spec.rb +82 -0
  1150. data/spec/models/rental_preferred_vendor_put_message_spec.rb +34 -0
  1151. data/spec/models/rental_property_post_message_spec.rb +92 -0
  1152. data/spec/models/rental_property_put_message_spec.rb +80 -0
  1153. data/spec/models/rental_property_unit_post_message_spec.rb +78 -0
  1154. data/spec/models/rental_search_message_spec.rb +88 -0
  1155. data/spec/models/rental_tenant_post_message_spec.rb +110 -0
  1156. data/spec/models/rental_tenant_put_message_spec.rb +104 -0
  1157. data/spec/models/rental_tenant_renewal_post_message_spec.rb +104 -0
  1158. data/spec/models/rental_unit_features_message_spec.rb +38 -0
  1159. data/spec/models/rental_unit_features_put_message_spec.rb +38 -0
  1160. data/spec/models/rental_unit_message_spec.rb +108 -0
  1161. data/spec/models/rental_unit_put_message_spec.rb +78 -0
  1162. data/spec/models/rental_unit_search_message_spec.rb +46 -0
  1163. data/spec/models/rental_units_post_message_spec.rb +84 -0
  1164. data/spec/models/requested_by_user_entity_message_spec.rb +68 -0
  1165. data/spec/models/resident_center_user_message_spec.rb +56 -0
  1166. data/spec/models/resident_center_user_reference_message_spec.rb +62 -0
  1167. data/spec/models/resident_center_user_search_message_spec.rb +66 -0
  1168. data/spec/models/resident_request_task_message_spec.rb +144 -0
  1169. data/spec/models/resident_request_task_post_message_spec.rb +114 -0
  1170. data/spec/models/resident_request_task_put_message_spec.rb +84 -0
  1171. data/spec/models/resident_request_task_search_message_spec.rb +118 -0
  1172. data/spec/models/save_address_message_spec.rb +74 -0
  1173. data/spec/models/save_emergency_contact_message_spec.rb +52 -0
  1174. data/spec/models/task_category_message_spec.rb +52 -0
  1175. data/spec/models/task_category_put_message_spec.rb +34 -0
  1176. data/spec/models/task_category_response_message_spec.rb +52 -0
  1177. data/spec/models/task_category_save_message_spec.rb +34 -0
  1178. data/spec/models/task_history_file_message_spec.rb +64 -0
  1179. data/spec/models/task_history_file_upload_post_message_spec.rb +34 -0
  1180. data/spec/models/task_history_message_spec.rb +112 -0
  1181. data/spec/models/task_history_put_message_spec.rb +34 -0
  1182. data/spec/models/task_history_user_message_spec.rb +52 -0
  1183. data/spec/models/task_search_message_spec.rb +128 -0
  1184. data/spec/models/task_sub_category_message_spec.rb +40 -0
  1185. data/spec/models/tax_information_post_message_spec.rb +62 -0
  1186. data/spec/models/tax_information_save_message_spec.rb +68 -0
  1187. data/spec/models/tenant_message_spec.rb +128 -0
  1188. data/spec/models/tenant_search_message_spec.rb +96 -0
  1189. data/spec/models/to_do_task_message_spec.rb +108 -0
  1190. data/spec/models/to_do_task_post_message_spec.rb +96 -0
  1191. data/spec/models/to_do_task_put_message_spec.rb +96 -0
  1192. data/spec/models/to_do_task_search_message_spec.rb +112 -0
  1193. data/spec/models/undeposited_funds_message_spec.rb +34 -0
  1194. data/spec/models/unit_agreement_message_spec.rb +50 -0
  1195. data/spec/models/user_message_spec.rb +104 -0
  1196. data/spec/models/user_role_message_spec.rb +52 -0
  1197. data/spec/models/user_search_message_spec.rb +66 -0
  1198. data/spec/models/vehicle_message_spec.rb +52 -0
  1199. data/spec/models/vendor_category_message_spec.rb +46 -0
  1200. data/spec/models/vendor_category_save_message_spec.rb +34 -0
  1201. data/spec/models/vendor_credit_line_item_message_spec.rb +58 -0
  1202. data/spec/models/vendor_credit_line_item_post_message_spec.rb +52 -0
  1203. data/spec/models/vendor_credit_message_spec.rb +58 -0
  1204. data/spec/models/vendor_credit_post_message_spec.rb +52 -0
  1205. data/spec/models/vendor_insurance_message_spec.rb +46 -0
  1206. data/spec/models/vendor_insurance_save_message_spec.rb +46 -0
  1207. data/spec/models/vendor_message_spec.rb +130 -0
  1208. data/spec/models/vendor_post_message_spec.rb +118 -0
  1209. data/spec/models/vendor_put_message_spec.rb +118 -0
  1210. data/spec/models/vendor_refund_line_message_spec.rb +58 -0
  1211. data/spec/models/vendor_refund_line_post_message_spec.rb +52 -0
  1212. data/spec/models/vendor_refund_message_spec.rb +74 -0
  1213. data/spec/models/vendor_refund_post_message_spec.rb +68 -0
  1214. data/spec/models/vendor_search_message_spec.rb +84 -0
  1215. data/spec/models/vendor_tax_information_message_spec.rb +68 -0
  1216. data/spec/models/vendor_transaction_message_spec.rb +68 -0
  1217. data/spec/models/vendor_transaction_search_message_spec.rb +62 -0
  1218. data/spec/models/work_order_entry_contact_message_spec.rb +40 -0
  1219. data/spec/models/work_order_entry_contact_resource_message_spec.rb +44 -0
  1220. data/spec/models/work_order_line_item_message_spec.rb +52 -0
  1221. data/spec/models/work_order_line_item_save_message_spec.rb +52 -0
  1222. data/spec/models/work_order_message_spec.rb +110 -0
  1223. data/spec/models/work_order_post_message_spec.rb +98 -0
  1224. data/spec/models/work_order_put_message_spec.rb +86 -0
  1225. data/spec/models/work_order_search_message_spec.rb +158 -0
  1226. data/spec/models/work_order_task_message_spec.rb +88 -0
  1227. data/spec/models/work_order_task_post_message_spec.rb +78 -0
  1228. data/spec/spec_helper.rb +111 -0
  1229. metadata +1725 -0
@@ -0,0 +1,2041 @@
1
+ # Buildium::AccountingApi
2
+
3
+ All URIs are relative to *https://api.buildium.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_bill**](AccountingApi.md#create_bill) | **POST** /v1/bills | Create a bill |
8
+ | [**create_bill_payment**](AccountingApi.md#create_bill_payment) | **POST** /v1/bills/{billId}/payments | Create a bill payment |
9
+ | [**create_budget**](AccountingApi.md#create_budget) | **POST** /v1/budgets | Create a budget |
10
+ | [**create_general_journal_entry**](AccountingApi.md#create_general_journal_entry) | **POST** /v1/generalledger/journalentries | Create a general journal entry |
11
+ | [**create_general_ledger_account**](AccountingApi.md#create_general_ledger_account) | **POST** /v1/glaccounts | Create a general ledger account |
12
+ | [**create_upload_file_request**](AccountingApi.md#create_upload_file_request) | **POST** /v1/bills/{billId}/files/uploadrequests | Upload a bill file |
13
+ | [**delete_bill_file**](AccountingApi.md#delete_bill_file) | **DELETE** /v1/bills/{billId}/files/{fileId} | Delete a bill file |
14
+ | [**download_bill_file**](AccountingApi.md#download_bill_file) | **POST** /v1/bills/{billId}/files/{fileId}/downloadrequest | Download a bill file |
15
+ | [**get_all_files_for_bill**](AccountingApi.md#get_all_files_for_bill) | **GET** /v1/bills/{billId}/files | Retrieve all files for a bill |
16
+ | [**get_all_gl_accounts**](AccountingApi.md#get_all_gl_accounts) | **GET** /v1/glaccounts | Retrieve all general ledger accounts |
17
+ | [**get_all_transactions**](AccountingApi.md#get_all_transactions) | **GET** /v1/generalledger/transactions | Retrieve all general ledger transactions |
18
+ | [**get_bill_by_id**](AccountingApi.md#get_bill_by_id) | **GET** /v1/bills/{billId} | Retrieve a bill |
19
+ | [**get_bill_file_by_id**](AccountingApi.md#get_bill_file_by_id) | **GET** /v1/bills/{billId}/files/{fileId} | Retrieve a file for a bill |
20
+ | [**get_bill_payment_by_id**](AccountingApi.md#get_bill_payment_by_id) | **GET** /v1/bills/{billId}/payments/{paymentId} | Retrieve a bill payment |
21
+ | [**get_bill_payments**](AccountingApi.md#get_bill_payments) | **GET** /v1/bills/{billId}/payments | Retrieve all bill payments |
22
+ | [**get_bills_async**](AccountingApi.md#get_bills_async) | **GET** /v1/bills | Retrieve all bills |
23
+ | [**get_budget_by_id**](AccountingApi.md#get_budget_by_id) | **GET** /v1/budgets/{budgetId} | Retrieve a budget |
24
+ | [**get_budgets**](AccountingApi.md#get_budgets) | **GET** /v1/budgets | Retrieve all budgets |
25
+ | [**get_gl_account_balances**](AccountingApi.md#get_gl_account_balances) | **GET** /v1/glaccounts/balances | Retrieve all general ledger account balances |
26
+ | [**get_gl_account_by_id**](AccountingApi.md#get_gl_account_by_id) | **GET** /v1/glaccounts/{glAccountId} | Retrieve a general ledger account |
27
+ | [**get_transaction_by_id**](AccountingApi.md#get_transaction_by_id) | **GET** /v1/generalledger/transactions/{transactionId} | Retrieve a general ledger transaction |
28
+ | [**update_bill**](AccountingApi.md#update_bill) | **PUT** /v1/bills/{billId} | Update a bill |
29
+ | [**update_budget**](AccountingApi.md#update_budget) | **PUT** /v1/budgets/{budgetId} | Update a budget |
30
+ | [**update_general_journal_entry**](AccountingApi.md#update_general_journal_entry) | **PUT** /v1/generalledger/journalentries/{journalEntryId} | Update a general journal entry |
31
+ | [**update_gl_account**](AccountingApi.md#update_gl_account) | **PUT** /v1/glaccounts/{glAccountId} | Update a general ledger account |
32
+
33
+
34
+ ## create_bill
35
+
36
+ > <BillMessage> create_bill(bill_post_message)
37
+
38
+ Create a bill
39
+
40
+ Creates a bill. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; Bills</span> - `View` `Edit`
41
+
42
+ ### Examples
43
+
44
+ ```ruby
45
+ require 'time'
46
+ require 'buildium-ruby'
47
+ # setup authorization
48
+ Buildium.configure do |config|
49
+ # Configure API key authorization: clientId
50
+ config.api_key['clientId'] = 'YOUR API KEY'
51
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
52
+ # config.api_key_prefix['clientId'] = 'Bearer'
53
+
54
+ # Configure API key authorization: clientSecret
55
+ config.api_key['clientSecret'] = 'YOUR API KEY'
56
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
57
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
58
+ end
59
+
60
+ api_instance = Buildium::AccountingApi.new
61
+ bill_post_message = Buildium::BillPostMessage.new({date: Date.today, due_date: Date.today, vendor_id: 37, lines: [Buildium::BillLinePostMessage.new({accounting_entity: Buildium::AccountingEntitySaveMessage.new({id: 37, accounting_entity_type: 'Association'}), gl_account_id: 37, amount: 3.56})]}) # BillPostMessage |
62
+
63
+ begin
64
+ # Create a bill
65
+ result = api_instance.create_bill(bill_post_message)
66
+ p result
67
+ rescue Buildium::ApiError => e
68
+ puts "Error when calling AccountingApi->create_bill: #{e}"
69
+ end
70
+ ```
71
+
72
+ #### Using the create_bill_with_http_info variant
73
+
74
+ This returns an Array which contains the response data, status code and headers.
75
+
76
+ > <Array(<BillMessage>, Integer, Hash)> create_bill_with_http_info(bill_post_message)
77
+
78
+ ```ruby
79
+ begin
80
+ # Create a bill
81
+ data, status_code, headers = api_instance.create_bill_with_http_info(bill_post_message)
82
+ p status_code # => 2xx
83
+ p headers # => { ... }
84
+ p data # => <BillMessage>
85
+ rescue Buildium::ApiError => e
86
+ puts "Error when calling AccountingApi->create_bill_with_http_info: #{e}"
87
+ end
88
+ ```
89
+
90
+ ### Parameters
91
+
92
+ | Name | Type | Description | Notes |
93
+ | ---- | ---- | ----------- | ----- |
94
+ | **bill_post_message** | [**BillPostMessage**](BillPostMessage.md) | | |
95
+
96
+ ### Return type
97
+
98
+ [**BillMessage**](BillMessage.md)
99
+
100
+ ### Authorization
101
+
102
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
103
+
104
+ ### HTTP request headers
105
+
106
+ - **Content-Type**: application/json
107
+ - **Accept**: application/json
108
+
109
+
110
+ ## create_bill_payment
111
+
112
+ > <BillPaymentMessage> create_bill_payment(bill_id, bill_payment_post_message)
113
+
114
+ Create a bill payment
115
+
116
+ Creates a bill payment. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; Bills</span> - `View` `Edit` <span class=\"permissionBlock\">Accounting &gt; Bank Accounts</span> - `View` `Edit`
117
+
118
+ ### Examples
119
+
120
+ ```ruby
121
+ require 'time'
122
+ require 'buildium-ruby'
123
+ # setup authorization
124
+ Buildium.configure do |config|
125
+ # Configure API key authorization: clientId
126
+ config.api_key['clientId'] = 'YOUR API KEY'
127
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
128
+ # config.api_key_prefix['clientId'] = 'Bearer'
129
+
130
+ # Configure API key authorization: clientSecret
131
+ config.api_key['clientSecret'] = 'YOUR API KEY'
132
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
133
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
134
+ end
135
+
136
+ api_instance = Buildium::AccountingApi.new
137
+ bill_id = 56 # Integer |
138
+ bill_payment_post_message = Buildium::BillPaymentPostMessage.new({bank_account_id: 37, entry_date: Date.today, lines: [Buildium::BillPaymentLinePostMessage.new({bill_line_id: 37, amount: 3.56})]}) # BillPaymentPostMessage |
139
+
140
+ begin
141
+ # Create a bill payment
142
+ result = api_instance.create_bill_payment(bill_id, bill_payment_post_message)
143
+ p result
144
+ rescue Buildium::ApiError => e
145
+ puts "Error when calling AccountingApi->create_bill_payment: #{e}"
146
+ end
147
+ ```
148
+
149
+ #### Using the create_bill_payment_with_http_info variant
150
+
151
+ This returns an Array which contains the response data, status code and headers.
152
+
153
+ > <Array(<BillPaymentMessage>, Integer, Hash)> create_bill_payment_with_http_info(bill_id, bill_payment_post_message)
154
+
155
+ ```ruby
156
+ begin
157
+ # Create a bill payment
158
+ data, status_code, headers = api_instance.create_bill_payment_with_http_info(bill_id, bill_payment_post_message)
159
+ p status_code # => 2xx
160
+ p headers # => { ... }
161
+ p data # => <BillPaymentMessage>
162
+ rescue Buildium::ApiError => e
163
+ puts "Error when calling AccountingApi->create_bill_payment_with_http_info: #{e}"
164
+ end
165
+ ```
166
+
167
+ ### Parameters
168
+
169
+ | Name | Type | Description | Notes |
170
+ | ---- | ---- | ----------- | ----- |
171
+ | **bill_id** | **Integer** | | |
172
+ | **bill_payment_post_message** | [**BillPaymentPostMessage**](BillPaymentPostMessage.md) | | |
173
+
174
+ ### Return type
175
+
176
+ [**BillPaymentMessage**](BillPaymentMessage.md)
177
+
178
+ ### Authorization
179
+
180
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
181
+
182
+ ### HTTP request headers
183
+
184
+ - **Content-Type**: application/json
185
+ - **Accept**: application/json
186
+
187
+
188
+ ## create_budget
189
+
190
+ > <BudgetMessage> create_budget(budget_post_message)
191
+
192
+ Create a budget
193
+
194
+ Creates a budget. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; Budgets</span> - `View` `Edit`
195
+
196
+ ### Examples
197
+
198
+ ```ruby
199
+ require 'time'
200
+ require 'buildium-ruby'
201
+ # setup authorization
202
+ Buildium.configure do |config|
203
+ # Configure API key authorization: clientId
204
+ config.api_key['clientId'] = 'YOUR API KEY'
205
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
206
+ # config.api_key_prefix['clientId'] = 'Bearer'
207
+
208
+ # Configure API key authorization: clientSecret
209
+ config.api_key['clientSecret'] = 'YOUR API KEY'
210
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
211
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
212
+ end
213
+
214
+ api_instance = Buildium::AccountingApi.new
215
+ budget_post_message = Buildium::BudgetPostMessage.new({name: 'name_example', property_id: 37, start_month: 'January', fiscal_year: 37, details: [Buildium::BudgetDetailsSaveMessage.new({gl_account_id: 37, monthly_amounts: Buildium::BudgetMonthlyAmountsSaveMessage.new({january: 3.56, february: 3.56, march: 3.56, april: 3.56, may: 3.56, june: 3.56, july: 3.56, august: 3.56, september: 3.56, october: 3.56, november: 3.56, december: 3.56})})]}) # BudgetPostMessage |
216
+
217
+ begin
218
+ # Create a budget
219
+ result = api_instance.create_budget(budget_post_message)
220
+ p result
221
+ rescue Buildium::ApiError => e
222
+ puts "Error when calling AccountingApi->create_budget: #{e}"
223
+ end
224
+ ```
225
+
226
+ #### Using the create_budget_with_http_info variant
227
+
228
+ This returns an Array which contains the response data, status code and headers.
229
+
230
+ > <Array(<BudgetMessage>, Integer, Hash)> create_budget_with_http_info(budget_post_message)
231
+
232
+ ```ruby
233
+ begin
234
+ # Create a budget
235
+ data, status_code, headers = api_instance.create_budget_with_http_info(budget_post_message)
236
+ p status_code # => 2xx
237
+ p headers # => { ... }
238
+ p data # => <BudgetMessage>
239
+ rescue Buildium::ApiError => e
240
+ puts "Error when calling AccountingApi->create_budget_with_http_info: #{e}"
241
+ end
242
+ ```
243
+
244
+ ### Parameters
245
+
246
+ | Name | Type | Description | Notes |
247
+ | ---- | ---- | ----------- | ----- |
248
+ | **budget_post_message** | [**BudgetPostMessage**](BudgetPostMessage.md) | | |
249
+
250
+ ### Return type
251
+
252
+ [**BudgetMessage**](BudgetMessage.md)
253
+
254
+ ### Authorization
255
+
256
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
257
+
258
+ ### HTTP request headers
259
+
260
+ - **Content-Type**: application/json
261
+ - **Accept**: application/json
262
+
263
+
264
+ ## create_general_journal_entry
265
+
266
+ > <GeneralLedgerTransactionMessage> create_general_journal_entry(general_journal_entry_post_message)
267
+
268
+ Create a general journal entry
269
+
270
+ Creates a general journal entry. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; General Ledger Transactions</span> - `View` `Edit`
271
+
272
+ ### Examples
273
+
274
+ ```ruby
275
+ require 'time'
276
+ require 'buildium-ruby'
277
+ # setup authorization
278
+ Buildium.configure do |config|
279
+ # Configure API key authorization: clientId
280
+ config.api_key['clientId'] = 'YOUR API KEY'
281
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
282
+ # config.api_key_prefix['clientId'] = 'Bearer'
283
+
284
+ # Configure API key authorization: clientSecret
285
+ config.api_key['clientSecret'] = 'YOUR API KEY'
286
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
287
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
288
+ end
289
+
290
+ api_instance = Buildium::AccountingApi.new
291
+ general_journal_entry_post_message = Buildium::GeneralJournalEntryPostMessage.new({accounting_entity: Buildium::AccountingEntitySaveMessage.new({id: 37, accounting_entity_type: 'Association'}), date: Date.today, lines: [Buildium::GeneralJournalEntryLineSaveMessage.new({gl_account_id: 37, posting_type: 'Credit', amount: 3.56})]}) # GeneralJournalEntryPostMessage |
292
+
293
+ begin
294
+ # Create a general journal entry
295
+ result = api_instance.create_general_journal_entry(general_journal_entry_post_message)
296
+ p result
297
+ rescue Buildium::ApiError => e
298
+ puts "Error when calling AccountingApi->create_general_journal_entry: #{e}"
299
+ end
300
+ ```
301
+
302
+ #### Using the create_general_journal_entry_with_http_info variant
303
+
304
+ This returns an Array which contains the response data, status code and headers.
305
+
306
+ > <Array(<GeneralLedgerTransactionMessage>, Integer, Hash)> create_general_journal_entry_with_http_info(general_journal_entry_post_message)
307
+
308
+ ```ruby
309
+ begin
310
+ # Create a general journal entry
311
+ data, status_code, headers = api_instance.create_general_journal_entry_with_http_info(general_journal_entry_post_message)
312
+ p status_code # => 2xx
313
+ p headers # => { ... }
314
+ p data # => <GeneralLedgerTransactionMessage>
315
+ rescue Buildium::ApiError => e
316
+ puts "Error when calling AccountingApi->create_general_journal_entry_with_http_info: #{e}"
317
+ end
318
+ ```
319
+
320
+ ### Parameters
321
+
322
+ | Name | Type | Description | Notes |
323
+ | ---- | ---- | ----------- | ----- |
324
+ | **general_journal_entry_post_message** | [**GeneralJournalEntryPostMessage**](GeneralJournalEntryPostMessage.md) | | |
325
+
326
+ ### Return type
327
+
328
+ [**GeneralLedgerTransactionMessage**](GeneralLedgerTransactionMessage.md)
329
+
330
+ ### Authorization
331
+
332
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
333
+
334
+ ### HTTP request headers
335
+
336
+ - **Content-Type**: application/json
337
+ - **Accept**: application/json
338
+
339
+
340
+ ## create_general_ledger_account
341
+
342
+ > <GLAccountMessage> create_general_ledger_account(gl_account_post_message)
343
+
344
+ Create a general ledger account
345
+
346
+ Creates a general ledger account. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; General Ledger Accounts</span> - `View` `Edit`
347
+
348
+ ### Examples
349
+
350
+ ```ruby
351
+ require 'time'
352
+ require 'buildium-ruby'
353
+ # setup authorization
354
+ Buildium.configure do |config|
355
+ # Configure API key authorization: clientId
356
+ config.api_key['clientId'] = 'YOUR API KEY'
357
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
358
+ # config.api_key_prefix['clientId'] = 'Bearer'
359
+
360
+ # Configure API key authorization: clientSecret
361
+ config.api_key['clientSecret'] = 'YOUR API KEY'
362
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
363
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
364
+ end
365
+
366
+ api_instance = Buildium::AccountingApi.new
367
+ gl_account_post_message = Buildium::GLAccountPostMessage.new({sub_type: 'CurrentAsset', name: 'name_example', account_number: 'account_number_example'}) # GLAccountPostMessage |
368
+
369
+ begin
370
+ # Create a general ledger account
371
+ result = api_instance.create_general_ledger_account(gl_account_post_message)
372
+ p result
373
+ rescue Buildium::ApiError => e
374
+ puts "Error when calling AccountingApi->create_general_ledger_account: #{e}"
375
+ end
376
+ ```
377
+
378
+ #### Using the create_general_ledger_account_with_http_info variant
379
+
380
+ This returns an Array which contains the response data, status code and headers.
381
+
382
+ > <Array(<GLAccountMessage>, Integer, Hash)> create_general_ledger_account_with_http_info(gl_account_post_message)
383
+
384
+ ```ruby
385
+ begin
386
+ # Create a general ledger account
387
+ data, status_code, headers = api_instance.create_general_ledger_account_with_http_info(gl_account_post_message)
388
+ p status_code # => 2xx
389
+ p headers # => { ... }
390
+ p data # => <GLAccountMessage>
391
+ rescue Buildium::ApiError => e
392
+ puts "Error when calling AccountingApi->create_general_ledger_account_with_http_info: #{e}"
393
+ end
394
+ ```
395
+
396
+ ### Parameters
397
+
398
+ | Name | Type | Description | Notes |
399
+ | ---- | ---- | ----------- | ----- |
400
+ | **gl_account_post_message** | [**GLAccountPostMessage**](GLAccountPostMessage.md) | | |
401
+
402
+ ### Return type
403
+
404
+ [**GLAccountMessage**](GLAccountMessage.md)
405
+
406
+ ### Authorization
407
+
408
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
409
+
410
+ ### HTTP request headers
411
+
412
+ - **Content-Type**: application/json
413
+ - **Accept**: application/json
414
+
415
+
416
+ ## create_upload_file_request
417
+
418
+ > <FileUploadTicketMessage> create_upload_file_request(bill_id, file_name_post_message)
419
+
420
+ Upload a bill file
421
+
422
+ Uploads a file and associates it to the specified bill record. <br /><br />Uploading a file requires making two API requests. Each step is outlined below. <br /><br /><strong>Step 1 - Save file metadata</strong><br /> The first step in the file upload process is to submit the file metadata to `/v1/bills/{billId:int}/files/uploadrequests`. The response of this call will contain a URL and a collection of form data that will be used in step 2 to generate the request for the file binary upload. <br /><br /><strong>NOTE:</strong> The response data will expire after 5 minutes. The file metadata will not be saved in the Buildium system if step 2 of this process is not completed successfully. <br /><br /><strong>Step 2 - Upload the file binary</strong><br /> Uploading the file binary will require using the response from step 1 to form a POST request to the Buildium file provider. Follow these steps to create the request: <br /> 1. Form a POST request using the value of the `BucketUrl` property as the URL. <br /><br /> 2. Set the `Content-Type` header to `multipart/form-data`. <br /><br /> 3. Copy the fields from the `FormData` property to this request as form-data key/value pairs. <br /><strong>NOTE:</strong> These values must added to the request form-data in the order they were received in the response. <br /><br /> 4. Lastly create a form-data key named `file` and set the value to the file binary. <br /><strong>NOTE:</strong> This must be the last field in the form-data list. <br /><br />This image shows what the POST request should look like if you're using Postman: <img src=\"file-upload-example.png\" /><br /><br /> 5. Send the POST request! A successful request will return with a `204 - NO CONTENT` HTTP response code. For any failure responses, please refer to <a target=\"_blank\" href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#RESTErrorResponses\">AWS documentation</a> on REST error responses. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; Bills</span> - `View` `Edit`
423
+
424
+ ### Examples
425
+
426
+ ```ruby
427
+ require 'time'
428
+ require 'buildium-ruby'
429
+ # setup authorization
430
+ Buildium.configure do |config|
431
+ # Configure API key authorization: clientId
432
+ config.api_key['clientId'] = 'YOUR API KEY'
433
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
434
+ # config.api_key_prefix['clientId'] = 'Bearer'
435
+
436
+ # Configure API key authorization: clientSecret
437
+ config.api_key['clientSecret'] = 'YOUR API KEY'
438
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
439
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
440
+ end
441
+
442
+ api_instance = Buildium::AccountingApi.new
443
+ bill_id = 56 # Integer |
444
+ file_name_post_message = Buildium::FileNamePostMessage.new({file_name: 'file_name_example'}) # FileNamePostMessage |
445
+
446
+ begin
447
+ # Upload a bill file
448
+ result = api_instance.create_upload_file_request(bill_id, file_name_post_message)
449
+ p result
450
+ rescue Buildium::ApiError => e
451
+ puts "Error when calling AccountingApi->create_upload_file_request: #{e}"
452
+ end
453
+ ```
454
+
455
+ #### Using the create_upload_file_request_with_http_info variant
456
+
457
+ This returns an Array which contains the response data, status code and headers.
458
+
459
+ > <Array(<FileUploadTicketMessage>, Integer, Hash)> create_upload_file_request_with_http_info(bill_id, file_name_post_message)
460
+
461
+ ```ruby
462
+ begin
463
+ # Upload a bill file
464
+ data, status_code, headers = api_instance.create_upload_file_request_with_http_info(bill_id, file_name_post_message)
465
+ p status_code # => 2xx
466
+ p headers # => { ... }
467
+ p data # => <FileUploadTicketMessage>
468
+ rescue Buildium::ApiError => e
469
+ puts "Error when calling AccountingApi->create_upload_file_request_with_http_info: #{e}"
470
+ end
471
+ ```
472
+
473
+ ### Parameters
474
+
475
+ | Name | Type | Description | Notes |
476
+ | ---- | ---- | ----------- | ----- |
477
+ | **bill_id** | **Integer** | | |
478
+ | **file_name_post_message** | [**FileNamePostMessage**](FileNamePostMessage.md) | | |
479
+
480
+ ### Return type
481
+
482
+ [**FileUploadTicketMessage**](FileUploadTicketMessage.md)
483
+
484
+ ### Authorization
485
+
486
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
487
+
488
+ ### HTTP request headers
489
+
490
+ - **Content-Type**: application/json
491
+ - **Accept**: application/json
492
+
493
+
494
+ ## delete_bill_file
495
+
496
+ > delete_bill_file(bill_id, file_id)
497
+
498
+ Delete a bill file
499
+
500
+ Deletes the specified file from a bill. The file will be permanently deleted from the Buildium platform and can not be recovered. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; Bills</span> - `View` `Edit` `Delete`
501
+
502
+ ### Examples
503
+
504
+ ```ruby
505
+ require 'time'
506
+ require 'buildium-ruby'
507
+ # setup authorization
508
+ Buildium.configure do |config|
509
+ # Configure API key authorization: clientId
510
+ config.api_key['clientId'] = 'YOUR API KEY'
511
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
512
+ # config.api_key_prefix['clientId'] = 'Bearer'
513
+
514
+ # Configure API key authorization: clientSecret
515
+ config.api_key['clientSecret'] = 'YOUR API KEY'
516
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
517
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
518
+ end
519
+
520
+ api_instance = Buildium::AccountingApi.new
521
+ bill_id = 56 # Integer |
522
+ file_id = 56 # Integer |
523
+
524
+ begin
525
+ # Delete a bill file
526
+ api_instance.delete_bill_file(bill_id, file_id)
527
+ rescue Buildium::ApiError => e
528
+ puts "Error when calling AccountingApi->delete_bill_file: #{e}"
529
+ end
530
+ ```
531
+
532
+ #### Using the delete_bill_file_with_http_info variant
533
+
534
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
535
+
536
+ > <Array(nil, Integer, Hash)> delete_bill_file_with_http_info(bill_id, file_id)
537
+
538
+ ```ruby
539
+ begin
540
+ # Delete a bill file
541
+ data, status_code, headers = api_instance.delete_bill_file_with_http_info(bill_id, file_id)
542
+ p status_code # => 2xx
543
+ p headers # => { ... }
544
+ p data # => nil
545
+ rescue Buildium::ApiError => e
546
+ puts "Error when calling AccountingApi->delete_bill_file_with_http_info: #{e}"
547
+ end
548
+ ```
549
+
550
+ ### Parameters
551
+
552
+ | Name | Type | Description | Notes |
553
+ | ---- | ---- | ----------- | ----- |
554
+ | **bill_id** | **Integer** | | |
555
+ | **file_id** | **Integer** | | |
556
+
557
+ ### Return type
558
+
559
+ nil (empty response body)
560
+
561
+ ### Authorization
562
+
563
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
564
+
565
+ ### HTTP request headers
566
+
567
+ - **Content-Type**: Not defined
568
+ - **Accept**: application/json
569
+
570
+
571
+ ## download_bill_file
572
+
573
+ > <FileDownloadMessage> download_bill_file(bill_id, file_id)
574
+
575
+ Download a bill file
576
+
577
+ Downloads a specific file associated to the bill. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; Bills</span> - `View`
578
+
579
+ ### Examples
580
+
581
+ ```ruby
582
+ require 'time'
583
+ require 'buildium-ruby'
584
+ # setup authorization
585
+ Buildium.configure do |config|
586
+ # Configure API key authorization: clientId
587
+ config.api_key['clientId'] = 'YOUR API KEY'
588
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
589
+ # config.api_key_prefix['clientId'] = 'Bearer'
590
+
591
+ # Configure API key authorization: clientSecret
592
+ config.api_key['clientSecret'] = 'YOUR API KEY'
593
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
594
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
595
+ end
596
+
597
+ api_instance = Buildium::AccountingApi.new
598
+ bill_id = 56 # Integer |
599
+ file_id = 56 # Integer |
600
+
601
+ begin
602
+ # Download a bill file
603
+ result = api_instance.download_bill_file(bill_id, file_id)
604
+ p result
605
+ rescue Buildium::ApiError => e
606
+ puts "Error when calling AccountingApi->download_bill_file: #{e}"
607
+ end
608
+ ```
609
+
610
+ #### Using the download_bill_file_with_http_info variant
611
+
612
+ This returns an Array which contains the response data, status code and headers.
613
+
614
+ > <Array(<FileDownloadMessage>, Integer, Hash)> download_bill_file_with_http_info(bill_id, file_id)
615
+
616
+ ```ruby
617
+ begin
618
+ # Download a bill file
619
+ data, status_code, headers = api_instance.download_bill_file_with_http_info(bill_id, file_id)
620
+ p status_code # => 2xx
621
+ p headers # => { ... }
622
+ p data # => <FileDownloadMessage>
623
+ rescue Buildium::ApiError => e
624
+ puts "Error when calling AccountingApi->download_bill_file_with_http_info: #{e}"
625
+ end
626
+ ```
627
+
628
+ ### Parameters
629
+
630
+ | Name | Type | Description | Notes |
631
+ | ---- | ---- | ----------- | ----- |
632
+ | **bill_id** | **Integer** | | |
633
+ | **file_id** | **Integer** | | |
634
+
635
+ ### Return type
636
+
637
+ [**FileDownloadMessage**](FileDownloadMessage.md)
638
+
639
+ ### Authorization
640
+
641
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
642
+
643
+ ### HTTP request headers
644
+
645
+ - **Content-Type**: Not defined
646
+ - **Accept**: application/json
647
+
648
+
649
+ ## get_all_files_for_bill
650
+
651
+ > <Array<BillFileMessage>> get_all_files_for_bill(bill_id, opts)
652
+
653
+ Retrieve all files for a bill
654
+
655
+ Retrieves the metadata for all files associated to the specified bill. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; Bills</span> - `View`
656
+
657
+ ### Examples
658
+
659
+ ```ruby
660
+ require 'time'
661
+ require 'buildium-ruby'
662
+ # setup authorization
663
+ Buildium.configure do |config|
664
+ # Configure API key authorization: clientId
665
+ config.api_key['clientId'] = 'YOUR API KEY'
666
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
667
+ # config.api_key_prefix['clientId'] = 'Bearer'
668
+
669
+ # Configure API key authorization: clientSecret
670
+ config.api_key['clientSecret'] = 'YOUR API KEY'
671
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
672
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
673
+ end
674
+
675
+ api_instance = Buildium::AccountingApi.new
676
+ bill_id = 56 # Integer |
677
+ opts = {
678
+ orderby: 'orderby_example', # String | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information.
679
+ offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
680
+ limit: 56 # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50.
681
+ }
682
+
683
+ begin
684
+ # Retrieve all files for a bill
685
+ result = api_instance.get_all_files_for_bill(bill_id, opts)
686
+ p result
687
+ rescue Buildium::ApiError => e
688
+ puts "Error when calling AccountingApi->get_all_files_for_bill: #{e}"
689
+ end
690
+ ```
691
+
692
+ #### Using the get_all_files_for_bill_with_http_info variant
693
+
694
+ This returns an Array which contains the response data, status code and headers.
695
+
696
+ > <Array(<Array<BillFileMessage>>, Integer, Hash)> get_all_files_for_bill_with_http_info(bill_id, opts)
697
+
698
+ ```ruby
699
+ begin
700
+ # Retrieve all files for a bill
701
+ data, status_code, headers = api_instance.get_all_files_for_bill_with_http_info(bill_id, opts)
702
+ p status_code # => 2xx
703
+ p headers # => { ... }
704
+ p data # => <Array<BillFileMessage>>
705
+ rescue Buildium::ApiError => e
706
+ puts "Error when calling AccountingApi->get_all_files_for_bill_with_http_info: #{e}"
707
+ end
708
+ ```
709
+
710
+ ### Parameters
711
+
712
+ | Name | Type | Description | Notes |
713
+ | ---- | ---- | ----------- | ----- |
714
+ | **bill_id** | **Integer** | | |
715
+ | **orderby** | **String** | &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information. | [optional] |
716
+ | **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0. | [optional] |
717
+ | **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 1000 and the default is 50. | [optional] |
718
+
719
+ ### Return type
720
+
721
+ [**Array&lt;BillFileMessage&gt;**](BillFileMessage.md)
722
+
723
+ ### Authorization
724
+
725
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
726
+
727
+ ### HTTP request headers
728
+
729
+ - **Content-Type**: Not defined
730
+ - **Accept**: application/json
731
+
732
+
733
+ ## get_all_gl_accounts
734
+
735
+ > <Array<GLAccountMessage>> get_all_gl_accounts(opts)
736
+
737
+ Retrieve all general ledger accounts
738
+
739
+ Retrieves a list of general ledger accounts.<br /><br />General ledger accounts are used to categorize transactions for accounting purposes. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; General Ledger Accounts</span> - `View`
740
+
741
+ ### Examples
742
+
743
+ ```ruby
744
+ require 'time'
745
+ require 'buildium-ruby'
746
+ # setup authorization
747
+ Buildium.configure do |config|
748
+ # Configure API key authorization: clientId
749
+ config.api_key['clientId'] = 'YOUR API KEY'
750
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
751
+ # config.api_key_prefix['clientId'] = 'Bearer'
752
+
753
+ # Configure API key authorization: clientSecret
754
+ config.api_key['clientSecret'] = 'YOUR API KEY'
755
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
756
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
757
+ end
758
+
759
+ api_instance = Buildium::AccountingApi.new
760
+ opts = {
761
+ accounttypes: ['Asset'], # Array<String> | Filters results by the specified general ledger account types.
762
+ orderby: 'orderby_example', # String | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information.
763
+ offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
764
+ limit: 56 # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50.
765
+ }
766
+
767
+ begin
768
+ # Retrieve all general ledger accounts
769
+ result = api_instance.get_all_gl_accounts(opts)
770
+ p result
771
+ rescue Buildium::ApiError => e
772
+ puts "Error when calling AccountingApi->get_all_gl_accounts: #{e}"
773
+ end
774
+ ```
775
+
776
+ #### Using the get_all_gl_accounts_with_http_info variant
777
+
778
+ This returns an Array which contains the response data, status code and headers.
779
+
780
+ > <Array(<Array<GLAccountMessage>>, Integer, Hash)> get_all_gl_accounts_with_http_info(opts)
781
+
782
+ ```ruby
783
+ begin
784
+ # Retrieve all general ledger accounts
785
+ data, status_code, headers = api_instance.get_all_gl_accounts_with_http_info(opts)
786
+ p status_code # => 2xx
787
+ p headers # => { ... }
788
+ p data # => <Array<GLAccountMessage>>
789
+ rescue Buildium::ApiError => e
790
+ puts "Error when calling AccountingApi->get_all_gl_accounts_with_http_info: #{e}"
791
+ end
792
+ ```
793
+
794
+ ### Parameters
795
+
796
+ | Name | Type | Description | Notes |
797
+ | ---- | ---- | ----------- | ----- |
798
+ | **accounttypes** | [**Array&lt;String&gt;**](String.md) | Filters results by the specified general ledger account types. | [optional] |
799
+ | **orderby** | **String** | &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information. | [optional] |
800
+ | **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0. | [optional] |
801
+ | **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 1000 and the default is 50. | [optional] |
802
+
803
+ ### Return type
804
+
805
+ [**Array&lt;GLAccountMessage&gt;**](GLAccountMessage.md)
806
+
807
+ ### Authorization
808
+
809
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
810
+
811
+ ### HTTP request headers
812
+
813
+ - **Content-Type**: Not defined
814
+ - **Accept**: application/json
815
+
816
+
817
+ ## get_all_transactions
818
+
819
+ > <Array<GeneralLedgerTransactionMessage>> get_all_transactions(startdate, enddate, glaccountids, opts)
820
+
821
+ Retrieve all general ledger transactions
822
+
823
+ Retrieves a list of general ledger transactions. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; General Ledger Transactions</span> - `View`
824
+
825
+ ### Examples
826
+
827
+ ```ruby
828
+ require 'time'
829
+ require 'buildium-ruby'
830
+ # setup authorization
831
+ Buildium.configure do |config|
832
+ # Configure API key authorization: clientId
833
+ config.api_key['clientId'] = 'YOUR API KEY'
834
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
835
+ # config.api_key_prefix['clientId'] = 'Bearer'
836
+
837
+ # Configure API key authorization: clientSecret
838
+ config.api_key['clientSecret'] = 'YOUR API KEY'
839
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
840
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
841
+ end
842
+
843
+ api_instance = Buildium::AccountingApi.new
844
+ startdate = Date.parse('2013-10-20') # Date | Filters results to any transaction whose date is greater than or equal to the specified value.
845
+ enddate = Date.parse('2013-10-20') # Date | Filters results to any transaction whose date is less than or equal to the specified value.
846
+ glaccountids = [37] # Array<Integer> | Filters results to transactions whose general ledger account belongs to the specified set of general ledger account ids.
847
+ opts = {
848
+ selectionentityid: 56, # Integer | Filters results to any transaction containing journal lines for an entity associated with the specified entity id value. The id must be of the type specified in SelectionEntityType.
849
+ selectionentitytype: 'Rental', # String | Specifies the type of entity that SelectionEntityId refers to.
850
+ orderby: 'orderby_example', # String | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information.
851
+ offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
852
+ limit: 56 # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50.
853
+ }
854
+
855
+ begin
856
+ # Retrieve all general ledger transactions
857
+ result = api_instance.get_all_transactions(startdate, enddate, glaccountids, opts)
858
+ p result
859
+ rescue Buildium::ApiError => e
860
+ puts "Error when calling AccountingApi->get_all_transactions: #{e}"
861
+ end
862
+ ```
863
+
864
+ #### Using the get_all_transactions_with_http_info variant
865
+
866
+ This returns an Array which contains the response data, status code and headers.
867
+
868
+ > <Array(<Array<GeneralLedgerTransactionMessage>>, Integer, Hash)> get_all_transactions_with_http_info(startdate, enddate, glaccountids, opts)
869
+
870
+ ```ruby
871
+ begin
872
+ # Retrieve all general ledger transactions
873
+ data, status_code, headers = api_instance.get_all_transactions_with_http_info(startdate, enddate, glaccountids, opts)
874
+ p status_code # => 2xx
875
+ p headers # => { ... }
876
+ p data # => <Array<GeneralLedgerTransactionMessage>>
877
+ rescue Buildium::ApiError => e
878
+ puts "Error when calling AccountingApi->get_all_transactions_with_http_info: #{e}"
879
+ end
880
+ ```
881
+
882
+ ### Parameters
883
+
884
+ | Name | Type | Description | Notes |
885
+ | ---- | ---- | ----------- | ----- |
886
+ | **startdate** | **Date** | Filters results to any transaction whose date is greater than or equal to the specified value. | |
887
+ | **enddate** | **Date** | Filters results to any transaction whose date is less than or equal to the specified value. | |
888
+ | **glaccountids** | [**Array&lt;Integer&gt;**](Integer.md) | Filters results to transactions whose general ledger account belongs to the specified set of general ledger account ids. | |
889
+ | **selectionentityid** | **Integer** | Filters results to any transaction containing journal lines for an entity associated with the specified entity id value. The id must be of the type specified in SelectionEntityType. | [optional] |
890
+ | **selectionentitytype** | **String** | Specifies the type of entity that SelectionEntityId refers to. | [optional] |
891
+ | **orderby** | **String** | &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information. | [optional] |
892
+ | **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0. | [optional] |
893
+ | **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 1000 and the default is 50. | [optional] |
894
+
895
+ ### Return type
896
+
897
+ [**Array&lt;GeneralLedgerTransactionMessage&gt;**](GeneralLedgerTransactionMessage.md)
898
+
899
+ ### Authorization
900
+
901
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
902
+
903
+ ### HTTP request headers
904
+
905
+ - **Content-Type**: Not defined
906
+ - **Accept**: application/json
907
+
908
+
909
+ ## get_bill_by_id
910
+
911
+ > <BillMessage> get_bill_by_id(bill_id)
912
+
913
+ Retrieve a bill
914
+
915
+ Retrieves a single bill. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; Bills</span> - `View`
916
+
917
+ ### Examples
918
+
919
+ ```ruby
920
+ require 'time'
921
+ require 'buildium-ruby'
922
+ # setup authorization
923
+ Buildium.configure do |config|
924
+ # Configure API key authorization: clientId
925
+ config.api_key['clientId'] = 'YOUR API KEY'
926
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
927
+ # config.api_key_prefix['clientId'] = 'Bearer'
928
+
929
+ # Configure API key authorization: clientSecret
930
+ config.api_key['clientSecret'] = 'YOUR API KEY'
931
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
932
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
933
+ end
934
+
935
+ api_instance = Buildium::AccountingApi.new
936
+ bill_id = 56 # Integer |
937
+
938
+ begin
939
+ # Retrieve a bill
940
+ result = api_instance.get_bill_by_id(bill_id)
941
+ p result
942
+ rescue Buildium::ApiError => e
943
+ puts "Error when calling AccountingApi->get_bill_by_id: #{e}"
944
+ end
945
+ ```
946
+
947
+ #### Using the get_bill_by_id_with_http_info variant
948
+
949
+ This returns an Array which contains the response data, status code and headers.
950
+
951
+ > <Array(<BillMessage>, Integer, Hash)> get_bill_by_id_with_http_info(bill_id)
952
+
953
+ ```ruby
954
+ begin
955
+ # Retrieve a bill
956
+ data, status_code, headers = api_instance.get_bill_by_id_with_http_info(bill_id)
957
+ p status_code # => 2xx
958
+ p headers # => { ... }
959
+ p data # => <BillMessage>
960
+ rescue Buildium::ApiError => e
961
+ puts "Error when calling AccountingApi->get_bill_by_id_with_http_info: #{e}"
962
+ end
963
+ ```
964
+
965
+ ### Parameters
966
+
967
+ | Name | Type | Description | Notes |
968
+ | ---- | ---- | ----------- | ----- |
969
+ | **bill_id** | **Integer** | | |
970
+
971
+ ### Return type
972
+
973
+ [**BillMessage**](BillMessage.md)
974
+
975
+ ### Authorization
976
+
977
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
978
+
979
+ ### HTTP request headers
980
+
981
+ - **Content-Type**: Not defined
982
+ - **Accept**: application/json
983
+
984
+
985
+ ## get_bill_file_by_id
986
+
987
+ > <BillFileMessage> get_bill_file_by_id(bill_id, file_id)
988
+
989
+ Retrieve a file for a bill
990
+
991
+ Retrieves the metadata for a specific file associated with the specified bill. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; Bills</span> - `View`
992
+
993
+ ### Examples
994
+
995
+ ```ruby
996
+ require 'time'
997
+ require 'buildium-ruby'
998
+ # setup authorization
999
+ Buildium.configure do |config|
1000
+ # Configure API key authorization: clientId
1001
+ config.api_key['clientId'] = 'YOUR API KEY'
1002
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1003
+ # config.api_key_prefix['clientId'] = 'Bearer'
1004
+
1005
+ # Configure API key authorization: clientSecret
1006
+ config.api_key['clientSecret'] = 'YOUR API KEY'
1007
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1008
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
1009
+ end
1010
+
1011
+ api_instance = Buildium::AccountingApi.new
1012
+ bill_id = 56 # Integer |
1013
+ file_id = 56 # Integer |
1014
+
1015
+ begin
1016
+ # Retrieve a file for a bill
1017
+ result = api_instance.get_bill_file_by_id(bill_id, file_id)
1018
+ p result
1019
+ rescue Buildium::ApiError => e
1020
+ puts "Error when calling AccountingApi->get_bill_file_by_id: #{e}"
1021
+ end
1022
+ ```
1023
+
1024
+ #### Using the get_bill_file_by_id_with_http_info variant
1025
+
1026
+ This returns an Array which contains the response data, status code and headers.
1027
+
1028
+ > <Array(<BillFileMessage>, Integer, Hash)> get_bill_file_by_id_with_http_info(bill_id, file_id)
1029
+
1030
+ ```ruby
1031
+ begin
1032
+ # Retrieve a file for a bill
1033
+ data, status_code, headers = api_instance.get_bill_file_by_id_with_http_info(bill_id, file_id)
1034
+ p status_code # => 2xx
1035
+ p headers # => { ... }
1036
+ p data # => <BillFileMessage>
1037
+ rescue Buildium::ApiError => e
1038
+ puts "Error when calling AccountingApi->get_bill_file_by_id_with_http_info: #{e}"
1039
+ end
1040
+ ```
1041
+
1042
+ ### Parameters
1043
+
1044
+ | Name | Type | Description | Notes |
1045
+ | ---- | ---- | ----------- | ----- |
1046
+ | **bill_id** | **Integer** | | |
1047
+ | **file_id** | **Integer** | | |
1048
+
1049
+ ### Return type
1050
+
1051
+ [**BillFileMessage**](BillFileMessage.md)
1052
+
1053
+ ### Authorization
1054
+
1055
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1056
+
1057
+ ### HTTP request headers
1058
+
1059
+ - **Content-Type**: Not defined
1060
+ - **Accept**: application/json
1061
+
1062
+
1063
+ ## get_bill_payment_by_id
1064
+
1065
+ > <BillPaymentMessage> get_bill_payment_by_id(bill_id, payment_id)
1066
+
1067
+ Retrieve a bill payment
1068
+
1069
+ Retrieves specific bill payment. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; Bills</span> - `View`
1070
+
1071
+ ### Examples
1072
+
1073
+ ```ruby
1074
+ require 'time'
1075
+ require 'buildium-ruby'
1076
+ # setup authorization
1077
+ Buildium.configure do |config|
1078
+ # Configure API key authorization: clientId
1079
+ config.api_key['clientId'] = 'YOUR API KEY'
1080
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1081
+ # config.api_key_prefix['clientId'] = 'Bearer'
1082
+
1083
+ # Configure API key authorization: clientSecret
1084
+ config.api_key['clientSecret'] = 'YOUR API KEY'
1085
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1086
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
1087
+ end
1088
+
1089
+ api_instance = Buildium::AccountingApi.new
1090
+ bill_id = 56 # Integer |
1091
+ payment_id = 56 # Integer |
1092
+
1093
+ begin
1094
+ # Retrieve a bill payment
1095
+ result = api_instance.get_bill_payment_by_id(bill_id, payment_id)
1096
+ p result
1097
+ rescue Buildium::ApiError => e
1098
+ puts "Error when calling AccountingApi->get_bill_payment_by_id: #{e}"
1099
+ end
1100
+ ```
1101
+
1102
+ #### Using the get_bill_payment_by_id_with_http_info variant
1103
+
1104
+ This returns an Array which contains the response data, status code and headers.
1105
+
1106
+ > <Array(<BillPaymentMessage>, Integer, Hash)> get_bill_payment_by_id_with_http_info(bill_id, payment_id)
1107
+
1108
+ ```ruby
1109
+ begin
1110
+ # Retrieve a bill payment
1111
+ data, status_code, headers = api_instance.get_bill_payment_by_id_with_http_info(bill_id, payment_id)
1112
+ p status_code # => 2xx
1113
+ p headers # => { ... }
1114
+ p data # => <BillPaymentMessage>
1115
+ rescue Buildium::ApiError => e
1116
+ puts "Error when calling AccountingApi->get_bill_payment_by_id_with_http_info: #{e}"
1117
+ end
1118
+ ```
1119
+
1120
+ ### Parameters
1121
+
1122
+ | Name | Type | Description | Notes |
1123
+ | ---- | ---- | ----------- | ----- |
1124
+ | **bill_id** | **Integer** | | |
1125
+ | **payment_id** | **Integer** | | |
1126
+
1127
+ ### Return type
1128
+
1129
+ [**BillPaymentMessage**](BillPaymentMessage.md)
1130
+
1131
+ ### Authorization
1132
+
1133
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1134
+
1135
+ ### HTTP request headers
1136
+
1137
+ - **Content-Type**: Not defined
1138
+ - **Accept**: application/json
1139
+
1140
+
1141
+ ## get_bill_payments
1142
+
1143
+ > <Array<BillPaymentMessage>> get_bill_payments(bill_id, opts)
1144
+
1145
+ Retrieve all bill payments
1146
+
1147
+ Retrieves a list of bill payments for a specific bill. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; Bills</span> - `View`
1148
+
1149
+ ### Examples
1150
+
1151
+ ```ruby
1152
+ require 'time'
1153
+ require 'buildium-ruby'
1154
+ # setup authorization
1155
+ Buildium.configure do |config|
1156
+ # Configure API key authorization: clientId
1157
+ config.api_key['clientId'] = 'YOUR API KEY'
1158
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1159
+ # config.api_key_prefix['clientId'] = 'Bearer'
1160
+
1161
+ # Configure API key authorization: clientSecret
1162
+ config.api_key['clientSecret'] = 'YOUR API KEY'
1163
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1164
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
1165
+ end
1166
+
1167
+ api_instance = Buildium::AccountingApi.new
1168
+ bill_id = 56 # Integer |
1169
+ opts = {
1170
+ orderby: 'orderby_example', # String | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information.
1171
+ offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
1172
+ limit: 56 # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50.
1173
+ }
1174
+
1175
+ begin
1176
+ # Retrieve all bill payments
1177
+ result = api_instance.get_bill_payments(bill_id, opts)
1178
+ p result
1179
+ rescue Buildium::ApiError => e
1180
+ puts "Error when calling AccountingApi->get_bill_payments: #{e}"
1181
+ end
1182
+ ```
1183
+
1184
+ #### Using the get_bill_payments_with_http_info variant
1185
+
1186
+ This returns an Array which contains the response data, status code and headers.
1187
+
1188
+ > <Array(<Array<BillPaymentMessage>>, Integer, Hash)> get_bill_payments_with_http_info(bill_id, opts)
1189
+
1190
+ ```ruby
1191
+ begin
1192
+ # Retrieve all bill payments
1193
+ data, status_code, headers = api_instance.get_bill_payments_with_http_info(bill_id, opts)
1194
+ p status_code # => 2xx
1195
+ p headers # => { ... }
1196
+ p data # => <Array<BillPaymentMessage>>
1197
+ rescue Buildium::ApiError => e
1198
+ puts "Error when calling AccountingApi->get_bill_payments_with_http_info: #{e}"
1199
+ end
1200
+ ```
1201
+
1202
+ ### Parameters
1203
+
1204
+ | Name | Type | Description | Notes |
1205
+ | ---- | ---- | ----------- | ----- |
1206
+ | **bill_id** | **Integer** | | |
1207
+ | **orderby** | **String** | &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information. | [optional] |
1208
+ | **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0. | [optional] |
1209
+ | **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 1000 and the default is 50. | [optional] |
1210
+
1211
+ ### Return type
1212
+
1213
+ [**Array&lt;BillPaymentMessage&gt;**](BillPaymentMessage.md)
1214
+
1215
+ ### Authorization
1216
+
1217
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1218
+
1219
+ ### HTTP request headers
1220
+
1221
+ - **Content-Type**: Not defined
1222
+ - **Accept**: application/json
1223
+
1224
+
1225
+ ## get_bills_async
1226
+
1227
+ > <Array<BillMessage>> get_bills_async(opts)
1228
+
1229
+ Retrieve all bills
1230
+
1231
+ Retrieves a list of bills. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; Bills</span> - `View`
1232
+
1233
+ ### Examples
1234
+
1235
+ ```ruby
1236
+ require 'time'
1237
+ require 'buildium-ruby'
1238
+ # setup authorization
1239
+ Buildium.configure do |config|
1240
+ # Configure API key authorization: clientId
1241
+ config.api_key['clientId'] = 'YOUR API KEY'
1242
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1243
+ # config.api_key_prefix['clientId'] = 'Bearer'
1244
+
1245
+ # Configure API key authorization: clientSecret
1246
+ config.api_key['clientSecret'] = 'YOUR API KEY'
1247
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1248
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
1249
+ end
1250
+
1251
+ api_instance = Buildium::AccountingApi.new
1252
+ opts = {
1253
+ entityid: 56, # Integer | Filters results to any bill containing line items associated with the specified entity identifier. This filter is used in conjunction with the `EntityType` field which must be set to the type of entity this identifier references.
1254
+ entitytype: 'Rental', # String | Specifies the type of entity that `EntityId` refers to. This field is required if `EntityId` is specified.
1255
+ vendorid: 56, # Integer | Filters results to bills associated with a specific vendor.
1256
+ referencenumber: 'referencenumber_example', # String | Filters results to bills whose reference number contains the specified value.
1257
+ paidstatus: 'Paid', # String | Filters results by the bill's paid status. If no status is specified, bills with any status will be returned.
1258
+ frompaiddate: Date.parse('2013-10-20'), # Date | Filters results to any bill whose paid date is greater than or equal to the specified value.
1259
+ topaiddate: Date.parse('2013-10-20'), # Date | Filters results to any bill whose paid date is less than or equal to the specified value.
1260
+ approvalstatuses: ['NotNeeded'], # Array<String> | Filters the results to bills matching the specified approval statuses. If no approval status is specified, bills with any status will be returned.
1261
+ orderby: 'orderby_example', # String | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information.
1262
+ offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
1263
+ limit: 56 # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50.
1264
+ }
1265
+
1266
+ begin
1267
+ # Retrieve all bills
1268
+ result = api_instance.get_bills_async(opts)
1269
+ p result
1270
+ rescue Buildium::ApiError => e
1271
+ puts "Error when calling AccountingApi->get_bills_async: #{e}"
1272
+ end
1273
+ ```
1274
+
1275
+ #### Using the get_bills_async_with_http_info variant
1276
+
1277
+ This returns an Array which contains the response data, status code and headers.
1278
+
1279
+ > <Array(<Array<BillMessage>>, Integer, Hash)> get_bills_async_with_http_info(opts)
1280
+
1281
+ ```ruby
1282
+ begin
1283
+ # Retrieve all bills
1284
+ data, status_code, headers = api_instance.get_bills_async_with_http_info(opts)
1285
+ p status_code # => 2xx
1286
+ p headers # => { ... }
1287
+ p data # => <Array<BillMessage>>
1288
+ rescue Buildium::ApiError => e
1289
+ puts "Error when calling AccountingApi->get_bills_async_with_http_info: #{e}"
1290
+ end
1291
+ ```
1292
+
1293
+ ### Parameters
1294
+
1295
+ | Name | Type | Description | Notes |
1296
+ | ---- | ---- | ----------- | ----- |
1297
+ | **entityid** | **Integer** | Filters results to any bill containing line items associated with the specified entity identifier. This filter is used in conjunction with the &#x60;EntityType&#x60; field which must be set to the type of entity this identifier references. | [optional] |
1298
+ | **entitytype** | **String** | Specifies the type of entity that &#x60;EntityId&#x60; refers to. This field is required if &#x60;EntityId&#x60; is specified. | [optional] |
1299
+ | **vendorid** | **Integer** | Filters results to bills associated with a specific vendor. | [optional] |
1300
+ | **referencenumber** | **String** | Filters results to bills whose reference number contains the specified value. | [optional] |
1301
+ | **paidstatus** | **String** | Filters results by the bill&#39;s paid status. If no status is specified, bills with any status will be returned. | [optional] |
1302
+ | **frompaiddate** | **Date** | Filters results to any bill whose paid date is greater than or equal to the specified value. | [optional] |
1303
+ | **topaiddate** | **Date** | Filters results to any bill whose paid date is less than or equal to the specified value. | [optional] |
1304
+ | **approvalstatuses** | [**Array&lt;String&gt;**](String.md) | Filters the results to bills matching the specified approval statuses. If no approval status is specified, bills with any status will be returned. | [optional] |
1305
+ | **orderby** | **String** | &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information. | [optional] |
1306
+ | **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0. | [optional] |
1307
+ | **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 1000 and the default is 50. | [optional] |
1308
+
1309
+ ### Return type
1310
+
1311
+ [**Array&lt;BillMessage&gt;**](BillMessage.md)
1312
+
1313
+ ### Authorization
1314
+
1315
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1316
+
1317
+ ### HTTP request headers
1318
+
1319
+ - **Content-Type**: Not defined
1320
+ - **Accept**: application/json
1321
+
1322
+
1323
+ ## get_budget_by_id
1324
+
1325
+ > <BudgetMessage> get_budget_by_id(budget_id)
1326
+
1327
+ Retrieve a budget
1328
+
1329
+ Retrieves a budget. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; Budgets</span> - `View`
1330
+
1331
+ ### Examples
1332
+
1333
+ ```ruby
1334
+ require 'time'
1335
+ require 'buildium-ruby'
1336
+ # setup authorization
1337
+ Buildium.configure do |config|
1338
+ # Configure API key authorization: clientId
1339
+ config.api_key['clientId'] = 'YOUR API KEY'
1340
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1341
+ # config.api_key_prefix['clientId'] = 'Bearer'
1342
+
1343
+ # Configure API key authorization: clientSecret
1344
+ config.api_key['clientSecret'] = 'YOUR API KEY'
1345
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1346
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
1347
+ end
1348
+
1349
+ api_instance = Buildium::AccountingApi.new
1350
+ budget_id = 56 # Integer |
1351
+
1352
+ begin
1353
+ # Retrieve a budget
1354
+ result = api_instance.get_budget_by_id(budget_id)
1355
+ p result
1356
+ rescue Buildium::ApiError => e
1357
+ puts "Error when calling AccountingApi->get_budget_by_id: #{e}"
1358
+ end
1359
+ ```
1360
+
1361
+ #### Using the get_budget_by_id_with_http_info variant
1362
+
1363
+ This returns an Array which contains the response data, status code and headers.
1364
+
1365
+ > <Array(<BudgetMessage>, Integer, Hash)> get_budget_by_id_with_http_info(budget_id)
1366
+
1367
+ ```ruby
1368
+ begin
1369
+ # Retrieve a budget
1370
+ data, status_code, headers = api_instance.get_budget_by_id_with_http_info(budget_id)
1371
+ p status_code # => 2xx
1372
+ p headers # => { ... }
1373
+ p data # => <BudgetMessage>
1374
+ rescue Buildium::ApiError => e
1375
+ puts "Error when calling AccountingApi->get_budget_by_id_with_http_info: #{e}"
1376
+ end
1377
+ ```
1378
+
1379
+ ### Parameters
1380
+
1381
+ | Name | Type | Description | Notes |
1382
+ | ---- | ---- | ----------- | ----- |
1383
+ | **budget_id** | **Integer** | | |
1384
+
1385
+ ### Return type
1386
+
1387
+ [**BudgetMessage**](BudgetMessage.md)
1388
+
1389
+ ### Authorization
1390
+
1391
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1392
+
1393
+ ### HTTP request headers
1394
+
1395
+ - **Content-Type**: Not defined
1396
+ - **Accept**: application/json
1397
+
1398
+
1399
+ ## get_budgets
1400
+
1401
+ > <Array<BudgetMessage>> get_budgets(opts)
1402
+
1403
+ Retrieve all budgets
1404
+
1405
+ Retrieves all budgets. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; Budgets</span> - `View`
1406
+
1407
+ ### Examples
1408
+
1409
+ ```ruby
1410
+ require 'time'
1411
+ require 'buildium-ruby'
1412
+ # setup authorization
1413
+ Buildium.configure do |config|
1414
+ # Configure API key authorization: clientId
1415
+ config.api_key['clientId'] = 'YOUR API KEY'
1416
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1417
+ # config.api_key_prefix['clientId'] = 'Bearer'
1418
+
1419
+ # Configure API key authorization: clientSecret
1420
+ config.api_key['clientSecret'] = 'YOUR API KEY'
1421
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1422
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
1423
+ end
1424
+
1425
+ api_instance = Buildium::AccountingApi.new
1426
+ opts = {
1427
+ propertyids: [37], # Array<Integer> | Filters results to any budget associated to any of the specified set of property ids.
1428
+ fiscalyear: 56, # Integer | Filters results to any budgets that end in the given fiscal year. FiscalYear must be a positive number.
1429
+ name: 'name_example', # String | Filters results to any budgets whose name *contains* the specified value.
1430
+ orderby: 'orderby_example', # String | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information.
1431
+ offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
1432
+ limit: 56 # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50.
1433
+ }
1434
+
1435
+ begin
1436
+ # Retrieve all budgets
1437
+ result = api_instance.get_budgets(opts)
1438
+ p result
1439
+ rescue Buildium::ApiError => e
1440
+ puts "Error when calling AccountingApi->get_budgets: #{e}"
1441
+ end
1442
+ ```
1443
+
1444
+ #### Using the get_budgets_with_http_info variant
1445
+
1446
+ This returns an Array which contains the response data, status code and headers.
1447
+
1448
+ > <Array(<Array<BudgetMessage>>, Integer, Hash)> get_budgets_with_http_info(opts)
1449
+
1450
+ ```ruby
1451
+ begin
1452
+ # Retrieve all budgets
1453
+ data, status_code, headers = api_instance.get_budgets_with_http_info(opts)
1454
+ p status_code # => 2xx
1455
+ p headers # => { ... }
1456
+ p data # => <Array<BudgetMessage>>
1457
+ rescue Buildium::ApiError => e
1458
+ puts "Error when calling AccountingApi->get_budgets_with_http_info: #{e}"
1459
+ end
1460
+ ```
1461
+
1462
+ ### Parameters
1463
+
1464
+ | Name | Type | Description | Notes |
1465
+ | ---- | ---- | ----------- | ----- |
1466
+ | **propertyids** | [**Array&lt;Integer&gt;**](Integer.md) | Filters results to any budget associated to any of the specified set of property ids. | [optional] |
1467
+ | **fiscalyear** | **Integer** | Filters results to any budgets that end in the given fiscal year. FiscalYear must be a positive number. | [optional] |
1468
+ | **name** | **String** | Filters results to any budgets whose name *contains* the specified value. | [optional] |
1469
+ | **orderby** | **String** | &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information. | [optional] |
1470
+ | **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0. | [optional] |
1471
+ | **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 1000 and the default is 50. | [optional] |
1472
+
1473
+ ### Return type
1474
+
1475
+ [**Array&lt;BudgetMessage&gt;**](BudgetMessage.md)
1476
+
1477
+ ### Authorization
1478
+
1479
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1480
+
1481
+ ### HTTP request headers
1482
+
1483
+ - **Content-Type**: Not defined
1484
+ - **Accept**: application/json
1485
+
1486
+
1487
+ ## get_gl_account_balances
1488
+
1489
+ > <Array<GLAccountBalanceMessage>> get_gl_account_balances(accountingbasis, asofdate, opts)
1490
+
1491
+ Retrieve all general ledger account balances
1492
+
1493
+ Retrieves all general ledger account balances as of a given date. The response includes the total balance of each account along with the subtotals for any accounting entities (company, associations or rental properties) that have transactions assigned to the account. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; General Ledger Accounts</span> - `View`
1494
+
1495
+ ### Examples
1496
+
1497
+ ```ruby
1498
+ require 'time'
1499
+ require 'buildium-ruby'
1500
+ # setup authorization
1501
+ Buildium.configure do |config|
1502
+ # Configure API key authorization: clientId
1503
+ config.api_key['clientId'] = 'YOUR API KEY'
1504
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1505
+ # config.api_key_prefix['clientId'] = 'Bearer'
1506
+
1507
+ # Configure API key authorization: clientSecret
1508
+ config.api_key['clientSecret'] = 'YOUR API KEY'
1509
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1510
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
1511
+ end
1512
+
1513
+ api_instance = Buildium::AccountingApi.new
1514
+ accountingbasis = 'Accrual' # String | The methodology in which revenues and expenses are recognized when calculating the balances. Specifying `Cash` calculates balances based on when money changes hands. Specifying `Accrual` calculates balances based on the period in which the transaction originally happened.
1515
+ asofdate = Date.parse('2013-10-20') # Date | Indicates the end date through which the balances will be calculated. This will include all transactions in your account until this specified date.
1516
+ opts = {
1517
+ entitytype: 'Association', # String | Specifies the type of entity that `EntityId` field refers to.
1518
+ entityid: 56, # Integer | Filters transactions used in calculating the general ledger account balances to only those containing journal lines for with the specified entity id value. The entity id specified must be of the type specified in `EntityType`.
1519
+ glaccountids: [37], # Array<Integer> | Filters results to the specified set of general ledger account identifiers.
1520
+ orderby: 'orderby_example', # String | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information.
1521
+ offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
1522
+ limit: 56 # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50.
1523
+ }
1524
+
1525
+ begin
1526
+ # Retrieve all general ledger account balances
1527
+ result = api_instance.get_gl_account_balances(accountingbasis, asofdate, opts)
1528
+ p result
1529
+ rescue Buildium::ApiError => e
1530
+ puts "Error when calling AccountingApi->get_gl_account_balances: #{e}"
1531
+ end
1532
+ ```
1533
+
1534
+ #### Using the get_gl_account_balances_with_http_info variant
1535
+
1536
+ This returns an Array which contains the response data, status code and headers.
1537
+
1538
+ > <Array(<Array<GLAccountBalanceMessage>>, Integer, Hash)> get_gl_account_balances_with_http_info(accountingbasis, asofdate, opts)
1539
+
1540
+ ```ruby
1541
+ begin
1542
+ # Retrieve all general ledger account balances
1543
+ data, status_code, headers = api_instance.get_gl_account_balances_with_http_info(accountingbasis, asofdate, opts)
1544
+ p status_code # => 2xx
1545
+ p headers # => { ... }
1546
+ p data # => <Array<GLAccountBalanceMessage>>
1547
+ rescue Buildium::ApiError => e
1548
+ puts "Error when calling AccountingApi->get_gl_account_balances_with_http_info: #{e}"
1549
+ end
1550
+ ```
1551
+
1552
+ ### Parameters
1553
+
1554
+ | Name | Type | Description | Notes |
1555
+ | ---- | ---- | ----------- | ----- |
1556
+ | **accountingbasis** | **String** | The methodology in which revenues and expenses are recognized when calculating the balances. Specifying &#x60;Cash&#x60; calculates balances based on when money changes hands. Specifying &#x60;Accrual&#x60; calculates balances based on the period in which the transaction originally happened. | |
1557
+ | **asofdate** | **Date** | Indicates the end date through which the balances will be calculated. This will include all transactions in your account until this specified date. | |
1558
+ | **entitytype** | **String** | Specifies the type of entity that &#x60;EntityId&#x60; field refers to. | [optional] |
1559
+ | **entityid** | **Integer** | Filters transactions used in calculating the general ledger account balances to only those containing journal lines for with the specified entity id value. The entity id specified must be of the type specified in &#x60;EntityType&#x60;. | [optional] |
1560
+ | **glaccountids** | [**Array&lt;Integer&gt;**](Integer.md) | Filters results to the specified set of general ledger account identifiers. | [optional] |
1561
+ | **orderby** | **String** | &#x60;orderby&#x60; indicates the field(s) and direction to sort the results in the response. See &lt;a href&#x3D;\&quot;#section/API-Overview/Bulk-Request-Options\&quot;&gt;Bulk Request Options&lt;/a&gt; for more information. | [optional] |
1562
+ | **offset** | **Integer** | &#x60;offset&#x60; indicates the position of the first record to return. The &#x60;offset&#x60; is zero-based and the default is 0. | [optional] |
1563
+ | **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 1000 and the default is 50. | [optional] |
1564
+
1565
+ ### Return type
1566
+
1567
+ [**Array&lt;GLAccountBalanceMessage&gt;**](GLAccountBalanceMessage.md)
1568
+
1569
+ ### Authorization
1570
+
1571
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1572
+
1573
+ ### HTTP request headers
1574
+
1575
+ - **Content-Type**: Not defined
1576
+ - **Accept**: application/json
1577
+
1578
+
1579
+ ## get_gl_account_by_id
1580
+
1581
+ > <GLAccountMessage> get_gl_account_by_id(gl_account_id)
1582
+
1583
+ Retrieve a general ledger account
1584
+
1585
+ Retrieves a specific general ledger account. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; General Ledger Accounts</span> - `View`
1586
+
1587
+ ### Examples
1588
+
1589
+ ```ruby
1590
+ require 'time'
1591
+ require 'buildium-ruby'
1592
+ # setup authorization
1593
+ Buildium.configure do |config|
1594
+ # Configure API key authorization: clientId
1595
+ config.api_key['clientId'] = 'YOUR API KEY'
1596
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1597
+ # config.api_key_prefix['clientId'] = 'Bearer'
1598
+
1599
+ # Configure API key authorization: clientSecret
1600
+ config.api_key['clientSecret'] = 'YOUR API KEY'
1601
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1602
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
1603
+ end
1604
+
1605
+ api_instance = Buildium::AccountingApi.new
1606
+ gl_account_id = 56 # Integer | The general ledger account identifier.
1607
+
1608
+ begin
1609
+ # Retrieve a general ledger account
1610
+ result = api_instance.get_gl_account_by_id(gl_account_id)
1611
+ p result
1612
+ rescue Buildium::ApiError => e
1613
+ puts "Error when calling AccountingApi->get_gl_account_by_id: #{e}"
1614
+ end
1615
+ ```
1616
+
1617
+ #### Using the get_gl_account_by_id_with_http_info variant
1618
+
1619
+ This returns an Array which contains the response data, status code and headers.
1620
+
1621
+ > <Array(<GLAccountMessage>, Integer, Hash)> get_gl_account_by_id_with_http_info(gl_account_id)
1622
+
1623
+ ```ruby
1624
+ begin
1625
+ # Retrieve a general ledger account
1626
+ data, status_code, headers = api_instance.get_gl_account_by_id_with_http_info(gl_account_id)
1627
+ p status_code # => 2xx
1628
+ p headers # => { ... }
1629
+ p data # => <GLAccountMessage>
1630
+ rescue Buildium::ApiError => e
1631
+ puts "Error when calling AccountingApi->get_gl_account_by_id_with_http_info: #{e}"
1632
+ end
1633
+ ```
1634
+
1635
+ ### Parameters
1636
+
1637
+ | Name | Type | Description | Notes |
1638
+ | ---- | ---- | ----------- | ----- |
1639
+ | **gl_account_id** | **Integer** | The general ledger account identifier. | |
1640
+
1641
+ ### Return type
1642
+
1643
+ [**GLAccountMessage**](GLAccountMessage.md)
1644
+
1645
+ ### Authorization
1646
+
1647
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1648
+
1649
+ ### HTTP request headers
1650
+
1651
+ - **Content-Type**: Not defined
1652
+ - **Accept**: application/json
1653
+
1654
+
1655
+ ## get_transaction_by_id
1656
+
1657
+ > <GeneralLedgerTransactionMessage> get_transaction_by_id(transaction_id)
1658
+
1659
+ Retrieve a general ledger transaction
1660
+
1661
+ Retrieves a specific general ledger transaction. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; General Ledger Transactions</span> - `View`
1662
+
1663
+ ### Examples
1664
+
1665
+ ```ruby
1666
+ require 'time'
1667
+ require 'buildium-ruby'
1668
+ # setup authorization
1669
+ Buildium.configure do |config|
1670
+ # Configure API key authorization: clientId
1671
+ config.api_key['clientId'] = 'YOUR API KEY'
1672
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1673
+ # config.api_key_prefix['clientId'] = 'Bearer'
1674
+
1675
+ # Configure API key authorization: clientSecret
1676
+ config.api_key['clientSecret'] = 'YOUR API KEY'
1677
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1678
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
1679
+ end
1680
+
1681
+ api_instance = Buildium::AccountingApi.new
1682
+ transaction_id = 56 # Integer | The general ledger transaction identifier.
1683
+
1684
+ begin
1685
+ # Retrieve a general ledger transaction
1686
+ result = api_instance.get_transaction_by_id(transaction_id)
1687
+ p result
1688
+ rescue Buildium::ApiError => e
1689
+ puts "Error when calling AccountingApi->get_transaction_by_id: #{e}"
1690
+ end
1691
+ ```
1692
+
1693
+ #### Using the get_transaction_by_id_with_http_info variant
1694
+
1695
+ This returns an Array which contains the response data, status code and headers.
1696
+
1697
+ > <Array(<GeneralLedgerTransactionMessage>, Integer, Hash)> get_transaction_by_id_with_http_info(transaction_id)
1698
+
1699
+ ```ruby
1700
+ begin
1701
+ # Retrieve a general ledger transaction
1702
+ data, status_code, headers = api_instance.get_transaction_by_id_with_http_info(transaction_id)
1703
+ p status_code # => 2xx
1704
+ p headers # => { ... }
1705
+ p data # => <GeneralLedgerTransactionMessage>
1706
+ rescue Buildium::ApiError => e
1707
+ puts "Error when calling AccountingApi->get_transaction_by_id_with_http_info: #{e}"
1708
+ end
1709
+ ```
1710
+
1711
+ ### Parameters
1712
+
1713
+ | Name | Type | Description | Notes |
1714
+ | ---- | ---- | ----------- | ----- |
1715
+ | **transaction_id** | **Integer** | The general ledger transaction identifier. | |
1716
+
1717
+ ### Return type
1718
+
1719
+ [**GeneralLedgerTransactionMessage**](GeneralLedgerTransactionMessage.md)
1720
+
1721
+ ### Authorization
1722
+
1723
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1724
+
1725
+ ### HTTP request headers
1726
+
1727
+ - **Content-Type**: Not defined
1728
+ - **Accept**: application/json
1729
+
1730
+
1731
+ ## update_bill
1732
+
1733
+ > <BillMessage> update_bill(bill_id, bill_put_message)
1734
+
1735
+ Update a bill
1736
+
1737
+ Use this operation to update any of the writable fields of an existing bill resource. When updating this resource keep the following in mind: <br /><ul><li>Writable fields omitted from the request or that do not have a value in the request message are set to `NULL`. If you do not want to update the field, submit the original field value.</li><li>When a bill has an existing payment any edits to the line items that change the total bill amount must result in the new total bill amount being equal to or greater than the amount paid.</li><li>When adding a new line item leave the `LineItem.Id` field empty.</li></ul><br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; Bills</span> - `View` `Edit`
1738
+
1739
+ ### Examples
1740
+
1741
+ ```ruby
1742
+ require 'time'
1743
+ require 'buildium-ruby'
1744
+ # setup authorization
1745
+ Buildium.configure do |config|
1746
+ # Configure API key authorization: clientId
1747
+ config.api_key['clientId'] = 'YOUR API KEY'
1748
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1749
+ # config.api_key_prefix['clientId'] = 'Bearer'
1750
+
1751
+ # Configure API key authorization: clientSecret
1752
+ config.api_key['clientSecret'] = 'YOUR API KEY'
1753
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1754
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
1755
+ end
1756
+
1757
+ api_instance = Buildium::AccountingApi.new
1758
+ bill_id = 56 # Integer |
1759
+ bill_put_message = Buildium::BillPutMessage.new({date: Date.today, due_date: Date.today, vendor_id: 37}) # BillPutMessage |
1760
+
1761
+ begin
1762
+ # Update a bill
1763
+ result = api_instance.update_bill(bill_id, bill_put_message)
1764
+ p result
1765
+ rescue Buildium::ApiError => e
1766
+ puts "Error when calling AccountingApi->update_bill: #{e}"
1767
+ end
1768
+ ```
1769
+
1770
+ #### Using the update_bill_with_http_info variant
1771
+
1772
+ This returns an Array which contains the response data, status code and headers.
1773
+
1774
+ > <Array(<BillMessage>, Integer, Hash)> update_bill_with_http_info(bill_id, bill_put_message)
1775
+
1776
+ ```ruby
1777
+ begin
1778
+ # Update a bill
1779
+ data, status_code, headers = api_instance.update_bill_with_http_info(bill_id, bill_put_message)
1780
+ p status_code # => 2xx
1781
+ p headers # => { ... }
1782
+ p data # => <BillMessage>
1783
+ rescue Buildium::ApiError => e
1784
+ puts "Error when calling AccountingApi->update_bill_with_http_info: #{e}"
1785
+ end
1786
+ ```
1787
+
1788
+ ### Parameters
1789
+
1790
+ | Name | Type | Description | Notes |
1791
+ | ---- | ---- | ----------- | ----- |
1792
+ | **bill_id** | **Integer** | | |
1793
+ | **bill_put_message** | [**BillPutMessage**](BillPutMessage.md) | | |
1794
+
1795
+ ### Return type
1796
+
1797
+ [**BillMessage**](BillMessage.md)
1798
+
1799
+ ### Authorization
1800
+
1801
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1802
+
1803
+ ### HTTP request headers
1804
+
1805
+ - **Content-Type**: application/json
1806
+ - **Accept**: application/json
1807
+
1808
+
1809
+ ## update_budget
1810
+
1811
+ > <BudgetMessage> update_budget(budget_id, budget_put_message)
1812
+
1813
+ Update a budget
1814
+
1815
+ Updates a budget. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; Budgets</span> - `View` `Edit`
1816
+
1817
+ ### Examples
1818
+
1819
+ ```ruby
1820
+ require 'time'
1821
+ require 'buildium-ruby'
1822
+ # setup authorization
1823
+ Buildium.configure do |config|
1824
+ # Configure API key authorization: clientId
1825
+ config.api_key['clientId'] = 'YOUR API KEY'
1826
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1827
+ # config.api_key_prefix['clientId'] = 'Bearer'
1828
+
1829
+ # Configure API key authorization: clientSecret
1830
+ config.api_key['clientSecret'] = 'YOUR API KEY'
1831
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1832
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
1833
+ end
1834
+
1835
+ api_instance = Buildium::AccountingApi.new
1836
+ budget_id = 56 # Integer |
1837
+ budget_put_message = Buildium::BudgetPutMessage.new({name: 'name_example', details: [Buildium::BudgetDetailsSaveMessage.new({gl_account_id: 37, monthly_amounts: Buildium::BudgetMonthlyAmountsSaveMessage.new({january: 3.56, february: 3.56, march: 3.56, april: 3.56, may: 3.56, june: 3.56, july: 3.56, august: 3.56, september: 3.56, october: 3.56, november: 3.56, december: 3.56})})]}) # BudgetPutMessage |
1838
+
1839
+ begin
1840
+ # Update a budget
1841
+ result = api_instance.update_budget(budget_id, budget_put_message)
1842
+ p result
1843
+ rescue Buildium::ApiError => e
1844
+ puts "Error when calling AccountingApi->update_budget: #{e}"
1845
+ end
1846
+ ```
1847
+
1848
+ #### Using the update_budget_with_http_info variant
1849
+
1850
+ This returns an Array which contains the response data, status code and headers.
1851
+
1852
+ > <Array(<BudgetMessage>, Integer, Hash)> update_budget_with_http_info(budget_id, budget_put_message)
1853
+
1854
+ ```ruby
1855
+ begin
1856
+ # Update a budget
1857
+ data, status_code, headers = api_instance.update_budget_with_http_info(budget_id, budget_put_message)
1858
+ p status_code # => 2xx
1859
+ p headers # => { ... }
1860
+ p data # => <BudgetMessage>
1861
+ rescue Buildium::ApiError => e
1862
+ puts "Error when calling AccountingApi->update_budget_with_http_info: #{e}"
1863
+ end
1864
+ ```
1865
+
1866
+ ### Parameters
1867
+
1868
+ | Name | Type | Description | Notes |
1869
+ | ---- | ---- | ----------- | ----- |
1870
+ | **budget_id** | **Integer** | | |
1871
+ | **budget_put_message** | [**BudgetPutMessage**](BudgetPutMessage.md) | | |
1872
+
1873
+ ### Return type
1874
+
1875
+ [**BudgetMessage**](BudgetMessage.md)
1876
+
1877
+ ### Authorization
1878
+
1879
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1880
+
1881
+ ### HTTP request headers
1882
+
1883
+ - **Content-Type**: application/json
1884
+ - **Accept**: application/json
1885
+
1886
+
1887
+ ## update_general_journal_entry
1888
+
1889
+ > <GeneralLedgerTransactionMessage> update_general_journal_entry(journal_entry_id, general_journal_entry_put_message)
1890
+
1891
+ Update a general journal entry
1892
+
1893
+ Updates a general journal entry. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; General Ledger Transactions</span> - `View` `Edit`
1894
+
1895
+ ### Examples
1896
+
1897
+ ```ruby
1898
+ require 'time'
1899
+ require 'buildium-ruby'
1900
+ # setup authorization
1901
+ Buildium.configure do |config|
1902
+ # Configure API key authorization: clientId
1903
+ config.api_key['clientId'] = 'YOUR API KEY'
1904
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1905
+ # config.api_key_prefix['clientId'] = 'Bearer'
1906
+
1907
+ # Configure API key authorization: clientSecret
1908
+ config.api_key['clientSecret'] = 'YOUR API KEY'
1909
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1910
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
1911
+ end
1912
+
1913
+ api_instance = Buildium::AccountingApi.new
1914
+ journal_entry_id = 56 # Integer |
1915
+ general_journal_entry_put_message = Buildium::GeneralJournalEntryPutMessage.new({accounting_entity: Buildium::AccountingEntitySaveMessage.new({id: 37, accounting_entity_type: 'Association'}), date: Date.today, lines: [Buildium::GeneralJournalEntryLineSaveMessage.new({gl_account_id: 37, posting_type: 'Credit', amount: 3.56})]}) # GeneralJournalEntryPutMessage |
1916
+
1917
+ begin
1918
+ # Update a general journal entry
1919
+ result = api_instance.update_general_journal_entry(journal_entry_id, general_journal_entry_put_message)
1920
+ p result
1921
+ rescue Buildium::ApiError => e
1922
+ puts "Error when calling AccountingApi->update_general_journal_entry: #{e}"
1923
+ end
1924
+ ```
1925
+
1926
+ #### Using the update_general_journal_entry_with_http_info variant
1927
+
1928
+ This returns an Array which contains the response data, status code and headers.
1929
+
1930
+ > <Array(<GeneralLedgerTransactionMessage>, Integer, Hash)> update_general_journal_entry_with_http_info(journal_entry_id, general_journal_entry_put_message)
1931
+
1932
+ ```ruby
1933
+ begin
1934
+ # Update a general journal entry
1935
+ data, status_code, headers = api_instance.update_general_journal_entry_with_http_info(journal_entry_id, general_journal_entry_put_message)
1936
+ p status_code # => 2xx
1937
+ p headers # => { ... }
1938
+ p data # => <GeneralLedgerTransactionMessage>
1939
+ rescue Buildium::ApiError => e
1940
+ puts "Error when calling AccountingApi->update_general_journal_entry_with_http_info: #{e}"
1941
+ end
1942
+ ```
1943
+
1944
+ ### Parameters
1945
+
1946
+ | Name | Type | Description | Notes |
1947
+ | ---- | ---- | ----------- | ----- |
1948
+ | **journal_entry_id** | **Integer** | | |
1949
+ | **general_journal_entry_put_message** | [**GeneralJournalEntryPutMessage**](GeneralJournalEntryPutMessage.md) | | |
1950
+
1951
+ ### Return type
1952
+
1953
+ [**GeneralLedgerTransactionMessage**](GeneralLedgerTransactionMessage.md)
1954
+
1955
+ ### Authorization
1956
+
1957
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
1958
+
1959
+ ### HTTP request headers
1960
+
1961
+ - **Content-Type**: application/json
1962
+ - **Accept**: application/json
1963
+
1964
+
1965
+ ## update_gl_account
1966
+
1967
+ > <GLAccountMessage> update_gl_account(gl_account_id, gl_account_put_message)
1968
+
1969
+ Update a general ledger account
1970
+
1971
+ Updates a general ledger account. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting &gt; General Ledger Accounts</span> - `View` `Edit`
1972
+
1973
+ ### Examples
1974
+
1975
+ ```ruby
1976
+ require 'time'
1977
+ require 'buildium-ruby'
1978
+ # setup authorization
1979
+ Buildium.configure do |config|
1980
+ # Configure API key authorization: clientId
1981
+ config.api_key['clientId'] = 'YOUR API KEY'
1982
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1983
+ # config.api_key_prefix['clientId'] = 'Bearer'
1984
+
1985
+ # Configure API key authorization: clientSecret
1986
+ config.api_key['clientSecret'] = 'YOUR API KEY'
1987
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1988
+ # config.api_key_prefix['clientSecret'] = 'Bearer'
1989
+ end
1990
+
1991
+ api_instance = Buildium::AccountingApi.new
1992
+ gl_account_id = 56 # Integer |
1993
+ gl_account_put_message = Buildium::GLAccountPutMessage.new({name: 'name_example', sub_type: 'CurrentAsset'}) # GLAccountPutMessage |
1994
+
1995
+ begin
1996
+ # Update a general ledger account
1997
+ result = api_instance.update_gl_account(gl_account_id, gl_account_put_message)
1998
+ p result
1999
+ rescue Buildium::ApiError => e
2000
+ puts "Error when calling AccountingApi->update_gl_account: #{e}"
2001
+ end
2002
+ ```
2003
+
2004
+ #### Using the update_gl_account_with_http_info variant
2005
+
2006
+ This returns an Array which contains the response data, status code and headers.
2007
+
2008
+ > <Array(<GLAccountMessage>, Integer, Hash)> update_gl_account_with_http_info(gl_account_id, gl_account_put_message)
2009
+
2010
+ ```ruby
2011
+ begin
2012
+ # Update a general ledger account
2013
+ data, status_code, headers = api_instance.update_gl_account_with_http_info(gl_account_id, gl_account_put_message)
2014
+ p status_code # => 2xx
2015
+ p headers # => { ... }
2016
+ p data # => <GLAccountMessage>
2017
+ rescue Buildium::ApiError => e
2018
+ puts "Error when calling AccountingApi->update_gl_account_with_http_info: #{e}"
2019
+ end
2020
+ ```
2021
+
2022
+ ### Parameters
2023
+
2024
+ | Name | Type | Description | Notes |
2025
+ | ---- | ---- | ----------- | ----- |
2026
+ | **gl_account_id** | **Integer** | | |
2027
+ | **gl_account_put_message** | [**GLAccountPutMessage**](GLAccountPutMessage.md) | | |
2028
+
2029
+ ### Return type
2030
+
2031
+ [**GLAccountMessage**](GLAccountMessage.md)
2032
+
2033
+ ### Authorization
2034
+
2035
+ [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
2036
+
2037
+ ### HTTP request headers
2038
+
2039
+ - **Content-Type**: application/json
2040
+ - **Accept**: application/json
2041
+