Method: Propertyware::AccountingApi#get_accounts

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

#get_accounts(opts = {}) ⇒ Array<Account>

Retrieve all the general ledger accounts (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 general ledger accounts.<br/><br/>Required permission:<br/><span class="permissionBlock">GL ACCOUNTS</span> - Read <br/><br/>Sortable by: accountcode, id, accountnumber

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.

  • :account_number (String) —

    Filters results to accounts with a specific number.

  • :include_deactivated (Boolean) —

    Include deactivated results if a &#x60;true&#x60; value is passed. If no value is specified, only active accounts will be returned.

  • :account_code (String) —

    Filters results to accounts with a specific code.

  • :parent_gl_account_id (Integer) —

    Filters results to accounts that are a children of a specific parent account.

Returns:



564
565
566
567
 
# File 'lib/propertyware/api/accounting_api.rb', line 564

def get_accounts(opts = {})
  data, _status_code, _headers = get_accounts_with_http_info(opts)
  data
end