Module: Ruconomic::API::Account

Extended by:
WebService
Defined in:
lib/ruconomic/api/account.rb

Class Method Summary collapse

Class Method Details

.createHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Creates a new account. Parameters: number: The number of the new account. name: The name of the new account. type: The type of the new account.


84
85
86
87
88
# File 'lib/ruconomic/api/account.rb', line 84

def self.create
  response = invoke('Account_Create') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.create_from_dataHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Creates a new account from a data object. Parameters: data: The data object that specifies the properties of the new account.


12
13
14
15
16
# File 'lib/ruconomic/api/account.rb', line 12

def self.create_from_data
  response = invoke('Account_CreateFromData') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.create_from_data_arrayHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Creates new accounts from data objects. Parameters: dataArray: The array of data objects that specifies the properties of the new accounts.


24
25
26
27
28
# File 'lib/ruconomic/api/account.rb', line 24

def self.create_from_data_array
  response = invoke('Account_CreateFromDataArray') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.deleteHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Deletes an account. Parameters: accountHandle: Handle for the account.


166
167
168
169
170
# File 'lib/ruconomic/api/account.rb', line 166

def self.delete
  response = invoke('Account_Delete') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.find_by_nameHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Returns handles for the accounts with the given name. Parameters: name: The name to search for.


142
143
144
145
146
# File 'lib/ruconomic/api/account.rb', line 142

def self.find_by_name
  response = invoke('Account_FindByName') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.find_by_numberHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Returns a handle for the account with the given number. Parameters: number: The number to search for.


118
119
120
121
122
# File 'lib/ruconomic/api/account.rb', line 118

def self.find_by_number
  response = invoke('Account_FindByNumber') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.find_by_number_listHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Returns an array with handles for the accounts corresponding to the given account numbers. If an account with a given number does not exist or if no number is given then the array contains nothing at that index. Parameters: numbers: The numbers to search for.


130
131
132
133
134
# File 'lib/ruconomic/api/account.rb', line 130

def self.find_by_number_list
  response = invoke('Account_FindByNumberList') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_allHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Return handles for all accounts.


95
96
97
98
99
# File 'lib/ruconomic/api/account.rb', line 95

def self.get_all
  response = invoke('Account_GetAll') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_all_updatedHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Return handles for all accounts from date. fromDate is based on CET. includeCalculatedProperties is reserved for future usage and should be set to false for now.


106
107
108
109
110
# File 'lib/ruconomic/api/account.rb', line 106

def self.get_all_updated
  response = invoke('Account_GetAllUpdated') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_balanceHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets the balance of an account. Parameters: accountHandle: Handle for the account.


464
465
466
467
468
# File 'lib/ruconomic/api/account.rb', line 464

def self.get_balance
  response = invoke('Account_GetBalance') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_block_direct_entriesHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets whether an account is blocked for direct entries. Parameters: accountHandle: Handle for the account.


344
345
346
347
348
# File 'lib/ruconomic/api/account.rb', line 344

def self.get_block_direct_entries
  response = invoke('Account_GetBlockDirectEntries') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_budget_figuresHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Returns an array with handles for the budget figures for the given account.


177
178
179
180
181
# File 'lib/ruconomic/api/account.rb', line 177

def self.get_budget_figures
  response = invoke('Account_GetBudgetFigures') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_budget_figures_by_dateHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Returns an array with handles for the budget figures within the given time interval. Parameters: fromDate: First day in the interval. toDate: Last day in the interval.


189
190
191
192
193
# File 'lib/ruconomic/api/account.rb', line 189

def self.get_budget_figures_by_date
  response = invoke('Account_GetBudgetFiguresByDate') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_contra_accountHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets a handle for the contra account of an account. Parameters: accountHandle: Handle for the account.


392
393
394
395
396
# File 'lib/ruconomic/api/account.rb', line 392

def self.
  response = invoke('Account_GetContraAccount') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_dataHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Returns an account data object for a given account. Parameters: entityHandle: A handle for the account.


60
61
62
63
64
# File 'lib/ruconomic/api/account.rb', line 60

def self.get_data
  response = invoke('Account_GetData') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_data_arrayHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Returns account data objects for a given set of account handles. Parameters: entityHandles: An array of the account handles.


72
73
74
75
76
# File 'lib/ruconomic/api/account.rb', line 72

def self.get_data_array
  response = invoke('Account_GetDataArray') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_debit_creditHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets whether an account is a debit or credit account. Parameters: accountHandle: Handle for the account.


296
297
298
299
300
# File 'lib/ruconomic/api/account.rb', line 296

def self.get_debit_credit
  response = invoke('Account_GetDebitCredit') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_departmentHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets a handle for the department of an account. The department is only accessible when there is access to the Dimension add-on module. Parameters: accountHandle: Handle for the account.


476
477
478
479
480
# File 'lib/ruconomic/api/account.rb', line 476

def self.get_department
  response = invoke('Account_GetDepartment') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_distribution_keyHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets a handle for the distribution key of an account. The distribution key is only accessible when there is access to the Dimension add-on module. Parameters: acccountHandle: Handle for the account.


500
501
502
503
504
# File 'lib/ruconomic/api/account.rb', line 500

def self.get_distribution_key
  response = invoke('Account_GetDistributionKey') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_entries_by_dateHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Returns a handle for the entries within the given time interval. Parameters: First : First day in interval. Last : Last day in interval.


201
202
203
204
205
# File 'lib/ruconomic/api/account.rb', line 201

def self.get_entries_by_date
  response = invoke('Account_GetEntriesByDate') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_entries_by_numberHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Returns an array with handles for the entries with serial numbers in the given interval. Parameters: minNumber: The start of the interval. maxNumber: The end of the interval.


213
214
215
216
217
# File 'lib/ruconomic/api/account.rb', line 213

def self.get_entries_by_number
  response = invoke('Account_GetEntriesByNumber') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_entry_totals_by_dateHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Returns entry totals for the specified accounts and date interval. Parameters: accounts: The accounts for which to return entry totals. first: Start date of interval. last: End date of interval.


154
155
156
157
158
# File 'lib/ruconomic/api/account.rb', line 154

def self.get_entry_totals_by_date
  response = invoke('Account_GetEntryTotalsByDate') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_is_accessibleHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets whether an account is accessible. Parameters: accountHandle: Handle for the account.


320
321
322
323
324
# File 'lib/ruconomic/api/account.rb', line 320

def self.get_is_accessible
  response = invoke('Account_GetIsAccessible') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_nameHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets the name of an account. Parameters: accountHandle: Handle for the account.


248
249
250
251
252
# File 'lib/ruconomic/api/account.rb', line 248

def self.get_name
  response = invoke('Account_GetName') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_numberHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets the number of an account. Parameters: accountHandle: Handle for the account.


236
237
238
239
240
# File 'lib/ruconomic/api/account.rb', line 236

def self.get_number
  response = invoke('Account_GetNumber') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_opening_accountHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets a handle for the opening account of an account. Parameters: accountHandle: Handle for the account.


416
417
418
419
420
# File 'lib/ruconomic/api/account.rb', line 416

def self.
  response = invoke('Account_GetOpeningAccount') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_sum_intervalsHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Returns an array with handles for the sum interval for the given account.


224
225
226
227
228
# File 'lib/ruconomic/api/account.rb', line 224

def self.get_sum_intervals
  response = invoke('Account_GetSumIntervals') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_total_fromHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets a handle for the first account to sum from if the type of the account is AccountType.TotalFrom. Parameters: accountHandle: Handle for the account.


440
441
442
443
444
# File 'lib/ruconomic/api/account.rb', line 440

def self.get_total_from
  response = invoke('Account_GetTotalFrom') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_typeHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets the account type of an account. Parameters: accountHandle: Handle for the account.


272
273
274
275
276
# File 'lib/ruconomic/api/account.rb', line 272

def self.get_type
  response = invoke('Account_GetType') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_vat_accountHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets a handle for the VAT account of an account. Parameters: accountHandle: Handle for the account.


368
369
370
371
372
# File 'lib/ruconomic/api/account.rb', line 368

def self.
  response = invoke('Account_GetVatAccount') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.set_block_direct_entriesHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Sets whether an account is blocked for direct entries. Parameters: accountHandle: Handle for the account. value: Value that indicates whether the account should be blocked for direct entries.


356
357
358
359
360
# File 'lib/ruconomic/api/account.rb', line 356

def self.set_block_direct_entries
  response = invoke('Account_SetBlockDirectEntries') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.set_contra_accountHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Sets the contra account of an account. Parameters: accountHandle: Handle for the account. valueHandle: Handle for the new contra account of the account.


404
405
406
407
408
# File 'lib/ruconomic/api/account.rb', line 404

def self.
  response = invoke('Account_SetContraAccount') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.set_debit_creditHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Sets whether an account is a debit or credit account. Parameters: accountHandle: Handle for the account. value: Value that indicates whether the account should be a debit or credit account.


308
309
310
311
312
# File 'lib/ruconomic/api/account.rb', line 308

def self.set_debit_credit
  response = invoke('Account_SetDebitCredit') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.set_departmentHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Sets the department of an account. The department is only accessible when there is access to the Dimension add-on module. The department cannot be set when the distribution key is set. Parameters: accountHandle: Handle for the account. value: Handle for the new department of the account.


488
489
490
491
492
# File 'lib/ruconomic/api/account.rb', line 488

def self.set_department
  response = invoke('Account_SetDepartment') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.set_distribution_keyHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Sets the distribution key of an account. The distribution key is only accessible when there is access to the Dimension add-on module. The distribution key cannot be set when the department is set. Parameters: accountHandle: Handle for the account. value: Handle for the new distribution key of the account.


512
513
514
515
516
# File 'lib/ruconomic/api/account.rb', line 512

def self.set_distribution_key
  response = invoke('Account_SetDistributionKey') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.set_is_accessibleHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Sets whether an account is accessible. Parameters: accountHandle: Handle for the account. value: Value that indicates whether the account should be accessible.


332
333
334
335
336
# File 'lib/ruconomic/api/account.rb', line 332

def self.set_is_accessible
  response = invoke('Account_SetIsAccessible') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.set_nameHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Sets the name of an account. Parameters: accountHandle: Handle for the account. value: The new name of the account.


260
261
262
263
264
# File 'lib/ruconomic/api/account.rb', line 260

def self.set_name
  response = invoke('Account_SetName') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.set_opening_accountHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Sets the opening account of an account. Parameters: accountHandle: Handle for the account. valueHandle: Handle for the new opening account of the account.


428
429
430
431
432
# File 'lib/ruconomic/api/account.rb', line 428

def self.
  response = invoke('Account_SetOpeningAccount') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.set_total_fromHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Sets a handle for the first account to sum from if the type of the account is AccountType.TotalFrom. This is only used if the account has account type TotalFrom. Parameters: accountHandle: Handle for the account. valueHandle: Handle for the new 'total from'-account.


452
453
454
455
456
# File 'lib/ruconomic/api/account.rb', line 452

def self.set_total_from
  response = invoke('Account_SetTotalFrom') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.set_typeHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Sets the account type of an account. This also updates the property TotalFrom. Parameters: accountHandle: Handle for the account. valueHandle: New account type of the account.


284
285
286
287
288
# File 'lib/ruconomic/api/account.rb', line 284

def self.set_type
  response = invoke('Account_SetType') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.set_vat_accountHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Sets the VAT account of an account. Parameters: accountHandle: Handle for the account. vatAccountHandle: Handle for the new VAT account of the account.


380
381
382
383
384
# File 'lib/ruconomic/api/account.rb', line 380

def self.
  response = invoke('Account_SetVatAccount') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.update_from_dataHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Updates an account from a data object. Parameters: data: The data object.


48
49
50
51
52
# File 'lib/ruconomic/api/account.rb', line 48

def self.update_from_data
  response = invoke('Account_UpdateFromData') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.update_from_data_arrayHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Update accounts from data objects. Parameters: dataArray: The array of data objects.


36
37
38
39
40
# File 'lib/ruconomic/api/account.rb', line 36

def self.update_from_data_array
  response = invoke('Account_UpdateFromDataArray') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end