Class: UU::Fairpay2::FinancialTransaction::BankTransactionCreate

Inherits:

OS::REST::DTO

Object
OS::REST::DTO
UU::Fairpay2::FinancialTransaction::BankTransactionCreate

show all

Defined in:

lib/uu/fairpay2/financialtransaction/bank_transaction_create.rb

Overview

Value object defining data required (available) for creating new Bank Transaction entity.

Instance Attribute Summary (collapse)

- (Fixnum) amount

Amount of the Bank Transaction.
- (Fixnum) amount_for_opp_side

Amount for opposite side Required attribute, cannot be null or invalid Fixnum.
- (String) code

Code of the bank transaction.
- (UU::OS::UESURI) competent_role_uri

URI of the role competent for the Bank Transaction.
- (String) constant_symbol

Constant symbol.
- (String) credit_account_currency

Credit Account Currency Required attribute, cannot be null, empty, whitespace only or longer than 250 characters.
- (String) credit_account_number

Credit Client Account Number Must not be empty string, must not contain whitespace characters only and must not be longer than 4000 characters.
- (UU::OS::UESURI) credit_account_uri

UESURI of Credit Account Uri Must be valid UESURI of account.
- (String) currency

Currency code.
- (String) debit_account_currency

Debit Account Currency Required attribute, cannot be null, empty, whitespace only or longer than 250 characters.
- (String) debit_account_number

Debit Client Account Number Must not be empty string, must not contain whitespace characters only and must not be longer than 4000 characters.
- (UU::OS::UESURI) debit_account_uri

UESURI of Debit Account Uri Must be valid UESURI of account.
- (String) debit_business_case_uri

UESURI of the debit business case or Client Account Business Case.
- (String) description

Description of the Bank Transaction.
- (TrueClass, FalseClass) dry_run

Dry run.
- (Fixnum) exchange_rate_for_opp_side

Exchange rate for opposite side.
- (String) finman_transaction_uri

UESURI of Finman g03 transaction or uri of financial transaction in uuFinMang05.
- (UU::OS::UESURI) location_uri

UESURI of org.
- (String) message_payer

Message for payer.
- (String) message_recipient

Message for recipient.
- (UU::OS::UESURI) meta_artifact_uri

URI of the meta artifact.
- (String) name

Name of the bank transaction.
- (UU::OS::Artifact::SecurityLevel) security_level

Security level.
- (String) specific_symbol

Specific symbol.
- (String) variable_symbol

Variable symbol.

Instance Attribute Details

- (`Fixnum`) amount

Amount of the Bank Transaction. Required attribute, cannot be null or invalid Fixnum.

Parameters:

(Fixnum)

Returns:

(Fixnum)



50
51
52

# File 'lib/uu/fairpay2/financialtransaction/bank_transaction_create.rb', line 50

def amount
  @amount
end

- (`Fixnum`) amount_for_opp_side

Amount for opposite side Required attribute, cannot be null or invalid Fixnum. Maximum digits before decimal part is 7.

Parameters:

(Fixnum)

Returns:

(Fixnum)



152
153
154

# File 'lib/uu/fairpay2/financialtransaction/bank_transaction_create.rb', line 152

def amount_for_opp_side
  @amount_for_opp_side
end

- (`String`) code

Code of the bank transaction. The code must be unique in target territory. It cannot be empty string nor longer than 250 characters and can contain only allowed characters.

Parameters:

(String)

Returns:

(String)



21
22
23

# File 'lib/uu/fairpay2/financialtransaction/bank_transaction_create.rb', line 21

def code
  @code
end

- (`UU::OS::UESURI`) competent_role_uri

URI of the role competent for the Bank Transaction. Required attribute, cannot be null and must be valid UESURI.

Parameters:

(String, UU::OS::UESURI)

Returns:

(UU::OS::UESURI)



33
34
35

# File 'lib/uu/fairpay2/financialtransaction/bank_transaction_create.rb', line 33

def competent_role_uri
  @competent_role_uri
end

- (`String`) constant_symbol

Constant symbol. Must not be empty string, must not contain whitespace characters only and must not be longer than 4000 characters.

Parameters:

(String)

Returns:

(String)



56
57
58

# File 'lib/uu/fairpay2/financialtransaction/bank_transaction_create.rb', line 56

def constant_symbol
  @constant_symbol
end

- (`String`) credit_account_currency

Credit Account Currency Required attribute, cannot be null, empty, whitespace only or longer than 250 characters.

Parameters:

(String)

Returns:

(String)



134
135
136

# File 'lib/uu/fairpay2/financialtransaction/bank_transaction_create.rb', line 134

def credit_account_currency
  @credit_account_currency
end

- (`String`) credit_account_number

Credit Client Account Number Must not be empty string, must not contain whitespace characters only and must not be longer than 4000 characters.

Parameters:

(String)

Returns:

(String)



110
111
112

# File 'lib/uu/fairpay2/financialtransaction/bank_transaction_create.rb', line 110

def credit_account_number
  @credit_account_number
end

- (`UU::OS::UESURI`) credit_account_uri

UESURI of Credit Account Uri Must be valid UESURI of account.

Parameters:

(String, UU::OS::UESURI)

Returns:

(UU::OS::UESURI)



122
123
124

# File 'lib/uu/fairpay2/financialtransaction/bank_transaction_create.rb', line 122

def credit_account_uri
  @credit_account_uri
end

- (`String`) currency

Currency code. Required attribute, cannot be null, empty, whitespace only or longer than 250 characters.

Parameters:

(String)

Returns:

(String)



62
63
64

# File 'lib/uu/fairpay2/financialtransaction/bank_transaction_create.rb', line 62

def currency
  @currency
end

- (`String`) debit_account_currency

Debit Account Currency Required attribute, cannot be null, empty, whitespace only or longer than 250 characters.

Parameters:

(String)

Returns:

(String)



140
141
142

# File 'lib/uu/fairpay2/financialtransaction/bank_transaction_create.rb', line 140

def debit_account_currency
  @debit_account_currency
end

- (`String`) debit_account_number

Debit Client Account Number Must not be empty string, must not contain whitespace characters only and must not be longer than 4000 characters.

Parameters:

(String)

Returns:

(String)



116
117
118

# File 'lib/uu/fairpay2/financialtransaction/bank_transaction_create.rb', line 116

def debit_account_number
  @debit_account_number
end

- (`UU::OS::UESURI`) debit_account_uri

UESURI of Debit Account Uri Must be valid UESURI of account.

Parameters:

(String, UU::OS::UESURI)

Returns:

(UU::OS::UESURI)



128
129
130

# File 'lib/uu/fairpay2/financialtransaction/bank_transaction_create.rb', line 128

def debit_account_uri
  @debit_account_uri
end

- (`String`) debit_business_case_uri

UESURI of the debit business case or Client Account Business Case. Required attribute, cannot be null and must be valid UESURI.

Parameters:

(String)

Returns:

(String)



68
69
70

# File 'lib/uu/fairpay2/financialtransaction/bank_transaction_create.rb', line 68

def debit_business_case_uri
  @debit_business_case_uri
end

- (`String`) description

Description of the Bank Transaction. Must not be empty string, must not contain whitespace characters only and must not be longer than 4000 characters.

Parameters:

(String)

Returns:

(String)



27
28
29

# File 'lib/uu/fairpay2/financialtransaction/bank_transaction_create.rb', line 27

def description
  @description
end

- (`TrueClass`, `FalseClass`) dry_run

Dry run. If true, all validations will be processed, but payment will not be created.

Parameters:

(TrueClass, FalseClass)

Returns:

(TrueClass, FalseClass)



158
159
160

# File 'lib/uu/fairpay2/financialtransaction/bank_transaction_create.rb', line 158

def dry_run
  @dry_run
end

- (`Fixnum`) exchange_rate_for_opp_side

Exchange rate for opposite side. Required attribute, cannot be null or invalid Fixnum.

Parameters:

(Fixnum)

Returns:

(Fixnum)



146
147
148

# File 'lib/uu/fairpay2/financialtransaction/bank_transaction_create.rb', line 146

def exchange_rate_for_opp_side
  @exchange_rate_for_opp_side
end

- (`String`) finman_transaction_uri

UESURI of Finman g03 transaction or uri of financial transaction in uuFinMang05. Attribute is not required. Should be used only in integration FINMAN->FAIRPAY

Parameters:

(String)

Returns:

(String)



98
99
100

# File 'lib/uu/fairpay2/financialtransaction/bank_transaction_create.rb', line 98

def finman_transaction_uri
  @finman_transaction_uri
end

- (`UU::OS::UESURI`) location_uri

UESURI of org. unit or folder where we want to create Finman transaction. Required attribute, cannot be null and must be valid UESURI.

Parameters:

(String, UU::OS::UESURI)

Returns:

(UU::OS::UESURI)



104
105
106

# File 'lib/uu/fairpay2/financialtransaction/bank_transaction_create.rb', line 104

def location_uri
  @location_uri
end

- (`String`) message_payer

Message for payer. Must not be empty string, must not contain whitespace characters only and must not be longer than 4000 characters.

Parameters:

(String)

Returns:

(String)



92
93
94

# File 'lib/uu/fairpay2/financialtransaction/bank_transaction_create.rb', line 92

def message_payer
  @message_payer
end

- (`String`) message_recipient

Message for recipient. Must not be empty string, must not contain whitespace characters only and must not be longer than 4000 characters.

Parameters:

(String)

Returns:

(String)



86
87
88

# File 'lib/uu/fairpay2/financialtransaction/bank_transaction_create.rb', line 86

def message_recipient
  @message_recipient
end

- (`UU::OS::UESURI`) meta_artifact_uri

URI of the meta artifact. Required attribute, cannot be null and must be valid UESURI.

Parameters:

(String, UU::OS::UESURI)

Returns:

(UU::OS::UESURI)



39
40
41

# File 'lib/uu/fairpay2/financialtransaction/bank_transaction_create.rb', line 39

def meta_artifact_uri
  @meta_artifact_uri
end

- (`String`) name

Name of the bank transaction. Cannot be null nor empty string nor longer than 250 characters and can contain only allowed characters.

Parameters:

(String)

Returns:

(String)



15
16
17

# File 'lib/uu/fairpay2/financialtransaction/bank_transaction_create.rb', line 15

def name
  @name
end

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

Security level.

Parameters:

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

Returns:

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



44
45
46

# File 'lib/uu/fairpay2/financialtransaction/bank_transaction_create.rb', line 44

def security_level
  @security_level
end

- (`String`) specific_symbol

Specific symbol. Must not be empty string, must not contain whitespace characters only and must not be longer than 4000 characters.

Parameters:

(String)

Returns:

(String)



74
75
76

# File 'lib/uu/fairpay2/financialtransaction/bank_transaction_create.rb', line 74

def specific_symbol
  @specific_symbol
end

- (`String`) variable_symbol

Variable symbol. Must not be empty string, must not contain whitespace characters only and must not be longer than 4000 characters.

Parameters:

(String)

Returns:

(String)



80
81
82

# File 'lib/uu/fairpay2/financialtransaction/bank_transaction_create.rb', line 80

def variable_symbol
  @variable_symbol
end

Class: UU::Fairpay2::FinancialTransaction::BankTransactionCreate

Overview

Instance Attribute Summary (collapse)

Instance Attribute Details

- (Fixnum) amount

- (Fixnum) amount_for_opp_side

- (String) code

- (UU::OS::UESURI) competent_role_uri

- (String) constant_symbol

- (String) credit_account_currency

- (String) credit_account_number

- (UU::OS::UESURI) credit_account_uri

- (String) currency

- (String) debit_account_currency

- (String) debit_account_number

- (UU::OS::UESURI) debit_account_uri

- (String) debit_business_case_uri

- (String) description

- (TrueClass, FalseClass) dry_run

- (Fixnum) exchange_rate_for_opp_side

- (String) finman_transaction_uri

- (UU::OS::UESURI) location_uri

- (String) message_payer

- (String) message_recipient

- (UU::OS::UESURI) meta_artifact_uri

- (String) name

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

- (String) specific_symbol

- (String) variable_symbol

- (`Fixnum`) amount

- (`Fixnum`) amount_for_opp_side

- (`String`) code

- (`UU::OS::UESURI`) competent_role_uri

- (`String`) constant_symbol

- (`String`) credit_account_currency

- (`String`) credit_account_number

- (`UU::OS::UESURI`) credit_account_uri

- (`String`) currency

- (`String`) debit_account_currency

- (`String`) debit_account_number

- (`UU::OS::UESURI`) debit_account_uri

- (`String`) debit_business_case_uri

- (`String`) description

- (`TrueClass`, `FalseClass`) dry_run

- (`Fixnum`) exchange_rate_for_opp_side

- (`String`) finman_transaction_uri

- (`UU::OS::UESURI`) location_uri

- (`String`) message_payer

- (`String`) message_recipient

- (`UU::OS::UESURI`) meta_artifact_uri

- (`String`) name

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

- (`String`) specific_symbol

- (`String`) variable_symbol