Class: TripletexApi::LedgerApi

Inherits:
Object
  • Object
show all
Defined in:
lib/tripletex_api/api/ledger_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LedgerApi

Returns a new instance of LedgerApi.



19
20
21
 
# File 'lib/tripletex_api/api/ledger_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_api/api/ledger_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#open_post(date, opts = {}) ⇒ ListResponseLedgerAccount

Find open posts corresponding with sent data.

Parameters:

  • date —

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

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

    the optional parameters

Options Hash (opts):

  • :account_id (Integer) —

    Element ID

  • :supplier_id (Integer) —

    Element ID

  • :customer_id (Integer) —

    Element ID

  • :employee_id (Integer) —

    Element ID

  • :department_id (Integer) —

    Element ID

  • :project_id (Integer) —

    Element ID

  • :product_id (Integer) —

    Element ID

  • :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:



39
40
41
42
 
# File 'lib/tripletex_api/api/ledger_api.rb', line 39

def open_post(date, opts = {})
  data, _status_code, _headers = open_post_with_http_info(date, opts)
  return data
end

#open_post_with_http_info(date, opts = {}) ⇒ Array<(ListResponseLedgerAccount, Fixnum, Hash)>

Find open posts corresponding with sent data.

Parameters:

  • date —

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

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

    the optional parameters

Options Hash (opts):

  • :account_id (Integer) —

    Element ID

  • :supplier_id (Integer) —

    Element ID

  • :customer_id (Integer) —

    Element ID

  • :employee_id (Integer) —

    Element ID

  • :department_id (Integer) —

    Element ID

  • :project_id (Integer) —

    Element ID

  • :product_id (Integer) —

    Element ID

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:

  • (Array<(ListResponseLedgerAccount, Fixnum, Hash)>) —

    ListResponseLedgerAccount data, response status code and response headers



60
61
62
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
 
# File 'lib/tripletex_api/api/ledger_api.rb', line 60

def open_post_with_http_info(date, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LedgerApi.open_post ..."
  end
  # verify the required parameter 'date' is set
  if @api_client.config.client_side_validation && date.nil?
    fail ArgumentError, "Missing the required parameter 'date' when calling LedgerApi.open_post"
  end
  # resource path
  local_var_path = "/ledger/openPost"

  # query parameters
  query_params = {}
  query_params[:'date'] = date
  query_params[:'accountId'] = opts[:'account_id'] if !opts[:'account_id'].nil?
  query_params[:'supplierId'] = opts[:'supplier_id'] if !opts[:'supplier_id'].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[:'productId'] = opts[:'product_id'] if !opts[:'product_id'].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 => 'ListResponseLedgerAccount')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LedgerApi#open_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get ledger (hovedbok).

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):

  • :open_postings (String) —

    Deprecated

  • :account_id (Integer) —

    Element ID

  • :supplier_id (Integer) —

    Element ID

  • :customer_id (Integer) —

    Element ID

  • :employee_id (Integer) —

    Element ID

  • :department_id (Integer) —

    Element ID

  • :project_id (Integer) —

    Element ID

  • :product_id (Integer) —

    Element ID

  • :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:



126
127
128
129
 
# File 'lib/tripletex_api/api/ledger_api.rb', line 126

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

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

Get ledger (hovedbok).

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):

  • :open_postings (String) —

    Deprecated

  • :account_id (Integer) —

    Element ID

  • :supplier_id (Integer) —

    Element ID

  • :customer_id (Integer) —

    Element ID

  • :employee_id (Integer) —

    Element ID

  • :department_id (Integer) —

    Element ID

  • :project_id (Integer) —

    Element ID

  • :product_id (Integer) —

    Element ID

  • :from (Integer) —

    From index

  • :count (Integer) —

    Number of elements to return

  • :sorting (String) —

    Sorting pattern

  • :fields (String) —

    Fields filter pattern

Returns:

  • (Array<(ListResponseLedgerAccount, Fixnum, Hash)>) —

    ListResponseLedgerAccount data, response status code and response headers



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/tripletex_api/api/ledger_api.rb', line 149

def search_with_http_info(date_from, date_to, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LedgerApi.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 LedgerApi.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 LedgerApi.search"
  end
  # resource path
  local_var_path = "/ledger"

  # query parameters
  query_params = {}
  query_params[:'dateFrom'] = date_from
  query_params[:'dateTo'] = date_to
  query_params[:'openPostings'] = opts[:'open_postings'] if !opts[:'open_postings'].nil?
  query_params[:'accountId'] = opts[:'account_id'] if !opts[:'account_id'].nil?
  query_params[:'supplierId'] = opts[:'supplier_id'] if !opts[:'supplier_id'].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[:'productId'] = opts[:'product_id'] if !opts[:'product_id'].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 => 'ListResponseLedgerAccount')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LedgerApi#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end