Module: Ruconomic::API::BudgetFigure

Extended by:
WebService
Defined in:
lib/ruconomic/api/budget_figure.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 budget figure. Parameters: account: The account of the budget figure text: The text of the budget figure fromDate: The start date of the budget figure. toDate: The end date of the budget figure. amountDefaultCurrency: The amount in the default currency of the budget figure.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


240
241
242
243
244
# File 'lib/ruconomic/api/budget_figure.rb', line 240

def self.create
  response = invoke('BudgetFigure_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 budget figure from a data object. Parameters: data: The data object that specifies the properties of the new budget figure.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


287
288
289
290
291
# File 'lib/ruconomic/api/budget_figure.rb', line 287

def self.create_from_data
  response = invoke('BudgetFigure_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 budget figures from data objects. Parameters: dataArray: The array of data objects that specifies the properties of the new budget figures.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


299
300
301
302
303
# File 'lib/ruconomic/api/budget_figure.rb', line 299

def self.create_from_data_array
  response = invoke('BudgetFigure_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 a budget figure. Parameters: budgetfigureHandle: Handle for the budget figure.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


252
253
254
255
256
# File 'lib/ruconomic/api/budget_figure.rb', line 252

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

.find_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 a time interval. Parameters: fromDate: First day in the interval. toDate: Last day in the interval.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


275
276
277
278
279
# File 'lib/ruconomic/api/budget_figure.rb', line 275

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

.get_accountHash

Note:

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

Get handle for account of a budget figure. Parameters: budgetfigureHandle: Handle for the budget figure.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


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

def self.
  response = invoke('BudgetFigure_GetAccount') 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 budget figures.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


263
264
265
266
267
# File 'lib/ruconomic/api/budget_figure.rb', line 263

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

.get_amount_default_currencyHash

Note:

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

Gets the amount of a budget figure. Parameters: budgetfigureHandle: Handle for the budget figure.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


120
121
122
123
124
# File 'lib/ruconomic/api/budget_figure.rb', line 120

def self.get_amount_default_currency
  response = invoke('BudgetFigure_GetAmountDefaultCurrency') 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 a budget figure data object for a given budgetfigure. Parameters: entityHandle: A handle for the budget figure.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


335
336
337
338
339
# File 'lib/ruconomic/api/budget_figure.rb', line 335

def self.get_data
  response = invoke('BudgetFigure_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 budget figure data objects for a given set of budget figure handles. Parameters: entityHandles: An array of budget figure handles.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


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

def self.get_data_array
  response = invoke('BudgetFigure_GetDataArray') 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 a budget figure. The department is only accessible when there is access to the Dimension add-on module. Parameters: budgetfigureHandle: Handle for the budget figure.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


204
205
206
207
208
# File 'lib/ruconomic/api/budget_figure.rb', line 204

def self.get_department
  response = invoke('BudgetFigure_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 a budget figure. The distribution key is only accessible when there is access to the Dimension add-on module. Parameters: budgetfigureHandle: Handle for the budget figure.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


228
229
230
231
232
# File 'lib/ruconomic/api/budget_figure.rb', line 228

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

.get_from_dateHash

Note:

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

Gets the fromdate of a budget figure. Parameters: budgetfigureHandle: Handle for the budget figure.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


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

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

.get_quantity1Hash

Note:

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

Gets the quantity1 of a budget figure. The quantity1 is only accessible when there is access to the Dimension add-on module. Parameters: budgetfigureHandle: Handle for the budget figure.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


156
157
158
159
160
# File 'lib/ruconomic/api/budget_figure.rb', line 156

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

.get_quantity2Hash

Note:

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

Gets the quantity2 of a budget figure. The quantity2 is only accessible when there is access to the Dimension add-on module. Parameters: budgetfigureHandle: Handle for the budget figure.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


168
169
170
171
172
# File 'lib/ruconomic/api/budget_figure.rb', line 168

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

.get_textHash

Note:

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

Gets the text of a budget figure. Parameters: budgetfigureHandle: Handle for the budget figure.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


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

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

.get_to_dateHash

Note:

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

Gets the todate of a budget figure. Parameters: budgetfigureHandle: Handle for the budget figure.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


108
109
110
111
112
# File 'lib/ruconomic/api/budget_figure.rb', line 108

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

.get_unit1Hash

Note:

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

Gets a handle for the unit1 of a budget figure. The unit1 is only accessible when there is access to the Dimension add-on module. Parameters: budgetfigureHandle: Handle for the budget figure.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


132
133
134
135
136
# File 'lib/ruconomic/api/budget_figure.rb', line 132

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

.get_unit2Hash

Note:

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

Gets a handle for the unit2 of a budget figure. The unit2 is only accessible when there is access to the Dimension add-on module. Parameters: budgetfigureHandle: Handle for the budget figure.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


144
145
146
147
148
# File 'lib/ruconomic/api/budget_figure.rb', line 144

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

.set_accountHash

Note:

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

Set the account of a budget figure. Parameters: budgetfigureHandle: Handle for the budget figure. valueHandle: New handle for new account of the budget figure.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


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

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

.set_amount_default_currencyHash

Note:

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

Sets the amount of a budget figure. Parameters: budgetfigureHandle: Handle for the budget figure. value: The new amount of the budget figure.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


180
181
182
183
184
# File 'lib/ruconomic/api/budget_figure.rb', line 180

def self.set_amount_default_currency
  response = invoke('BudgetFigure_SetAmountDefaultCurrency') 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 a budget figure. 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: budgetfigureHandle: Handle for the budget figure. value: Handle for the new department of the budget figure.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


192
193
194
195
196
# File 'lib/ruconomic/api/budget_figure.rb', line 192

def self.set_department
  response = invoke('BudgetFigure_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 a budget figure. 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: budgetfigureHandle: Handle for the budget figure. value: Handle for the new distribution key of the budget figure.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


216
217
218
219
220
# File 'lib/ruconomic/api/budget_figure.rb', line 216

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

.set_from_dateHash

Note:

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

Sets the fromdate of a budget figure. Parameters: budgetfigureHandle: Handle for the budget figure. value: The new fromdate of the budget figure.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


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

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

.set_textHash

Note:

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

Sets the text of a budget figure. Parameters: budgetfigureHandle: Handle for the budget figure. value: The new text of the budget figure.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


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

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

.set_to_dateHash

Note:

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

Sets the todate of a budget figure. Parameters: budgetfigureHandle: Handle for the budget figure. value: The new todate of the budget figure.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


96
97
98
99
100
# File 'lib/ruconomic/api/budget_figure.rb', line 96

def self.set_to_date
  response = invoke('BudgetFigure_SetToDate') 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 a budget figure from a data object. Parameters: data: The data object.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


323
324
325
326
327
# File 'lib/ruconomic/api/budget_figure.rb', line 323

def self.update_from_data
  response = invoke('BudgetFigure_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 budget figures from data objects. Parameters: dataArray: The array of data objects.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


311
312
313
314
315
# File 'lib/ruconomic/api/budget_figure.rb', line 311

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