Method: Propertyware::AccountingApi#get_owner_draws

Defined in:
lib/propertyware/api/accounting_api.rb

#get_owner_draws(opts = {}) ⇒ Array<OwnerDraw>

Retrieve all the owner draws (BETA) <p class="betaWarning">Note: This operation is still in beta and might be subject to breaking changes. Production integrations should be avoided at this stage.</p> Retrieves a list of owner draws.<br/><br/>Required permission:<br/><span class="permissionBlock">PORTFOLIOS</span> - Read <br/><br/>Sortable by: postdate, createddate, lastmodifieddatetime, portfolioid, id

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    &#x60;offset&#x60; indicates the position of the first record to return. The offset is zero-based and the default is 0.

  • :limit (Integer) —

    &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 500 and the default is 100. (default to 100)

  • :last_modified_date_time_start (Time) —

    Filters results to any item modified on or after the date time specified.

  • :last_modified_date_time_end (Time) —

    Filters results to any item modified on or prior to the date time specified.

  • :orderby (String) —

    Indicates the field(s) and direction to sort the results in the response.

  • :post_date_start (Date) —

    Filters results to any transaction with a start date on or after the date specified.

  • :post_date_end (Date) —

    Filters results to any transaction with a start date on or prior to the date specified.

  • :portfolio_id (Integer) —

    Filters results to with portfolioID.

Returns:



824
825
826
827
 
# File 'lib/propertyware/api/accounting_api.rb', line 824

def get_owner_draws(opts = {})
  data, _status_code, _headers = get_owner_draws_with_http_info(opts)
  data
end