Class: UU::Finman::FinancialTransaction::TransferAttributes

Inherits:
FinancialTransactionDTO show all
Defined in:
lib/uu/finman/financialtransaction/transfer_attributes.rb

Overview

DTO for get attributes command of financial transfer.

Instance Attribute Summary (collapse)

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class UU::Finman::FinancialTransaction::FinancialTransactionDTO

Instance Attribute Details

- (Fixnum) amount_with_vat

Amount of the Financial Transaction with vat.

Parameters:

  • (Fixnum)

Returns:

  • (Fixnum) 


125
126
127
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 125

def amount_with_vat
  @amount_with_vat
end

- (Fixnum) amount_without_vat

Amount of the Financial Transaction without vat.

Parameters:

  • (Fixnum)

Returns:

  • (Fixnum) 


120
121
122
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 120

def amount_without_vat
  @amount_without_vat
end

- (String) code

Code of the financial transaction.

Parameters:

  • (String)

Returns:

  • (String) 


35
36
37
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 35

def code
  @code
end

- (UU::OS::UESURI) competent_role_uri

URI of role competent for the financial transaction.

Parameters:

  • (String, UU::OS::UESURI)

Returns:

  • (UU::OS::UESURI) 


45
46
47
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 45

def competent_role_uri
  @competent_role_uri
end

- (UU::OS::UESURI) complementary_transfer_uri

UESURI of complementary transfer to this reinvoicing transfer. Set only for reinvoicing transfers

Parameters:

  • (String, UU::OS::UESURI)

Returns:

  • (UU::OS::UESURI) 


131
132
133
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 131

def complementary_transfer_uri
  @complementary_transfer_uri
end

- (UU::OS::UESURI) contract_uri

UESURI of Contract.

Parameters:

  • (String, UU::OS::UESURI)

Returns:

  • (UU::OS::UESURI) 


141
142
143
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 141

def contract_uri
  @contract_uri
end

- (ControlSide) control_side

Specifies which side controls transaction (CREDIT or DEBIT).

Parameters:

Returns:



136
137
138
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 136

def control_side
  @control_side
end

- (String) cost_item_code

Code of cost item.

Parameters:

  • (String)

Returns:

  • (String) 


146
147
148
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 146

def cost_item_code
  @cost_item_code
end

- (String) creation_stamp

Creation stamp of the financial transaction.

Parameters:

  • (String)

Returns:

  • (String) 


65
66
67
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 65

def creation_stamp
  @creation_stamp
end

- (String) creation_time

Creation time of the financial transaction.

Parameters:

  • (String, Time)

Returns:

  • (String) 


70
71
72
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 70

def creation_time
  @creation_time
end

- (String) credit_account_number

Number of credit account.

Parameters:

  • (String)

Returns:

  • (String) 


151
152
153
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 151

def 
  @credit_account_number
end

- (UU::OS::UESURI) credit_account_uri

UESURI of credit account artifact.

Parameters:

  • (String, UU::OS::UESURI)

Returns:

  • (UU::OS::UESURI) 


156
157
158
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 156

def 
  @credit_account_uri
end

- (UU::OS::UESURI) credit_business_case_uri

UESURI of the credit business case

Parameters:

  • (String, UU::OS::UESURI)

Returns:

  • (UU::OS::UESURI) 


161
162
163
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 161

def credit_business_case_uri
  @credit_business_case_uri
end

- (String) credit_description

Description for credit side.

Parameters:

  • (String)

Returns:

  • (String) 


166
167
168
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 166

def credit_description
  @credit_description
end

- (UU::OS::UESURI) credit_financial_category_uri

UESURI of credit financial category.

Parameters:

  • (String, UU::OS::UESURI)

Returns:

  • (UU::OS::UESURI) 


171
172
173
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 171

def credit_financial_category_uri
  @credit_financial_category_uri
end

- (String) credit_side_currency

Code of credit side currency.

Parameters:

  • (String)

Returns:

  • (String) 


278
279
280
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 278

def credit_side_currency
  @credit_side_currency
end

- (String) debit_account_number

Number of debit account.

Parameters:

  • (String)

Returns:

  • (String) 


176
177
178
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 176

def 
  @debit_account_number
end

- (UU::OS::UESURI) debit_account_uri

UESURI of debit account artifact.

Parameters:

  • (String, UU::OS::UESURI)

Returns:

  • (UU::OS::UESURI) 


181
182
183
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 181

def 
  @debit_account_uri
end

- (UU::OS::UESURI) debit_business_case_uri

UESURI of the debit business case.

Parameters:

  • (String, UU::OS::UESURI)

Returns:

  • (UU::OS::UESURI) 


186
187
188
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 186

def debit_business_case_uri
  @debit_business_case_uri
end

- (String) debit_description

Description for debit side.

Parameters:

  • (String)

Returns:

  • (String) 


191
192
193
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 191

def debit_description
  @debit_description
end

- (UU::OS::UESURI) debit_financial_category_uri

UESURI of debit financial category.

Parameters:

  • (String, UU::OS::UESURI)

Returns:

  • (UU::OS::UESURI) 


196
197
198
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 196

def debit_financial_category_uri
  @debit_financial_category_uri
end

- (String) debit_side_currency

Code of debit side currency.

Parameters:

  • (String)

Returns:

  • (String) 


283
284
285
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 283

def debit_side_currency
  @debit_side_currency
end

- (String) description

Description of the financial transaction.

Parameters:

  • (String)

Returns:

  • (String) 


40
41
42
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 40

def description
  @description
end

- (String) entity_type_uri

UESURI of the entity type of the artifact

Parameters:

  • (String)

Returns:

  • (String) 


115
116
117
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 115

def entity_type_uri
  @entity_type_uri
end

- (String) expected_pay_date

Date the payment is expected to be payed to.

Parameters:

  • (String, Time)

Returns:

  • (String) 


201
202
203
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 201

def expected_pay_date
  @expected_pay_date
end

- (Fixnum) explicit_amount

Amount in other side currency, specified by user

Parameters:

  • (Fixnum)

Returns:

  • (Fixnum) 


206
207
208
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 206

def explicit_amount
  @explicit_amount
end

- (FinancialTransactionClass) financial_transaction_class

Class of financial transaction (specifies if it is Payment, Transfer, Expost payment or Credit note)

Parameters:

Returns:



217
218
219
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 217

def financial_transaction_class
  @financial_transaction_class
end

- (FinancialTransactionType) financial_transaction_type

Type of financial transaction. Item from enumeration FinancialTransactionType Possible values: CASH or NONCASH

Parameters:

Returns:



212
213
214
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 212

def financial_transaction_type
  @financial_transaction_type
end

- (UU::OS::UESURI) icon_uri

URI of the icon of the financial transaction.

Parameters:

  • (String, UU::OS::UESURI)

Returns:

  • (UU::OS::UESURI) 


110
111
112
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 110

def icon_uri
  @icon_uri
end

- (String) income_item_code

Code of income item.

Parameters:

  • (String)

Returns:

  • (String) 


222
223
224
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 222

def income_item_code
  @income_item_code
end

- (TrueClass, FalseClass) is_ready_to_be_paid

True states that the transfer will be automatically confirmed on the expected paydate.

Parameters:

  • (TrueClass, FalseClass)

Returns:

  • (TrueClass, FalseClass) 


228
229
230
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 228

def is_ready_to_be_paid
  @is_ready_to_be_paid
end

- (UU::OS::UESURI) location_uri

URI of container of the financial transaction.

Parameters:

  • (String, UU::OS::UESURI)

Returns:

  • (UU::OS::UESURI) 


50
51
52
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 50

def location_uri
  @location_uri
end

- (UU::OS::UESURI) meta_artifact_uri

URI of meta artifact of the financial transaction.

Parameters:

  • (String, UU::OS::UESURI)

Returns:

  • (UU::OS::UESURI) 


25
26
27
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 25

def meta_artifact_uri
  @meta_artifact_uri
end

- (String) modification_stamp

Modification stamp of the financial transaction.

Parameters:

  • (String)

Returns:

  • (String) 


75
76
77
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 75

def modification_stamp
  @modification_stamp
end

- (String) modification_time

Modification time of the financial transaction.

Parameters:

  • (String, Time)

Returns:

  • (String) 


80
81
82
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 80

def modification_time
  @modification_time
end

- (String) name

Name of the financial transaction.

Parameters:

  • (String)

Returns:

  • (String) 


30
31
32
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 30

def name
  @name
end

- (UU::OS::UESURI) organizational_unit_uri

URI of organizational unit of the financial transaction.

Parameters:

  • (String, UU::OS::UESURI)

Returns:

  • (UU::OS::UESURI) 


55
56
57
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 55

def organizational_unit_uri
  @organizational_unit_uri
end

- (String) pay_date

Pay date of the transaction.

Parameters:

  • (String, Time)

Returns:

  • (String) 


233
234
235
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 233

def pay_date
  @pay_date
end

- (Fixnum) realization_probability

Probability of payment realization in %.

Parameters:

  • (Fixnum)

Returns:

  • (Fixnum) 


238
239
240
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 238

def realization_probability
  @realization_probability
end

- (UU::OS::UESURI) reinvoice_from_category_uri

UESURI of financial category the amount will be reinvoiced from.

Parameters:

  • (String, UU::OS::UESURI)

Returns:

  • (UU::OS::UESURI) 


243
244
245
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 243

def reinvoice_from_category_uri
  @reinvoice_from_category_uri
end

- (String) reinvoice_from_item

Code of item the amount will be reinvoiced on.

Parameters:

  • (String)

Returns:

  • (String) 


253
254
255
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 253

def reinvoice_from_item
  @reinvoice_from_item
end

- (String) reinvoice_on_item

Code of item the amount will be reinvoiced on.

Parameters:

  • (String)

Returns:

  • (String) 


258
259
260
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 258

def reinvoice_on_item
  @reinvoice_on_item
end

- (UU::OS::UESURI) reinvoice_to_category_uri

UESURI of financial category the amount will be reinvoiced to.

Parameters:

  • (String, UU::OS::UESURI)

Returns:

  • (UU::OS::UESURI) 


248
249
250
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 248

def reinvoice_to_category_uri
  @reinvoice_to_category_uri
end

- (ReinvoicingType) reinvoicing_type

Identifies type of reinvoicing. Possible values: INCOMES_INCOMES, COSTS_COSTS

Parameters:

Returns:



263
264
265
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 263

def reinvoicing_type
  @reinvoicing_type
end

- (String) related_links

Related links(URI, label) in JSON format.

Parameters:

  • (String)

Returns:

  • (String) 


298
299
300
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 298

def related_links
  @related_links
end

- (UU::OS::Artifact::SecurityLevel) security_level

Security level of the financial transaction.

Parameters:

  • (String, UU::OS::Artifact::SecurityLevel)

Returns:

  • (UU::OS::Artifact::SecurityLevel) 


60
61
62
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 60

def security_level
  @security_level
end

- (String) state_comment

Comment of current state of the financial transaction.

Parameters:

  • (String)

Returns:

  • (String) 


95
96
97
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 95

def state_comment
  @state_comment
end

- (String) state_name

Name of current state of the financial transaction.

Parameters:

  • (String)

Returns:

  • (String) 


90
91
92
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 90

def state_name
  @state_name
end

- (UU::OS::Artifact::ArtifactStateType) state_type

Type of current state of the financial transaction.

Parameters:

  • (UU::OS::Artifact::ArtifactStateType)

Returns:

  • (UU::OS::Artifact::ArtifactStateType) 


100
101
102
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 100

def state_type
  @state_type
end

- (String) transaction_currency

Code of transaction currency.

Parameters:

  • (String)

Returns:

  • (String) 


288
289
290
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 288

def transaction_currency
  @transaction_currency
end

- (UU::OS::UESURI) uri

URI of the financial transaction.

Parameters:

  • (String, UU::OS::UESURI)

Returns:

  • (UU::OS::UESURI) 


20
21
22
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 20

def uri
  @uri
end

- (String) variable_symbol

Variable symbol.

Parameters:

  • (String)

Returns:

  • (String) 


293
294
295
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 293

def variable_symbol
  @variable_symbol
end

- (String) vat_date

Vat date of the transaction.

Parameters:

  • (String, Time)

Returns:

  • (String) 


268
269
270
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 268

def vat_date
  @vat_date
end

- (Fixnum) vat_rate

Vat rate.

Parameters:

  • (Fixnum)

Returns:

  • (Fixnum) 


273
274
275
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 273

def vat_rate
  @vat_rate
end

- (String) version

Version of the financial transaction.

Parameters:

  • (String)

Returns:

  • (String) 


85
86
87
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 85

def version
  @version
end

- (String) width

Flag of width of sheets of the financial transaction.

Parameters:

  • (String)

Returns:

  • (String) 


105
106
107
 
# File 'lib/uu/finman/financialtransaction/transfer_attributes.rb', line 105

def width
  @width
end