propertyware 1.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.github/workflows/ci.yml +27 -0
- data/.github/workflows/publish.yml +48 -0
- data/.gitignore +39 -0
- data/.openapi-generator/FILES +375 -0
- data/.openapi-generator/VERSION +1 -0
- data/.openapi-generator/templates/ruby-client/gemspec.mustache +37 -0
- data/.openapi-generator/templates/ruby-client/partial_model_generic.mustache +371 -0
- data/.openapi-generator/templates/ruby-client/rubocop.mustache +124 -0
- data/.openapi-generator-ignore +23 -0
- data/.rspec +2 -0
- data/.rubocop.yml +124 -0
- data/CUSTOMIZATIONS.md +11 -0
- data/DOCS.md +673 -0
- data/Gemfile +9 -0
- data/Gemfile.lock +76 -0
- data/README.md +93 -0
- data/Rakefile +10 -0
- data/bin/CUSTOMIZATIONS.md +11 -0
- data/bin/README.md +93 -0
- data/bin/config.yml +7 -0
- data/bin/fix_json.rb +59 -0
- data/bin/propertyware.json +1 -0
- data/bin/rebuild.sh +31 -0
- data/docs/Account.md +84 -0
- data/docs/AccountingApi.md +1235 -0
- data/docs/Address.md +28 -0
- data/docs/Amenity.md +24 -0
- data/docs/AutoJournalEntry.md +46 -0
- data/docs/AutoPayment.md +42 -0
- data/docs/Bank.md +52 -0
- data/docs/BankDeposit.md +32 -0
- data/docs/BasicVendor.md +40 -0
- data/docs/Bill.md +54 -0
- data/docs/BillPaid.md +24 -0
- data/docs/BillPay.md +20 -0
- data/docs/BillPayment.md +46 -0
- data/docs/BillSplit.md +42 -0
- data/docs/BillsApi.md +1391 -0
- data/docs/Building.md +116 -0
- data/docs/BuildingsApi.md +1037 -0
- data/docs/Campaign.md +60 -0
- data/docs/CampaignSource.md +26 -0
- data/docs/Charge.md +36 -0
- data/docs/ChargeTx.md +52 -0
- data/docs/Check.md +48 -0
- data/docs/CheckSplit.md +30 -0
- data/docs/Comment.md +28 -0
- data/docs/Contact.md +74 -0
- data/docs/ContactsApi.md +783 -0
- data/docs/Conversation.md +36 -0
- data/docs/CreditCardAccount.md +18 -0
- data/docs/CurrentAsset.md +30 -0
- data/docs/CurrentLiability.md +30 -0
- data/docs/CustomField.md +24 -0
- data/docs/Discount.md +40 -0
- data/docs/Document.md +40 -0
- data/docs/DocumentsApi.md +267 -0
- data/docs/Entry.md +34 -0
- data/docs/Equity.md +32 -0
- data/docs/ErrorResponse.md +22 -0
- data/docs/Expense.md +32 -0
- data/docs/GLItem.md +40 -0
- data/docs/HealthCheckApi.md +86 -0
- data/docs/Income.md +34 -0
- data/docs/Inspection.md +46 -0
- data/docs/InspectionArea.md +22 -0
- data/docs/InspectionItem.md +24 -0
- data/docs/InspectionsApi.md +193 -0
- data/docs/JournalEntry.md +36 -0
- data/docs/JournalEntrySplit.md +24 -0
- data/docs/JournalEntrySplitResponse.md +24 -0
- data/docs/LateFeeRule.md +26 -0
- data/docs/Lease.md +76 -0
- data/docs/LeaseClause.md +22 -0
- data/docs/LeaseContact.md +36 -0
- data/docs/LeasesApi.md +3319 -0
- data/docs/ManagementFee.md +30 -0
- data/docs/ManagementSettings.md +26 -0
- data/docs/Marketing.md +62 -0
- data/docs/NonCurrentAsset.md +26 -0
- data/docs/NonCurrentLiability.md +30 -0
- data/docs/NonOperatingExpense.md +32 -0
- data/docs/NonOperatingInome.md +32 -0
- data/docs/Note.md +28 -0
- data/docs/Owner.md +38 -0
- data/docs/OwnerContribution.md +44 -0
- data/docs/OwnerDraw.md +44 -0
- data/docs/Payment.md +50 -0
- data/docs/PaymentCharge.md +36 -0
- data/docs/Portfolio.md +60 -0
- data/docs/PortfoliosApi.md +701 -0
- data/docs/PropertyManager.md +26 -0
- data/docs/Prospect.md +114 -0
- data/docs/ProspectsApi.md +789 -0
- data/docs/RESTAPIBulkErrorResponse.md +22 -0
- data/docs/RESTAPIBulkSuccessResponse.md +18 -0
- data/docs/RESTAPIError.md +20 -0
- data/docs/Refund.md +44 -0
- data/docs/ResponseEntity.md +20 -0
- data/docs/SaveAccount.md +52 -0
- data/docs/SaveAddress.md +28 -0
- data/docs/SaveAdjustment.md +26 -0
- data/docs/SaveAutoCharge.md +28 -0
- data/docs/SaveBankDeposit.md +20 -0
- data/docs/SaveBill.md +42 -0
- data/docs/SaveBillPayment.md +30 -0
- data/docs/SaveBillSplit.md +36 -0
- data/docs/SaveBuilding.md +84 -0
- data/docs/SaveCharge.md +28 -0
- data/docs/SaveCheck.md +30 -0
- data/docs/SaveCheckSplit.md +30 -0
- data/docs/SaveComment.md +18 -0
- data/docs/SaveContact.md +60 -0
- data/docs/SaveConversation.md +20 -0
- data/docs/SaveCredit.md +26 -0
- data/docs/SaveDiscount.md +28 -0
- data/docs/SaveJournalEntrySplit.md +22 -0
- data/docs/SaveLease.md +50 -0
- data/docs/SaveLeaseJournalEntry.md +26 -0
- data/docs/SaveOwner.md +36 -0
- data/docs/SaveOwnerContribution.md +34 -0
- data/docs/SaveOwnerDraw.md +34 -0
- data/docs/SavePayment.md +34 -0
- data/docs/SavePortfolio.md +38 -0
- data/docs/SaveProspect.md +76 -0
- data/docs/SaveProspectContact.md +36 -0
- data/docs/SaveRefund.md +34 -0
- data/docs/SaveUnit.md +60 -0
- data/docs/SaveVendor.md +46 -0
- data/docs/SaveWorkOrder.md +36 -0
- data/docs/SaveWorkOrderTask.md +30 -0
- data/docs/SplitPaid.md +34 -0
- data/docs/SplitPay.md +20 -0
- data/docs/Task.md +42 -0
- data/docs/Transaction.md +54 -0
- data/docs/Unit.md +96 -0
- data/docs/UnitsApi.md +875 -0
- data/docs/UpdateLeaseJournalEntry.md +26 -0
- data/docs/Vendor.md +76 -0
- data/docs/VendorsApi.md +617 -0
- data/docs/WorkOrder.md +78 -0
- data/docs/WorkOrdersApi.md +883 -0
- data/lib/propertyware/api/accounting_api.rb +1041 -0
- data/lib/propertyware/api/bills_api.rb +1182 -0
- data/lib/propertyware/api/buildings_api.rb +863 -0
- data/lib/propertyware/api/contacts_api.rb +666 -0
- data/lib/propertyware/api/documents_api.rb +235 -0
- data/lib/propertyware/api/health_check_api.rb +79 -0
- data/lib/propertyware/api/inspections_api.rb +172 -0
- data/lib/propertyware/api/leases_api.rb +2787 -0
- data/lib/propertyware/api/portfolios_api.rb +599 -0
- data/lib/propertyware/api/prospects_api.rb +671 -0
- data/lib/propertyware/api/units_api.rb +740 -0
- data/lib/propertyware/api/vendors_api.rb +522 -0
- data/lib/propertyware/api/work_orders_api.rb +763 -0
- data/lib/propertyware/api_client.rb +428 -0
- data/lib/propertyware/api_error.rb +58 -0
- data/lib/propertyware/configuration.rb +392 -0
- data/lib/propertyware/models/account.rb +549 -0
- data/lib/propertyware/models/address.rb +269 -0
- data/lib/propertyware/models/amenity.rb +249 -0
- data/lib/propertyware/models/auto_journal_entry.rb +358 -0
- data/lib/propertyware/models/auto_payment.rb +338 -0
- data/lib/propertyware/models/bank.rb +389 -0
- data/lib/propertyware/models/bank_deposit.rb +289 -0
- data/lib/propertyware/models/basic_vendor.rb +330 -0
- data/lib/propertyware/models/bill.rb +401 -0
- data/lib/propertyware/models/bill_paid.rb +250 -0
- data/lib/propertyware/models/bill_pay.rb +230 -0
- data/lib/propertyware/models/bill_payment.rb +361 -0
- data/lib/propertyware/models/bill_split.rb +339 -0
- data/lib/propertyware/models/building.rb +782 -0
- data/lib/propertyware/models/campaign.rb +430 -0
- data/lib/propertyware/models/campaign_source.rb +258 -0
- data/lib/propertyware/models/charge.rb +318 -0
- data/lib/propertyware/models/charge_tx.rb +401 -0
- data/lib/propertyware/models/check.rb +425 -0
- data/lib/propertyware/models/check_split.rb +284 -0
- data/lib/propertyware/models/comment.rb +269 -0
- data/lib/propertyware/models/contact.rb +546 -0
- data/lib/propertyware/models/conversation.rb +345 -0
- data/lib/propertyware/models/credit_card_account.rb +219 -0
- data/lib/propertyware/models/current_asset.rb +279 -0
- data/lib/propertyware/models/current_liability.rb +279 -0
- data/lib/propertyware/models/custom_field.rb +249 -0
- data/lib/propertyware/models/discount.rb +339 -0
- data/lib/propertyware/models/document.rb +362 -0
- data/lib/propertyware/models/entry.rb +297 -0
- data/lib/propertyware/models/equity.rb +289 -0
- data/lib/propertyware/models/error_response.rb +237 -0
- data/lib/propertyware/models/expense.rb +289 -0
- data/lib/propertyware/models/gl_item.rb +330 -0
- data/lib/propertyware/models/income.rb +299 -0
- data/lib/propertyware/models/inspection.rb +361 -0
- data/lib/propertyware/models/inspection_area.rb +241 -0
- data/lib/propertyware/models/inspection_item.rb +249 -0
- data/lib/propertyware/models/journal_entry.rb +311 -0
- data/lib/propertyware/models/journal_entry_split.rb +264 -0
- data/lib/propertyware/models/journal_entry_split_response.rb +263 -0
- data/lib/propertyware/models/late_fee_rule.rb +258 -0
- data/lib/propertyware/models/lease.rb +515 -0
- data/lib/propertyware/models/lease_clause.rb +238 -0
- data/lib/propertyware/models/lease_contact.rb +309 -0
- data/lib/propertyware/models/management_fee.rb +279 -0
- data/lib/propertyware/models/management_settings.rb +261 -0
- data/lib/propertyware/models/marketing.rb +439 -0
- data/lib/propertyware/models/non_current_asset.rb +259 -0
- data/lib/propertyware/models/non_current_liability.rb +279 -0
- data/lib/propertyware/models/non_operating_expense.rb +289 -0
- data/lib/propertyware/models/non_operating_inome.rb +289 -0
- data/lib/propertyware/models/note.rb +267 -0
- data/lib/propertyware/models/owner.rb +318 -0
- data/lib/propertyware/models/owner_contribution.rb +418 -0
- data/lib/propertyware/models/owner_draw.rb +398 -0
- data/lib/propertyware/models/payment.rb +423 -0
- data/lib/propertyware/models/payment_charge.rb +358 -0
- data/lib/propertyware/models/portfolio.rb +479 -0
- data/lib/propertyware/models/property_manager.rb +259 -0
- data/lib/propertyware/models/prospect.rb +701 -0
- data/lib/propertyware/models/refund.rb +384 -0
- data/lib/propertyware/models/response_entity.rb +260 -0
- data/lib/propertyware/models/restapi_bulk_error_response.rb +237 -0
- data/lib/propertyware/models/restapi_bulk_success_response.rb +217 -0
- data/lib/propertyware/models/restapi_error.rb +226 -0
- data/lib/propertyware/models/save_account.rb +398 -0
- data/lib/propertyware/models/save_address.rb +274 -0
- data/lib/propertyware/models/save_adjustment.rb +269 -0
- data/lib/propertyware/models/save_auto_charge.rb +328 -0
- data/lib/propertyware/models/save_bank_deposit.rb +239 -0
- data/lib/propertyware/models/save_bill.rb +356 -0
- data/lib/propertyware/models/save_bill_payment.rb +314 -0
- data/lib/propertyware/models/save_bill_split.rb +319 -0
- data/lib/propertyware/models/save_building.rb +653 -0
- data/lib/propertyware/models/save_charge.rb +289 -0
- data/lib/propertyware/models/save_check.rb +291 -0
- data/lib/propertyware/models/save_check_split.rb +289 -0
- data/lib/propertyware/models/save_comment.rb +224 -0
- data/lib/propertyware/models/save_contact.rb +472 -0
- data/lib/propertyware/models/save_conversation.rb +273 -0
- data/lib/propertyware/models/save_credit.rb +271 -0
- data/lib/propertyware/models/save_discount.rb +289 -0
- data/lib/propertyware/models/save_journal_entry_split.rb +254 -0
- data/lib/propertyware/models/save_lease.rb +444 -0
- data/lib/propertyware/models/save_lease_journal_entry.rb +276 -0
- data/lib/propertyware/models/save_owner.rb +318 -0
- data/lib/propertyware/models/save_owner_contribution.rb +373 -0
- data/lib/propertyware/models/save_owner_draw.rb +334 -0
- data/lib/propertyware/models/save_payment.rb +373 -0
- data/lib/propertyware/models/save_portfolio.rb +379 -0
- data/lib/propertyware/models/save_prospect.rb +511 -0
- data/lib/propertyware/models/save_prospect_contact.rb +318 -0
- data/lib/propertyware/models/save_refund.rb +334 -0
- data/lib/propertyware/models/save_unit.rb +492 -0
- data/lib/propertyware/models/save_vendor.rb +379 -0
- data/lib/propertyware/models/save_work_order.rb +345 -0
- data/lib/propertyware/models/save_work_order_task.rb +284 -0
- data/lib/propertyware/models/split_paid.rb +298 -0
- data/lib/propertyware/models/split_pay.rb +228 -0
- data/lib/propertyware/models/task.rb +339 -0
- data/lib/propertyware/models/transaction.rb +433 -0
- data/lib/propertyware/models/unit.rb +670 -0
- data/lib/propertyware/models/update_lease_journal_entry.rb +276 -0
- data/lib/propertyware/models/vendor.rb +511 -0
- data/lib/propertyware/models/work_order.rb +557 -0
- data/lib/propertyware/version.rb +15 -0
- data/lib/propertyware.rb +158 -0
- data/openapitools.json +7 -0
- data/propertyware.gemspec +39 -0
- data/spec/api/accounting_api_spec.rb +239 -0
- data/spec/api/bills_api_spec.rb +260 -0
- data/spec/api/buildings_api_spec.rb +199 -0
- data/spec/api/contacts_api_spec.rb +159 -0
- data/spec/api/documents_api_spec.rb +77 -0
- data/spec/api/health_check_api_spec.rb +46 -0
- data/spec/api/inspections_api_spec.rb +68 -0
- data/spec/api/leases_api_spec.rb +579 -0
- data/spec/api/portfolios_api_spec.rb +147 -0
- data/spec/api/prospects_api_spec.rb +162 -0
- data/spec/api/units_api_spec.rb +176 -0
- data/spec/api/vendors_api_spec.rb +134 -0
- data/spec/api/work_orders_api_spec.rb +180 -0
- data/spec/api_client_spec.rb +223 -0
- data/spec/configuration_spec.rb +82 -0
- data/spec/models/account_spec.rb +232 -0
- data/spec/models/address_spec.rb +64 -0
- data/spec/models/amenity_spec.rb +52 -0
- data/spec/models/auto_journal_entry_spec.rb +118 -0
- data/spec/models/auto_payment_spec.rb +106 -0
- data/spec/models/bank_deposit_spec.rb +76 -0
- data/spec/models/bank_spec.rb +136 -0
- data/spec/models/basic_vendor_spec.rb +100 -0
- data/spec/models/bill_paid_spec.rb +52 -0
- data/spec/models/bill_pay_spec.rb +40 -0
- data/spec/models/bill_payment_spec.rb +118 -0
- data/spec/models/bill_spec.rb +142 -0
- data/spec/models/bill_split_spec.rb +106 -0
- data/spec/models/building_spec.rb +344 -0
- data/spec/models/campaign_source_spec.rb +58 -0
- data/spec/models/campaign_spec.rb +160 -0
- data/spec/models/charge_spec.rb +88 -0
- data/spec/models/charge_tx_spec.rb +136 -0
- data/spec/models/check_spec.rb +128 -0
- data/spec/models/check_split_spec.rb +70 -0
- data/spec/models/comment_spec.rb +64 -0
- data/spec/models/contact_spec.rb +210 -0
- data/spec/models/conversation_spec.rb +92 -0
- data/spec/models/credit_card_account_spec.rb +34 -0
- data/spec/models/current_asset_spec.rb +70 -0
- data/spec/models/current_liability_spec.rb +70 -0
- data/spec/models/custom_field_spec.rb +52 -0
- data/spec/models/discount_spec.rb +100 -0
- data/spec/models/document_spec.rb +104 -0
- data/spec/models/entry_spec.rb +82 -0
- data/spec/models/equity_spec.rb +76 -0
- data/spec/models/error_response_spec.rb +46 -0
- data/spec/models/expense_spec.rb +76 -0
- data/spec/models/gl_item_spec.rb +100 -0
- data/spec/models/income_spec.rb +82 -0
- data/spec/models/inspection_area_spec.rb +46 -0
- data/spec/models/inspection_item_spec.rb +52 -0
- data/spec/models/inspection_spec.rb +118 -0
- data/spec/models/journal_entry_spec.rb +88 -0
- data/spec/models/journal_entry_split_response_spec.rb +52 -0
- data/spec/models/journal_entry_split_spec.rb +52 -0
- data/spec/models/late_fee_rule_spec.rb +58 -0
- data/spec/models/lease_clause_spec.rb +46 -0
- data/spec/models/lease_contact_spec.rb +88 -0
- data/spec/models/lease_spec.rb +208 -0
- data/spec/models/management_fee_spec.rb +70 -0
- data/spec/models/management_settings_spec.rb +58 -0
- data/spec/models/marketing_spec.rb +166 -0
- data/spec/models/non_current_asset_spec.rb +58 -0
- data/spec/models/non_current_liability_spec.rb +70 -0
- data/spec/models/non_operating_expense_spec.rb +76 -0
- data/spec/models/non_operating_inome_spec.rb +76 -0
- data/spec/models/note_spec.rb +64 -0
- data/spec/models/owner_contribution_spec.rb +116 -0
- data/spec/models/owner_draw_spec.rb +116 -0
- data/spec/models/owner_spec.rb +94 -0
- data/spec/models/payment_charge_spec.rb +92 -0
- data/spec/models/payment_spec.rb +134 -0
- data/spec/models/portfolio_spec.rb +168 -0
- data/spec/models/property_manager_spec.rb +58 -0
- data/spec/models/prospect_spec.rb +322 -0
- data/spec/models/refund_spec.rb +112 -0
- data/spec/models/response_entity_spec.rb +44 -0
- data/spec/models/restapi_bulk_error_response_spec.rb +46 -0
- data/spec/models/restapi_bulk_success_response_spec.rb +34 -0
- data/spec/models/restapi_error_spec.rb +40 -0
- data/spec/models/save_account_spec.rb +136 -0
- data/spec/models/save_address_spec.rb +64 -0
- data/spec/models/save_adjustment_spec.rb +58 -0
- data/spec/models/save_auto_charge_spec.rb +68 -0
- data/spec/models/save_bank_deposit_spec.rb +40 -0
- data/spec/models/save_bill_payment_spec.rb +74 -0
- data/spec/models/save_bill_spec.rb +106 -0
- data/spec/models/save_bill_split_spec.rb +88 -0
- data/spec/models/save_building_spec.rb +248 -0
- data/spec/models/save_charge_spec.rb +64 -0
- data/spec/models/save_check_spec.rb +70 -0
- data/spec/models/save_check_split_spec.rb +70 -0
- data/spec/models/save_comment_spec.rb +34 -0
- data/spec/models/save_contact_spec.rb +164 -0
- data/spec/models/save_conversation_spec.rb +44 -0
- data/spec/models/save_credit_spec.rb +58 -0
- data/spec/models/save_discount_spec.rb +64 -0
- data/spec/models/save_journal_entry_split_spec.rb +46 -0
- data/spec/models/save_lease_journal_entry_spec.rb +58 -0
- data/spec/models/save_lease_spec.rb +134 -0
- data/spec/models/save_owner_contribution_spec.rb +86 -0
- data/spec/models/save_owner_draw_spec.rb +82 -0
- data/spec/models/save_owner_spec.rb +88 -0
- data/spec/models/save_payment_spec.rb +86 -0
- data/spec/models/save_portfolio_spec.rb +102 -0
- data/spec/models/save_prospect_contact_spec.rb +88 -0
- data/spec/models/save_prospect_spec.rb +208 -0
- data/spec/models/save_refund_spec.rb +82 -0
- data/spec/models/save_unit_spec.rb +164 -0
- data/spec/models/save_vendor_spec.rb +118 -0
- data/spec/models/save_work_order_spec.rb +92 -0
- data/spec/models/save_work_order_task_spec.rb +70 -0
- data/spec/models/split_paid_spec.rb +82 -0
- data/spec/models/split_pay_spec.rb +40 -0
- data/spec/models/task_spec.rb +106 -0
- data/spec/models/transaction_spec.rb +146 -0
- data/spec/models/unit_spec.rb +280 -0
- data/spec/models/update_lease_journal_entry_spec.rb +58 -0
- data/spec/models/vendor_spec.rb +208 -0
- data/spec/models/work_order_spec.rb +218 -0
- data/spec/spec_helper.rb +111 -0
- metadata +609 -0
data/docs/BillsApi.md
ADDED
@@ -0,0 +1,1391 @@
|
|
1
|
+
# Propertyware::BillsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.propertyware.com/pw/api/rest/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**create_bill**](BillsApi.md#create_bill) | **POST** /bills | Create a bill (BETA) |
|
8
|
+
| [**create_bill_payment**](BillsApi.md#create_bill_payment) | **POST** /bills/payment | Creates Bill Payment (BETA) |
|
9
|
+
| [**create_bill_payments_using_post1**](BillsApi.md#create_bill_payments_using_post1) | **POST** /bills/payments/bulk | Create bill payments in bulk (BETA) |
|
10
|
+
| [**create_bills**](BillsApi.md#create_bills) | **POST** /bills/bulk | Create bills in bulk (BETA) |
|
11
|
+
| [**create_credit**](BillsApi.md#create_credit) | **POST** /bills/credit | Create a credit (BETA) |
|
12
|
+
| [**create_vendor_check**](BillsApi.md#create_vendor_check) | **POST** /bills/vendorChecks | Create a Vendor check (BETA) |
|
13
|
+
| [**delete_bill**](BillsApi.md#delete_bill) | **DELETE** /bills/{billID} | Delete a Bill (BETA) |
|
14
|
+
| [**get_bill**](BillsApi.md#get_bill) | **GET** /bills/{billID} | Retrieve a bill (BETA) |
|
15
|
+
| [**get_bill_payment**](BillsApi.md#get_bill_payment) | **GET** /bills/payments/{billPaymentID} | Retrieve a bill payment (BETA) |
|
16
|
+
| [**get_bill_payments**](BillsApi.md#get_bill_payments) | **GET** /bills/payments | Retrieve all bill payments (BETA) |
|
17
|
+
| [**get_bills**](BillsApi.md#get_bills) | **GET** /bills | Retrieve all bills (BETA) |
|
18
|
+
| [**get_vendor_checks**](BillsApi.md#get_vendor_checks) | **GET** /bills/vendorChecks | Retrieve all Vendor checks (BETA) |
|
19
|
+
| [**update_bill**](BillsApi.md#update_bill) | **PUT** /bills/{billId} | Update a Bill (BETA) |
|
20
|
+
| [**update_bill_payment**](BillsApi.md#update_bill_payment) | **PUT** /bills/payment/{billPaymentID} | Update a Bill Payment (BETA) |
|
21
|
+
| [**update_credit**](BillsApi.md#update_credit) | **PUT** /bills/credit/{creditID} | Update a Credit (BETA) |
|
22
|
+
| [**update_vendor_check**](BillsApi.md#update_vendor_check) | **PUT** /bills/vendorChecks/{vendorCheckID} | Update a Vendor check (BETA) |
|
23
|
+
|
24
|
+
|
25
|
+
## create_bill
|
26
|
+
|
27
|
+
> <Bill> create_bill(save_bill)
|
28
|
+
|
29
|
+
Create a bill (BETA)
|
30
|
+
|
31
|
+
<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>
|
32
|
+
|
33
|
+
### Examples
|
34
|
+
|
35
|
+
```ruby
|
36
|
+
require 'time'
|
37
|
+
require 'propertyware'
|
38
|
+
# setup authorization
|
39
|
+
Propertyware.configure do |config|
|
40
|
+
# Configure API key authorization: organizationId
|
41
|
+
config.api_key['organizationId'] = 'YOUR API KEY'
|
42
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
43
|
+
# config.api_key_prefix['organizationId'] = 'Bearer'
|
44
|
+
|
45
|
+
# Configure API key authorization: clientId
|
46
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
47
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
48
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
49
|
+
|
50
|
+
# Configure API key authorization: clientSecret
|
51
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
52
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
53
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
54
|
+
end
|
55
|
+
|
56
|
+
api_instance = Propertyware::BillsApi.new
|
57
|
+
save_bill = Propertyware::SaveBill.new({bill_date: Date.today, due_date: Date.today, vendor_id: 3.56}) # SaveBill | saveBill
|
58
|
+
|
59
|
+
begin
|
60
|
+
# Create a bill (BETA)
|
61
|
+
result = api_instance.create_bill(save_bill)
|
62
|
+
p result
|
63
|
+
rescue Propertyware::ApiError => e
|
64
|
+
puts "Error when calling BillsApi->create_bill: #{e}"
|
65
|
+
end
|
66
|
+
```
|
67
|
+
|
68
|
+
#### Using the create_bill_with_http_info variant
|
69
|
+
|
70
|
+
This returns an Array which contains the response data, status code and headers.
|
71
|
+
|
72
|
+
> <Array(<Bill>, Integer, Hash)> create_bill_with_http_info(save_bill)
|
73
|
+
|
74
|
+
```ruby
|
75
|
+
begin
|
76
|
+
# Create a bill (BETA)
|
77
|
+
data, status_code, headers = api_instance.create_bill_with_http_info(save_bill)
|
78
|
+
p status_code # => 2xx
|
79
|
+
p headers # => { ... }
|
80
|
+
p data # => <Bill>
|
81
|
+
rescue Propertyware::ApiError => e
|
82
|
+
puts "Error when calling BillsApi->create_bill_with_http_info: #{e}"
|
83
|
+
end
|
84
|
+
```
|
85
|
+
|
86
|
+
### Parameters
|
87
|
+
|
88
|
+
| Name | Type | Description | Notes |
|
89
|
+
| ---- | ---- | ----------- | ----- |
|
90
|
+
| **save_bill** | [**SaveBill**](SaveBill.md) | saveBill | |
|
91
|
+
|
92
|
+
### Return type
|
93
|
+
|
94
|
+
[**Bill**](Bill.md)
|
95
|
+
|
96
|
+
### Authorization
|
97
|
+
|
98
|
+
[organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
99
|
+
|
100
|
+
### HTTP request headers
|
101
|
+
|
102
|
+
- **Content-Type**: application/json
|
103
|
+
- **Accept**: application/json
|
104
|
+
|
105
|
+
|
106
|
+
## create_bill_payment
|
107
|
+
|
108
|
+
> <BillPayment> create_bill_payment(save_bill_payment)
|
109
|
+
|
110
|
+
Creates Bill Payment (BETA)
|
111
|
+
|
112
|
+
<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>
|
113
|
+
|
114
|
+
### Examples
|
115
|
+
|
116
|
+
```ruby
|
117
|
+
require 'time'
|
118
|
+
require 'propertyware'
|
119
|
+
# setup authorization
|
120
|
+
Propertyware.configure do |config|
|
121
|
+
# Configure API key authorization: organizationId
|
122
|
+
config.api_key['organizationId'] = 'YOUR API KEY'
|
123
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
124
|
+
# config.api_key_prefix['organizationId'] = 'Bearer'
|
125
|
+
|
126
|
+
# Configure API key authorization: clientId
|
127
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
128
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
129
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
130
|
+
|
131
|
+
# Configure API key authorization: clientSecret
|
132
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
133
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
134
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
135
|
+
end
|
136
|
+
|
137
|
+
api_instance = Propertyware::BillsApi.new
|
138
|
+
save_bill_payment = Propertyware::SaveBillPayment.new # SaveBillPayment | saveBillPayment
|
139
|
+
|
140
|
+
begin
|
141
|
+
# Creates Bill Payment (BETA)
|
142
|
+
result = api_instance.create_bill_payment(save_bill_payment)
|
143
|
+
p result
|
144
|
+
rescue Propertyware::ApiError => e
|
145
|
+
puts "Error when calling BillsApi->create_bill_payment: #{e}"
|
146
|
+
end
|
147
|
+
```
|
148
|
+
|
149
|
+
#### Using the create_bill_payment_with_http_info variant
|
150
|
+
|
151
|
+
This returns an Array which contains the response data, status code and headers.
|
152
|
+
|
153
|
+
> <Array(<BillPayment>, Integer, Hash)> create_bill_payment_with_http_info(save_bill_payment)
|
154
|
+
|
155
|
+
```ruby
|
156
|
+
begin
|
157
|
+
# Creates Bill Payment (BETA)
|
158
|
+
data, status_code, headers = api_instance.create_bill_payment_with_http_info(save_bill_payment)
|
159
|
+
p status_code # => 2xx
|
160
|
+
p headers # => { ... }
|
161
|
+
p data # => <BillPayment>
|
162
|
+
rescue Propertyware::ApiError => e
|
163
|
+
puts "Error when calling BillsApi->create_bill_payment_with_http_info: #{e}"
|
164
|
+
end
|
165
|
+
```
|
166
|
+
|
167
|
+
### Parameters
|
168
|
+
|
169
|
+
| Name | Type | Description | Notes |
|
170
|
+
| ---- | ---- | ----------- | ----- |
|
171
|
+
| **save_bill_payment** | [**SaveBillPayment**](SaveBillPayment.md) | saveBillPayment | |
|
172
|
+
|
173
|
+
### Return type
|
174
|
+
|
175
|
+
[**BillPayment**](BillPayment.md)
|
176
|
+
|
177
|
+
### Authorization
|
178
|
+
|
179
|
+
[organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
180
|
+
|
181
|
+
### HTTP request headers
|
182
|
+
|
183
|
+
- **Content-Type**: application/json
|
184
|
+
- **Accept**: application/json
|
185
|
+
|
186
|
+
|
187
|
+
## create_bill_payments_using_post1
|
188
|
+
|
189
|
+
> <Array<RESTAPIBulkSuccessResponse>> create_bill_payments_using_post1(save_bill_payment)
|
190
|
+
|
191
|
+
Create bill payments in bulk (BETA)
|
192
|
+
|
193
|
+
<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>
|
194
|
+
|
195
|
+
### Examples
|
196
|
+
|
197
|
+
```ruby
|
198
|
+
require 'time'
|
199
|
+
require 'propertyware'
|
200
|
+
# setup authorization
|
201
|
+
Propertyware.configure do |config|
|
202
|
+
# Configure API key authorization: organizationId
|
203
|
+
config.api_key['organizationId'] = 'YOUR API KEY'
|
204
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
205
|
+
# config.api_key_prefix['organizationId'] = 'Bearer'
|
206
|
+
|
207
|
+
# Configure API key authorization: clientId
|
208
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
209
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
210
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
211
|
+
|
212
|
+
# Configure API key authorization: clientSecret
|
213
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
214
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
215
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
216
|
+
end
|
217
|
+
|
218
|
+
api_instance = Propertyware::BillsApi.new
|
219
|
+
save_bill_payment = [Propertyware::SaveBillPayment.new] # Array<SaveBillPayment> | saveBillPayment
|
220
|
+
|
221
|
+
begin
|
222
|
+
# Create bill payments in bulk (BETA)
|
223
|
+
result = api_instance.create_bill_payments_using_post1(save_bill_payment)
|
224
|
+
p result
|
225
|
+
rescue Propertyware::ApiError => e
|
226
|
+
puts "Error when calling BillsApi->create_bill_payments_using_post1: #{e}"
|
227
|
+
end
|
228
|
+
```
|
229
|
+
|
230
|
+
#### Using the create_bill_payments_using_post1_with_http_info variant
|
231
|
+
|
232
|
+
This returns an Array which contains the response data, status code and headers.
|
233
|
+
|
234
|
+
> <Array(<Array<RESTAPIBulkSuccessResponse>>, Integer, Hash)> create_bill_payments_using_post1_with_http_info(save_bill_payment)
|
235
|
+
|
236
|
+
```ruby
|
237
|
+
begin
|
238
|
+
# Create bill payments in bulk (BETA)
|
239
|
+
data, status_code, headers = api_instance.create_bill_payments_using_post1_with_http_info(save_bill_payment)
|
240
|
+
p status_code # => 2xx
|
241
|
+
p headers # => { ... }
|
242
|
+
p data # => <Array<RESTAPIBulkSuccessResponse>>
|
243
|
+
rescue Propertyware::ApiError => e
|
244
|
+
puts "Error when calling BillsApi->create_bill_payments_using_post1_with_http_info: #{e}"
|
245
|
+
end
|
246
|
+
```
|
247
|
+
|
248
|
+
### Parameters
|
249
|
+
|
250
|
+
| Name | Type | Description | Notes |
|
251
|
+
| ---- | ---- | ----------- | ----- |
|
252
|
+
| **save_bill_payment** | [**Array<SaveBillPayment>**](SaveBillPayment.md) | saveBillPayment | |
|
253
|
+
|
254
|
+
### Return type
|
255
|
+
|
256
|
+
[**Array<RESTAPIBulkSuccessResponse>**](RESTAPIBulkSuccessResponse.md)
|
257
|
+
|
258
|
+
### Authorization
|
259
|
+
|
260
|
+
[organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
261
|
+
|
262
|
+
### HTTP request headers
|
263
|
+
|
264
|
+
- **Content-Type**: application/json
|
265
|
+
- **Accept**: application/json
|
266
|
+
|
267
|
+
|
268
|
+
## create_bills
|
269
|
+
|
270
|
+
> <Array<RESTAPIBulkSuccessResponse>> create_bills(save_bill)
|
271
|
+
|
272
|
+
Create bills in bulk (BETA)
|
273
|
+
|
274
|
+
<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>
|
275
|
+
|
276
|
+
### Examples
|
277
|
+
|
278
|
+
```ruby
|
279
|
+
require 'time'
|
280
|
+
require 'propertyware'
|
281
|
+
# setup authorization
|
282
|
+
Propertyware.configure do |config|
|
283
|
+
# Configure API key authorization: organizationId
|
284
|
+
config.api_key['organizationId'] = 'YOUR API KEY'
|
285
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
286
|
+
# config.api_key_prefix['organizationId'] = 'Bearer'
|
287
|
+
|
288
|
+
# Configure API key authorization: clientId
|
289
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
290
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
291
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
292
|
+
|
293
|
+
# Configure API key authorization: clientSecret
|
294
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
295
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
296
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
297
|
+
end
|
298
|
+
|
299
|
+
api_instance = Propertyware::BillsApi.new
|
300
|
+
save_bill = [Propertyware::SaveBill.new({bill_date: Date.today, due_date: Date.today, vendor_id: 3.56})] # Array<SaveBill> | saveBill
|
301
|
+
|
302
|
+
begin
|
303
|
+
# Create bills in bulk (BETA)
|
304
|
+
result = api_instance.create_bills(save_bill)
|
305
|
+
p result
|
306
|
+
rescue Propertyware::ApiError => e
|
307
|
+
puts "Error when calling BillsApi->create_bills: #{e}"
|
308
|
+
end
|
309
|
+
```
|
310
|
+
|
311
|
+
#### Using the create_bills_with_http_info variant
|
312
|
+
|
313
|
+
This returns an Array which contains the response data, status code and headers.
|
314
|
+
|
315
|
+
> <Array(<Array<RESTAPIBulkSuccessResponse>>, Integer, Hash)> create_bills_with_http_info(save_bill)
|
316
|
+
|
317
|
+
```ruby
|
318
|
+
begin
|
319
|
+
# Create bills in bulk (BETA)
|
320
|
+
data, status_code, headers = api_instance.create_bills_with_http_info(save_bill)
|
321
|
+
p status_code # => 2xx
|
322
|
+
p headers # => { ... }
|
323
|
+
p data # => <Array<RESTAPIBulkSuccessResponse>>
|
324
|
+
rescue Propertyware::ApiError => e
|
325
|
+
puts "Error when calling BillsApi->create_bills_with_http_info: #{e}"
|
326
|
+
end
|
327
|
+
```
|
328
|
+
|
329
|
+
### Parameters
|
330
|
+
|
331
|
+
| Name | Type | Description | Notes |
|
332
|
+
| ---- | ---- | ----------- | ----- |
|
333
|
+
| **save_bill** | [**Array<SaveBill>**](SaveBill.md) | saveBill | |
|
334
|
+
|
335
|
+
### Return type
|
336
|
+
|
337
|
+
[**Array<RESTAPIBulkSuccessResponse>**](RESTAPIBulkSuccessResponse.md)
|
338
|
+
|
339
|
+
### Authorization
|
340
|
+
|
341
|
+
[organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
342
|
+
|
343
|
+
### HTTP request headers
|
344
|
+
|
345
|
+
- **Content-Type**: application/json
|
346
|
+
- **Accept**: application/json
|
347
|
+
|
348
|
+
|
349
|
+
## create_credit
|
350
|
+
|
351
|
+
> <Bill> create_credit(save_credit)
|
352
|
+
|
353
|
+
Create a credit (BETA)
|
354
|
+
|
355
|
+
<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>
|
356
|
+
|
357
|
+
### Examples
|
358
|
+
|
359
|
+
```ruby
|
360
|
+
require 'time'
|
361
|
+
require 'propertyware'
|
362
|
+
# setup authorization
|
363
|
+
Propertyware.configure do |config|
|
364
|
+
# Configure API key authorization: organizationId
|
365
|
+
config.api_key['organizationId'] = 'YOUR API KEY'
|
366
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
367
|
+
# config.api_key_prefix['organizationId'] = 'Bearer'
|
368
|
+
|
369
|
+
# Configure API key authorization: clientId
|
370
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
371
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
372
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
373
|
+
|
374
|
+
# Configure API key authorization: clientSecret
|
375
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
376
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
377
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
378
|
+
end
|
379
|
+
|
380
|
+
api_instance = Propertyware::BillsApi.new
|
381
|
+
save_credit = Propertyware::SaveCredit.new({bill_date: Date.today, vendor_id: 3.56}) # SaveCredit | saveCredit
|
382
|
+
|
383
|
+
begin
|
384
|
+
# Create a credit (BETA)
|
385
|
+
result = api_instance.create_credit(save_credit)
|
386
|
+
p result
|
387
|
+
rescue Propertyware::ApiError => e
|
388
|
+
puts "Error when calling BillsApi->create_credit: #{e}"
|
389
|
+
end
|
390
|
+
```
|
391
|
+
|
392
|
+
#### Using the create_credit_with_http_info variant
|
393
|
+
|
394
|
+
This returns an Array which contains the response data, status code and headers.
|
395
|
+
|
396
|
+
> <Array(<Bill>, Integer, Hash)> create_credit_with_http_info(save_credit)
|
397
|
+
|
398
|
+
```ruby
|
399
|
+
begin
|
400
|
+
# Create a credit (BETA)
|
401
|
+
data, status_code, headers = api_instance.create_credit_with_http_info(save_credit)
|
402
|
+
p status_code # => 2xx
|
403
|
+
p headers # => { ... }
|
404
|
+
p data # => <Bill>
|
405
|
+
rescue Propertyware::ApiError => e
|
406
|
+
puts "Error when calling BillsApi->create_credit_with_http_info: #{e}"
|
407
|
+
end
|
408
|
+
```
|
409
|
+
|
410
|
+
### Parameters
|
411
|
+
|
412
|
+
| Name | Type | Description | Notes |
|
413
|
+
| ---- | ---- | ----------- | ----- |
|
414
|
+
| **save_credit** | [**SaveCredit**](SaveCredit.md) | saveCredit | |
|
415
|
+
|
416
|
+
### Return type
|
417
|
+
|
418
|
+
[**Bill**](Bill.md)
|
419
|
+
|
420
|
+
### Authorization
|
421
|
+
|
422
|
+
[organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
423
|
+
|
424
|
+
### HTTP request headers
|
425
|
+
|
426
|
+
- **Content-Type**: application/json
|
427
|
+
- **Accept**: application/json
|
428
|
+
|
429
|
+
|
430
|
+
## create_vendor_check
|
431
|
+
|
432
|
+
> <Check> create_vendor_check(save_check)
|
433
|
+
|
434
|
+
Create a Vendor check (BETA)
|
435
|
+
|
436
|
+
<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>
|
437
|
+
|
438
|
+
### Examples
|
439
|
+
|
440
|
+
```ruby
|
441
|
+
require 'time'
|
442
|
+
require 'propertyware'
|
443
|
+
# setup authorization
|
444
|
+
Propertyware.configure do |config|
|
445
|
+
# Configure API key authorization: organizationId
|
446
|
+
config.api_key['organizationId'] = 'YOUR API KEY'
|
447
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
448
|
+
# config.api_key_prefix['organizationId'] = 'Bearer'
|
449
|
+
|
450
|
+
# Configure API key authorization: clientId
|
451
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
452
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
453
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
454
|
+
|
455
|
+
# Configure API key authorization: clientSecret
|
456
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
457
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
458
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
459
|
+
end
|
460
|
+
|
461
|
+
api_instance = Propertyware::BillsApi.new
|
462
|
+
save_check = Propertyware::SaveCheck.new({check_date: Date.today, destination_account_id: 3.56}) # SaveCheck | saveCheck
|
463
|
+
|
464
|
+
begin
|
465
|
+
# Create a Vendor check (BETA)
|
466
|
+
result = api_instance.create_vendor_check(save_check)
|
467
|
+
p result
|
468
|
+
rescue Propertyware::ApiError => e
|
469
|
+
puts "Error when calling BillsApi->create_vendor_check: #{e}"
|
470
|
+
end
|
471
|
+
```
|
472
|
+
|
473
|
+
#### Using the create_vendor_check_with_http_info variant
|
474
|
+
|
475
|
+
This returns an Array which contains the response data, status code and headers.
|
476
|
+
|
477
|
+
> <Array(<Check>, Integer, Hash)> create_vendor_check_with_http_info(save_check)
|
478
|
+
|
479
|
+
```ruby
|
480
|
+
begin
|
481
|
+
# Create a Vendor check (BETA)
|
482
|
+
data, status_code, headers = api_instance.create_vendor_check_with_http_info(save_check)
|
483
|
+
p status_code # => 2xx
|
484
|
+
p headers # => { ... }
|
485
|
+
p data # => <Check>
|
486
|
+
rescue Propertyware::ApiError => e
|
487
|
+
puts "Error when calling BillsApi->create_vendor_check_with_http_info: #{e}"
|
488
|
+
end
|
489
|
+
```
|
490
|
+
|
491
|
+
### Parameters
|
492
|
+
|
493
|
+
| Name | Type | Description | Notes |
|
494
|
+
| ---- | ---- | ----------- | ----- |
|
495
|
+
| **save_check** | [**SaveCheck**](SaveCheck.md) | saveCheck | |
|
496
|
+
|
497
|
+
### Return type
|
498
|
+
|
499
|
+
[**Check**](Check.md)
|
500
|
+
|
501
|
+
### Authorization
|
502
|
+
|
503
|
+
[organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
504
|
+
|
505
|
+
### HTTP request headers
|
506
|
+
|
507
|
+
- **Content-Type**: application/json
|
508
|
+
- **Accept**: application/json
|
509
|
+
|
510
|
+
|
511
|
+
## delete_bill
|
512
|
+
|
513
|
+
> <ResponseEntity> delete_bill(bill_id)
|
514
|
+
|
515
|
+
Delete a Bill (BETA)
|
516
|
+
|
517
|
+
<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>
|
518
|
+
|
519
|
+
### Examples
|
520
|
+
|
521
|
+
```ruby
|
522
|
+
require 'time'
|
523
|
+
require 'propertyware'
|
524
|
+
# setup authorization
|
525
|
+
Propertyware.configure do |config|
|
526
|
+
# Configure API key authorization: organizationId
|
527
|
+
config.api_key['organizationId'] = 'YOUR API KEY'
|
528
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
529
|
+
# config.api_key_prefix['organizationId'] = 'Bearer'
|
530
|
+
|
531
|
+
# Configure API key authorization: clientId
|
532
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
533
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
534
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
535
|
+
|
536
|
+
# Configure API key authorization: clientSecret
|
537
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
538
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
539
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
540
|
+
end
|
541
|
+
|
542
|
+
api_instance = Propertyware::BillsApi.new
|
543
|
+
bill_id = 789 # Integer | Bill ID
|
544
|
+
|
545
|
+
begin
|
546
|
+
# Delete a Bill (BETA)
|
547
|
+
result = api_instance.delete_bill(bill_id)
|
548
|
+
p result
|
549
|
+
rescue Propertyware::ApiError => e
|
550
|
+
puts "Error when calling BillsApi->delete_bill: #{e}"
|
551
|
+
end
|
552
|
+
```
|
553
|
+
|
554
|
+
#### Using the delete_bill_with_http_info variant
|
555
|
+
|
556
|
+
This returns an Array which contains the response data, status code and headers.
|
557
|
+
|
558
|
+
> <Array(<ResponseEntity>, Integer, Hash)> delete_bill_with_http_info(bill_id)
|
559
|
+
|
560
|
+
```ruby
|
561
|
+
begin
|
562
|
+
# Delete a Bill (BETA)
|
563
|
+
data, status_code, headers = api_instance.delete_bill_with_http_info(bill_id)
|
564
|
+
p status_code # => 2xx
|
565
|
+
p headers # => { ... }
|
566
|
+
p data # => <ResponseEntity>
|
567
|
+
rescue Propertyware::ApiError => e
|
568
|
+
puts "Error when calling BillsApi->delete_bill_with_http_info: #{e}"
|
569
|
+
end
|
570
|
+
```
|
571
|
+
|
572
|
+
### Parameters
|
573
|
+
|
574
|
+
| Name | Type | Description | Notes |
|
575
|
+
| ---- | ---- | ----------- | ----- |
|
576
|
+
| **bill_id** | **Integer** | Bill ID | |
|
577
|
+
|
578
|
+
### Return type
|
579
|
+
|
580
|
+
[**ResponseEntity**](ResponseEntity.md)
|
581
|
+
|
582
|
+
### Authorization
|
583
|
+
|
584
|
+
[organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
585
|
+
|
586
|
+
### HTTP request headers
|
587
|
+
|
588
|
+
- **Content-Type**: Not defined
|
589
|
+
- **Accept**: application/json
|
590
|
+
|
591
|
+
|
592
|
+
## get_bill
|
593
|
+
|
594
|
+
> <Bill> get_bill(bill_id)
|
595
|
+
|
596
|
+
Retrieve a bill (BETA)
|
597
|
+
|
598
|
+
<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>
|
599
|
+
|
600
|
+
### Examples
|
601
|
+
|
602
|
+
```ruby
|
603
|
+
require 'time'
|
604
|
+
require 'propertyware'
|
605
|
+
# setup authorization
|
606
|
+
Propertyware.configure do |config|
|
607
|
+
# Configure API key authorization: organizationId
|
608
|
+
config.api_key['organizationId'] = 'YOUR API KEY'
|
609
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
610
|
+
# config.api_key_prefix['organizationId'] = 'Bearer'
|
611
|
+
|
612
|
+
# Configure API key authorization: clientId
|
613
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
614
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
615
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
616
|
+
|
617
|
+
# Configure API key authorization: clientSecret
|
618
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
619
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
620
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
621
|
+
end
|
622
|
+
|
623
|
+
api_instance = Propertyware::BillsApi.new
|
624
|
+
bill_id = 789 # Integer | Bill ID
|
625
|
+
|
626
|
+
begin
|
627
|
+
# Retrieve a bill (BETA)
|
628
|
+
result = api_instance.get_bill(bill_id)
|
629
|
+
p result
|
630
|
+
rescue Propertyware::ApiError => e
|
631
|
+
puts "Error when calling BillsApi->get_bill: #{e}"
|
632
|
+
end
|
633
|
+
```
|
634
|
+
|
635
|
+
#### Using the get_bill_with_http_info variant
|
636
|
+
|
637
|
+
This returns an Array which contains the response data, status code and headers.
|
638
|
+
|
639
|
+
> <Array(<Bill>, Integer, Hash)> get_bill_with_http_info(bill_id)
|
640
|
+
|
641
|
+
```ruby
|
642
|
+
begin
|
643
|
+
# Retrieve a bill (BETA)
|
644
|
+
data, status_code, headers = api_instance.get_bill_with_http_info(bill_id)
|
645
|
+
p status_code # => 2xx
|
646
|
+
p headers # => { ... }
|
647
|
+
p data # => <Bill>
|
648
|
+
rescue Propertyware::ApiError => e
|
649
|
+
puts "Error when calling BillsApi->get_bill_with_http_info: #{e}"
|
650
|
+
end
|
651
|
+
```
|
652
|
+
|
653
|
+
### Parameters
|
654
|
+
|
655
|
+
| Name | Type | Description | Notes |
|
656
|
+
| ---- | ---- | ----------- | ----- |
|
657
|
+
| **bill_id** | **Integer** | Bill ID | |
|
658
|
+
|
659
|
+
### Return type
|
660
|
+
|
661
|
+
[**Bill**](Bill.md)
|
662
|
+
|
663
|
+
### Authorization
|
664
|
+
|
665
|
+
[organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
666
|
+
|
667
|
+
### HTTP request headers
|
668
|
+
|
669
|
+
- **Content-Type**: Not defined
|
670
|
+
- **Accept**: application/json
|
671
|
+
|
672
|
+
|
673
|
+
## get_bill_payment
|
674
|
+
|
675
|
+
> <BillPayment> get_bill_payment(bill_payment_id)
|
676
|
+
|
677
|
+
Retrieve a bill payment (BETA)
|
678
|
+
|
679
|
+
<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>
|
680
|
+
|
681
|
+
### Examples
|
682
|
+
|
683
|
+
```ruby
|
684
|
+
require 'time'
|
685
|
+
require 'propertyware'
|
686
|
+
# setup authorization
|
687
|
+
Propertyware.configure do |config|
|
688
|
+
# Configure API key authorization: organizationId
|
689
|
+
config.api_key['organizationId'] = 'YOUR API KEY'
|
690
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
691
|
+
# config.api_key_prefix['organizationId'] = 'Bearer'
|
692
|
+
|
693
|
+
# Configure API key authorization: clientId
|
694
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
695
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
696
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
697
|
+
|
698
|
+
# Configure API key authorization: clientSecret
|
699
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
700
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
701
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
702
|
+
end
|
703
|
+
|
704
|
+
api_instance = Propertyware::BillsApi.new
|
705
|
+
bill_payment_id = 789 # Integer | Bill Payment ID
|
706
|
+
|
707
|
+
begin
|
708
|
+
# Retrieve a bill payment (BETA)
|
709
|
+
result = api_instance.get_bill_payment(bill_payment_id)
|
710
|
+
p result
|
711
|
+
rescue Propertyware::ApiError => e
|
712
|
+
puts "Error when calling BillsApi->get_bill_payment: #{e}"
|
713
|
+
end
|
714
|
+
```
|
715
|
+
|
716
|
+
#### Using the get_bill_payment_with_http_info variant
|
717
|
+
|
718
|
+
This returns an Array which contains the response data, status code and headers.
|
719
|
+
|
720
|
+
> <Array(<BillPayment>, Integer, Hash)> get_bill_payment_with_http_info(bill_payment_id)
|
721
|
+
|
722
|
+
```ruby
|
723
|
+
begin
|
724
|
+
# Retrieve a bill payment (BETA)
|
725
|
+
data, status_code, headers = api_instance.get_bill_payment_with_http_info(bill_payment_id)
|
726
|
+
p status_code # => 2xx
|
727
|
+
p headers # => { ... }
|
728
|
+
p data # => <BillPayment>
|
729
|
+
rescue Propertyware::ApiError => e
|
730
|
+
puts "Error when calling BillsApi->get_bill_payment_with_http_info: #{e}"
|
731
|
+
end
|
732
|
+
```
|
733
|
+
|
734
|
+
### Parameters
|
735
|
+
|
736
|
+
| Name | Type | Description | Notes |
|
737
|
+
| ---- | ---- | ----------- | ----- |
|
738
|
+
| **bill_payment_id** | **Integer** | Bill Payment ID | |
|
739
|
+
|
740
|
+
### Return type
|
741
|
+
|
742
|
+
[**BillPayment**](BillPayment.md)
|
743
|
+
|
744
|
+
### Authorization
|
745
|
+
|
746
|
+
[organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
747
|
+
|
748
|
+
### HTTP request headers
|
749
|
+
|
750
|
+
- **Content-Type**: Not defined
|
751
|
+
- **Accept**: application/json
|
752
|
+
|
753
|
+
|
754
|
+
## get_bill_payments
|
755
|
+
|
756
|
+
> <Array<BillPayment>> get_bill_payments(opts)
|
757
|
+
|
758
|
+
Retrieve all bill payments (BETA)
|
759
|
+
|
760
|
+
<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>
|
761
|
+
|
762
|
+
### Examples
|
763
|
+
|
764
|
+
```ruby
|
765
|
+
require 'time'
|
766
|
+
require 'propertyware'
|
767
|
+
# setup authorization
|
768
|
+
Propertyware.configure do |config|
|
769
|
+
# Configure API key authorization: organizationId
|
770
|
+
config.api_key['organizationId'] = 'YOUR API KEY'
|
771
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
772
|
+
# config.api_key_prefix['organizationId'] = 'Bearer'
|
773
|
+
|
774
|
+
# Configure API key authorization: clientId
|
775
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
776
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
777
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
778
|
+
|
779
|
+
# Configure API key authorization: clientSecret
|
780
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
781
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
782
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
783
|
+
end
|
784
|
+
|
785
|
+
api_instance = Propertyware::BillsApi.new
|
786
|
+
opts = {
|
787
|
+
offset: 56, # Integer | `offset` indicates the position of the first record to return. The offset is zero-based and the default is 0.
|
788
|
+
limit: 56, # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 500 and the default is 100.
|
789
|
+
last_modified_date_time_start: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any item modified on or after the date time specified.
|
790
|
+
last_modified_date_time_end: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any item modified on or prior to the date time specified.
|
791
|
+
orderby: 'orderby_example', # String | Indicates the field(s) and direction to sort the results in the response.
|
792
|
+
vendor_id: 789, # Integer | Filters results to bills associated with a specific vendor.
|
793
|
+
payment_gl_account_id: 789, # Integer | Filters results to bills associated with a specific payment general ledger account.
|
794
|
+
payment_date_start: Date.parse('2013-10-20'), # Date | Filters results to any payment with a date on or after to the date specified.
|
795
|
+
payment_date_end: Date.parse('2013-10-20') # Date | Filters results to any payment with a date on or prior to the date specified.
|
796
|
+
}
|
797
|
+
|
798
|
+
begin
|
799
|
+
# Retrieve all bill payments (BETA)
|
800
|
+
result = api_instance.get_bill_payments(opts)
|
801
|
+
p result
|
802
|
+
rescue Propertyware::ApiError => e
|
803
|
+
puts "Error when calling BillsApi->get_bill_payments: #{e}"
|
804
|
+
end
|
805
|
+
```
|
806
|
+
|
807
|
+
#### Using the get_bill_payments_with_http_info variant
|
808
|
+
|
809
|
+
This returns an Array which contains the response data, status code and headers.
|
810
|
+
|
811
|
+
> <Array(<Array<BillPayment>>, Integer, Hash)> get_bill_payments_with_http_info(opts)
|
812
|
+
|
813
|
+
```ruby
|
814
|
+
begin
|
815
|
+
# Retrieve all bill payments (BETA)
|
816
|
+
data, status_code, headers = api_instance.get_bill_payments_with_http_info(opts)
|
817
|
+
p status_code # => 2xx
|
818
|
+
p headers # => { ... }
|
819
|
+
p data # => <Array<BillPayment>>
|
820
|
+
rescue Propertyware::ApiError => e
|
821
|
+
puts "Error when calling BillsApi->get_bill_payments_with_http_info: #{e}"
|
822
|
+
end
|
823
|
+
```
|
824
|
+
|
825
|
+
### Parameters
|
826
|
+
|
827
|
+
| Name | Type | Description | Notes |
|
828
|
+
| ---- | ---- | ----------- | ----- |
|
829
|
+
| **offset** | **Integer** | `offset` indicates the position of the first record to return. The offset is zero-based and the default is 0. | [optional] |
|
830
|
+
| **limit** | **Integer** | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 500 and the default is 100. | [optional][default to 100] |
|
831
|
+
| **last_modified_date_time_start** | **Time** | Filters results to any item modified on or after the date time specified. | [optional] |
|
832
|
+
| **last_modified_date_time_end** | **Time** | Filters results to any item modified on or prior to the date time specified. | [optional] |
|
833
|
+
| **orderby** | **String** | Indicates the field(s) and direction to sort the results in the response. | [optional] |
|
834
|
+
| **vendor_id** | **Integer** | Filters results to bills associated with a specific vendor. | [optional] |
|
835
|
+
| **payment_gl_account_id** | **Integer** | Filters results to bills associated with a specific payment general ledger account. | [optional] |
|
836
|
+
| **payment_date_start** | **Date** | Filters results to any payment with a date on or after to the date specified. | [optional] |
|
837
|
+
| **payment_date_end** | **Date** | Filters results to any payment with a date on or prior to the date specified. | [optional] |
|
838
|
+
|
839
|
+
### Return type
|
840
|
+
|
841
|
+
[**Array<BillPayment>**](BillPayment.md)
|
842
|
+
|
843
|
+
### Authorization
|
844
|
+
|
845
|
+
[organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
846
|
+
|
847
|
+
### HTTP request headers
|
848
|
+
|
849
|
+
- **Content-Type**: Not defined
|
850
|
+
- **Accept**: application/json
|
851
|
+
|
852
|
+
|
853
|
+
## get_bills
|
854
|
+
|
855
|
+
> <Array<Bill>> get_bills(opts)
|
856
|
+
|
857
|
+
Retrieve all bills (BETA)
|
858
|
+
|
859
|
+
<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>
|
860
|
+
|
861
|
+
### Examples
|
862
|
+
|
863
|
+
```ruby
|
864
|
+
require 'time'
|
865
|
+
require 'propertyware'
|
866
|
+
# setup authorization
|
867
|
+
Propertyware.configure do |config|
|
868
|
+
# Configure API key authorization: organizationId
|
869
|
+
config.api_key['organizationId'] = 'YOUR API KEY'
|
870
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
871
|
+
# config.api_key_prefix['organizationId'] = 'Bearer'
|
872
|
+
|
873
|
+
# Configure API key authorization: clientId
|
874
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
875
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
876
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
877
|
+
|
878
|
+
# Configure API key authorization: clientSecret
|
879
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
880
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
881
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
882
|
+
end
|
883
|
+
|
884
|
+
api_instance = Propertyware::BillsApi.new
|
885
|
+
opts = {
|
886
|
+
offset: 56, # Integer | `offset` indicates the position of the first record to return. The offset is zero-based and the default is 0.
|
887
|
+
limit: 56, # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 500 and the default is 100.
|
888
|
+
last_modified_date_time_start: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any item modified on or after the date time specified.
|
889
|
+
last_modified_date_time_end: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any item modified on or prior to the date time specified.
|
890
|
+
orderby: 'orderby_example', # String | Indicates the field(s) and direction to sort the results in the response.
|
891
|
+
portfolio_id: 789, # Integer | Filters results to bills associated with a specific portfolio.
|
892
|
+
vendor_id: 789, # Integer | Filters results to bills associated with a specific vendor.
|
893
|
+
work_order_id: 789, # Integer | Filters results to bills associated with a specific work order.
|
894
|
+
markup_gl_account_id: 789, # Integer | Filters results to bills associated with a specific markup general ledger account.
|
895
|
+
paid: true, # Boolean | Filters results by the bill's paid status. If no status is specified, bills with any status will be returned.
|
896
|
+
bill_date_start: Date.parse('2013-10-20'), # Date | Filters results to any bill with a billing date on or after to the date specified.
|
897
|
+
bill_date_end: Date.parse('2013-10-20'), # Date | Filters results to any bill with a billing date on or prior to the date specified.
|
898
|
+
due_date_start: Date.parse('2013-10-20'), # Date | Filters results to any bill with a due date on or after to the date specified.
|
899
|
+
due_date_end: Date.parse('2013-10-20') # Date | Filters results to any bill with a due date on or prior to the date specified.
|
900
|
+
}
|
901
|
+
|
902
|
+
begin
|
903
|
+
# Retrieve all bills (BETA)
|
904
|
+
result = api_instance.get_bills(opts)
|
905
|
+
p result
|
906
|
+
rescue Propertyware::ApiError => e
|
907
|
+
puts "Error when calling BillsApi->get_bills: #{e}"
|
908
|
+
end
|
909
|
+
```
|
910
|
+
|
911
|
+
#### Using the get_bills_with_http_info variant
|
912
|
+
|
913
|
+
This returns an Array which contains the response data, status code and headers.
|
914
|
+
|
915
|
+
> <Array(<Array<Bill>>, Integer, Hash)> get_bills_with_http_info(opts)
|
916
|
+
|
917
|
+
```ruby
|
918
|
+
begin
|
919
|
+
# Retrieve all bills (BETA)
|
920
|
+
data, status_code, headers = api_instance.get_bills_with_http_info(opts)
|
921
|
+
p status_code # => 2xx
|
922
|
+
p headers # => { ... }
|
923
|
+
p data # => <Array<Bill>>
|
924
|
+
rescue Propertyware::ApiError => e
|
925
|
+
puts "Error when calling BillsApi->get_bills_with_http_info: #{e}"
|
926
|
+
end
|
927
|
+
```
|
928
|
+
|
929
|
+
### Parameters
|
930
|
+
|
931
|
+
| Name | Type | Description | Notes |
|
932
|
+
| ---- | ---- | ----------- | ----- |
|
933
|
+
| **offset** | **Integer** | `offset` indicates the position of the first record to return. The offset is zero-based and the default is 0. | [optional] |
|
934
|
+
| **limit** | **Integer** | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 500 and the default is 100. | [optional][default to 100] |
|
935
|
+
| **last_modified_date_time_start** | **Time** | Filters results to any item modified on or after the date time specified. | [optional] |
|
936
|
+
| **last_modified_date_time_end** | **Time** | Filters results to any item modified on or prior to the date time specified. | [optional] |
|
937
|
+
| **orderby** | **String** | Indicates the field(s) and direction to sort the results in the response. | [optional] |
|
938
|
+
| **portfolio_id** | **Integer** | Filters results to bills associated with a specific portfolio. | [optional] |
|
939
|
+
| **vendor_id** | **Integer** | Filters results to bills associated with a specific vendor. | [optional] |
|
940
|
+
| **work_order_id** | **Integer** | Filters results to bills associated with a specific work order. | [optional] |
|
941
|
+
| **markup_gl_account_id** | **Integer** | Filters results to bills associated with a specific markup general ledger account. | [optional] |
|
942
|
+
| **paid** | **Boolean** | Filters results by the bill's paid status. If no status is specified, bills with any status will be returned. | [optional] |
|
943
|
+
| **bill_date_start** | **Date** | Filters results to any bill with a billing date on or after to the date specified. | [optional] |
|
944
|
+
| **bill_date_end** | **Date** | Filters results to any bill with a billing date on or prior to the date specified. | [optional] |
|
945
|
+
| **due_date_start** | **Date** | Filters results to any bill with a due date on or after to the date specified. | [optional] |
|
946
|
+
| **due_date_end** | **Date** | Filters results to any bill with a due date on or prior to the date specified. | [optional] |
|
947
|
+
|
948
|
+
### Return type
|
949
|
+
|
950
|
+
[**Array<Bill>**](Bill.md)
|
951
|
+
|
952
|
+
### Authorization
|
953
|
+
|
954
|
+
[organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
955
|
+
|
956
|
+
### HTTP request headers
|
957
|
+
|
958
|
+
- **Content-Type**: Not defined
|
959
|
+
- **Accept**: application/json
|
960
|
+
|
961
|
+
|
962
|
+
## get_vendor_checks
|
963
|
+
|
964
|
+
> <Array<Check>> get_vendor_checks(opts)
|
965
|
+
|
966
|
+
Retrieve all Vendor checks (BETA)
|
967
|
+
|
968
|
+
<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>
|
969
|
+
|
970
|
+
### Examples
|
971
|
+
|
972
|
+
```ruby
|
973
|
+
require 'time'
|
974
|
+
require 'propertyware'
|
975
|
+
# setup authorization
|
976
|
+
Propertyware.configure do |config|
|
977
|
+
# Configure API key authorization: organizationId
|
978
|
+
config.api_key['organizationId'] = 'YOUR API KEY'
|
979
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
980
|
+
# config.api_key_prefix['organizationId'] = 'Bearer'
|
981
|
+
|
982
|
+
# Configure API key authorization: clientId
|
983
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
984
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
985
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
986
|
+
|
987
|
+
# Configure API key authorization: clientSecret
|
988
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
989
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
990
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
991
|
+
end
|
992
|
+
|
993
|
+
api_instance = Propertyware::BillsApi.new
|
994
|
+
opts = {
|
995
|
+
offset: 56, # Integer | `offset` indicates the position of the first record to return. The offset is zero-based and the default is 0.
|
996
|
+
limit: 56, # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 500 and the default is 100.
|
997
|
+
last_modified_date_time_start: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any item modified on or after the date time specified.
|
998
|
+
last_modified_date_time_end: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any item modified on or prior to the date time specified.
|
999
|
+
orderby: 'orderby_example', # String | Indicates the field(s) and direction to sort the results in the response.
|
1000
|
+
post_date_start: Date.parse('2013-10-20'), # Date | Filters results to any transaction with a start date on or after the date specified.
|
1001
|
+
post_date_end: Date.parse('2013-10-20'), # Date | Filters results to any transaction with a start date on or prior to the date specified.
|
1002
|
+
portfolio_id: 789, # Integer | Filters results associated with a specific portfolio.
|
1003
|
+
vendor_id: 789 # Integer | Filters results to transactions associated with a specific vendor.
|
1004
|
+
}
|
1005
|
+
|
1006
|
+
begin
|
1007
|
+
# Retrieve all Vendor checks (BETA)
|
1008
|
+
result = api_instance.get_vendor_checks(opts)
|
1009
|
+
p result
|
1010
|
+
rescue Propertyware::ApiError => e
|
1011
|
+
puts "Error when calling BillsApi->get_vendor_checks: #{e}"
|
1012
|
+
end
|
1013
|
+
```
|
1014
|
+
|
1015
|
+
#### Using the get_vendor_checks_with_http_info variant
|
1016
|
+
|
1017
|
+
This returns an Array which contains the response data, status code and headers.
|
1018
|
+
|
1019
|
+
> <Array(<Array<Check>>, Integer, Hash)> get_vendor_checks_with_http_info(opts)
|
1020
|
+
|
1021
|
+
```ruby
|
1022
|
+
begin
|
1023
|
+
# Retrieve all Vendor checks (BETA)
|
1024
|
+
data, status_code, headers = api_instance.get_vendor_checks_with_http_info(opts)
|
1025
|
+
p status_code # => 2xx
|
1026
|
+
p headers # => { ... }
|
1027
|
+
p data # => <Array<Check>>
|
1028
|
+
rescue Propertyware::ApiError => e
|
1029
|
+
puts "Error when calling BillsApi->get_vendor_checks_with_http_info: #{e}"
|
1030
|
+
end
|
1031
|
+
```
|
1032
|
+
|
1033
|
+
### Parameters
|
1034
|
+
|
1035
|
+
| Name | Type | Description | Notes |
|
1036
|
+
| ---- | ---- | ----------- | ----- |
|
1037
|
+
| **offset** | **Integer** | `offset` indicates the position of the first record to return. The offset is zero-based and the default is 0. | [optional] |
|
1038
|
+
| **limit** | **Integer** | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 500 and the default is 100. | [optional][default to 100] |
|
1039
|
+
| **last_modified_date_time_start** | **Time** | Filters results to any item modified on or after the date time specified. | [optional] |
|
1040
|
+
| **last_modified_date_time_end** | **Time** | Filters results to any item modified on or prior to the date time specified. | [optional] |
|
1041
|
+
| **orderby** | **String** | Indicates the field(s) and direction to sort the results in the response. | [optional] |
|
1042
|
+
| **post_date_start** | **Date** | Filters results to any transaction with a start date on or after the date specified. | [optional] |
|
1043
|
+
| **post_date_end** | **Date** | Filters results to any transaction with a start date on or prior to the date specified. | [optional] |
|
1044
|
+
| **portfolio_id** | **Integer** | Filters results associated with a specific portfolio. | [optional] |
|
1045
|
+
| **vendor_id** | **Integer** | Filters results to transactions associated with a specific vendor. | [optional] |
|
1046
|
+
|
1047
|
+
### Return type
|
1048
|
+
|
1049
|
+
[**Array<Check>**](Check.md)
|
1050
|
+
|
1051
|
+
### Authorization
|
1052
|
+
|
1053
|
+
[organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
1054
|
+
|
1055
|
+
### HTTP request headers
|
1056
|
+
|
1057
|
+
- **Content-Type**: Not defined
|
1058
|
+
- **Accept**: application/json
|
1059
|
+
|
1060
|
+
|
1061
|
+
## update_bill
|
1062
|
+
|
1063
|
+
> <Bill> update_bill(bill_id, save_bill)
|
1064
|
+
|
1065
|
+
Update a Bill (BETA)
|
1066
|
+
|
1067
|
+
<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>
|
1068
|
+
|
1069
|
+
### Examples
|
1070
|
+
|
1071
|
+
```ruby
|
1072
|
+
require 'time'
|
1073
|
+
require 'propertyware'
|
1074
|
+
# setup authorization
|
1075
|
+
Propertyware.configure do |config|
|
1076
|
+
# Configure API key authorization: organizationId
|
1077
|
+
config.api_key['organizationId'] = 'YOUR API KEY'
|
1078
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1079
|
+
# config.api_key_prefix['organizationId'] = 'Bearer'
|
1080
|
+
|
1081
|
+
# Configure API key authorization: clientId
|
1082
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
1083
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1084
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
1085
|
+
|
1086
|
+
# Configure API key authorization: clientSecret
|
1087
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
1088
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1089
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
1090
|
+
end
|
1091
|
+
|
1092
|
+
api_instance = Propertyware::BillsApi.new
|
1093
|
+
bill_id = 789 # Integer | Bill ID
|
1094
|
+
save_bill = Propertyware::SaveBill.new({bill_date: Date.today, due_date: Date.today, vendor_id: 3.56}) # SaveBill | saveBill
|
1095
|
+
|
1096
|
+
begin
|
1097
|
+
# Update a Bill (BETA)
|
1098
|
+
result = api_instance.update_bill(bill_id, save_bill)
|
1099
|
+
p result
|
1100
|
+
rescue Propertyware::ApiError => e
|
1101
|
+
puts "Error when calling BillsApi->update_bill: #{e}"
|
1102
|
+
end
|
1103
|
+
```
|
1104
|
+
|
1105
|
+
#### Using the update_bill_with_http_info variant
|
1106
|
+
|
1107
|
+
This returns an Array which contains the response data, status code and headers.
|
1108
|
+
|
1109
|
+
> <Array(<Bill>, Integer, Hash)> update_bill_with_http_info(bill_id, save_bill)
|
1110
|
+
|
1111
|
+
```ruby
|
1112
|
+
begin
|
1113
|
+
# Update a Bill (BETA)
|
1114
|
+
data, status_code, headers = api_instance.update_bill_with_http_info(bill_id, save_bill)
|
1115
|
+
p status_code # => 2xx
|
1116
|
+
p headers # => { ... }
|
1117
|
+
p data # => <Bill>
|
1118
|
+
rescue Propertyware::ApiError => e
|
1119
|
+
puts "Error when calling BillsApi->update_bill_with_http_info: #{e}"
|
1120
|
+
end
|
1121
|
+
```
|
1122
|
+
|
1123
|
+
### Parameters
|
1124
|
+
|
1125
|
+
| Name | Type | Description | Notes |
|
1126
|
+
| ---- | ---- | ----------- | ----- |
|
1127
|
+
| **bill_id** | **Integer** | Bill ID | |
|
1128
|
+
| **save_bill** | [**SaveBill**](SaveBill.md) | saveBill | |
|
1129
|
+
|
1130
|
+
### Return type
|
1131
|
+
|
1132
|
+
[**Bill**](Bill.md)
|
1133
|
+
|
1134
|
+
### Authorization
|
1135
|
+
|
1136
|
+
[organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
1137
|
+
|
1138
|
+
### HTTP request headers
|
1139
|
+
|
1140
|
+
- **Content-Type**: application/json
|
1141
|
+
- **Accept**: application/json
|
1142
|
+
|
1143
|
+
|
1144
|
+
## update_bill_payment
|
1145
|
+
|
1146
|
+
> <BillPayment> update_bill_payment(bill_payment_id, save_bill_payment)
|
1147
|
+
|
1148
|
+
Update a Bill Payment (BETA)
|
1149
|
+
|
1150
|
+
<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>
|
1151
|
+
|
1152
|
+
### Examples
|
1153
|
+
|
1154
|
+
```ruby
|
1155
|
+
require 'time'
|
1156
|
+
require 'propertyware'
|
1157
|
+
# setup authorization
|
1158
|
+
Propertyware.configure do |config|
|
1159
|
+
# Configure API key authorization: organizationId
|
1160
|
+
config.api_key['organizationId'] = 'YOUR API KEY'
|
1161
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1162
|
+
# config.api_key_prefix['organizationId'] = 'Bearer'
|
1163
|
+
|
1164
|
+
# Configure API key authorization: clientId
|
1165
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
1166
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1167
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
1168
|
+
|
1169
|
+
# Configure API key authorization: clientSecret
|
1170
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
1171
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1172
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
1173
|
+
end
|
1174
|
+
|
1175
|
+
api_instance = Propertyware::BillsApi.new
|
1176
|
+
bill_payment_id = 789 # Integer | Bill Payment ID
|
1177
|
+
save_bill_payment = Propertyware::SaveBillPayment.new # SaveBillPayment | saveBillPayment
|
1178
|
+
|
1179
|
+
begin
|
1180
|
+
# Update a Bill Payment (BETA)
|
1181
|
+
result = api_instance.update_bill_payment(bill_payment_id, save_bill_payment)
|
1182
|
+
p result
|
1183
|
+
rescue Propertyware::ApiError => e
|
1184
|
+
puts "Error when calling BillsApi->update_bill_payment: #{e}"
|
1185
|
+
end
|
1186
|
+
```
|
1187
|
+
|
1188
|
+
#### Using the update_bill_payment_with_http_info variant
|
1189
|
+
|
1190
|
+
This returns an Array which contains the response data, status code and headers.
|
1191
|
+
|
1192
|
+
> <Array(<BillPayment>, Integer, Hash)> update_bill_payment_with_http_info(bill_payment_id, save_bill_payment)
|
1193
|
+
|
1194
|
+
```ruby
|
1195
|
+
begin
|
1196
|
+
# Update a Bill Payment (BETA)
|
1197
|
+
data, status_code, headers = api_instance.update_bill_payment_with_http_info(bill_payment_id, save_bill_payment)
|
1198
|
+
p status_code # => 2xx
|
1199
|
+
p headers # => { ... }
|
1200
|
+
p data # => <BillPayment>
|
1201
|
+
rescue Propertyware::ApiError => e
|
1202
|
+
puts "Error when calling BillsApi->update_bill_payment_with_http_info: #{e}"
|
1203
|
+
end
|
1204
|
+
```
|
1205
|
+
|
1206
|
+
### Parameters
|
1207
|
+
|
1208
|
+
| Name | Type | Description | Notes |
|
1209
|
+
| ---- | ---- | ----------- | ----- |
|
1210
|
+
| **bill_payment_id** | **Integer** | Bill Payment ID | |
|
1211
|
+
| **save_bill_payment** | [**SaveBillPayment**](SaveBillPayment.md) | saveBillPayment | |
|
1212
|
+
|
1213
|
+
### Return type
|
1214
|
+
|
1215
|
+
[**BillPayment**](BillPayment.md)
|
1216
|
+
|
1217
|
+
### Authorization
|
1218
|
+
|
1219
|
+
[organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
1220
|
+
|
1221
|
+
### HTTP request headers
|
1222
|
+
|
1223
|
+
- **Content-Type**: application/json
|
1224
|
+
- **Accept**: application/json
|
1225
|
+
|
1226
|
+
|
1227
|
+
## update_credit
|
1228
|
+
|
1229
|
+
> <Bill> update_credit(credit_id, save_credit)
|
1230
|
+
|
1231
|
+
Update a Credit (BETA)
|
1232
|
+
|
1233
|
+
<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>
|
1234
|
+
|
1235
|
+
### Examples
|
1236
|
+
|
1237
|
+
```ruby
|
1238
|
+
require 'time'
|
1239
|
+
require 'propertyware'
|
1240
|
+
# setup authorization
|
1241
|
+
Propertyware.configure do |config|
|
1242
|
+
# Configure API key authorization: organizationId
|
1243
|
+
config.api_key['organizationId'] = 'YOUR API KEY'
|
1244
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1245
|
+
# config.api_key_prefix['organizationId'] = 'Bearer'
|
1246
|
+
|
1247
|
+
# Configure API key authorization: clientId
|
1248
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
1249
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1250
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
1251
|
+
|
1252
|
+
# Configure API key authorization: clientSecret
|
1253
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
1254
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1255
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
1256
|
+
end
|
1257
|
+
|
1258
|
+
api_instance = Propertyware::BillsApi.new
|
1259
|
+
credit_id = 789 # Integer | Credit ID
|
1260
|
+
save_credit = Propertyware::SaveCredit.new({bill_date: Date.today, vendor_id: 3.56}) # SaveCredit | saveCredit
|
1261
|
+
|
1262
|
+
begin
|
1263
|
+
# Update a Credit (BETA)
|
1264
|
+
result = api_instance.update_credit(credit_id, save_credit)
|
1265
|
+
p result
|
1266
|
+
rescue Propertyware::ApiError => e
|
1267
|
+
puts "Error when calling BillsApi->update_credit: #{e}"
|
1268
|
+
end
|
1269
|
+
```
|
1270
|
+
|
1271
|
+
#### Using the update_credit_with_http_info variant
|
1272
|
+
|
1273
|
+
This returns an Array which contains the response data, status code and headers.
|
1274
|
+
|
1275
|
+
> <Array(<Bill>, Integer, Hash)> update_credit_with_http_info(credit_id, save_credit)
|
1276
|
+
|
1277
|
+
```ruby
|
1278
|
+
begin
|
1279
|
+
# Update a Credit (BETA)
|
1280
|
+
data, status_code, headers = api_instance.update_credit_with_http_info(credit_id, save_credit)
|
1281
|
+
p status_code # => 2xx
|
1282
|
+
p headers # => { ... }
|
1283
|
+
p data # => <Bill>
|
1284
|
+
rescue Propertyware::ApiError => e
|
1285
|
+
puts "Error when calling BillsApi->update_credit_with_http_info: #{e}"
|
1286
|
+
end
|
1287
|
+
```
|
1288
|
+
|
1289
|
+
### Parameters
|
1290
|
+
|
1291
|
+
| Name | Type | Description | Notes |
|
1292
|
+
| ---- | ---- | ----------- | ----- |
|
1293
|
+
| **credit_id** | **Integer** | Credit ID | |
|
1294
|
+
| **save_credit** | [**SaveCredit**](SaveCredit.md) | saveCredit | |
|
1295
|
+
|
1296
|
+
### Return type
|
1297
|
+
|
1298
|
+
[**Bill**](Bill.md)
|
1299
|
+
|
1300
|
+
### Authorization
|
1301
|
+
|
1302
|
+
[organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
1303
|
+
|
1304
|
+
### HTTP request headers
|
1305
|
+
|
1306
|
+
- **Content-Type**: application/json
|
1307
|
+
- **Accept**: application/json
|
1308
|
+
|
1309
|
+
|
1310
|
+
## update_vendor_check
|
1311
|
+
|
1312
|
+
> <Check> update_vendor_check(vendor_check_id, save_check)
|
1313
|
+
|
1314
|
+
Update a Vendor check (BETA)
|
1315
|
+
|
1316
|
+
<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>
|
1317
|
+
|
1318
|
+
### Examples
|
1319
|
+
|
1320
|
+
```ruby
|
1321
|
+
require 'time'
|
1322
|
+
require 'propertyware'
|
1323
|
+
# setup authorization
|
1324
|
+
Propertyware.configure do |config|
|
1325
|
+
# Configure API key authorization: organizationId
|
1326
|
+
config.api_key['organizationId'] = 'YOUR API KEY'
|
1327
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1328
|
+
# config.api_key_prefix['organizationId'] = 'Bearer'
|
1329
|
+
|
1330
|
+
# Configure API key authorization: clientId
|
1331
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
1332
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1333
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
1334
|
+
|
1335
|
+
# Configure API key authorization: clientSecret
|
1336
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
1337
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1338
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
1339
|
+
end
|
1340
|
+
|
1341
|
+
api_instance = Propertyware::BillsApi.new
|
1342
|
+
vendor_check_id = 789 # Integer | Vendor Check ID
|
1343
|
+
save_check = Propertyware::SaveCheck.new({check_date: Date.today, destination_account_id: 3.56}) # SaveCheck | saveCheck
|
1344
|
+
|
1345
|
+
begin
|
1346
|
+
# Update a Vendor check (BETA)
|
1347
|
+
result = api_instance.update_vendor_check(vendor_check_id, save_check)
|
1348
|
+
p result
|
1349
|
+
rescue Propertyware::ApiError => e
|
1350
|
+
puts "Error when calling BillsApi->update_vendor_check: #{e}"
|
1351
|
+
end
|
1352
|
+
```
|
1353
|
+
|
1354
|
+
#### Using the update_vendor_check_with_http_info variant
|
1355
|
+
|
1356
|
+
This returns an Array which contains the response data, status code and headers.
|
1357
|
+
|
1358
|
+
> <Array(<Check>, Integer, Hash)> update_vendor_check_with_http_info(vendor_check_id, save_check)
|
1359
|
+
|
1360
|
+
```ruby
|
1361
|
+
begin
|
1362
|
+
# Update a Vendor check (BETA)
|
1363
|
+
data, status_code, headers = api_instance.update_vendor_check_with_http_info(vendor_check_id, save_check)
|
1364
|
+
p status_code # => 2xx
|
1365
|
+
p headers # => { ... }
|
1366
|
+
p data # => <Check>
|
1367
|
+
rescue Propertyware::ApiError => e
|
1368
|
+
puts "Error when calling BillsApi->update_vendor_check_with_http_info: #{e}"
|
1369
|
+
end
|
1370
|
+
```
|
1371
|
+
|
1372
|
+
### Parameters
|
1373
|
+
|
1374
|
+
| Name | Type | Description | Notes |
|
1375
|
+
| ---- | ---- | ----------- | ----- |
|
1376
|
+
| **vendor_check_id** | **Integer** | Vendor Check ID | |
|
1377
|
+
| **save_check** | [**SaveCheck**](SaveCheck.md) | saveCheck | |
|
1378
|
+
|
1379
|
+
### Return type
|
1380
|
+
|
1381
|
+
[**Check**](Check.md)
|
1382
|
+
|
1383
|
+
### Authorization
|
1384
|
+
|
1385
|
+
[organizationId](../README.md#organizationId), [clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
1386
|
+
|
1387
|
+
### HTTP request headers
|
1388
|
+
|
1389
|
+
- **Content-Type**: application/json
|
1390
|
+
- **Accept**: application/json
|
1391
|
+
|