Class: TripletexRubyClient::BalanceSheetApi

Inherits:
Object
  • Object
show all
Defined in:
lib/tripletex_ruby_client/api/balance_sheet_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BalanceSheetApi

Returns a new instance of BalanceSheetApi.



19
20
21
 
# File 'lib/tripletex_ruby_client/api/balance_sheet_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/tripletex_ruby_client/api/balance_sheet_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#search(date_from, date_to, opts = {}) ⇒ ListResponseBalanceSheetAccount

BETA

Get balance sheet (saldobalanse).

Parameters:

  • date_from —

    Format is yyyy-MM-dd (from and incl.).

  • date_to —

    Format is yyyy-MM-dd (to and excl.).

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

    the optional parameters

Options Hash (opts):

  • :account_number_from (Integer) —

    From and including

  • :account_number_to (Integer) —

    To and excluding

  • :customer_id (Integer) —

    Element ID

  • :employee_id (Integer) —

    Element ID

  • :department_id (Integer) —

    Element ID

  • :project_id (Integer) —

    Element ID

  • :include_sub_projects (BOOLEAN) —

    Should sub projects of the given project be included (default to false)

  • :include_active_accounts_without_movements (BOOLEAN) —

    Should active accounts with no movements be included (default to false)

  • :from (Integer) —

    From index (default to 0)

  • :count (Integer) —

    Number of elements to return (default to 1000)

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



40
41
42
43
 
# File 'lib/tripletex_ruby_client/api/balance_sheet_api.rb', line 40

def search(date_from, date_to, opts = {})
  data, _status_code, _headers = search_with_http_info(date_from, date_to, opts)
  data
end

#search_with_http_info(date_from, date_to, opts = {}) ⇒ Array<(ListResponseBalanceSheetAccount, Fixnum, Hash)>

BETA

Get balance sheet (saldobalanse).

Parameters:

  • date_from —

    Format is yyyy-MM-dd (from and incl.).

  • date_to —

    Format is yyyy-MM-dd (to and excl.).

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

    the optional parameters

Options Hash (opts):

  • :account_number_from (Integer) —

    From and including

  • :account_number_to (Integer) —

    To and excluding

  • :customer_id (Integer) —

    Element ID

  • :employee_id (Integer) —

    Element ID

  • :department_id (Integer) —

    Element ID

  • :project_id (Integer) —

    Element ID

  • :include_sub_projects (BOOLEAN) —

    Should sub projects of the given project be included

  • :include_active_accounts_without_movements (BOOLEAN) —

    Should active accounts with no movements be included

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/tripletex_ruby_client/api/balance_sheet_api.rb', line 63

def search_with_http_info(date_from, date_to, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BalanceSheetApi.search ...'
  end
  # verify the required parameter 'date_from' is set
  if @api_client.config.client_side_validation && date_from.nil?
    fail ArgumentError, "Missing the required parameter 'date_from' when calling BalanceSheetApi.search"
  end
  # verify the required parameter 'date_to' is set
  if @api_client.config.client_side_validation && date_to.nil?
    fail ArgumentError, "Missing the required parameter 'date_to' when calling BalanceSheetApi.search"
  end
  # resource path
  local_var_path = '/balanceSheet'

  # query parameters
  query_params = {}
  query_params[:'dateFrom'] = date_from
  query_params[:'dateTo'] = date_to
  query_params[:'accountNumberFrom'] = opts[:'account_number_from'] if !opts[:'account_number_from'].nil?
  query_params[:'accountNumberTo'] = opts[:'account_number_to'] if !opts[:'account_number_to'].nil?
  query_params[:'customerId'] = opts[:'customer_id'] if !opts[:'customer_id'].nil?
  query_params[:'employeeId'] = opts[:'employee_id'] if !opts[:'employee_id'].nil?
  query_params[:'departmentId'] = opts[:'department_id'] if !opts[:'department_id'].nil?
  query_params[:'projectId'] = opts[:'project_id'] if !opts[:'project_id'].nil?
  query_params[:'includeSubProjects'] = opts[:'include_sub_projects'] if !opts[:'include_sub_projects'].nil?
  query_params[:'includeActiveAccountsWithoutMovements'] = opts[:'include_active_accounts_without_movements'] if !opts[:'include_active_accounts_without_movements'].nil?
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
  query_params[:'sorting'] = opts[:'sorting'] if !opts[:'sorting'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['tokenAuthScheme']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ListResponseBalanceSheetAccount')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: BalanceSheetApi#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end