propertyware 1.0.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (392) hide show
  1. checksums.yaml +7 -0
  2. data/.github/workflows/ci.yml +27 -0
  3. data/.github/workflows/publish.yml +48 -0
  4. data/.gitignore +39 -0
  5. data/.openapi-generator/FILES +375 -0
  6. data/.openapi-generator/VERSION +1 -0
  7. data/.openapi-generator/templates/ruby-client/gemspec.mustache +37 -0
  8. data/.openapi-generator/templates/ruby-client/partial_model_generic.mustache +371 -0
  9. data/.openapi-generator/templates/ruby-client/rubocop.mustache +124 -0
  10. data/.openapi-generator-ignore +23 -0
  11. data/.rspec +2 -0
  12. data/.rubocop.yml +124 -0
  13. data/CUSTOMIZATIONS.md +11 -0
  14. data/DOCS.md +673 -0
  15. data/Gemfile +9 -0
  16. data/Gemfile.lock +76 -0
  17. data/README.md +93 -0
  18. data/Rakefile +10 -0
  19. data/bin/CUSTOMIZATIONS.md +11 -0
  20. data/bin/README.md +93 -0
  21. data/bin/config.yml +7 -0
  22. data/bin/fix_json.rb +59 -0
  23. data/bin/propertyware.json +1 -0
  24. data/bin/rebuild.sh +31 -0
  25. data/docs/Account.md +84 -0
  26. data/docs/AccountingApi.md +1235 -0
  27. data/docs/Address.md +28 -0
  28. data/docs/Amenity.md +24 -0
  29. data/docs/AutoJournalEntry.md +46 -0
  30. data/docs/AutoPayment.md +42 -0
  31. data/docs/Bank.md +52 -0
  32. data/docs/BankDeposit.md +32 -0
  33. data/docs/BasicVendor.md +40 -0
  34. data/docs/Bill.md +54 -0
  35. data/docs/BillPaid.md +24 -0
  36. data/docs/BillPay.md +20 -0
  37. data/docs/BillPayment.md +46 -0
  38. data/docs/BillSplit.md +42 -0
  39. data/docs/BillsApi.md +1391 -0
  40. data/docs/Building.md +116 -0
  41. data/docs/BuildingsApi.md +1037 -0
  42. data/docs/Campaign.md +60 -0
  43. data/docs/CampaignSource.md +26 -0
  44. data/docs/Charge.md +36 -0
  45. data/docs/ChargeTx.md +52 -0
  46. data/docs/Check.md +48 -0
  47. data/docs/CheckSplit.md +30 -0
  48. data/docs/Comment.md +28 -0
  49. data/docs/Contact.md +74 -0
  50. data/docs/ContactsApi.md +783 -0
  51. data/docs/Conversation.md +36 -0
  52. data/docs/CreditCardAccount.md +18 -0
  53. data/docs/CurrentAsset.md +30 -0
  54. data/docs/CurrentLiability.md +30 -0
  55. data/docs/CustomField.md +24 -0
  56. data/docs/Discount.md +40 -0
  57. data/docs/Document.md +40 -0
  58. data/docs/DocumentsApi.md +267 -0
  59. data/docs/Entry.md +34 -0
  60. data/docs/Equity.md +32 -0
  61. data/docs/ErrorResponse.md +22 -0
  62. data/docs/Expense.md +32 -0
  63. data/docs/GLItem.md +40 -0
  64. data/docs/HealthCheckApi.md +86 -0
  65. data/docs/Income.md +34 -0
  66. data/docs/Inspection.md +46 -0
  67. data/docs/InspectionArea.md +22 -0
  68. data/docs/InspectionItem.md +24 -0
  69. data/docs/InspectionsApi.md +193 -0
  70. data/docs/JournalEntry.md +36 -0
  71. data/docs/JournalEntrySplit.md +24 -0
  72. data/docs/JournalEntrySplitResponse.md +24 -0
  73. data/docs/LateFeeRule.md +26 -0
  74. data/docs/Lease.md +76 -0
  75. data/docs/LeaseClause.md +22 -0
  76. data/docs/LeaseContact.md +36 -0
  77. data/docs/LeasesApi.md +3319 -0
  78. data/docs/ManagementFee.md +30 -0
  79. data/docs/ManagementSettings.md +26 -0
  80. data/docs/Marketing.md +62 -0
  81. data/docs/NonCurrentAsset.md +26 -0
  82. data/docs/NonCurrentLiability.md +30 -0
  83. data/docs/NonOperatingExpense.md +32 -0
  84. data/docs/NonOperatingInome.md +32 -0
  85. data/docs/Note.md +28 -0
  86. data/docs/Owner.md +38 -0
  87. data/docs/OwnerContribution.md +44 -0
  88. data/docs/OwnerDraw.md +44 -0
  89. data/docs/Payment.md +50 -0
  90. data/docs/PaymentCharge.md +36 -0
  91. data/docs/Portfolio.md +60 -0
  92. data/docs/PortfoliosApi.md +701 -0
  93. data/docs/PropertyManager.md +26 -0
  94. data/docs/Prospect.md +114 -0
  95. data/docs/ProspectsApi.md +789 -0
  96. data/docs/RESTAPIBulkErrorResponse.md +22 -0
  97. data/docs/RESTAPIBulkSuccessResponse.md +18 -0
  98. data/docs/RESTAPIError.md +20 -0
  99. data/docs/Refund.md +44 -0
  100. data/docs/ResponseEntity.md +20 -0
  101. data/docs/SaveAccount.md +52 -0
  102. data/docs/SaveAddress.md +28 -0
  103. data/docs/SaveAdjustment.md +26 -0
  104. data/docs/SaveAutoCharge.md +28 -0
  105. data/docs/SaveBankDeposit.md +20 -0
  106. data/docs/SaveBill.md +42 -0
  107. data/docs/SaveBillPayment.md +30 -0
  108. data/docs/SaveBillSplit.md +36 -0
  109. data/docs/SaveBuilding.md +84 -0
  110. data/docs/SaveCharge.md +28 -0
  111. data/docs/SaveCheck.md +30 -0
  112. data/docs/SaveCheckSplit.md +30 -0
  113. data/docs/SaveComment.md +18 -0
  114. data/docs/SaveContact.md +60 -0
  115. data/docs/SaveConversation.md +20 -0
  116. data/docs/SaveCredit.md +26 -0
  117. data/docs/SaveDiscount.md +28 -0
  118. data/docs/SaveJournalEntrySplit.md +22 -0
  119. data/docs/SaveLease.md +50 -0
  120. data/docs/SaveLeaseJournalEntry.md +26 -0
  121. data/docs/SaveOwner.md +36 -0
  122. data/docs/SaveOwnerContribution.md +34 -0
  123. data/docs/SaveOwnerDraw.md +34 -0
  124. data/docs/SavePayment.md +34 -0
  125. data/docs/SavePortfolio.md +38 -0
  126. data/docs/SaveProspect.md +76 -0
  127. data/docs/SaveProspectContact.md +36 -0
  128. data/docs/SaveRefund.md +34 -0
  129. data/docs/SaveUnit.md +60 -0
  130. data/docs/SaveVendor.md +46 -0
  131. data/docs/SaveWorkOrder.md +36 -0
  132. data/docs/SaveWorkOrderTask.md +30 -0
  133. data/docs/SplitPaid.md +34 -0
  134. data/docs/SplitPay.md +20 -0
  135. data/docs/Task.md +42 -0
  136. data/docs/Transaction.md +54 -0
  137. data/docs/Unit.md +96 -0
  138. data/docs/UnitsApi.md +875 -0
  139. data/docs/UpdateLeaseJournalEntry.md +26 -0
  140. data/docs/Vendor.md +76 -0
  141. data/docs/VendorsApi.md +617 -0
  142. data/docs/WorkOrder.md +78 -0
  143. data/docs/WorkOrdersApi.md +883 -0
  144. data/lib/propertyware/api/accounting_api.rb +1041 -0
  145. data/lib/propertyware/api/bills_api.rb +1182 -0
  146. data/lib/propertyware/api/buildings_api.rb +863 -0
  147. data/lib/propertyware/api/contacts_api.rb +666 -0
  148. data/lib/propertyware/api/documents_api.rb +235 -0
  149. data/lib/propertyware/api/health_check_api.rb +79 -0
  150. data/lib/propertyware/api/inspections_api.rb +172 -0
  151. data/lib/propertyware/api/leases_api.rb +2787 -0
  152. data/lib/propertyware/api/portfolios_api.rb +599 -0
  153. data/lib/propertyware/api/prospects_api.rb +671 -0
  154. data/lib/propertyware/api/units_api.rb +740 -0
  155. data/lib/propertyware/api/vendors_api.rb +522 -0
  156. data/lib/propertyware/api/work_orders_api.rb +763 -0
  157. data/lib/propertyware/api_client.rb +428 -0
  158. data/lib/propertyware/api_error.rb +58 -0
  159. data/lib/propertyware/configuration.rb +392 -0
  160. data/lib/propertyware/models/account.rb +549 -0
  161. data/lib/propertyware/models/address.rb +269 -0
  162. data/lib/propertyware/models/amenity.rb +249 -0
  163. data/lib/propertyware/models/auto_journal_entry.rb +358 -0
  164. data/lib/propertyware/models/auto_payment.rb +338 -0
  165. data/lib/propertyware/models/bank.rb +389 -0
  166. data/lib/propertyware/models/bank_deposit.rb +289 -0
  167. data/lib/propertyware/models/basic_vendor.rb +330 -0
  168. data/lib/propertyware/models/bill.rb +401 -0
  169. data/lib/propertyware/models/bill_paid.rb +250 -0
  170. data/lib/propertyware/models/bill_pay.rb +230 -0
  171. data/lib/propertyware/models/bill_payment.rb +361 -0
  172. data/lib/propertyware/models/bill_split.rb +339 -0
  173. data/lib/propertyware/models/building.rb +782 -0
  174. data/lib/propertyware/models/campaign.rb +430 -0
  175. data/lib/propertyware/models/campaign_source.rb +258 -0
  176. data/lib/propertyware/models/charge.rb +318 -0
  177. data/lib/propertyware/models/charge_tx.rb +401 -0
  178. data/lib/propertyware/models/check.rb +425 -0
  179. data/lib/propertyware/models/check_split.rb +284 -0
  180. data/lib/propertyware/models/comment.rb +269 -0
  181. data/lib/propertyware/models/contact.rb +546 -0
  182. data/lib/propertyware/models/conversation.rb +345 -0
  183. data/lib/propertyware/models/credit_card_account.rb +219 -0
  184. data/lib/propertyware/models/current_asset.rb +279 -0
  185. data/lib/propertyware/models/current_liability.rb +279 -0
  186. data/lib/propertyware/models/custom_field.rb +249 -0
  187. data/lib/propertyware/models/discount.rb +339 -0
  188. data/lib/propertyware/models/document.rb +362 -0
  189. data/lib/propertyware/models/entry.rb +297 -0
  190. data/lib/propertyware/models/equity.rb +289 -0
  191. data/lib/propertyware/models/error_response.rb +237 -0
  192. data/lib/propertyware/models/expense.rb +289 -0
  193. data/lib/propertyware/models/gl_item.rb +330 -0
  194. data/lib/propertyware/models/income.rb +299 -0
  195. data/lib/propertyware/models/inspection.rb +361 -0
  196. data/lib/propertyware/models/inspection_area.rb +241 -0
  197. data/lib/propertyware/models/inspection_item.rb +249 -0
  198. data/lib/propertyware/models/journal_entry.rb +311 -0
  199. data/lib/propertyware/models/journal_entry_split.rb +264 -0
  200. data/lib/propertyware/models/journal_entry_split_response.rb +263 -0
  201. data/lib/propertyware/models/late_fee_rule.rb +258 -0
  202. data/lib/propertyware/models/lease.rb +515 -0
  203. data/lib/propertyware/models/lease_clause.rb +238 -0
  204. data/lib/propertyware/models/lease_contact.rb +309 -0
  205. data/lib/propertyware/models/management_fee.rb +279 -0
  206. data/lib/propertyware/models/management_settings.rb +261 -0
  207. data/lib/propertyware/models/marketing.rb +439 -0
  208. data/lib/propertyware/models/non_current_asset.rb +259 -0
  209. data/lib/propertyware/models/non_current_liability.rb +279 -0
  210. data/lib/propertyware/models/non_operating_expense.rb +289 -0
  211. data/lib/propertyware/models/non_operating_inome.rb +289 -0
  212. data/lib/propertyware/models/note.rb +267 -0
  213. data/lib/propertyware/models/owner.rb +318 -0
  214. data/lib/propertyware/models/owner_contribution.rb +418 -0
  215. data/lib/propertyware/models/owner_draw.rb +398 -0
  216. data/lib/propertyware/models/payment.rb +423 -0
  217. data/lib/propertyware/models/payment_charge.rb +358 -0
  218. data/lib/propertyware/models/portfolio.rb +479 -0
  219. data/lib/propertyware/models/property_manager.rb +259 -0
  220. data/lib/propertyware/models/prospect.rb +701 -0
  221. data/lib/propertyware/models/refund.rb +384 -0
  222. data/lib/propertyware/models/response_entity.rb +260 -0
  223. data/lib/propertyware/models/restapi_bulk_error_response.rb +237 -0
  224. data/lib/propertyware/models/restapi_bulk_success_response.rb +217 -0
  225. data/lib/propertyware/models/restapi_error.rb +226 -0
  226. data/lib/propertyware/models/save_account.rb +398 -0
  227. data/lib/propertyware/models/save_address.rb +274 -0
  228. data/lib/propertyware/models/save_adjustment.rb +269 -0
  229. data/lib/propertyware/models/save_auto_charge.rb +328 -0
  230. data/lib/propertyware/models/save_bank_deposit.rb +239 -0
  231. data/lib/propertyware/models/save_bill.rb +356 -0
  232. data/lib/propertyware/models/save_bill_payment.rb +314 -0
  233. data/lib/propertyware/models/save_bill_split.rb +319 -0
  234. data/lib/propertyware/models/save_building.rb +653 -0
  235. data/lib/propertyware/models/save_charge.rb +289 -0
  236. data/lib/propertyware/models/save_check.rb +291 -0
  237. data/lib/propertyware/models/save_check_split.rb +289 -0
  238. data/lib/propertyware/models/save_comment.rb +224 -0
  239. data/lib/propertyware/models/save_contact.rb +472 -0
  240. data/lib/propertyware/models/save_conversation.rb +273 -0
  241. data/lib/propertyware/models/save_credit.rb +271 -0
  242. data/lib/propertyware/models/save_discount.rb +289 -0
  243. data/lib/propertyware/models/save_journal_entry_split.rb +254 -0
  244. data/lib/propertyware/models/save_lease.rb +444 -0
  245. data/lib/propertyware/models/save_lease_journal_entry.rb +276 -0
  246. data/lib/propertyware/models/save_owner.rb +318 -0
  247. data/lib/propertyware/models/save_owner_contribution.rb +373 -0
  248. data/lib/propertyware/models/save_owner_draw.rb +334 -0
  249. data/lib/propertyware/models/save_payment.rb +373 -0
  250. data/lib/propertyware/models/save_portfolio.rb +379 -0
  251. data/lib/propertyware/models/save_prospect.rb +511 -0
  252. data/lib/propertyware/models/save_prospect_contact.rb +318 -0
  253. data/lib/propertyware/models/save_refund.rb +334 -0
  254. data/lib/propertyware/models/save_unit.rb +492 -0
  255. data/lib/propertyware/models/save_vendor.rb +379 -0
  256. data/lib/propertyware/models/save_work_order.rb +345 -0
  257. data/lib/propertyware/models/save_work_order_task.rb +284 -0
  258. data/lib/propertyware/models/split_paid.rb +298 -0
  259. data/lib/propertyware/models/split_pay.rb +228 -0
  260. data/lib/propertyware/models/task.rb +339 -0
  261. data/lib/propertyware/models/transaction.rb +433 -0
  262. data/lib/propertyware/models/unit.rb +670 -0
  263. data/lib/propertyware/models/update_lease_journal_entry.rb +276 -0
  264. data/lib/propertyware/models/vendor.rb +511 -0
  265. data/lib/propertyware/models/work_order.rb +557 -0
  266. data/lib/propertyware/version.rb +15 -0
  267. data/lib/propertyware.rb +158 -0
  268. data/openapitools.json +7 -0
  269. data/propertyware.gemspec +39 -0
  270. data/spec/api/accounting_api_spec.rb +239 -0
  271. data/spec/api/bills_api_spec.rb +260 -0
  272. data/spec/api/buildings_api_spec.rb +199 -0
  273. data/spec/api/contacts_api_spec.rb +159 -0
  274. data/spec/api/documents_api_spec.rb +77 -0
  275. data/spec/api/health_check_api_spec.rb +46 -0
  276. data/spec/api/inspections_api_spec.rb +68 -0
  277. data/spec/api/leases_api_spec.rb +579 -0
  278. data/spec/api/portfolios_api_spec.rb +147 -0
  279. data/spec/api/prospects_api_spec.rb +162 -0
  280. data/spec/api/units_api_spec.rb +176 -0
  281. data/spec/api/vendors_api_spec.rb +134 -0
  282. data/spec/api/work_orders_api_spec.rb +180 -0
  283. data/spec/api_client_spec.rb +223 -0
  284. data/spec/configuration_spec.rb +82 -0
  285. data/spec/models/account_spec.rb +232 -0
  286. data/spec/models/address_spec.rb +64 -0
  287. data/spec/models/amenity_spec.rb +52 -0
  288. data/spec/models/auto_journal_entry_spec.rb +118 -0
  289. data/spec/models/auto_payment_spec.rb +106 -0
  290. data/spec/models/bank_deposit_spec.rb +76 -0
  291. data/spec/models/bank_spec.rb +136 -0
  292. data/spec/models/basic_vendor_spec.rb +100 -0
  293. data/spec/models/bill_paid_spec.rb +52 -0
  294. data/spec/models/bill_pay_spec.rb +40 -0
  295. data/spec/models/bill_payment_spec.rb +118 -0
  296. data/spec/models/bill_spec.rb +142 -0
  297. data/spec/models/bill_split_spec.rb +106 -0
  298. data/spec/models/building_spec.rb +344 -0
  299. data/spec/models/campaign_source_spec.rb +58 -0
  300. data/spec/models/campaign_spec.rb +160 -0
  301. data/spec/models/charge_spec.rb +88 -0
  302. data/spec/models/charge_tx_spec.rb +136 -0
  303. data/spec/models/check_spec.rb +128 -0
  304. data/spec/models/check_split_spec.rb +70 -0
  305. data/spec/models/comment_spec.rb +64 -0
  306. data/spec/models/contact_spec.rb +210 -0
  307. data/spec/models/conversation_spec.rb +92 -0
  308. data/spec/models/credit_card_account_spec.rb +34 -0
  309. data/spec/models/current_asset_spec.rb +70 -0
  310. data/spec/models/current_liability_spec.rb +70 -0
  311. data/spec/models/custom_field_spec.rb +52 -0
  312. data/spec/models/discount_spec.rb +100 -0
  313. data/spec/models/document_spec.rb +104 -0
  314. data/spec/models/entry_spec.rb +82 -0
  315. data/spec/models/equity_spec.rb +76 -0
  316. data/spec/models/error_response_spec.rb +46 -0
  317. data/spec/models/expense_spec.rb +76 -0
  318. data/spec/models/gl_item_spec.rb +100 -0
  319. data/spec/models/income_spec.rb +82 -0
  320. data/spec/models/inspection_area_spec.rb +46 -0
  321. data/spec/models/inspection_item_spec.rb +52 -0
  322. data/spec/models/inspection_spec.rb +118 -0
  323. data/spec/models/journal_entry_spec.rb +88 -0
  324. data/spec/models/journal_entry_split_response_spec.rb +52 -0
  325. data/spec/models/journal_entry_split_spec.rb +52 -0
  326. data/spec/models/late_fee_rule_spec.rb +58 -0
  327. data/spec/models/lease_clause_spec.rb +46 -0
  328. data/spec/models/lease_contact_spec.rb +88 -0
  329. data/spec/models/lease_spec.rb +208 -0
  330. data/spec/models/management_fee_spec.rb +70 -0
  331. data/spec/models/management_settings_spec.rb +58 -0
  332. data/spec/models/marketing_spec.rb +166 -0
  333. data/spec/models/non_current_asset_spec.rb +58 -0
  334. data/spec/models/non_current_liability_spec.rb +70 -0
  335. data/spec/models/non_operating_expense_spec.rb +76 -0
  336. data/spec/models/non_operating_inome_spec.rb +76 -0
  337. data/spec/models/note_spec.rb +64 -0
  338. data/spec/models/owner_contribution_spec.rb +116 -0
  339. data/spec/models/owner_draw_spec.rb +116 -0
  340. data/spec/models/owner_spec.rb +94 -0
  341. data/spec/models/payment_charge_spec.rb +92 -0
  342. data/spec/models/payment_spec.rb +134 -0
  343. data/spec/models/portfolio_spec.rb +168 -0
  344. data/spec/models/property_manager_spec.rb +58 -0
  345. data/spec/models/prospect_spec.rb +322 -0
  346. data/spec/models/refund_spec.rb +112 -0
  347. data/spec/models/response_entity_spec.rb +44 -0
  348. data/spec/models/restapi_bulk_error_response_spec.rb +46 -0
  349. data/spec/models/restapi_bulk_success_response_spec.rb +34 -0
  350. data/spec/models/restapi_error_spec.rb +40 -0
  351. data/spec/models/save_account_spec.rb +136 -0
  352. data/spec/models/save_address_spec.rb +64 -0
  353. data/spec/models/save_adjustment_spec.rb +58 -0
  354. data/spec/models/save_auto_charge_spec.rb +68 -0
  355. data/spec/models/save_bank_deposit_spec.rb +40 -0
  356. data/spec/models/save_bill_payment_spec.rb +74 -0
  357. data/spec/models/save_bill_spec.rb +106 -0
  358. data/spec/models/save_bill_split_spec.rb +88 -0
  359. data/spec/models/save_building_spec.rb +248 -0
  360. data/spec/models/save_charge_spec.rb +64 -0
  361. data/spec/models/save_check_spec.rb +70 -0
  362. data/spec/models/save_check_split_spec.rb +70 -0
  363. data/spec/models/save_comment_spec.rb +34 -0
  364. data/spec/models/save_contact_spec.rb +164 -0
  365. data/spec/models/save_conversation_spec.rb +44 -0
  366. data/spec/models/save_credit_spec.rb +58 -0
  367. data/spec/models/save_discount_spec.rb +64 -0
  368. data/spec/models/save_journal_entry_split_spec.rb +46 -0
  369. data/spec/models/save_lease_journal_entry_spec.rb +58 -0
  370. data/spec/models/save_lease_spec.rb +134 -0
  371. data/spec/models/save_owner_contribution_spec.rb +86 -0
  372. data/spec/models/save_owner_draw_spec.rb +82 -0
  373. data/spec/models/save_owner_spec.rb +88 -0
  374. data/spec/models/save_payment_spec.rb +86 -0
  375. data/spec/models/save_portfolio_spec.rb +102 -0
  376. data/spec/models/save_prospect_contact_spec.rb +88 -0
  377. data/spec/models/save_prospect_spec.rb +208 -0
  378. data/spec/models/save_refund_spec.rb +82 -0
  379. data/spec/models/save_unit_spec.rb +164 -0
  380. data/spec/models/save_vendor_spec.rb +118 -0
  381. data/spec/models/save_work_order_spec.rb +92 -0
  382. data/spec/models/save_work_order_task_spec.rb +70 -0
  383. data/spec/models/split_paid_spec.rb +82 -0
  384. data/spec/models/split_pay_spec.rb +40 -0
  385. data/spec/models/task_spec.rb +106 -0
  386. data/spec/models/transaction_spec.rb +146 -0
  387. data/spec/models/unit_spec.rb +280 -0
  388. data/spec/models/update_lease_journal_entry_spec.rb +58 -0
  389. data/spec/models/vendor_spec.rb +208 -0
  390. data/spec/models/work_order_spec.rb +218 -0
  391. data/spec/spec_helper.rb +111 -0
  392. metadata +609 -0
@@ -0,0 +1,1182 @@
1
+ =begin
2
+ #Open API, powered by Propertyware
3
+
4
+ #<script type=\"text/javascript\" src=\"https://buildium.atlassian.net/s/d41d8cd98f00b204e9800998ecf8427e-T/-raa8on/b/8/c95134bc67d3a521bb3f4331beb9b804/_/download/batch/com.atlassian.jira.collector.plugin.jira-issue-collector-plugin:issuecollector/com.atlassian.jira.collector.plugin.jira-issue-collector-plugin:issuecollector.js?locale=en-US&collectorId=e43cd15d\"></script> # Introduction Welcome to Propertyware’s API—a powerful, RESTful programming interface that lets you leverage valuable Propertyware data. ## Account Configuration Before you can use Propertyware’s API, you’ll need to make some tweaks to your account settings. <br /> ### Enabling the API In order to start creating your keys and making requests, you’ll need to enable the API. > **Tip:** You’ll need an administrator user role with access to ***Administration Setup > API Keys*** to set things up properly. **Let's Begin!** 1. Sign in to your [Propertyware](https://app.propertyware.com/pw/login.jsp) account from your browser. 2. Open the ***Setup*** page 3. On the left navigation bar, expand ***Administration Setup*** and then click ***API Keys***. If you are having issues accessing the API keys page within your account you can submit a [Support](#section/API-Overview/Support) request for assistance. ## API Keys Account-level API keys authenticate every request and keep things secure. API keys have two components: a “client ID” and a “secret”. * **Client IDs** are similar to usernames. They’re used to identify your Propertyware API key and are safe to share. * **Secrets** are similar to passwords. They must be kept confidential. Whenever you make a request, you’ll need the API key’s client ID and secret. If you forget it, make a mistake, or try to use information that’s linked to a deleted key, the API will return a `401` response code. > **Tip:** We compiled a list of best practices that detail how securely store API keys. [Give it a read](#section/Getting-Started/Keeping-API-Keys-Safe)! ## Creating API Keys Now that the Open API is enabled, you’ll be able to create API keys. You’re almost there! **How to create an API key** 1. On the API Keys page, click ***Create API Key***. A modal will appear. <p> <img src=\"APIKey_Page.JPG\"/> </p> <p> <img src=\"APIKey_New.JPG\"/> </p> 2. Enter a clear, memorable name and description for your API key. It’ll make it easier to locate the right key when you make a request. 3. Now, choose which pieces of Propertyware data you want this API key to have access to by selecting the corresponding radio buttons. Once finished, click **GENERATE KEY**. 4. You have successfully created an API key! The client id and secret associated to this key will be presented. <p> <img src=\"APIKey_Generate.JPG\"/> </p> > **Important:** This is your only chance to record the secret. Make sure it’s stored somewhere secure! If it’s forgotten, you’ll need to delete this key and start from scratch. You have now successfully created an API key and have everything you need to send requests to the Propertyware API! Before moving on to [making your first request](#section/Getting-Started/How-to-Make-a-Request) please review [Keeping API Keys Safe](#section/Getting-Started/Keeping-API-Keys-Safe) for an overview on securely storing your API keys. <br /> If you are having issues creating API keys you can submit a [Support](#section/API-Overview/Support) request for assistance. ## Keeping API Keys Safe Based on their permissions, API keys could have full access to your account’s Propertyware data. It’s important that you only grant access to trusted applications, securely record secrets, and consider a password manager to stay organized. ### Recommended Practices - Avoid hard-coding client IDs and secrets inside source files. - Avoid storing client IDs and secrets in any files that may be committed to source control, particularly cloud-based source control platforms. - Apply restrictions to client IDs and secrets shared with your staff. You can restrict a key to particular Propertyware entities or to read-only access (GET resources only). - Avoid sharing client IDs and secrets across public, insecure platforms. - Establish a process to regularly recreate your client IDs and secrets from your Propertyware account. <br /> <br /> ## How to Make a Request You’ve done a great job setting up your account, Now, we’ll walk you through how to access your data. It’s very straightforward and should only take a few minutes! > **Tip:** Looking for the right HTTP client? If you’re just getting started, we recommend Postman. ### Let's Get Started! #### Step 1: Get Your API Key If you haven't yet done so, obtain your API key client ID and secret from your Propertyware account. Your API key is how the Propertyware API authenticates requests and ensures only you can access your data. #### Step 2: Install a HTTP client The Propertyware API supports any standard HTTP client. If you're looking for a user-friendly HTTP client application, we recommend [Postman](https://www.postman.com/product/api-client) – it allows you to access the Propertyware API without writing code. We’ll use Postman for our example below to demonstrate sending an API request. #### Step 3: Make a Sample Request Let's dive in and make a simple request to get all the [Buildings](#operation/getBuildingsUsingGET) in your account. This will confirm your connectivity to our platform and validate the keys you created on our website. Simply follow the instructions below. 1. Open the Postman application. 2. Open the *verb* menu and select **GET**. 3. Enter the request endpoint in the field next to GET. - Here’s the endpoint to get all buildings: https://api.propertyware.com/pw/api/rest/v1/buildings. 4. To authenticate the request, enter your `client ID`, your `secret` and your `organization iD` respectively in these request headers: - `x-propertyware-client-id` - `x-propertyware-client-secret` - `x-propertyware-system-id` _(organization id)_ The organization id uniquely identifies your Propertyware account and is an additional measure to enforce proper access to the correct data. ___Your client id and secret pair will only work with the organization it belongs to___. Your full request should look similar to the image below. <kbd><img src=\"request_example.png\" /></kbd> 5. Review the parameters of your request on last time. Once finished, click **Send**. 6. If successful, you should see a JSON response and a `200` HTTP status code. Congratulations! You've connected to the Propertyware API. You now have the knowledge required to make requests for any of our resources. If you've received an error response please review the JSON response message for a description of how to resolve the issue. You can also see more information about HTTP status codes in the [Response Codes](#section/API-Overview/Response-Codes) section. If you are still having trouble making a request after reviewing these sections please submit a [Support](#section/API-Overview/Support) request. # API Overview The Propertyware API is built upon standard REST conventions. It's designed to use consistent resource-oriented URLs, accept and return JSON-encoded messages, and use standard HTTP status codes and verbs. ## Base URL The base URL for production environment API requests is: `https://api.propertyware.com/pw/api/v1/rest` In order to ensure all requests and responses are secure between the API consumer and Propertyware servers, requests must be made using the `https` protocol. Any requests not made with the `https` protocol will be refused by the Propertyware API platform. > **Note:** URL paths are case-sensitive to stay consistent with common REST standards. If your request doesn’t align with the documented URL path, you’ll receive a `404` response code reminding you of this constraint. ## API Versioning The Propertyware API is version controlled. Versioning ensures backwards-incompatible changes to the API don’t impact any existing integrations. Propertyware uses only a major version nomenclature to manage changes. The current version of the Propertyware API is version 1. By specifying a version in the resource request URL, you'll get expected responses regardless of future changes to the API. Here's an example of calling version 1 of the retrieve all leases resource: `https://api.propertyware.com/pw/api/rest/v1/leases` Any request submitted without the version in the URL path will result in a `404` error response code. ### Releasing Changes to the API The Propertyware API will continue to evolve to ensure it meets the needs of our customers. Changes will be defined as either backwards-compatible or backwards-incompatible. We’ll provide advance notice for all API releases–regardless of the type of modifications being made. #### Backward-compatible Changes Backward-compatible changes are modifications to the API that shouldn't impact existing integrations. They'll apply to the current version of the API. Simply put: you won’t need to change the version to consume new changes like these. It's important as you develop against the Propertyware API that you ensure these types of changes don't impact your integration. Here's are examples of backward-compatible modifications. * Adding new API resources and/or endpoints. * Adding new optional request parameters to existing API methods. * Adding new properties to existing API responses and non-required properties for request messages. * Changing property order in existing API responses. All backward-compatible changes to the API will be documented in the [Changelog](#section/Changelog). #### Backwards-incompatible Changes When backwards-incompatible changes to the API occur, a new version of the API will be released. You’ll need to update the URL path to consume resources under the new API version. Backwards-incompatible changes include: * Removing a property from a request and/or response message. * Changing the name of a property in a message. * Adding a required parameter to a request message. * Changing existing enumeration values. New versions of the API will have full reference documentation and an upgrade guide. ## Authentication The Propertyware API uses API key’s client IDs and secrets to authenticate requests. An organization ID, an API key client ID and secret must be passed in every request header using the following parameters: - `x-propertyware-client-id` - `x-propertyware-client-secret` - `x-propertyware-system-id` Failing to provide both of them in the request header will cause the API to return a `401` HTTP status code. <!-- ## Rate Limiting (FUTURE) Rate limits help us ensure consistent and reliable performance for all users, even during peak loads. That’s why we limit clients to **10 concurrent requests per second**. If your request rate violates that limit, a response code of `429` is returned. Simply retry the request after a short interval (~200ms). --> ## Bulk Request Options All top-level API resources support bulk fetches. For instance, you can retrieve all [Portfolios](#operation/getPortfoliosUsingGET). These resources also allow for filtering criteria. Each resource has descriptions of the filter criteria available. In addition to filtering, our API gives you the ability to control the returned data’s pagination and the sort order. ### Pagination Endpoints that return result sets allow for pagination using `limit` and `offset` request parameters to reduce the amount of data returned. The `limit` request parameter will cap the number of results that come back in the response. If you don't specify a `limit` value, a **default of 100 results** are returned. The maximum `limit` value is 500. If a `limit` value is specified greater than 500, it will be overridden to the default to 500. The `offset` request parameter indicates the record position within the resultset to start at when returning the results. The `offset` is zero-based and is inclusive. If no `offset` value is submitted it will default to 0. The total resultset count is returned in the HTTP Header `X-Total-Count` #### Pagination Example As an example, let's say we make a request to retrieve all rental properties with no paging parameters. Our response indicates in the `X-Total-Count` header that there are 150 total rental properties. We want to get only the last 50 results so we would submit a request with the `offset` set to 100 and the `limit` set to 50. > **Note:** The `limit` and `offset` parameter names are case-sensitive. If they aren't formatted correctly, the API will return a `404` HTTP status code. ### Sorting Results You can specify the sort order of returned data by assigning properties from the returned object to the `orderby` parameter in the querystring. For example: ``` orderby=name ``` By default, the sort is performed in ascending order. To specify sort order, use \"asc\" for ascending or \"desc\" for descending. For example: ``` orderby=name desc ``` Additionally, you can sort by multiple properties by comma separating the properties. For example: ``` orderby=abbreviation asc,name desc ``` > **Note:** While the `orderby` parameter is case-sensitive, the properties specified in the `orderby` value aren't. ## Response Codes The Propertyware API supports standard HTTP status codes. |Response Code |Description | |--|--| |200 OK | Everything worked as expected. | |400 Bad Request | The request was unacceptable, often due to missing a required parameter.| |401 Unauthorized|The API client ID and secret weren’t provided or they’re no longer valid. Be sure that the client ID and secret combination are correct and they are still active.| |403 Forbidden|The API key doesn't have permission to perform the request. This could be due to authorization for the given endpoint or an inability to access given entities within the platform (e.g. properties). |404 Not Found|The requested resource doesn't exist.| |415 Unsupported Media Type |Ensure you have the appropriate content-type header value set on your request. Each resource is documented with media type(s) that are accepted.| |429 Too Many Requests |Too many requests against the API too quickly. We recommend an exponential backoff of your requests.| |500 and above - Server Errors|Something went wrong on Propertyware's end. Review the JSON response message for more details about the error.| ## API Date Format * For all request and response date fields allowing ISO date format: YYYY-MM-DD (e.g.2019-08-24). * For all request and response dateAndTime fields format is allowing: YYYY-MM-dd'T'HH:mm:ssXXX (e.g.2022-06-28T08:47:13Z). ## Support If you are unable to resolve your issue after reviewing the API documentation our support team can assist you. # Changelog ### 2023-07-11 * Retrieve all documents * Retrieve a document * Download a document ### 2023-06-10 * Lease contacts are included in Retrieve all leases API response * Lease contacts are included in Retrieve a lease API response ### 2023-04-24 * Bulk Insertion: Prospects * Bulk Insertion: Bill Payments ### 2023-04-11 * Bulk Insertion: Portfolios * Bulk Insertion: Buildings * Bulk Insertion: Units ### 2023-03-19 * Bulk insertion: contacts ### 2023-03-08 * Bulk insertion: bills ### 2023-01-24 * Custom fields in \"Get all\" endpoints * Prospect creation * Bill removals ### 2022-10-25 * API Read operations for non-financial data ### 2022-09-21 * API Read operations available
5
+
6
+ The version of the OpenAPI document: 1.0
7
+ Contact: support@propertyware.com
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 6.6.0
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module Propertyware
16
+ class BillsApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Create a bill (BETA)
23
+ # <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Creates a bill.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">BILLS</span> - <code>Write</code>
24
+ # @param save_bill [SaveBill] saveBill
25
+ # @param [Hash] opts the optional parameters
26
+ # @return [Bill]
27
+ def create_bill(save_bill, opts = {})
28
+ data, _status_code, _headers = create_bill_with_http_info(save_bill, opts)
29
+ data
30
+ end
31
+
32
+ # Create a bill (BETA)
33
+ # &lt;p class&#x3D;\&quot;betaError\&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Creates a bill.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;BILLS&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;
34
+ # @param save_bill [SaveBill] saveBill
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [Array<(Bill, Integer, Hash)>] Bill data, response status code and response headers
37
+ def create_bill_with_http_info(save_bill, opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: BillsApi.create_bill ...'
40
+ end
41
+ # verify the required parameter 'save_bill' is set
42
+ if @api_client.config.client_side_validation && save_bill.nil?
43
+ fail ArgumentError, "Missing the required parameter 'save_bill' when calling BillsApi.create_bill"
44
+ end
45
+ # resource path
46
+ local_var_path = '/bills'
47
+
48
+ # query parameters
49
+ query_params = opts[:query_params] || {}
50
+
51
+ # header parameters
52
+ header_params = opts[:header_params] || {}
53
+ # HTTP header 'Accept' (if needed)
54
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
55
+ # HTTP header 'Content-Type'
56
+ content_type = @api_client.select_header_content_type(['application/json'])
57
+ if !content_type.nil?
58
+ header_params['Content-Type'] = content_type
59
+ end
60
+
61
+ # form parameters
62
+ form_params = opts[:form_params] || {}
63
+
64
+ # http body (model)
65
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(save_bill)
66
+
67
+ # return_type
68
+ return_type = opts[:debug_return_type] || 'Bill'
69
+
70
+ # auth_names
71
+ auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']
72
+
73
+ new_options = opts.merge(
74
+ :operation => :"BillsApi.create_bill",
75
+ :header_params => header_params,
76
+ :query_params => query_params,
77
+ :form_params => form_params,
78
+ :body => post_body,
79
+ :auth_names => auth_names,
80
+ :return_type => return_type
81
+ )
82
+
83
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
84
+ if @api_client.config.debugging
85
+ @api_client.config.logger.debug "API called: BillsApi#create_bill\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
86
+ end
87
+ return data, status_code, headers
88
+ end
89
+
90
+ # Creates Bill Payment (BETA)
91
+ # <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Creates Bill Payment<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">VENDORS</span> - <code>Write</code>
92
+ # @param save_bill_payment [SaveBillPayment] saveBillPayment
93
+ # @param [Hash] opts the optional parameters
94
+ # @return [BillPayment]
95
+ def create_bill_payment(save_bill_payment, opts = {})
96
+ data, _status_code, _headers = create_bill_payment_with_http_info(save_bill_payment, opts)
97
+ data
98
+ end
99
+
100
+ # Creates Bill Payment (BETA)
101
+ # &lt;p class&#x3D;\&quot;betaError\&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Creates Bill Payment&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;VENDORS&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;
102
+ # @param save_bill_payment [SaveBillPayment] saveBillPayment
103
+ # @param [Hash] opts the optional parameters
104
+ # @return [Array<(BillPayment, Integer, Hash)>] BillPayment data, response status code and response headers
105
+ def create_bill_payment_with_http_info(save_bill_payment, opts = {})
106
+ if @api_client.config.debugging
107
+ @api_client.config.logger.debug 'Calling API: BillsApi.create_bill_payment ...'
108
+ end
109
+ # verify the required parameter 'save_bill_payment' is set
110
+ if @api_client.config.client_side_validation && save_bill_payment.nil?
111
+ fail ArgumentError, "Missing the required parameter 'save_bill_payment' when calling BillsApi.create_bill_payment"
112
+ end
113
+ # resource path
114
+ local_var_path = '/bills/payment'
115
+
116
+ # query parameters
117
+ query_params = opts[:query_params] || {}
118
+
119
+ # header parameters
120
+ header_params = opts[:header_params] || {}
121
+ # HTTP header 'Accept' (if needed)
122
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
123
+ # HTTP header 'Content-Type'
124
+ content_type = @api_client.select_header_content_type(['application/json'])
125
+ if !content_type.nil?
126
+ header_params['Content-Type'] = content_type
127
+ end
128
+
129
+ # form parameters
130
+ form_params = opts[:form_params] || {}
131
+
132
+ # http body (model)
133
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(save_bill_payment)
134
+
135
+ # return_type
136
+ return_type = opts[:debug_return_type] || 'BillPayment'
137
+
138
+ # auth_names
139
+ auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']
140
+
141
+ new_options = opts.merge(
142
+ :operation => :"BillsApi.create_bill_payment",
143
+ :header_params => header_params,
144
+ :query_params => query_params,
145
+ :form_params => form_params,
146
+ :body => post_body,
147
+ :auth_names => auth_names,
148
+ :return_type => return_type
149
+ )
150
+
151
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
152
+ if @api_client.config.debugging
153
+ @api_client.config.logger.debug "API called: BillsApi#create_bill_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
154
+ end
155
+ return data, status_code, headers
156
+ end
157
+
158
+ # Create bill payments in bulk (BETA)
159
+ # <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Creates bill payments in bulk.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">VENDORS</span> - <code>Write</code>
160
+ # @param save_bill_payment [Array<SaveBillPayment>] saveBillPayment
161
+ # @param [Hash] opts the optional parameters
162
+ # @return [Array<RESTAPIBulkSuccessResponse>]
163
+ def create_bill_payments_using_post1(save_bill_payment, opts = {})
164
+ data, _status_code, _headers = create_bill_payments_using_post1_with_http_info(save_bill_payment, opts)
165
+ data
166
+ end
167
+
168
+ # Create bill payments in bulk (BETA)
169
+ # &lt;p class&#x3D;\&quot;betaError\&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Creates bill payments in bulk.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;VENDORS&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;
170
+ # @param save_bill_payment [Array<SaveBillPayment>] saveBillPayment
171
+ # @param [Hash] opts the optional parameters
172
+ # @return [Array<(Array<RESTAPIBulkSuccessResponse>, Integer, Hash)>] Array<RESTAPIBulkSuccessResponse> data, response status code and response headers
173
+ def create_bill_payments_using_post1_with_http_info(save_bill_payment, opts = {})
174
+ if @api_client.config.debugging
175
+ @api_client.config.logger.debug 'Calling API: BillsApi.create_bill_payments_using_post1 ...'
176
+ end
177
+ # verify the required parameter 'save_bill_payment' is set
178
+ if @api_client.config.client_side_validation && save_bill_payment.nil?
179
+ fail ArgumentError, "Missing the required parameter 'save_bill_payment' when calling BillsApi.create_bill_payments_using_post1"
180
+ end
181
+ # resource path
182
+ local_var_path = '/bills/payments/bulk'
183
+
184
+ # query parameters
185
+ query_params = opts[:query_params] || {}
186
+
187
+ # header parameters
188
+ header_params = opts[:header_params] || {}
189
+ # HTTP header 'Accept' (if needed)
190
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
191
+ # HTTP header 'Content-Type'
192
+ content_type = @api_client.select_header_content_type(['application/json'])
193
+ if !content_type.nil?
194
+ header_params['Content-Type'] = content_type
195
+ end
196
+
197
+ # form parameters
198
+ form_params = opts[:form_params] || {}
199
+
200
+ # http body (model)
201
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(save_bill_payment)
202
+
203
+ # return_type
204
+ return_type = opts[:debug_return_type] || 'Array<RESTAPIBulkSuccessResponse>'
205
+
206
+ # auth_names
207
+ auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']
208
+
209
+ new_options = opts.merge(
210
+ :operation => :"BillsApi.create_bill_payments_using_post1",
211
+ :header_params => header_params,
212
+ :query_params => query_params,
213
+ :form_params => form_params,
214
+ :body => post_body,
215
+ :auth_names => auth_names,
216
+ :return_type => return_type
217
+ )
218
+
219
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
220
+ if @api_client.config.debugging
221
+ @api_client.config.logger.debug "API called: BillsApi#create_bill_payments_using_post1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
222
+ end
223
+ return data, status_code, headers
224
+ end
225
+
226
+ # Create bills in bulk (BETA)
227
+ # <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Creates bills in bulk.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">BILLS</span> - <code>Write</code>
228
+ # @param save_bill [Array<SaveBill>] saveBill
229
+ # @param [Hash] opts the optional parameters
230
+ # @return [Array<RESTAPIBulkSuccessResponse>]
231
+ def create_bills(save_bill, opts = {})
232
+ data, _status_code, _headers = create_bills_with_http_info(save_bill, opts)
233
+ data
234
+ end
235
+
236
+ # Create bills in bulk (BETA)
237
+ # &lt;p class&#x3D;\&quot;betaError\&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Creates bills in bulk.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;BILLS&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;
238
+ # @param save_bill [Array<SaveBill>] saveBill
239
+ # @param [Hash] opts the optional parameters
240
+ # @return [Array<(Array<RESTAPIBulkSuccessResponse>, Integer, Hash)>] Array<RESTAPIBulkSuccessResponse> data, response status code and response headers
241
+ def create_bills_with_http_info(save_bill, opts = {})
242
+ if @api_client.config.debugging
243
+ @api_client.config.logger.debug 'Calling API: BillsApi.create_bills ...'
244
+ end
245
+ # verify the required parameter 'save_bill' is set
246
+ if @api_client.config.client_side_validation && save_bill.nil?
247
+ fail ArgumentError, "Missing the required parameter 'save_bill' when calling BillsApi.create_bills"
248
+ end
249
+ # resource path
250
+ local_var_path = '/bills/bulk'
251
+
252
+ # query parameters
253
+ query_params = opts[:query_params] || {}
254
+
255
+ # header parameters
256
+ header_params = opts[:header_params] || {}
257
+ # HTTP header 'Accept' (if needed)
258
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
259
+ # HTTP header 'Content-Type'
260
+ content_type = @api_client.select_header_content_type(['application/json'])
261
+ if !content_type.nil?
262
+ header_params['Content-Type'] = content_type
263
+ end
264
+
265
+ # form parameters
266
+ form_params = opts[:form_params] || {}
267
+
268
+ # http body (model)
269
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(save_bill)
270
+
271
+ # return_type
272
+ return_type = opts[:debug_return_type] || 'Array<RESTAPIBulkSuccessResponse>'
273
+
274
+ # auth_names
275
+ auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']
276
+
277
+ new_options = opts.merge(
278
+ :operation => :"BillsApi.create_bills",
279
+ :header_params => header_params,
280
+ :query_params => query_params,
281
+ :form_params => form_params,
282
+ :body => post_body,
283
+ :auth_names => auth_names,
284
+ :return_type => return_type
285
+ )
286
+
287
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
288
+ if @api_client.config.debugging
289
+ @api_client.config.logger.debug "API called: BillsApi#create_bills\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
290
+ end
291
+ return data, status_code, headers
292
+ end
293
+
294
+ # Create a credit (BETA)
295
+ # <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Creates a credit.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">BILLS</span> - <code>Write</code>
296
+ # @param save_credit [SaveCredit] saveCredit
297
+ # @param [Hash] opts the optional parameters
298
+ # @return [Bill]
299
+ def create_credit(save_credit, opts = {})
300
+ data, _status_code, _headers = create_credit_with_http_info(save_credit, opts)
301
+ data
302
+ end
303
+
304
+ # Create a credit (BETA)
305
+ # &lt;p class&#x3D;\&quot;betaError\&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Creates a credit.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;BILLS&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;
306
+ # @param save_credit [SaveCredit] saveCredit
307
+ # @param [Hash] opts the optional parameters
308
+ # @return [Array<(Bill, Integer, Hash)>] Bill data, response status code and response headers
309
+ def create_credit_with_http_info(save_credit, opts = {})
310
+ if @api_client.config.debugging
311
+ @api_client.config.logger.debug 'Calling API: BillsApi.create_credit ...'
312
+ end
313
+ # verify the required parameter 'save_credit' is set
314
+ if @api_client.config.client_side_validation && save_credit.nil?
315
+ fail ArgumentError, "Missing the required parameter 'save_credit' when calling BillsApi.create_credit"
316
+ end
317
+ # resource path
318
+ local_var_path = '/bills/credit'
319
+
320
+ # query parameters
321
+ query_params = opts[:query_params] || {}
322
+
323
+ # header parameters
324
+ header_params = opts[:header_params] || {}
325
+ # HTTP header 'Accept' (if needed)
326
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
327
+ # HTTP header 'Content-Type'
328
+ content_type = @api_client.select_header_content_type(['application/json'])
329
+ if !content_type.nil?
330
+ header_params['Content-Type'] = content_type
331
+ end
332
+
333
+ # form parameters
334
+ form_params = opts[:form_params] || {}
335
+
336
+ # http body (model)
337
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(save_credit)
338
+
339
+ # return_type
340
+ return_type = opts[:debug_return_type] || 'Bill'
341
+
342
+ # auth_names
343
+ auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']
344
+
345
+ new_options = opts.merge(
346
+ :operation => :"BillsApi.create_credit",
347
+ :header_params => header_params,
348
+ :query_params => query_params,
349
+ :form_params => form_params,
350
+ :body => post_body,
351
+ :auth_names => auth_names,
352
+ :return_type => return_type
353
+ )
354
+
355
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
356
+ if @api_client.config.debugging
357
+ @api_client.config.logger.debug "API called: BillsApi#create_credit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
358
+ end
359
+ return data, status_code, headers
360
+ end
361
+
362
+ # Create a Vendor check (BETA)
363
+ # <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Creates a Vendor check.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">VENDORS</span> - <code>Write</code>
364
+ # @param save_check [SaveCheck] saveCheck
365
+ # @param [Hash] opts the optional parameters
366
+ # @return [Check]
367
+ def create_vendor_check(save_check, opts = {})
368
+ data, _status_code, _headers = create_vendor_check_with_http_info(save_check, opts)
369
+ data
370
+ end
371
+
372
+ # Create a Vendor check (BETA)
373
+ # &lt;p class&#x3D;\&quot;betaError\&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Creates a Vendor check.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;VENDORS&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;
374
+ # @param save_check [SaveCheck] saveCheck
375
+ # @param [Hash] opts the optional parameters
376
+ # @return [Array<(Check, Integer, Hash)>] Check data, response status code and response headers
377
+ def create_vendor_check_with_http_info(save_check, opts = {})
378
+ if @api_client.config.debugging
379
+ @api_client.config.logger.debug 'Calling API: BillsApi.create_vendor_check ...'
380
+ end
381
+ # verify the required parameter 'save_check' is set
382
+ if @api_client.config.client_side_validation && save_check.nil?
383
+ fail ArgumentError, "Missing the required parameter 'save_check' when calling BillsApi.create_vendor_check"
384
+ end
385
+ # resource path
386
+ local_var_path = '/bills/vendorChecks'
387
+
388
+ # query parameters
389
+ query_params = opts[:query_params] || {}
390
+
391
+ # header parameters
392
+ header_params = opts[:header_params] || {}
393
+ # HTTP header 'Accept' (if needed)
394
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
395
+ # HTTP header 'Content-Type'
396
+ content_type = @api_client.select_header_content_type(['application/json'])
397
+ if !content_type.nil?
398
+ header_params['Content-Type'] = content_type
399
+ end
400
+
401
+ # form parameters
402
+ form_params = opts[:form_params] || {}
403
+
404
+ # http body (model)
405
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(save_check)
406
+
407
+ # return_type
408
+ return_type = opts[:debug_return_type] || 'Check'
409
+
410
+ # auth_names
411
+ auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']
412
+
413
+ new_options = opts.merge(
414
+ :operation => :"BillsApi.create_vendor_check",
415
+ :header_params => header_params,
416
+ :query_params => query_params,
417
+ :form_params => form_params,
418
+ :body => post_body,
419
+ :auth_names => auth_names,
420
+ :return_type => return_type
421
+ )
422
+
423
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
424
+ if @api_client.config.debugging
425
+ @api_client.config.logger.debug "API called: BillsApi#create_vendor_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
426
+ end
427
+ return data, status_code, headers
428
+ end
429
+
430
+ # Delete a Bill (BETA)
431
+ # <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Delete a Bill.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">BILLS</span> - <code>Delete</code>
432
+ # @param bill_id [Integer] Bill ID
433
+ # @param [Hash] opts the optional parameters
434
+ # @return [ResponseEntity]
435
+ def delete_bill(bill_id, opts = {})
436
+ data, _status_code, _headers = delete_bill_with_http_info(bill_id, opts)
437
+ data
438
+ end
439
+
440
+ # Delete a Bill (BETA)
441
+ # &lt;p class&#x3D;\&quot;betaError\&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Delete a Bill.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;BILLS&lt;/span&gt; - &lt;code&gt;Delete&lt;/code&gt;
442
+ # @param bill_id [Integer] Bill ID
443
+ # @param [Hash] opts the optional parameters
444
+ # @return [Array<(ResponseEntity, Integer, Hash)>] ResponseEntity data, response status code and response headers
445
+ def delete_bill_with_http_info(bill_id, opts = {})
446
+ if @api_client.config.debugging
447
+ @api_client.config.logger.debug 'Calling API: BillsApi.delete_bill ...'
448
+ end
449
+ # verify the required parameter 'bill_id' is set
450
+ if @api_client.config.client_side_validation && bill_id.nil?
451
+ fail ArgumentError, "Missing the required parameter 'bill_id' when calling BillsApi.delete_bill"
452
+ end
453
+ # resource path
454
+ local_var_path = '/bills/{billID}'.sub('{' + 'billID' + '}', CGI.escape(bill_id.to_s))
455
+
456
+ # query parameters
457
+ query_params = opts[:query_params] || {}
458
+
459
+ # header parameters
460
+ header_params = opts[:header_params] || {}
461
+ # HTTP header 'Accept' (if needed)
462
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
463
+
464
+ # form parameters
465
+ form_params = opts[:form_params] || {}
466
+
467
+ # http body (model)
468
+ post_body = opts[:debug_body]
469
+
470
+ # return_type
471
+ return_type = opts[:debug_return_type] || 'ResponseEntity'
472
+
473
+ # auth_names
474
+ auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']
475
+
476
+ new_options = opts.merge(
477
+ :operation => :"BillsApi.delete_bill",
478
+ :header_params => header_params,
479
+ :query_params => query_params,
480
+ :form_params => form_params,
481
+ :body => post_body,
482
+ :auth_names => auth_names,
483
+ :return_type => return_type
484
+ )
485
+
486
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
487
+ if @api_client.config.debugging
488
+ @api_client.config.logger.debug "API called: BillsApi#delete_bill\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
489
+ end
490
+ return data, status_code, headers
491
+ end
492
+
493
+ # Retrieve a bill (BETA)
494
+ # <p class=\"betaWarning\"><b>Note: </b>This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.</p> Retrieves a specific bill.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">BILLS</span> - <code>Read</code>
495
+ # @param bill_id [Integer] Bill ID
496
+ # @param [Hash] opts the optional parameters
497
+ # @return [Bill]
498
+ def get_bill(bill_id, opts = {})
499
+ data, _status_code, _headers = get_bill_with_http_info(bill_id, opts)
500
+ data
501
+ end
502
+
503
+ # Retrieve a bill (BETA)
504
+ # &lt;p class&#x3D;\&quot;betaWarning\&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.&lt;/p&gt; Retrieves a specific bill.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;BILLS&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt;
505
+ # @param bill_id [Integer] Bill ID
506
+ # @param [Hash] opts the optional parameters
507
+ # @return [Array<(Bill, Integer, Hash)>] Bill data, response status code and response headers
508
+ def get_bill_with_http_info(bill_id, opts = {})
509
+ if @api_client.config.debugging
510
+ @api_client.config.logger.debug 'Calling API: BillsApi.get_bill ...'
511
+ end
512
+ # verify the required parameter 'bill_id' is set
513
+ if @api_client.config.client_side_validation && bill_id.nil?
514
+ fail ArgumentError, "Missing the required parameter 'bill_id' when calling BillsApi.get_bill"
515
+ end
516
+ # resource path
517
+ local_var_path = '/bills/{billID}'.sub('{' + 'billID' + '}', CGI.escape(bill_id.to_s))
518
+
519
+ # query parameters
520
+ query_params = opts[:query_params] || {}
521
+
522
+ # header parameters
523
+ header_params = opts[:header_params] || {}
524
+ # HTTP header 'Accept' (if needed)
525
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
526
+
527
+ # form parameters
528
+ form_params = opts[:form_params] || {}
529
+
530
+ # http body (model)
531
+ post_body = opts[:debug_body]
532
+
533
+ # return_type
534
+ return_type = opts[:debug_return_type] || 'Bill'
535
+
536
+ # auth_names
537
+ auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']
538
+
539
+ new_options = opts.merge(
540
+ :operation => :"BillsApi.get_bill",
541
+ :header_params => header_params,
542
+ :query_params => query_params,
543
+ :form_params => form_params,
544
+ :body => post_body,
545
+ :auth_names => auth_names,
546
+ :return_type => return_type
547
+ )
548
+
549
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
550
+ if @api_client.config.debugging
551
+ @api_client.config.logger.debug "API called: BillsApi#get_bill\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
552
+ end
553
+ return data, status_code, headers
554
+ end
555
+
556
+ # Retrieve a bill payment (BETA)
557
+ # <p class=\"betaWarning\"><b>Note: </b>This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.</p> Retrieves a specific bill payment.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">BILLS</span> - <code>Read</code>
558
+ # @param bill_payment_id [Integer] Bill Payment ID
559
+ # @param [Hash] opts the optional parameters
560
+ # @return [BillPayment]
561
+ def get_bill_payment(bill_payment_id, opts = {})
562
+ data, _status_code, _headers = get_bill_payment_with_http_info(bill_payment_id, opts)
563
+ data
564
+ end
565
+
566
+ # Retrieve a bill payment (BETA)
567
+ # &lt;p class&#x3D;\&quot;betaWarning\&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.&lt;/p&gt; Retrieves a specific bill payment.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;BILLS&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt;
568
+ # @param bill_payment_id [Integer] Bill Payment ID
569
+ # @param [Hash] opts the optional parameters
570
+ # @return [Array<(BillPayment, Integer, Hash)>] BillPayment data, response status code and response headers
571
+ def get_bill_payment_with_http_info(bill_payment_id, opts = {})
572
+ if @api_client.config.debugging
573
+ @api_client.config.logger.debug 'Calling API: BillsApi.get_bill_payment ...'
574
+ end
575
+ # verify the required parameter 'bill_payment_id' is set
576
+ if @api_client.config.client_side_validation && bill_payment_id.nil?
577
+ fail ArgumentError, "Missing the required parameter 'bill_payment_id' when calling BillsApi.get_bill_payment"
578
+ end
579
+ # resource path
580
+ local_var_path = '/bills/payments/{billPaymentID}'.sub('{' + 'billPaymentID' + '}', CGI.escape(bill_payment_id.to_s))
581
+
582
+ # query parameters
583
+ query_params = opts[:query_params] || {}
584
+
585
+ # header parameters
586
+ header_params = opts[:header_params] || {}
587
+ # HTTP header 'Accept' (if needed)
588
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
589
+
590
+ # form parameters
591
+ form_params = opts[:form_params] || {}
592
+
593
+ # http body (model)
594
+ post_body = opts[:debug_body]
595
+
596
+ # return_type
597
+ return_type = opts[:debug_return_type] || 'BillPayment'
598
+
599
+ # auth_names
600
+ auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']
601
+
602
+ new_options = opts.merge(
603
+ :operation => :"BillsApi.get_bill_payment",
604
+ :header_params => header_params,
605
+ :query_params => query_params,
606
+ :form_params => form_params,
607
+ :body => post_body,
608
+ :auth_names => auth_names,
609
+ :return_type => return_type
610
+ )
611
+
612
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
613
+ if @api_client.config.debugging
614
+ @api_client.config.logger.debug "API called: BillsApi#get_bill_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
615
+ end
616
+ return data, status_code, headers
617
+ end
618
+
619
+ # Retrieve all bill payments (BETA)
620
+ # <p class=\"betaWarning\"><b>Note: </b>This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.</p> Retrieves a list of bill payments.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">BILLS</span> - <code>Read</code> <br/><br/><b>Sortable by:</b> <code>createddate</code>, <code>vendorid</code>, <code>lastmodifieddatetime</code>, <code>paymentdate</code>, <code>checknumber</code>, <code>id</code>
621
+ # @param [Hash] opts the optional parameters
622
+ # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The offset is zero-based and the default is 0.
623
+ # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 500 and the default is 100. (default to 100)
624
+ # @option opts [Time] :last_modified_date_time_start Filters results to any item modified on or after the date time specified.
625
+ # @option opts [Time] :last_modified_date_time_end Filters results to any item modified on or prior to the date time specified.
626
+ # @option opts [String] :orderby Indicates the field(s) and direction to sort the results in the response.
627
+ # @option opts [Integer] :vendor_id Filters results to bills associated with a specific vendor.
628
+ # @option opts [Integer] :payment_gl_account_id Filters results to bills associated with a specific payment general ledger account.
629
+ # @option opts [Date] :payment_date_start Filters results to any payment with a date on or after to the date specified.
630
+ # @option opts [Date] :payment_date_end Filters results to any payment with a date on or prior to the date specified.
631
+ # @return [Array<BillPayment>]
632
+ def get_bill_payments(opts = {})
633
+ data, _status_code, _headers = get_bill_payments_with_http_info(opts)
634
+ data
635
+ end
636
+
637
+ # Retrieve all bill payments (BETA)
638
+ # &lt;p class&#x3D;\&quot;betaWarning\&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.&lt;/p&gt; Retrieves a list of bill payments.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;BILLS&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt; &lt;br/&gt;&lt;br/&gt;&lt;b&gt;Sortable by:&lt;/b&gt; &lt;code&gt;createddate&lt;/code&gt;, &lt;code&gt;vendorid&lt;/code&gt;, &lt;code&gt;lastmodifieddatetime&lt;/code&gt;, &lt;code&gt;paymentdate&lt;/code&gt;, &lt;code&gt;checknumber&lt;/code&gt;, &lt;code&gt;id&lt;/code&gt;
639
+ # @param [Hash] opts the optional parameters
640
+ # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The offset is zero-based and the default is 0.
641
+ # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 500 and the default is 100. (default to 100)
642
+ # @option opts [Time] :last_modified_date_time_start Filters results to any item modified on or after the date time specified.
643
+ # @option opts [Time] :last_modified_date_time_end Filters results to any item modified on or prior to the date time specified.
644
+ # @option opts [String] :orderby Indicates the field(s) and direction to sort the results in the response.
645
+ # @option opts [Integer] :vendor_id Filters results to bills associated with a specific vendor.
646
+ # @option opts [Integer] :payment_gl_account_id Filters results to bills associated with a specific payment general ledger account.
647
+ # @option opts [Date] :payment_date_start Filters results to any payment with a date on or after to the date specified.
648
+ # @option opts [Date] :payment_date_end Filters results to any payment with a date on or prior to the date specified.
649
+ # @return [Array<(Array<BillPayment>, Integer, Hash)>] Array<BillPayment> data, response status code and response headers
650
+ def get_bill_payments_with_http_info(opts = {})
651
+ if @api_client.config.debugging
652
+ @api_client.config.logger.debug 'Calling API: BillsApi.get_bill_payments ...'
653
+ end
654
+ # resource path
655
+ local_var_path = '/bills/payments'
656
+
657
+ # query parameters
658
+ query_params = opts[:query_params] || {}
659
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
660
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
661
+ query_params[:'lastModifiedDateTimeStart'] = opts[:'last_modified_date_time_start'] if !opts[:'last_modified_date_time_start'].nil?
662
+ query_params[:'lastModifiedDateTimeEnd'] = opts[:'last_modified_date_time_end'] if !opts[:'last_modified_date_time_end'].nil?
663
+ query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
664
+ query_params[:'vendorID'] = opts[:'vendor_id'] if !opts[:'vendor_id'].nil?
665
+ query_params[:'paymentGLAccountID'] = opts[:'payment_gl_account_id'] if !opts[:'payment_gl_account_id'].nil?
666
+ query_params[:'paymentDateStart'] = opts[:'payment_date_start'] if !opts[:'payment_date_start'].nil?
667
+ query_params[:'paymentDateEnd'] = opts[:'payment_date_end'] if !opts[:'payment_date_end'].nil?
668
+
669
+ # header parameters
670
+ header_params = opts[:header_params] || {}
671
+ # HTTP header 'Accept' (if needed)
672
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
673
+
674
+ # form parameters
675
+ form_params = opts[:form_params] || {}
676
+
677
+ # http body (model)
678
+ post_body = opts[:debug_body]
679
+
680
+ # return_type
681
+ return_type = opts[:debug_return_type] || 'Array<BillPayment>'
682
+
683
+ # auth_names
684
+ auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']
685
+
686
+ new_options = opts.merge(
687
+ :operation => :"BillsApi.get_bill_payments",
688
+ :header_params => header_params,
689
+ :query_params => query_params,
690
+ :form_params => form_params,
691
+ :body => post_body,
692
+ :auth_names => auth_names,
693
+ :return_type => return_type
694
+ )
695
+
696
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
697
+ if @api_client.config.debugging
698
+ @api_client.config.logger.debug "API called: BillsApi#get_bill_payments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
699
+ end
700
+ return data, status_code, headers
701
+ end
702
+
703
+ # Retrieve all bills (BETA)
704
+ # <p class=\"betaWarning\"><b>Note: </b>This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.</p> Retrieves a list of bills.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">BILLS</span> - <code>Read</code> <br/><br/><b>Sortable by:</b> <code>createddate</code>, <code>billdate</code>, <code>billnumber</code>, <code>lastmodifieddatetime</code>, <code>duedate</code>, <code>id</code>
705
+ # @param [Hash] opts the optional parameters
706
+ # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The offset is zero-based and the default is 0.
707
+ # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 500 and the default is 100. (default to 100)
708
+ # @option opts [Time] :last_modified_date_time_start Filters results to any item modified on or after the date time specified.
709
+ # @option opts [Time] :last_modified_date_time_end Filters results to any item modified on or prior to the date time specified.
710
+ # @option opts [String] :orderby Indicates the field(s) and direction to sort the results in the response.
711
+ # @option opts [Integer] :portfolio_id Filters results to bills associated with a specific portfolio.
712
+ # @option opts [Integer] :vendor_id Filters results to bills associated with a specific vendor.
713
+ # @option opts [Integer] :work_order_id Filters results to bills associated with a specific work order.
714
+ # @option opts [Integer] :markup_gl_account_id Filters results to bills associated with a specific markup general ledger account.
715
+ # @option opts [Boolean] :paid Filters results by the bill&#39;s paid status. If no status is specified, bills with any status will be returned.
716
+ # @option opts [Date] :bill_date_start Filters results to any bill with a billing date on or after to the date specified.
717
+ # @option opts [Date] :bill_date_end Filters results to any bill with a billing date on or prior to the date specified.
718
+ # @option opts [Date] :due_date_start Filters results to any bill with a due date on or after to the date specified.
719
+ # @option opts [Date] :due_date_end Filters results to any bill with a due date on or prior to the date specified.
720
+ # @return [Array<Bill>]
721
+ def get_bills(opts = {})
722
+ data, _status_code, _headers = get_bills_with_http_info(opts)
723
+ data
724
+ end
725
+
726
+ # Retrieve all bills (BETA)
727
+ # &lt;p class&#x3D;\&quot;betaWarning\&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.&lt;/p&gt; Retrieves a list of bills.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;BILLS&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt; &lt;br/&gt;&lt;br/&gt;&lt;b&gt;Sortable by:&lt;/b&gt; &lt;code&gt;createddate&lt;/code&gt;, &lt;code&gt;billdate&lt;/code&gt;, &lt;code&gt;billnumber&lt;/code&gt;, &lt;code&gt;lastmodifieddatetime&lt;/code&gt;, &lt;code&gt;duedate&lt;/code&gt;, &lt;code&gt;id&lt;/code&gt;
728
+ # @param [Hash] opts the optional parameters
729
+ # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The offset is zero-based and the default is 0.
730
+ # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 500 and the default is 100. (default to 100)
731
+ # @option opts [Time] :last_modified_date_time_start Filters results to any item modified on or after the date time specified.
732
+ # @option opts [Time] :last_modified_date_time_end Filters results to any item modified on or prior to the date time specified.
733
+ # @option opts [String] :orderby Indicates the field(s) and direction to sort the results in the response.
734
+ # @option opts [Integer] :portfolio_id Filters results to bills associated with a specific portfolio.
735
+ # @option opts [Integer] :vendor_id Filters results to bills associated with a specific vendor.
736
+ # @option opts [Integer] :work_order_id Filters results to bills associated with a specific work order.
737
+ # @option opts [Integer] :markup_gl_account_id Filters results to bills associated with a specific markup general ledger account.
738
+ # @option opts [Boolean] :paid Filters results by the bill&#39;s paid status. If no status is specified, bills with any status will be returned.
739
+ # @option opts [Date] :bill_date_start Filters results to any bill with a billing date on or after to the date specified.
740
+ # @option opts [Date] :bill_date_end Filters results to any bill with a billing date on or prior to the date specified.
741
+ # @option opts [Date] :due_date_start Filters results to any bill with a due date on or after to the date specified.
742
+ # @option opts [Date] :due_date_end Filters results to any bill with a due date on or prior to the date specified.
743
+ # @return [Array<(Array<Bill>, Integer, Hash)>] Array<Bill> data, response status code and response headers
744
+ def get_bills_with_http_info(opts = {})
745
+ if @api_client.config.debugging
746
+ @api_client.config.logger.debug 'Calling API: BillsApi.get_bills ...'
747
+ end
748
+ # resource path
749
+ local_var_path = '/bills'
750
+
751
+ # query parameters
752
+ query_params = opts[:query_params] || {}
753
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
754
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
755
+ query_params[:'lastModifiedDateTimeStart'] = opts[:'last_modified_date_time_start'] if !opts[:'last_modified_date_time_start'].nil?
756
+ query_params[:'lastModifiedDateTimeEnd'] = opts[:'last_modified_date_time_end'] if !opts[:'last_modified_date_time_end'].nil?
757
+ query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
758
+ query_params[:'portfolioID'] = opts[:'portfolio_id'] if !opts[:'portfolio_id'].nil?
759
+ query_params[:'vendorID'] = opts[:'vendor_id'] if !opts[:'vendor_id'].nil?
760
+ query_params[:'workOrderID'] = opts[:'work_order_id'] if !opts[:'work_order_id'].nil?
761
+ query_params[:'markupGLAccountID'] = opts[:'markup_gl_account_id'] if !opts[:'markup_gl_account_id'].nil?
762
+ query_params[:'paid'] = opts[:'paid'] if !opts[:'paid'].nil?
763
+ query_params[:'billDateStart'] = opts[:'bill_date_start'] if !opts[:'bill_date_start'].nil?
764
+ query_params[:'billDateEnd'] = opts[:'bill_date_end'] if !opts[:'bill_date_end'].nil?
765
+ query_params[:'dueDateStart'] = opts[:'due_date_start'] if !opts[:'due_date_start'].nil?
766
+ query_params[:'dueDateEnd'] = opts[:'due_date_end'] if !opts[:'due_date_end'].nil?
767
+
768
+ # header parameters
769
+ header_params = opts[:header_params] || {}
770
+ # HTTP header 'Accept' (if needed)
771
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
772
+
773
+ # form parameters
774
+ form_params = opts[:form_params] || {}
775
+
776
+ # http body (model)
777
+ post_body = opts[:debug_body]
778
+
779
+ # return_type
780
+ return_type = opts[:debug_return_type] || 'Array<Bill>'
781
+
782
+ # auth_names
783
+ auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']
784
+
785
+ new_options = opts.merge(
786
+ :operation => :"BillsApi.get_bills",
787
+ :header_params => header_params,
788
+ :query_params => query_params,
789
+ :form_params => form_params,
790
+ :body => post_body,
791
+ :auth_names => auth_names,
792
+ :return_type => return_type
793
+ )
794
+
795
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
796
+ if @api_client.config.debugging
797
+ @api_client.config.logger.debug "API called: BillsApi#get_bills\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
798
+ end
799
+ return data, status_code, headers
800
+ end
801
+
802
+ # Retrieve all Vendor checks (BETA)
803
+ # <p class=\"betaWarning\"><b>Note: </b>This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.</p> Retrieves a list of Vendor checks.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">VENDORS</span> - <code>Read</code> <br/><br/><b>Sortable by:</b> <code>postdate</code>, <code>createddate</code>, <code>vendorid</code>, <code>lastmodifieddatetime</code>, <code>id</code>
804
+ # @param [Hash] opts the optional parameters
805
+ # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The offset is zero-based and the default is 0.
806
+ # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 500 and the default is 100. (default to 100)
807
+ # @option opts [Time] :last_modified_date_time_start Filters results to any item modified on or after the date time specified.
808
+ # @option opts [Time] :last_modified_date_time_end Filters results to any item modified on or prior to the date time specified.
809
+ # @option opts [String] :orderby Indicates the field(s) and direction to sort the results in the response.
810
+ # @option opts [Date] :post_date_start Filters results to any transaction with a start date on or after the date specified.
811
+ # @option opts [Date] :post_date_end Filters results to any transaction with a start date on or prior to the date specified.
812
+ # @option opts [Integer] :portfolio_id Filters results associated with a specific portfolio.
813
+ # @option opts [Integer] :vendor_id Filters results to transactions associated with a specific vendor.
814
+ # @return [Array<Check>]
815
+ def get_vendor_checks(opts = {})
816
+ data, _status_code, _headers = get_vendor_checks_with_http_info(opts)
817
+ data
818
+ end
819
+
820
+ # Retrieve all Vendor checks (BETA)
821
+ # &lt;p class&#x3D;\&quot;betaWarning\&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.&lt;/p&gt; Retrieves a list of Vendor checks.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;VENDORS&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt; &lt;br/&gt;&lt;br/&gt;&lt;b&gt;Sortable by:&lt;/b&gt; &lt;code&gt;postdate&lt;/code&gt;, &lt;code&gt;createddate&lt;/code&gt;, &lt;code&gt;vendorid&lt;/code&gt;, &lt;code&gt;lastmodifieddatetime&lt;/code&gt;, &lt;code&gt;id&lt;/code&gt;
822
+ # @param [Hash] opts the optional parameters
823
+ # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The offset is zero-based and the default is 0.
824
+ # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 500 and the default is 100. (default to 100)
825
+ # @option opts [Time] :last_modified_date_time_start Filters results to any item modified on or after the date time specified.
826
+ # @option opts [Time] :last_modified_date_time_end Filters results to any item modified on or prior to the date time specified.
827
+ # @option opts [String] :orderby Indicates the field(s) and direction to sort the results in the response.
828
+ # @option opts [Date] :post_date_start Filters results to any transaction with a start date on or after the date specified.
829
+ # @option opts [Date] :post_date_end Filters results to any transaction with a start date on or prior to the date specified.
830
+ # @option opts [Integer] :portfolio_id Filters results associated with a specific portfolio.
831
+ # @option opts [Integer] :vendor_id Filters results to transactions associated with a specific vendor.
832
+ # @return [Array<(Array<Check>, Integer, Hash)>] Array<Check> data, response status code and response headers
833
+ def get_vendor_checks_with_http_info(opts = {})
834
+ if @api_client.config.debugging
835
+ @api_client.config.logger.debug 'Calling API: BillsApi.get_vendor_checks ...'
836
+ end
837
+ # resource path
838
+ local_var_path = '/bills/vendorChecks'
839
+
840
+ # query parameters
841
+ query_params = opts[:query_params] || {}
842
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
843
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
844
+ query_params[:'lastModifiedDateTimeStart'] = opts[:'last_modified_date_time_start'] if !opts[:'last_modified_date_time_start'].nil?
845
+ query_params[:'lastModifiedDateTimeEnd'] = opts[:'last_modified_date_time_end'] if !opts[:'last_modified_date_time_end'].nil?
846
+ query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
847
+ query_params[:'postDateStart'] = opts[:'post_date_start'] if !opts[:'post_date_start'].nil?
848
+ query_params[:'postDateEnd'] = opts[:'post_date_end'] if !opts[:'post_date_end'].nil?
849
+ query_params[:'portfolioID'] = opts[:'portfolio_id'] if !opts[:'portfolio_id'].nil?
850
+ query_params[:'vendorID'] = opts[:'vendor_id'] if !opts[:'vendor_id'].nil?
851
+
852
+ # header parameters
853
+ header_params = opts[:header_params] || {}
854
+ # HTTP header 'Accept' (if needed)
855
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
856
+
857
+ # form parameters
858
+ form_params = opts[:form_params] || {}
859
+
860
+ # http body (model)
861
+ post_body = opts[:debug_body]
862
+
863
+ # return_type
864
+ return_type = opts[:debug_return_type] || 'Array<Check>'
865
+
866
+ # auth_names
867
+ auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']
868
+
869
+ new_options = opts.merge(
870
+ :operation => :"BillsApi.get_vendor_checks",
871
+ :header_params => header_params,
872
+ :query_params => query_params,
873
+ :form_params => form_params,
874
+ :body => post_body,
875
+ :auth_names => auth_names,
876
+ :return_type => return_type
877
+ )
878
+
879
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
880
+ if @api_client.config.debugging
881
+ @api_client.config.logger.debug "API called: BillsApi#get_vendor_checks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
882
+ end
883
+ return data, status_code, headers
884
+ end
885
+
886
+ # Update a Bill (BETA)
887
+ # <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Update an existing bill.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">BILLS</span> - <code>Write</code>
888
+ # @param bill_id [Integer] Bill ID
889
+ # @param save_bill [SaveBill] saveBill
890
+ # @param [Hash] opts the optional parameters
891
+ # @return [Bill]
892
+ def update_bill(bill_id, save_bill, opts = {})
893
+ data, _status_code, _headers = update_bill_with_http_info(bill_id, save_bill, opts)
894
+ data
895
+ end
896
+
897
+ # Update a Bill (BETA)
898
+ # &lt;p class&#x3D;\&quot;betaError\&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Update an existing bill.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;BILLS&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;
899
+ # @param bill_id [Integer] Bill ID
900
+ # @param save_bill [SaveBill] saveBill
901
+ # @param [Hash] opts the optional parameters
902
+ # @return [Array<(Bill, Integer, Hash)>] Bill data, response status code and response headers
903
+ def update_bill_with_http_info(bill_id, save_bill, opts = {})
904
+ if @api_client.config.debugging
905
+ @api_client.config.logger.debug 'Calling API: BillsApi.update_bill ...'
906
+ end
907
+ # verify the required parameter 'bill_id' is set
908
+ if @api_client.config.client_side_validation && bill_id.nil?
909
+ fail ArgumentError, "Missing the required parameter 'bill_id' when calling BillsApi.update_bill"
910
+ end
911
+ # verify the required parameter 'save_bill' is set
912
+ if @api_client.config.client_side_validation && save_bill.nil?
913
+ fail ArgumentError, "Missing the required parameter 'save_bill' when calling BillsApi.update_bill"
914
+ end
915
+ # resource path
916
+ local_var_path = '/bills/{billId}'.sub('{' + 'billId' + '}', CGI.escape(bill_id.to_s))
917
+
918
+ # query parameters
919
+ query_params = opts[:query_params] || {}
920
+
921
+ # header parameters
922
+ header_params = opts[:header_params] || {}
923
+ # HTTP header 'Accept' (if needed)
924
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
925
+ # HTTP header 'Content-Type'
926
+ content_type = @api_client.select_header_content_type(['application/json'])
927
+ if !content_type.nil?
928
+ header_params['Content-Type'] = content_type
929
+ end
930
+
931
+ # form parameters
932
+ form_params = opts[:form_params] || {}
933
+
934
+ # http body (model)
935
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(save_bill)
936
+
937
+ # return_type
938
+ return_type = opts[:debug_return_type] || 'Bill'
939
+
940
+ # auth_names
941
+ auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']
942
+
943
+ new_options = opts.merge(
944
+ :operation => :"BillsApi.update_bill",
945
+ :header_params => header_params,
946
+ :query_params => query_params,
947
+ :form_params => form_params,
948
+ :body => post_body,
949
+ :auth_names => auth_names,
950
+ :return_type => return_type
951
+ )
952
+
953
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
954
+ if @api_client.config.debugging
955
+ @api_client.config.logger.debug "API called: BillsApi#update_bill\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
956
+ end
957
+ return data, status_code, headers
958
+ end
959
+
960
+ # Update a Bill Payment (BETA)
961
+ # <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Update a Bill Payment<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">VENDORS</span> - <code>Write</code>
962
+ # @param bill_payment_id [Integer] Bill Payment ID
963
+ # @param save_bill_payment [SaveBillPayment] saveBillPayment
964
+ # @param [Hash] opts the optional parameters
965
+ # @return [BillPayment]
966
+ def update_bill_payment(bill_payment_id, save_bill_payment, opts = {})
967
+ data, _status_code, _headers = update_bill_payment_with_http_info(bill_payment_id, save_bill_payment, opts)
968
+ data
969
+ end
970
+
971
+ # Update a Bill Payment (BETA)
972
+ # &lt;p class&#x3D;\&quot;betaError\&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Update a Bill Payment&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;VENDORS&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;
973
+ # @param bill_payment_id [Integer] Bill Payment ID
974
+ # @param save_bill_payment [SaveBillPayment] saveBillPayment
975
+ # @param [Hash] opts the optional parameters
976
+ # @return [Array<(BillPayment, Integer, Hash)>] BillPayment data, response status code and response headers
977
+ def update_bill_payment_with_http_info(bill_payment_id, save_bill_payment, opts = {})
978
+ if @api_client.config.debugging
979
+ @api_client.config.logger.debug 'Calling API: BillsApi.update_bill_payment ...'
980
+ end
981
+ # verify the required parameter 'bill_payment_id' is set
982
+ if @api_client.config.client_side_validation && bill_payment_id.nil?
983
+ fail ArgumentError, "Missing the required parameter 'bill_payment_id' when calling BillsApi.update_bill_payment"
984
+ end
985
+ # verify the required parameter 'save_bill_payment' is set
986
+ if @api_client.config.client_side_validation && save_bill_payment.nil?
987
+ fail ArgumentError, "Missing the required parameter 'save_bill_payment' when calling BillsApi.update_bill_payment"
988
+ end
989
+ # resource path
990
+ local_var_path = '/bills/payment/{billPaymentID}'.sub('{' + 'billPaymentID' + '}', CGI.escape(bill_payment_id.to_s))
991
+
992
+ # query parameters
993
+ query_params = opts[:query_params] || {}
994
+
995
+ # header parameters
996
+ header_params = opts[:header_params] || {}
997
+ # HTTP header 'Accept' (if needed)
998
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
999
+ # HTTP header 'Content-Type'
1000
+ content_type = @api_client.select_header_content_type(['application/json'])
1001
+ if !content_type.nil?
1002
+ header_params['Content-Type'] = content_type
1003
+ end
1004
+
1005
+ # form parameters
1006
+ form_params = opts[:form_params] || {}
1007
+
1008
+ # http body (model)
1009
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(save_bill_payment)
1010
+
1011
+ # return_type
1012
+ return_type = opts[:debug_return_type] || 'BillPayment'
1013
+
1014
+ # auth_names
1015
+ auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']
1016
+
1017
+ new_options = opts.merge(
1018
+ :operation => :"BillsApi.update_bill_payment",
1019
+ :header_params => header_params,
1020
+ :query_params => query_params,
1021
+ :form_params => form_params,
1022
+ :body => post_body,
1023
+ :auth_names => auth_names,
1024
+ :return_type => return_type
1025
+ )
1026
+
1027
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
1028
+ if @api_client.config.debugging
1029
+ @api_client.config.logger.debug "API called: BillsApi#update_bill_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1030
+ end
1031
+ return data, status_code, headers
1032
+ end
1033
+
1034
+ # Update a Credit (BETA)
1035
+ # <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Update an existing Credit.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">BILLS</span> - <code>Write</code>
1036
+ # @param credit_id [Integer] Credit ID
1037
+ # @param save_credit [SaveCredit] saveCredit
1038
+ # @param [Hash] opts the optional parameters
1039
+ # @return [Bill]
1040
+ def update_credit(credit_id, save_credit, opts = {})
1041
+ data, _status_code, _headers = update_credit_with_http_info(credit_id, save_credit, opts)
1042
+ data
1043
+ end
1044
+
1045
+ # Update a Credit (BETA)
1046
+ # &lt;p class&#x3D;\&quot;betaError\&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Update an existing Credit.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;BILLS&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;
1047
+ # @param credit_id [Integer] Credit ID
1048
+ # @param save_credit [SaveCredit] saveCredit
1049
+ # @param [Hash] opts the optional parameters
1050
+ # @return [Array<(Bill, Integer, Hash)>] Bill data, response status code and response headers
1051
+ def update_credit_with_http_info(credit_id, save_credit, opts = {})
1052
+ if @api_client.config.debugging
1053
+ @api_client.config.logger.debug 'Calling API: BillsApi.update_credit ...'
1054
+ end
1055
+ # verify the required parameter 'credit_id' is set
1056
+ if @api_client.config.client_side_validation && credit_id.nil?
1057
+ fail ArgumentError, "Missing the required parameter 'credit_id' when calling BillsApi.update_credit"
1058
+ end
1059
+ # verify the required parameter 'save_credit' is set
1060
+ if @api_client.config.client_side_validation && save_credit.nil?
1061
+ fail ArgumentError, "Missing the required parameter 'save_credit' when calling BillsApi.update_credit"
1062
+ end
1063
+ # resource path
1064
+ local_var_path = '/bills/credit/{creditID}'.sub('{' + 'creditID' + '}', CGI.escape(credit_id.to_s))
1065
+
1066
+ # query parameters
1067
+ query_params = opts[:query_params] || {}
1068
+
1069
+ # header parameters
1070
+ header_params = opts[:header_params] || {}
1071
+ # HTTP header 'Accept' (if needed)
1072
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1073
+ # HTTP header 'Content-Type'
1074
+ content_type = @api_client.select_header_content_type(['application/json'])
1075
+ if !content_type.nil?
1076
+ header_params['Content-Type'] = content_type
1077
+ end
1078
+
1079
+ # form parameters
1080
+ form_params = opts[:form_params] || {}
1081
+
1082
+ # http body (model)
1083
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(save_credit)
1084
+
1085
+ # return_type
1086
+ return_type = opts[:debug_return_type] || 'Bill'
1087
+
1088
+ # auth_names
1089
+ auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']
1090
+
1091
+ new_options = opts.merge(
1092
+ :operation => :"BillsApi.update_credit",
1093
+ :header_params => header_params,
1094
+ :query_params => query_params,
1095
+ :form_params => form_params,
1096
+ :body => post_body,
1097
+ :auth_names => auth_names,
1098
+ :return_type => return_type
1099
+ )
1100
+
1101
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
1102
+ if @api_client.config.debugging
1103
+ @api_client.config.logger.debug "API called: BillsApi#update_credit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1104
+ end
1105
+ return data, status_code, headers
1106
+ end
1107
+
1108
+ # Update a Vendor check (BETA)
1109
+ # <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Update an existing Vendor check.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">VENDORS</span> - <code>Write</code>
1110
+ # @param vendor_check_id [Integer] Vendor Check ID
1111
+ # @param save_check [SaveCheck] saveCheck
1112
+ # @param [Hash] opts the optional parameters
1113
+ # @return [Check]
1114
+ def update_vendor_check(vendor_check_id, save_check, opts = {})
1115
+ data, _status_code, _headers = update_vendor_check_with_http_info(vendor_check_id, save_check, opts)
1116
+ data
1117
+ end
1118
+
1119
+ # Update a Vendor check (BETA)
1120
+ # &lt;p class&#x3D;\&quot;betaError\&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Update an existing Vendor check.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;VENDORS&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;
1121
+ # @param vendor_check_id [Integer] Vendor Check ID
1122
+ # @param save_check [SaveCheck] saveCheck
1123
+ # @param [Hash] opts the optional parameters
1124
+ # @return [Array<(Check, Integer, Hash)>] Check data, response status code and response headers
1125
+ def update_vendor_check_with_http_info(vendor_check_id, save_check, opts = {})
1126
+ if @api_client.config.debugging
1127
+ @api_client.config.logger.debug 'Calling API: BillsApi.update_vendor_check ...'
1128
+ end
1129
+ # verify the required parameter 'vendor_check_id' is set
1130
+ if @api_client.config.client_side_validation && vendor_check_id.nil?
1131
+ fail ArgumentError, "Missing the required parameter 'vendor_check_id' when calling BillsApi.update_vendor_check"
1132
+ end
1133
+ # verify the required parameter 'save_check' is set
1134
+ if @api_client.config.client_side_validation && save_check.nil?
1135
+ fail ArgumentError, "Missing the required parameter 'save_check' when calling BillsApi.update_vendor_check"
1136
+ end
1137
+ # resource path
1138
+ local_var_path = '/bills/vendorChecks/{vendorCheckID}'.sub('{' + 'vendorCheckID' + '}', CGI.escape(vendor_check_id.to_s))
1139
+
1140
+ # query parameters
1141
+ query_params = opts[:query_params] || {}
1142
+
1143
+ # header parameters
1144
+ header_params = opts[:header_params] || {}
1145
+ # HTTP header 'Accept' (if needed)
1146
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1147
+ # HTTP header 'Content-Type'
1148
+ content_type = @api_client.select_header_content_type(['application/json'])
1149
+ if !content_type.nil?
1150
+ header_params['Content-Type'] = content_type
1151
+ end
1152
+
1153
+ # form parameters
1154
+ form_params = opts[:form_params] || {}
1155
+
1156
+ # http body (model)
1157
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(save_check)
1158
+
1159
+ # return_type
1160
+ return_type = opts[:debug_return_type] || 'Check'
1161
+
1162
+ # auth_names
1163
+ auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']
1164
+
1165
+ new_options = opts.merge(
1166
+ :operation => :"BillsApi.update_vendor_check",
1167
+ :header_params => header_params,
1168
+ :query_params => query_params,
1169
+ :form_params => form_params,
1170
+ :body => post_body,
1171
+ :auth_names => auth_names,
1172
+ :return_type => return_type
1173
+ )
1174
+
1175
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
1176
+ if @api_client.config.debugging
1177
+ @api_client.config.logger.debug "API called: BillsApi#update_vendor_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1178
+ end
1179
+ return data, status_code, headers
1180
+ end
1181
+ end
1182
+ end