=begin #Open API, powered by Buildium # # Introduction ### Welcome! Welcome to Buildium’s API—a powerful, RESTful programming interface that lets you leverage valuable Buildium data. Using HTTP requests, you can create integrations with applications that specialize in accounting, lead tracking, and more. Enjoy greater flexibility, transparency, and control over your business! ### What's in this Guide? This guide is full of simple, easy-to-follow instructions that’ll help you use Buildium’s API like a pro. Topics include: * choosing the right resources for your use case * making HTTP requests to any resource * understanding data and response codes
# Getting Started Excited to get going? We’ll walk you through the setup process. > **Note:** To take advantage of the Buildium Open API you must have a **Premium Subscription**. ## Account Configuration Before you can use Buildium’s API, you’ll need to make some tweaks to your account settings.
### 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 ***Application settings*** to set things up properly.
​ **Let's Begin!** 1. Sign in to your [Buildium](https://signin.managebuilding.com/manager/public/authentication/login?ReturnUrl=%2Fmanager%2F) account from your browser. 2. Open the ***Settings*** menu and click ***Application settings***. 3. Under ***System preferences***, click ***Api settings***. A modal will appear. 4. Click the ***Open API*** toggle to turn it on. Then click ***Save***. Congratulations! Your account's enabled. Now, you’re ready to start managing API keys.

If you are having issues enabling the API 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 Buildium account 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! > **Tip:** You’ll need an administrator user role to complete this step, too.
**How to create an API key** 1. Sign in to your [Buildium](https://signin.managebuilding.com/manager/public/authentication/login?ReturnUrl=%2Fmanager%2F) account from your browser. 2. Open the ***Settings*** menu and click ***Developer Tools***. The page will open automatically. 3. Click the ***Create API Key*** button. A modal will appear. 4. 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. Once finished, click **Next**. 5. Now, choose which pieces of Buildium data you want this API key to have access to by marking the corresponding checkboxes. Once finished, click **Next**. 6. You successfully created an API key! > **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 Buildium API! Before moving on to [making your first request](#section/Getting-Started/How-to-Make-a-Request) please review [Keeping your Keys Safe](#section/Getting-Started/Keeping-your-Keys-Safe) for an overview on securely storing your API keys.
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 Buildium 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 Buildium 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 Buildium account.

## 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 Buildium account. Your API key is how the Buildium API authenticates requests and ensures only you can access your data. See [Getting Started](#section/Getting-Started) for a deeper dive into enabling the API and creating keys. #### Step 2: Install a HTTP client The Buildium 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 Buildium 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 [Rental Properties](#operation/RentalsGetAllGLAccounts) response message now includes the property `IsBankAccount`. This is a boolean property that indicates whether the general ledger account is also a bank account. * A `Country` property has been added to all Address messages. This property contains an enumeration indicating the country of the address. The version of the OpenAPI document: v1 Generated by: https://openapi-generator.tech OpenAPI Generator version: 6.0.1 =end require 'cgi' module Buildium class OwnershipAccountTransactionsApi attr_accessor :api_client def initialize(api_client = ApiClient.default) @api_client = api_client end # Create a payment (auto allocated) # Creates a payment on the ownership account ledger. Note that the recorded payment will be automatically allocated to the general ledger accounts based on the payment allocation settings. These settings can be found under the Settings > Application Settings > Residents page in your account. If you'd like to specify the general ledger accounts the payment should apply to, please use the Create a payment endpoint.

Required permission(s):

Associations > Ownership account transactions - `View` `Edit` # @param ownership_account_id [Integer] # @param create_ownership_account_auto_allocated_payment_request [CreateOwnershipAccountAutoAllocatedPaymentRequest] # @param [Hash] opts the optional parameters # @return [OwnershipAccountTransactionMessage] def create_ownership_account_auto_allocated_payment(ownership_account_id, create_ownership_account_auto_allocated_payment_request, opts = {}) data, _status_code, _headers = create_ownership_account_auto_allocated_payment_with_http_info(ownership_account_id, create_ownership_account_auto_allocated_payment_request, opts) data end # Create a payment (auto allocated) # Creates a payment on the ownership account ledger. Note that the recorded payment will be automatically allocated to the general ledger accounts based on the payment allocation settings. These settings can be found under the Settings > Application Settings > Residents page in your account. If you'd like to specify the general ledger accounts the payment should apply to, please use the <a href=\"#operation/CreateOwnershipAccountLedgerPayment\">Create a payment</a> endpoint. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Ownership account transactions</span> - `View` `Edit` # @param ownership_account_id [Integer] # @param create_ownership_account_auto_allocated_payment_request [CreateOwnershipAccountAutoAllocatedPaymentRequest] # @param [Hash] opts the optional parameters # @return [Array<(OwnershipAccountTransactionMessage, Integer, Hash)>] OwnershipAccountTransactionMessage data, response status code and response headers def create_ownership_account_auto_allocated_payment_with_http_info(ownership_account_id, create_ownership_account_auto_allocated_payment_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.create_ownership_account_auto_allocated_payment ...' end # verify the required parameter 'ownership_account_id' is set if @api_client.config.client_side_validation && ownership_account_id.nil? fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling OwnershipAccountTransactionsApi.create_ownership_account_auto_allocated_payment" end # verify the required parameter 'create_ownership_account_auto_allocated_payment_request' is set if @api_client.config.client_side_validation && create_ownership_account_auto_allocated_payment_request.nil? fail ArgumentError, "Missing the required parameter 'create_ownership_account_auto_allocated_payment_request' when calling OwnershipAccountTransactionsApi.create_ownership_account_auto_allocated_payment" end # resource path local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/autoallocatedpayments'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(ownership_account_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(create_ownership_account_auto_allocated_payment_request) # return_type return_type = opts[:debug_return_type] || 'OwnershipAccountTransactionMessage' # auth_names auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret'] new_options = opts.merge( :operation => :"OwnershipAccountTransactionsApi.create_ownership_account_auto_allocated_payment", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: OwnershipAccountTransactionsApi#create_ownership_account_auto_allocated_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Create a credit # Creates a ledger credit.

Required permission(s):

Associations > Ownership account transactions - `View` `Edit` # @param ownership_account_id [Integer] # @param create_ownership_account_credit_request [CreateOwnershipAccountCreditRequest] # @param [Hash] opts the optional parameters # @return [OwnershipAccountTransactionMessage] def create_ownership_account_credit(ownership_account_id, create_ownership_account_credit_request, opts = {}) data, _status_code, _headers = create_ownership_account_credit_with_http_info(ownership_account_id, create_ownership_account_credit_request, opts) data end # Create a credit # Creates a ledger credit. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Ownership account transactions</span> - `View` `Edit` # @param ownership_account_id [Integer] # @param create_ownership_account_credit_request [CreateOwnershipAccountCreditRequest] # @param [Hash] opts the optional parameters # @return [Array<(OwnershipAccountTransactionMessage, Integer, Hash)>] OwnershipAccountTransactionMessage data, response status code and response headers def create_ownership_account_credit_with_http_info(ownership_account_id, create_ownership_account_credit_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.create_ownership_account_credit ...' end # verify the required parameter 'ownership_account_id' is set if @api_client.config.client_side_validation && ownership_account_id.nil? fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling OwnershipAccountTransactionsApi.create_ownership_account_credit" end # verify the required parameter 'create_ownership_account_credit_request' is set if @api_client.config.client_side_validation && create_ownership_account_credit_request.nil? fail ArgumentError, "Missing the required parameter 'create_ownership_account_credit_request' when calling OwnershipAccountTransactionsApi.create_ownership_account_credit" end # resource path local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/credits'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(ownership_account_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(create_ownership_account_credit_request) # return_type return_type = opts[:debug_return_type] || 'OwnershipAccountTransactionMessage' # auth_names auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret'] new_options = opts.merge( :operation => :"OwnershipAccountTransactionsApi.create_ownership_account_credit", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: OwnershipAccountTransactionsApi#create_ownership_account_credit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Create a recurring credit # Creates a recurring credit transaction that will post automatically on the specified ownership account ledger.

Required permission(s):

Associations > Ownership account transactions - `View` `Edit` # @param ownership_account_id [Integer] # @param create_ownership_account_credit_recurring_transaction_request [CreateOwnershipAccountCreditRecurringTransactionRequest] # @param [Hash] opts the optional parameters # @return [OwnershipAccountRecurringCreditMessage] def create_ownership_account_credit_recurring_transaction(ownership_account_id, create_ownership_account_credit_recurring_transaction_request, opts = {}) data, _status_code, _headers = create_ownership_account_credit_recurring_transaction_with_http_info(ownership_account_id, create_ownership_account_credit_recurring_transaction_request, opts) data end # Create a recurring credit # Creates a recurring credit transaction that will post automatically on the specified ownership account ledger. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Ownership account transactions</span> - `View` `Edit` # @param ownership_account_id [Integer] # @param create_ownership_account_credit_recurring_transaction_request [CreateOwnershipAccountCreditRecurringTransactionRequest] # @param [Hash] opts the optional parameters # @return [Array<(OwnershipAccountRecurringCreditMessage, Integer, Hash)>] OwnershipAccountRecurringCreditMessage data, response status code and response headers def create_ownership_account_credit_recurring_transaction_with_http_info(ownership_account_id, create_ownership_account_credit_recurring_transaction_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.create_ownership_account_credit_recurring_transaction ...' end # verify the required parameter 'ownership_account_id' is set if @api_client.config.client_side_validation && ownership_account_id.nil? fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling OwnershipAccountTransactionsApi.create_ownership_account_credit_recurring_transaction" end # verify the required parameter 'create_ownership_account_credit_recurring_transaction_request' is set if @api_client.config.client_side_validation && create_ownership_account_credit_recurring_transaction_request.nil? fail ArgumentError, "Missing the required parameter 'create_ownership_account_credit_recurring_transaction_request' when calling OwnershipAccountTransactionsApi.create_ownership_account_credit_recurring_transaction" end # resource path local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/recurringcredits'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(ownership_account_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(create_ownership_account_credit_recurring_transaction_request) # return_type return_type = opts[:debug_return_type] || 'OwnershipAccountRecurringCreditMessage' # auth_names auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret'] new_options = opts.merge( :operation => :"OwnershipAccountTransactionsApi.create_ownership_account_credit_recurring_transaction", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: OwnershipAccountTransactionsApi#create_ownership_account_credit_recurring_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Create a deposit withholding # Withholds an association owner deposit by reallocating the funds from a liability account to an income account to cover an expense(s).

Required permission(s):

Associations > Ownership account transactions - `View` `Edit` Accounting > General Ledger Accounts - `View` # @param ownership_account_id [Integer] # @param create_ownership_account_deposit_withholding_request [CreateOwnershipAccountDepositWithholdingRequest] # @param [Hash] opts the optional parameters # @return [OwnershipAccountTransactionMessage] def create_ownership_account_deposit_withholding(ownership_account_id, create_ownership_account_deposit_withholding_request, opts = {}) data, _status_code, _headers = create_ownership_account_deposit_withholding_with_http_info(ownership_account_id, create_ownership_account_deposit_withholding_request, opts) data end # Create a deposit withholding # Withholds an association owner deposit by reallocating the funds from a liability account to an income account to cover an expense(s). <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Ownership account transactions</span> - `View` `Edit` <span class=\"permissionBlock\">Accounting > General Ledger Accounts</span> - `View` # @param ownership_account_id [Integer] # @param create_ownership_account_deposit_withholding_request [CreateOwnershipAccountDepositWithholdingRequest] # @param [Hash] opts the optional parameters # @return [Array<(OwnershipAccountTransactionMessage, Integer, Hash)>] OwnershipAccountTransactionMessage data, response status code and response headers def create_ownership_account_deposit_withholding_with_http_info(ownership_account_id, create_ownership_account_deposit_withholding_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.create_ownership_account_deposit_withholding ...' end # verify the required parameter 'ownership_account_id' is set if @api_client.config.client_side_validation && ownership_account_id.nil? fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling OwnershipAccountTransactionsApi.create_ownership_account_deposit_withholding" end # verify the required parameter 'create_ownership_account_deposit_withholding_request' is set if @api_client.config.client_side_validation && create_ownership_account_deposit_withholding_request.nil? fail ArgumentError, "Missing the required parameter 'create_ownership_account_deposit_withholding_request' when calling OwnershipAccountTransactionsApi.create_ownership_account_deposit_withholding" end # resource path local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/applieddeposits'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(ownership_account_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(create_ownership_account_deposit_withholding_request) # return_type return_type = opts[:debug_return_type] || 'OwnershipAccountTransactionMessage' # auth_names auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret'] new_options = opts.merge( :operation => :"OwnershipAccountTransactionsApi.create_ownership_account_deposit_withholding", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: OwnershipAccountTransactionsApi#create_ownership_account_deposit_withholding\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Create a charge # Creates a ledger charge.

Required permission(s):

Associations > Ownership account transactions - `View` `Edit`
Accounting > Bills - `View` `Edit` In order to associate the charge to a bill using the BillId property, you must have this permission. # @param ownership_account_id [Integer] The ownership account identifier. # @param create_ownership_account_ledger_charge_request [CreateOwnershipAccountLedgerChargeRequest] # @param [Hash] opts the optional parameters # @return [OwnershipAccountTransactionMessage] def create_ownership_account_ledger_charge(ownership_account_id, create_ownership_account_ledger_charge_request, opts = {}) data, _status_code, _headers = create_ownership_account_ledger_charge_with_http_info(ownership_account_id, create_ownership_account_ledger_charge_request, opts) data end # Create a charge # Creates a ledger charge. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Ownership account transactions</span> - `View` `Edit` <br /><span class=\"permissionBlock\">Accounting > Bills</span> - `View` `Edit` In order to associate the charge to a bill using the BillId property, you must have this permission. # @param ownership_account_id [Integer] The ownership account identifier. # @param create_ownership_account_ledger_charge_request [CreateOwnershipAccountLedgerChargeRequest] # @param [Hash] opts the optional parameters # @return [Array<(OwnershipAccountTransactionMessage, Integer, Hash)>] OwnershipAccountTransactionMessage data, response status code and response headers def create_ownership_account_ledger_charge_with_http_info(ownership_account_id, create_ownership_account_ledger_charge_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.create_ownership_account_ledger_charge ...' end # verify the required parameter 'ownership_account_id' is set if @api_client.config.client_side_validation && ownership_account_id.nil? fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling OwnershipAccountTransactionsApi.create_ownership_account_ledger_charge" end # verify the required parameter 'create_ownership_account_ledger_charge_request' is set if @api_client.config.client_side_validation && create_ownership_account_ledger_charge_request.nil? fail ArgumentError, "Missing the required parameter 'create_ownership_account_ledger_charge_request' when calling OwnershipAccountTransactionsApi.create_ownership_account_ledger_charge" end # resource path local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/charges'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(ownership_account_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(create_ownership_account_ledger_charge_request) # return_type return_type = opts[:debug_return_type] || 'OwnershipAccountTransactionMessage' # auth_names auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret'] new_options = opts.merge( :operation => :"OwnershipAccountTransactionsApi.create_ownership_account_ledger_charge", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: OwnershipAccountTransactionsApi#create_ownership_account_ledger_charge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Create a payment # Creates a ledger payment.

Required permission(s):

Associations > Ownership account transactions - `View` `Edit` # @param ownership_account_id [Integer] # @param create_ownership_account_ledger_payment_request [CreateOwnershipAccountLedgerPaymentRequest] # @param [Hash] opts the optional parameters # @return [OwnershipAccountTransactionMessage] def create_ownership_account_ledger_payment(ownership_account_id, create_ownership_account_ledger_payment_request, opts = {}) data, _status_code, _headers = create_ownership_account_ledger_payment_with_http_info(ownership_account_id, create_ownership_account_ledger_payment_request, opts) data end # Create a payment # Creates a ledger payment. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Ownership account transactions</span> - `View` `Edit` # @param ownership_account_id [Integer] # @param create_ownership_account_ledger_payment_request [CreateOwnershipAccountLedgerPaymentRequest] # @param [Hash] opts the optional parameters # @return [Array<(OwnershipAccountTransactionMessage, Integer, Hash)>] OwnershipAccountTransactionMessage data, response status code and response headers def create_ownership_account_ledger_payment_with_http_info(ownership_account_id, create_ownership_account_ledger_payment_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.create_ownership_account_ledger_payment ...' end # verify the required parameter 'ownership_account_id' is set if @api_client.config.client_side_validation && ownership_account_id.nil? fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling OwnershipAccountTransactionsApi.create_ownership_account_ledger_payment" end # verify the required parameter 'create_ownership_account_ledger_payment_request' is set if @api_client.config.client_side_validation && create_ownership_account_ledger_payment_request.nil? fail ArgumentError, "Missing the required parameter 'create_ownership_account_ledger_payment_request' when calling OwnershipAccountTransactionsApi.create_ownership_account_ledger_payment" end # resource path local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/payments'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(ownership_account_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(create_ownership_account_ledger_payment_request) # return_type return_type = opts[:debug_return_type] || 'OwnershipAccountTransactionMessage' # auth_names auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret'] new_options = opts.merge( :operation => :"OwnershipAccountTransactionsApi.create_ownership_account_ledger_payment", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: OwnershipAccountTransactionsApi#create_ownership_account_ledger_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Create a recurring payment # Creates a recurring payment that will post automatically on the specified ownership account ledger.

Required permission(s):

Associations > Ownership account transactions - `View` `Edit` # @param ownership_account_id [Integer] # @param create_ownership_account_recurring_payment_request [CreateOwnershipAccountRecurringPaymentRequest] # @param [Hash] opts the optional parameters # @return [OwnershipAccountRecurringPaymentMessage] def create_ownership_account_recurring_payment(ownership_account_id, create_ownership_account_recurring_payment_request, opts = {}) data, _status_code, _headers = create_ownership_account_recurring_payment_with_http_info(ownership_account_id, create_ownership_account_recurring_payment_request, opts) data end # Create a recurring payment # Creates a recurring payment that will post automatically on the specified ownership account ledger. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Ownership account transactions</span> - `View` `Edit` # @param ownership_account_id [Integer] # @param create_ownership_account_recurring_payment_request [CreateOwnershipAccountRecurringPaymentRequest] # @param [Hash] opts the optional parameters # @return [Array<(OwnershipAccountRecurringPaymentMessage, Integer, Hash)>] OwnershipAccountRecurringPaymentMessage data, response status code and response headers def create_ownership_account_recurring_payment_with_http_info(ownership_account_id, create_ownership_account_recurring_payment_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.create_ownership_account_recurring_payment ...' end # verify the required parameter 'ownership_account_id' is set if @api_client.config.client_side_validation && ownership_account_id.nil? fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling OwnershipAccountTransactionsApi.create_ownership_account_recurring_payment" end # verify the required parameter 'create_ownership_account_recurring_payment_request' is set if @api_client.config.client_side_validation && create_ownership_account_recurring_payment_request.nil? fail ArgumentError, "Missing the required parameter 'create_ownership_account_recurring_payment_request' when calling OwnershipAccountTransactionsApi.create_ownership_account_recurring_payment" end # resource path local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/recurringpayments'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(ownership_account_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(create_ownership_account_recurring_payment_request) # return_type return_type = opts[:debug_return_type] || 'OwnershipAccountRecurringPaymentMessage' # auth_names auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret'] new_options = opts.merge( :operation => :"OwnershipAccountTransactionsApi.create_ownership_account_recurring_payment", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: OwnershipAccountTransactionsApi#create_ownership_account_recurring_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Create a refund # Creates a refund.

Required permission(s):

Accounting > Bank Accounts - `View` `Edit` # @param ownership_account_id [Integer] # @param create_ownership_account_refund_request [CreateOwnershipAccountRefundRequest] # @param [Hash] opts the optional parameters # @return [OwnershipAccountRefundMessage] def create_ownership_account_refund(ownership_account_id, create_ownership_account_refund_request, opts = {}) data, _status_code, _headers = create_ownership_account_refund_with_http_info(ownership_account_id, create_ownership_account_refund_request, opts) data end # Create a refund # Creates a refund. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting > Bank Accounts</span> - `View` `Edit` # @param ownership_account_id [Integer] # @param create_ownership_account_refund_request [CreateOwnershipAccountRefundRequest] # @param [Hash] opts the optional parameters # @return [Array<(OwnershipAccountRefundMessage, Integer, Hash)>] OwnershipAccountRefundMessage data, response status code and response headers def create_ownership_account_refund_with_http_info(ownership_account_id, create_ownership_account_refund_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.create_ownership_account_refund ...' end # verify the required parameter 'ownership_account_id' is set if @api_client.config.client_side_validation && ownership_account_id.nil? fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling OwnershipAccountTransactionsApi.create_ownership_account_refund" end # verify the required parameter 'create_ownership_account_refund_request' is set if @api_client.config.client_side_validation && create_ownership_account_refund_request.nil? fail ArgumentError, "Missing the required parameter 'create_ownership_account_refund_request' when calling OwnershipAccountTransactionsApi.create_ownership_account_refund" end # resource path local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/refunds'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(ownership_account_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(create_ownership_account_refund_request) # return_type return_type = opts[:debug_return_type] || 'OwnershipAccountRefundMessage' # auth_names auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret'] new_options = opts.merge( :operation => :"OwnershipAccountTransactionsApi.create_ownership_account_refund", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: OwnershipAccountTransactionsApi#create_ownership_account_refund\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Create a recurring charge # Creates a recurring charge transaction that will post automatically on the specified ownership account ledger.

Required permission(s):

Associations > Ownership account transactions - `View` `Edit` # @param ownership_account_id [Integer] # @param create_ownership_accounts_charge_recurring_transaction_request [CreateOwnershipAccountsChargeRecurringTransactionRequest] # @param [Hash] opts the optional parameters # @return [OwnershipAccountChargeRecurringTransactionMessage] def create_ownership_accounts_charge_recurring_transaction(ownership_account_id, create_ownership_accounts_charge_recurring_transaction_request, opts = {}) data, _status_code, _headers = create_ownership_accounts_charge_recurring_transaction_with_http_info(ownership_account_id, create_ownership_accounts_charge_recurring_transaction_request, opts) data end # Create a recurring charge # Creates a recurring charge transaction that will post automatically on the specified ownership account ledger. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Ownership account transactions</span> - `View` `Edit` # @param ownership_account_id [Integer] # @param create_ownership_accounts_charge_recurring_transaction_request [CreateOwnershipAccountsChargeRecurringTransactionRequest] # @param [Hash] opts the optional parameters # @return [Array<(OwnershipAccountChargeRecurringTransactionMessage, Integer, Hash)>] OwnershipAccountChargeRecurringTransactionMessage data, response status code and response headers def create_ownership_accounts_charge_recurring_transaction_with_http_info(ownership_account_id, create_ownership_accounts_charge_recurring_transaction_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.create_ownership_accounts_charge_recurring_transaction ...' end # verify the required parameter 'ownership_account_id' is set if @api_client.config.client_side_validation && ownership_account_id.nil? fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling OwnershipAccountTransactionsApi.create_ownership_accounts_charge_recurring_transaction" end # verify the required parameter 'create_ownership_accounts_charge_recurring_transaction_request' is set if @api_client.config.client_side_validation && create_ownership_accounts_charge_recurring_transaction_request.nil? fail ArgumentError, "Missing the required parameter 'create_ownership_accounts_charge_recurring_transaction_request' when calling OwnershipAccountTransactionsApi.create_ownership_accounts_charge_recurring_transaction" end # resource path local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/recurringcharges'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(ownership_account_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(create_ownership_accounts_charge_recurring_transaction_request) # return_type return_type = opts[:debug_return_type] || 'OwnershipAccountChargeRecurringTransactionMessage' # auth_names auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret'] new_options = opts.merge( :operation => :"OwnershipAccountTransactionsApi.create_ownership_accounts_charge_recurring_transaction", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: OwnershipAccountTransactionsApi#create_ownership_accounts_charge_recurring_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Retrieve all charges # Retrieves all ledger charges for a specific ownership account.

Required permission(s):

Associations > Ownership account transactions - `View` # @param ownership_account_id [Integer] # @param [Hash] opts the optional parameters # @option opts [Date] :transactiondatefrom Filters results to any lease transaction whose start date is greater than or equal to the specified value. # @option opts [Date] :transactiondateto Filters results to any lease transaction whose end date is less than or equal to the specified value. # @option opts [Array] :billids Filters results to any charge that has been associated to the indicated bill ids. # @option opts [String] :orderby `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information. # @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0. # @option opts [Integer] :limit `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50. # @return [Array] def get_all_ownership_account_charges(ownership_account_id, opts = {}) data, _status_code, _headers = get_all_ownership_account_charges_with_http_info(ownership_account_id, opts) data end # Retrieve all charges # Retrieves all ledger charges for a specific ownership account. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Ownership account transactions</span> - `View` # @param ownership_account_id [Integer] # @param [Hash] opts the optional parameters # @option opts [Date] :transactiondatefrom Filters results to any lease transaction whose start date is greater than or equal to the specified value. # @option opts [Date] :transactiondateto Filters results to any lease transaction whose end date is less than or equal to the specified value. # @option opts [Array] :billids Filters results to any charge that has been associated to the indicated bill ids. # @option opts [String] :orderby `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information. # @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0. # @option opts [Integer] :limit `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50. # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers def get_all_ownership_account_charges_with_http_info(ownership_account_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.get_all_ownership_account_charges ...' end # verify the required parameter 'ownership_account_id' is set if @api_client.config.client_side_validation && ownership_account_id.nil? fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling OwnershipAccountTransactionsApi.get_all_ownership_account_charges" end # resource path local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/charges'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(ownership_account_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'transactiondatefrom'] = opts[:'transactiondatefrom'] if !opts[:'transactiondatefrom'].nil? query_params[:'transactiondateto'] = opts[:'transactiondateto'] if !opts[:'transactiondateto'].nil? query_params[:'billids'] = @api_client.build_collection_param(opts[:'billids'], :multi) if !opts[:'billids'].nil? query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Array' # auth_names auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret'] new_options = opts.merge( :operation => :"OwnershipAccountTransactionsApi.get_all_ownership_account_charges", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: OwnershipAccountTransactionsApi#get_all_ownership_account_charges\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Retrieve all recurring transactions # Retrieves all recurring transactions for an ownership account.

Required permission(s):

Associations > Ownership account transactions - `View` # @param ownership_account_id [Integer] # @param [Hash] opts the optional parameters # @option opts [String] :orderby `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information. # @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0. # @option opts [Integer] :limit `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50. # @return [Array] def get_association_recurring_transaction(ownership_account_id, opts = {}) data, _status_code, _headers = get_association_recurring_transaction_with_http_info(ownership_account_id, opts) data end # Retrieve all recurring transactions # Retrieves all recurring transactions for an ownership account. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Ownership account transactions</span> - `View` # @param ownership_account_id [Integer] # @param [Hash] opts the optional parameters # @option opts [String] :orderby `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information. # @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0. # @option opts [Integer] :limit `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50. # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers def get_association_recurring_transaction_with_http_info(ownership_account_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.get_association_recurring_transaction ...' end # verify the required parameter 'ownership_account_id' is set if @api_client.config.client_side_validation && ownership_account_id.nil? fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling OwnershipAccountTransactionsApi.get_association_recurring_transaction" end # resource path local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/recurringtransactions'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(ownership_account_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Array' # auth_names auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret'] new_options = opts.merge( :operation => :"OwnershipAccountTransactionsApi.get_association_recurring_transaction", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: OwnershipAccountTransactionsApi#get_association_recurring_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Retrieve a charge # Retrieves a specific ownership account ledger charge.

Required permission(s):

Associations > Ownership account transactions - `View` # @param ownership_account_id [Integer] The ownership account identifier. # @param charge_id [Integer] # @param [Hash] opts the optional parameters # @return [OwnershipAccountLedgerChargeMessage] def get_ownership_account_charge_by_id(ownership_account_id, charge_id, opts = {}) data, _status_code, _headers = get_ownership_account_charge_by_id_with_http_info(ownership_account_id, charge_id, opts) data end # Retrieve a charge # Retrieves a specific ownership account ledger charge. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Ownership account transactions</span> - `View` # @param ownership_account_id [Integer] The ownership account identifier. # @param charge_id [Integer] # @param [Hash] opts the optional parameters # @return [Array<(OwnershipAccountLedgerChargeMessage, Integer, Hash)>] OwnershipAccountLedgerChargeMessage data, response status code and response headers def get_ownership_account_charge_by_id_with_http_info(ownership_account_id, charge_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.get_ownership_account_charge_by_id ...' end # verify the required parameter 'ownership_account_id' is set if @api_client.config.client_side_validation && ownership_account_id.nil? fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling OwnershipAccountTransactionsApi.get_ownership_account_charge_by_id" end # verify the required parameter 'charge_id' is set if @api_client.config.client_side_validation && charge_id.nil? fail ArgumentError, "Missing the required parameter 'charge_id' when calling OwnershipAccountTransactionsApi.get_ownership_account_charge_by_id" end # resource path local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/charges/{chargeId}'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(ownership_account_id.to_s)).sub('{' + 'chargeId' + '}', CGI.escape(charge_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'OwnershipAccountLedgerChargeMessage' # auth_names auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret'] new_options = opts.merge( :operation => :"OwnershipAccountTransactionsApi.get_ownership_account_charge_by_id", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: OwnershipAccountTransactionsApi#get_ownership_account_charge_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Retrieve all transactions # Retrieves all ledger transactions for a specific ownership account.

Required permission(s):

Associations > Ownership account transactions - `View` # @param ownership_account_id [Integer] The ownership account identifier. # @param [Hash] opts the optional parameters # @option opts [Date] :transactiondatefrom Filters results to any lease transaction whose start date is greater than or equal to the specified value. # @option opts [Date] :transactiondateto Filters results to any lease transaction whose end date is less than or equal to the specified value. # @option opts [Array] :transactiontypes Filters results to any lease transaction whose lease transaction type matches the specified status. If no type is specified, lease transactions with any type will be returned. # @option opts [String] :orderby `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information. # @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0. # @option opts [Integer] :limit `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50. # @return [Array] def get_ownership_account_ledger(ownership_account_id, opts = {}) data, _status_code, _headers = get_ownership_account_ledger_with_http_info(ownership_account_id, opts) data end # Retrieve all transactions # Retrieves all ledger transactions for a specific ownership account. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Ownership account transactions</span> - `View` # @param ownership_account_id [Integer] The ownership account identifier. # @param [Hash] opts the optional parameters # @option opts [Date] :transactiondatefrom Filters results to any lease transaction whose start date is greater than or equal to the specified value. # @option opts [Date] :transactiondateto Filters results to any lease transaction whose end date is less than or equal to the specified value. # @option opts [Array] :transactiontypes Filters results to any lease transaction whose lease transaction type matches the specified status. If no type is specified, lease transactions with any type will be returned. # @option opts [String] :orderby `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information. # @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0. # @option opts [Integer] :limit `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50. # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers def get_ownership_account_ledger_with_http_info(ownership_account_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.get_ownership_account_ledger ...' end # verify the required parameter 'ownership_account_id' is set if @api_client.config.client_side_validation && ownership_account_id.nil? fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling OwnershipAccountTransactionsApi.get_ownership_account_ledger" end allowable_values = ["Bill", "Check", "Charge", "Payment", "Credit", "Refund", "ApplyDeposit", "ElectronicFundsTransfer", "Other", "Deposit", "GeneralJournalEntry", "OwnerContribution", "ReversePayment", "ReverseElectronicFundsTransfer", "VendorCredit", "RentalApplicationFeePayment", "ReverseRentalApplicationFeePayment", "ReverseOwnerContribution", "VendorRefund", "UnreversedPayment", "UnreversedElectronicFundsTransfer", "UnreversedOwnerContribution", "UnreversedRentalApplicationFeePayment"] if @api_client.config.client_side_validation && opts[:'transactiontypes'] && !opts[:'transactiontypes'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"transactiontypes\", must include one of #{allowable_values}" end # resource path local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/transactions'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(ownership_account_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'transactiondatefrom'] = opts[:'transactiondatefrom'] if !opts[:'transactiondatefrom'].nil? query_params[:'transactiondateto'] = opts[:'transactiondateto'] if !opts[:'transactiondateto'].nil? query_params[:'transactiontypes'] = @api_client.build_collection_param(opts[:'transactiontypes'], :multi) if !opts[:'transactiontypes'].nil? query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Array' # auth_names auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret'] new_options = opts.merge( :operation => :"OwnershipAccountTransactionsApi.get_ownership_account_ledger", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: OwnershipAccountTransactionsApi#get_ownership_account_ledger\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Retrieve all outstanding balances # Retrieves a list of ownership account outstanding balances.

Required permission(s):

Associations > Outstanding Balances - `View` # @param [Hash] opts the optional parameters # @option opts [Integer] :associationid Association unique identifier # @option opts [Array] :ownershipaccountstatuses List of ownership account statuses # @option opts [Array] :ownershipaccountids List of ownership account ids # @option opts [String] :pastdueemail Status of notification of outstanding balances # @option opts [String] :balanceduration Duration of outstanding balances # @option opts [String] :orderby `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information. # @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0. # @option opts [Integer] :limit `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50. # @return [Array] def get_ownership_account_outstanding_balances(opts = {}) data, _status_code, _headers = get_ownership_account_outstanding_balances_with_http_info(opts) data end # Retrieve all outstanding balances # Retrieves a list of ownership account outstanding balances. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Outstanding Balances</span> - `View` # @param [Hash] opts the optional parameters # @option opts [Integer] :associationid Association unique identifier # @option opts [Array] :ownershipaccountstatuses List of ownership account statuses # @option opts [Array] :ownershipaccountids List of ownership account ids # @option opts [String] :pastdueemail Status of notification of outstanding balances # @option opts [String] :balanceduration Duration of outstanding balances # @option opts [String] :orderby `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information. # @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0. # @option opts [Integer] :limit `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50. # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers def get_ownership_account_outstanding_balances_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.get_ownership_account_outstanding_balances ...' end allowable_values = ["Active", "Past", "Future"] if @api_client.config.client_side_validation && opts[:'ownershipaccountstatuses'] && !opts[:'ownershipaccountstatuses'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"ownershipaccountstatuses\", must include one of #{allowable_values}" end allowable_values = ["NoEmailAddress", "Sent"] if @api_client.config.client_side_validation && opts[:'pastdueemail'] && !allowable_values.include?(opts[:'pastdueemail']) fail ArgumentError, "invalid value for \"pastdueemail\", must be one of #{allowable_values}" end allowable_values = ["TotalBalance", "Balance0to30Days", "Balance31to60Days", "Balance61to90Days", "BalanceOver90Days"] if @api_client.config.client_side_validation && opts[:'balanceduration'] && !allowable_values.include?(opts[:'balanceduration']) fail ArgumentError, "invalid value for \"balanceduration\", must be one of #{allowable_values}" end # resource path local_var_path = '/v1/associations/ownershipaccounts/outstandingbalances' # query parameters query_params = opts[:query_params] || {} query_params[:'associationid'] = opts[:'associationid'] if !opts[:'associationid'].nil? query_params[:'ownershipaccountstatuses'] = @api_client.build_collection_param(opts[:'ownershipaccountstatuses'], :multi) if !opts[:'ownershipaccountstatuses'].nil? query_params[:'ownershipaccountids'] = @api_client.build_collection_param(opts[:'ownershipaccountids'], :multi) if !opts[:'ownershipaccountids'].nil? query_params[:'pastdueemail'] = opts[:'pastdueemail'] if !opts[:'pastdueemail'].nil? query_params[:'balanceduration'] = opts[:'balanceduration'] if !opts[:'balanceduration'].nil? query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Array' # auth_names auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret'] new_options = opts.merge( :operation => :"OwnershipAccountTransactionsApi.get_ownership_account_outstanding_balances", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: OwnershipAccountTransactionsApi#get_ownership_account_outstanding_balances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Retrieve a recurring credit # Retrieves a recurring credit.

Required permission(s):

Associations > Ownership account transactions - `View` # @param ownership_account_id [Integer] # @param transaction_id [Integer] # @param [Hash] opts the optional parameters # @return [OwnershipAccountRecurringCreditMessage] def get_ownership_account_recurring_credit_by_id(ownership_account_id, transaction_id, opts = {}) data, _status_code, _headers = get_ownership_account_recurring_credit_by_id_with_http_info(ownership_account_id, transaction_id, opts) data end # Retrieve a recurring credit # Retrieves a recurring credit. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Ownership account transactions</span> - `View` # @param ownership_account_id [Integer] # @param transaction_id [Integer] # @param [Hash] opts the optional parameters # @return [Array<(OwnershipAccountRecurringCreditMessage, Integer, Hash)>] OwnershipAccountRecurringCreditMessage data, response status code and response headers def get_ownership_account_recurring_credit_by_id_with_http_info(ownership_account_id, transaction_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.get_ownership_account_recurring_credit_by_id ...' end # verify the required parameter 'ownership_account_id' is set if @api_client.config.client_side_validation && ownership_account_id.nil? fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling OwnershipAccountTransactionsApi.get_ownership_account_recurring_credit_by_id" end # verify the required parameter 'transaction_id' is set if @api_client.config.client_side_validation && transaction_id.nil? fail ArgumentError, "Missing the required parameter 'transaction_id' when calling OwnershipAccountTransactionsApi.get_ownership_account_recurring_credit_by_id" end # resource path local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/recurringcredits/{transactionId}'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(ownership_account_id.to_s)).sub('{' + 'transactionId' + '}', CGI.escape(transaction_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'OwnershipAccountRecurringCreditMessage' # auth_names auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret'] new_options = opts.merge( :operation => :"OwnershipAccountTransactionsApi.get_ownership_account_recurring_credit_by_id", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: OwnershipAccountTransactionsApi#get_ownership_account_recurring_credit_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Retrieve a refund # Retrieves a refund.

Required permission(s):

Accounting > Bank Accounts - `View` # @param ownership_account_id [Integer] # @param refund_id [Integer] # @param [Hash] opts the optional parameters # @return [OwnershipAccountRefundMessage] def get_ownership_account_refund_by_id(ownership_account_id, refund_id, opts = {}) data, _status_code, _headers = get_ownership_account_refund_by_id_with_http_info(ownership_account_id, refund_id, opts) data end # Retrieve a refund # Retrieves a refund. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting > Bank Accounts</span> - `View` # @param ownership_account_id [Integer] # @param refund_id [Integer] # @param [Hash] opts the optional parameters # @return [Array<(OwnershipAccountRefundMessage, Integer, Hash)>] OwnershipAccountRefundMessage data, response status code and response headers def get_ownership_account_refund_by_id_with_http_info(ownership_account_id, refund_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.get_ownership_account_refund_by_id ...' end # verify the required parameter 'ownership_account_id' is set if @api_client.config.client_side_validation && ownership_account_id.nil? fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling OwnershipAccountTransactionsApi.get_ownership_account_refund_by_id" end # verify the required parameter 'refund_id' is set if @api_client.config.client_side_validation && refund_id.nil? fail ArgumentError, "Missing the required parameter 'refund_id' when calling OwnershipAccountTransactionsApi.get_ownership_account_refund_by_id" end # resource path local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/refunds/{refundId}'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(ownership_account_id.to_s)).sub('{' + 'refundId' + '}', CGI.escape(refund_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'OwnershipAccountRefundMessage' # auth_names auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret'] new_options = opts.merge( :operation => :"OwnershipAccountTransactionsApi.get_ownership_account_refund_by_id", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: OwnershipAccountTransactionsApi#get_ownership_account_refund_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Retrieve a transaction # Retrieves a specific ownership account ledger transaction.

Required permission(s):

Associations > Ownership account transactions - `View` # @param ownership_account_id [Integer] The ownership account identifier. # @param transaction_id [Integer] The transaction identifier. # @param [Hash] opts the optional parameters # @return [OwnershipAccountTransactionMessage] def get_ownership_account_transaction_by_id(ownership_account_id, transaction_id, opts = {}) data, _status_code, _headers = get_ownership_account_transaction_by_id_with_http_info(ownership_account_id, transaction_id, opts) data end # Retrieve a transaction # Retrieves a specific ownership account ledger transaction. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Ownership account transactions</span> - `View` # @param ownership_account_id [Integer] The ownership account identifier. # @param transaction_id [Integer] The transaction identifier. # @param [Hash] opts the optional parameters # @return [Array<(OwnershipAccountTransactionMessage, Integer, Hash)>] OwnershipAccountTransactionMessage data, response status code and response headers def get_ownership_account_transaction_by_id_with_http_info(ownership_account_id, transaction_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.get_ownership_account_transaction_by_id ...' end # verify the required parameter 'ownership_account_id' is set if @api_client.config.client_side_validation && ownership_account_id.nil? fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling OwnershipAccountTransactionsApi.get_ownership_account_transaction_by_id" end # verify the required parameter 'transaction_id' is set if @api_client.config.client_side_validation && transaction_id.nil? fail ArgumentError, "Missing the required parameter 'transaction_id' when calling OwnershipAccountTransactionsApi.get_ownership_account_transaction_by_id" end # resource path local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/transactions/{transactionId}'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(ownership_account_id.to_s)).sub('{' + 'transactionId' + '}', CGI.escape(transaction_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'OwnershipAccountTransactionMessage' # auth_names auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret'] new_options = opts.merge( :operation => :"OwnershipAccountTransactionsApi.get_ownership_account_transaction_by_id", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: OwnershipAccountTransactionsApi#get_ownership_account_transaction_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Retrieve a recurring charge # Retrieves a recurring charge.

Required permission(s):

Associations > Ownership account transactions - `View` # @param ownership_account_id [Integer] # @param transaction_id [Integer] # @param [Hash] opts the optional parameters # @return [OwnershipAccountChargeRecurringTransactionMessage] def get_ownership_accounts_charge_recurring_transaction_by_id(ownership_account_id, transaction_id, opts = {}) data, _status_code, _headers = get_ownership_accounts_charge_recurring_transaction_by_id_with_http_info(ownership_account_id, transaction_id, opts) data end # Retrieve a recurring charge # Retrieves a recurring charge. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Ownership account transactions</span> - `View` # @param ownership_account_id [Integer] # @param transaction_id [Integer] # @param [Hash] opts the optional parameters # @return [Array<(OwnershipAccountChargeRecurringTransactionMessage, Integer, Hash)>] OwnershipAccountChargeRecurringTransactionMessage data, response status code and response headers def get_ownership_accounts_charge_recurring_transaction_by_id_with_http_info(ownership_account_id, transaction_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.get_ownership_accounts_charge_recurring_transaction_by_id ...' end # verify the required parameter 'ownership_account_id' is set if @api_client.config.client_side_validation && ownership_account_id.nil? fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling OwnershipAccountTransactionsApi.get_ownership_accounts_charge_recurring_transaction_by_id" end # verify the required parameter 'transaction_id' is set if @api_client.config.client_side_validation && transaction_id.nil? fail ArgumentError, "Missing the required parameter 'transaction_id' when calling OwnershipAccountTransactionsApi.get_ownership_accounts_charge_recurring_transaction_by_id" end # resource path local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/recurringcharges/{transactionId}'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(ownership_account_id.to_s)).sub('{' + 'transactionId' + '}', CGI.escape(transaction_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'OwnershipAccountChargeRecurringTransactionMessage' # auth_names auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret'] new_options = opts.merge( :operation => :"OwnershipAccountTransactionsApi.get_ownership_accounts_charge_recurring_transaction_by_id", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: OwnershipAccountTransactionsApi#get_ownership_accounts_charge_recurring_transaction_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Retrieve a recurring payment # Retrieves a recurring payment.

Required permission(s):

Associations > Ownership account transactions - `View` # @param ownership_account_id [Integer] # @param payment_id [Integer] # @param [Hash] opts the optional parameters # @return [OwnershipAccountRecurringPaymentMessage] def get_recurring_ownership_account_payments_by_id(ownership_account_id, payment_id, opts = {}) data, _status_code, _headers = get_recurring_ownership_account_payments_by_id_with_http_info(ownership_account_id, payment_id, opts) data end # Retrieve a recurring payment # Retrieves a recurring payment. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Ownership account transactions</span> - `View` # @param ownership_account_id [Integer] # @param payment_id [Integer] # @param [Hash] opts the optional parameters # @return [Array<(OwnershipAccountRecurringPaymentMessage, Integer, Hash)>] OwnershipAccountRecurringPaymentMessage data, response status code and response headers def get_recurring_ownership_account_payments_by_id_with_http_info(ownership_account_id, payment_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.get_recurring_ownership_account_payments_by_id ...' end # verify the required parameter 'ownership_account_id' is set if @api_client.config.client_side_validation && ownership_account_id.nil? fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling OwnershipAccountTransactionsApi.get_recurring_ownership_account_payments_by_id" end # verify the required parameter 'payment_id' is set if @api_client.config.client_side_validation && payment_id.nil? fail ArgumentError, "Missing the required parameter 'payment_id' when calling OwnershipAccountTransactionsApi.get_recurring_ownership_account_payments_by_id" end # resource path local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/recurringpayments/{paymentId}'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(ownership_account_id.to_s)).sub('{' + 'paymentId' + '}', CGI.escape(payment_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'OwnershipAccountRecurringPaymentMessage' # auth_names auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret'] new_options = opts.merge( :operation => :"OwnershipAccountTransactionsApi.get_recurring_ownership_account_payments_by_id", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: OwnershipAccountTransactionsApi#get_recurring_ownership_account_payments_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Update a charge # Updates a charge.

Required permission(s):

Associations > Ownership account transactions - `View` `Edit`
# @param ownership_account_id [Integer] The ownership account identifier. # @param charge_id [Integer] The charge identifier. # @param update_ownership_account_charge_request [UpdateOwnershipAccountChargeRequest] # @param [Hash] opts the optional parameters # @return [OwnershipAccountTransactionMessage] def update_ownership_account_charge(ownership_account_id, charge_id, update_ownership_account_charge_request, opts = {}) data, _status_code, _headers = update_ownership_account_charge_with_http_info(ownership_account_id, charge_id, update_ownership_account_charge_request, opts) data end # Update a charge # Updates a charge. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Ownership account transactions</span> - `View` `Edit` <br /> # @param ownership_account_id [Integer] The ownership account identifier. # @param charge_id [Integer] The charge identifier. # @param update_ownership_account_charge_request [UpdateOwnershipAccountChargeRequest] # @param [Hash] opts the optional parameters # @return [Array<(OwnershipAccountTransactionMessage, Integer, Hash)>] OwnershipAccountTransactionMessage data, response status code and response headers def update_ownership_account_charge_with_http_info(ownership_account_id, charge_id, update_ownership_account_charge_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.update_ownership_account_charge ...' end # verify the required parameter 'ownership_account_id' is set if @api_client.config.client_side_validation && ownership_account_id.nil? fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling OwnershipAccountTransactionsApi.update_ownership_account_charge" end # verify the required parameter 'charge_id' is set if @api_client.config.client_side_validation && charge_id.nil? fail ArgumentError, "Missing the required parameter 'charge_id' when calling OwnershipAccountTransactionsApi.update_ownership_account_charge" end # verify the required parameter 'update_ownership_account_charge_request' is set if @api_client.config.client_side_validation && update_ownership_account_charge_request.nil? fail ArgumentError, "Missing the required parameter 'update_ownership_account_charge_request' when calling OwnershipAccountTransactionsApi.update_ownership_account_charge" end # resource path local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/charges/{chargeId}'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(ownership_account_id.to_s)).sub('{' + 'chargeId' + '}', CGI.escape(charge_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(update_ownership_account_charge_request) # return_type return_type = opts[:debug_return_type] || 'OwnershipAccountTransactionMessage' # auth_names auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret'] new_options = opts.merge( :operation => :"OwnershipAccountTransactionsApi.update_ownership_account_charge", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: OwnershipAccountTransactionsApi#update_ownership_account_charge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Update a deposit withholding # Updates an ownership account deposit withholding.

Required permission(s):

Associations > Ownership account transactions - `View` `Edit` Accounting > General Ledger Accounts - `View` # @param ownership_account_id [Integer] # @param deposit_id [Integer] # @param update_ownership_account_deposit_withholding_request [UpdateOwnershipAccountDepositWithholdingRequest] # @param [Hash] opts the optional parameters # @return [OwnershipAccountTransactionMessage] def update_ownership_account_deposit_withholding(ownership_account_id, deposit_id, update_ownership_account_deposit_withholding_request, opts = {}) data, _status_code, _headers = update_ownership_account_deposit_withholding_with_http_info(ownership_account_id, deposit_id, update_ownership_account_deposit_withholding_request, opts) data end # Update a deposit withholding # Updates an ownership account deposit withholding. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Ownership account transactions</span> - `View` `Edit` <span class=\"permissionBlock\">Accounting > General Ledger Accounts</span> - `View` # @param ownership_account_id [Integer] # @param deposit_id [Integer] # @param update_ownership_account_deposit_withholding_request [UpdateOwnershipAccountDepositWithholdingRequest] # @param [Hash] opts the optional parameters # @return [Array<(OwnershipAccountTransactionMessage, Integer, Hash)>] OwnershipAccountTransactionMessage data, response status code and response headers def update_ownership_account_deposit_withholding_with_http_info(ownership_account_id, deposit_id, update_ownership_account_deposit_withholding_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.update_ownership_account_deposit_withholding ...' end # verify the required parameter 'ownership_account_id' is set if @api_client.config.client_side_validation && ownership_account_id.nil? fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling OwnershipAccountTransactionsApi.update_ownership_account_deposit_withholding" end # verify the required parameter 'deposit_id' is set if @api_client.config.client_side_validation && deposit_id.nil? fail ArgumentError, "Missing the required parameter 'deposit_id' when calling OwnershipAccountTransactionsApi.update_ownership_account_deposit_withholding" end # verify the required parameter 'update_ownership_account_deposit_withholding_request' is set if @api_client.config.client_side_validation && update_ownership_account_deposit_withholding_request.nil? fail ArgumentError, "Missing the required parameter 'update_ownership_account_deposit_withholding_request' when calling OwnershipAccountTransactionsApi.update_ownership_account_deposit_withholding" end # resource path local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/applieddeposits/{depositId}'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(ownership_account_id.to_s)).sub('{' + 'depositId' + '}', CGI.escape(deposit_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(update_ownership_account_deposit_withholding_request) # return_type return_type = opts[:debug_return_type] || 'OwnershipAccountTransactionMessage' # auth_names auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret'] new_options = opts.merge( :operation => :"OwnershipAccountTransactionsApi.update_ownership_account_deposit_withholding", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: OwnershipAccountTransactionsApi#update_ownership_account_deposit_withholding\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Update a payment # Updates a ledger payment. Each line item must have a unique general ledger account identifier. PaymentMethod, Date, Memo, and the total Amount cannot be changed for payments with a PaymentMethod of `BuildiumEFT`, `BuildiumCC` or `RetailCash`.

Required permission(s):

Associations > Ownership account transactions - `View` `Edit` # @param ownership_account_id [Integer] # @param payment_id [Integer] # @param update_ownership_account_ledger_payment_request [UpdateOwnershipAccountLedgerPaymentRequest] # @param [Hash] opts the optional parameters # @return [OwnershipAccountTransactionMessage] def update_ownership_account_ledger_payment(ownership_account_id, payment_id, update_ownership_account_ledger_payment_request, opts = {}) data, _status_code, _headers = update_ownership_account_ledger_payment_with_http_info(ownership_account_id, payment_id, update_ownership_account_ledger_payment_request, opts) data end # Update a payment # Updates a ledger payment. Each line item must have a unique general ledger account identifier. PaymentMethod, Date, Memo, and the total Amount cannot be changed for payments with a PaymentMethod of `BuildiumEFT`, `BuildiumCC` or `RetailCash`. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Ownership account transactions</span> - `View` `Edit` # @param ownership_account_id [Integer] # @param payment_id [Integer] # @param update_ownership_account_ledger_payment_request [UpdateOwnershipAccountLedgerPaymentRequest] # @param [Hash] opts the optional parameters # @return [Array<(OwnershipAccountTransactionMessage, Integer, Hash)>] OwnershipAccountTransactionMessage data, response status code and response headers def update_ownership_account_ledger_payment_with_http_info(ownership_account_id, payment_id, update_ownership_account_ledger_payment_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: OwnershipAccountTransactionsApi.update_ownership_account_ledger_payment ...' end # verify the required parameter 'ownership_account_id' is set if @api_client.config.client_side_validation && ownership_account_id.nil? fail ArgumentError, "Missing the required parameter 'ownership_account_id' when calling OwnershipAccountTransactionsApi.update_ownership_account_ledger_payment" end # verify the required parameter 'payment_id' is set if @api_client.config.client_side_validation && payment_id.nil? fail ArgumentError, "Missing the required parameter 'payment_id' when calling OwnershipAccountTransactionsApi.update_ownership_account_ledger_payment" end # verify the required parameter 'update_ownership_account_ledger_payment_request' is set if @api_client.config.client_side_validation && update_ownership_account_ledger_payment_request.nil? fail ArgumentError, "Missing the required parameter 'update_ownership_account_ledger_payment_request' when calling OwnershipAccountTransactionsApi.update_ownership_account_ledger_payment" end # resource path local_var_path = '/v1/associations/ownershipaccounts/{ownershipAccountId}/payments/{paymentId}'.sub('{' + 'ownershipAccountId' + '}', CGI.escape(ownership_account_id.to_s)).sub('{' + 'paymentId' + '}', CGI.escape(payment_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(update_ownership_account_ledger_payment_request) # return_type return_type = opts[:debug_return_type] || 'OwnershipAccountTransactionMessage' # auth_names auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret'] new_options = opts.merge( :operation => :"OwnershipAccountTransactionsApi.update_ownership_account_ledger_payment", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: OwnershipAccountTransactionsApi#update_ownership_account_ledger_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end end end