Class: UU::Finman::FinancialTransaction::TransferCreate

Inherits:

OS::REST::DTO

Object
OS::REST::DTO
UU::Finman::FinancialTransaction::TransferCreate

show all

Defined in:

lib/uu/finman/financialtransaction/transfer_create.rb

Overview

DTO for create command of Transfer create.

Instance Attribute Summary (collapse)

- (Fixnum) amount_with_vat

Amount of the Transfer with vat.
- (Fixnum) amount_without_vat

Amount of the Transfer without vat.
- (UU::OS::UESURI) contract_uri

UESURI of Contract.
- (String) cost_item_code

Code of cost item.
- (UU::OS::UESURI) counterparty_business_case_uri

UESURI of the business case of non-control side of paynment.
- (String) credit_account_number

Number of credit account.
- (UU::OS::UESURI) credit_account_uri

UESURI of credit account artifact.
- (String) credit_description

Description for credit side.
- (UU::OS::UESURI) credit_financial_category_uri

UESURI of credit financial category.
- (String) credit_side_currency

Code of credit side currency.
- (String) debit_account_number

Number of debit account.
- (UU::OS::UESURI) debit_account_uri

UESURI of debit account artifact.
- (String) debit_description

Description for debit side.
- (UU::OS::UESURI) debit_financial_category_uri

UESURI of debit financial category.
- (String) debit_side_currency

Code of debit side currency.
- (TrueClass, FalseClass) dry_run

Dry run.
- (String) expected_pay_date

Date the transfer is expected to be payed to.
- (Fixnum) explicit_amount

Explicit amount with VAT in opposite side currency.
- (Fixnum) explicit_exchange_rate

Explicit exchange rate.
- (String) financial_transaction_state

Type of advanced state.
- (String) financial_transaction_type

Type of financial transaction.
- (String) income_item_code

Code of income item.
- (TrueClass, FalseClass) is_ready_to_be_paid

Possible values: true or false.
- (TrueClass, FalseClass) is_transaction_credit

Possible values: true or false.
- (String) name

Name of created Transfer.
- (Fixnum) realization_probability

Probability of transfer realization in %.
- (String) related_links

Related links(URI, label) in JSON format.
- (String) transaction_currency

Code of transaction currency.
- (String) variable_symbol

Variable symbol.
- (String) vat_date

Credit vat date of the transaction.
- (Fixnum) vat_rate

Vat rate.

Instance Attribute Details

- (`Fixnum`) amount_with_vat

Amount of the Transfer with vat. Either amount with vat or vat rate must be set.

Parameters:

(Fixnum)

Returns:

(Fixnum)



27
28
29

# File 'lib/uu/finman/financialtransaction/transfer_create.rb', line 27

def amount_with_vat
  @amount_with_vat
end

- (`Fixnum`) amount_without_vat

Amount of the Transfer without vat. Required attribute. Cannot be null.

Parameters:

(Fixnum)

Returns:

(Fixnum)



21
22
23

# File 'lib/uu/finman/financialtransaction/transfer_create.rb', line 21

def amount_without_vat
  @amount_without_vat
end

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

UESURI of Contract.

Parameters:

(String, UU::OS::UESURI)

Returns:

(UU::OS::UESURI)



32
33
34

# File 'lib/uu/finman/financialtransaction/transfer_create.rb', line 32

def contract_uri
  @contract_uri
end

- (`String`) cost_item_code

Code of cost item.

Parameters:

(String)

Returns:

(String)



37
38
39

# File 'lib/uu/finman/financialtransaction/transfer_create.rb', line 37

def cost_item_code
  @cost_item_code
end

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

UESURI of the business case of non-control side of paynment. Requrired attribute. Cannot be null.

Parameters:

(String, UU::OS::UESURI)

Returns:

(UU::OS::UESURI)



43
44
45

# File 'lib/uu/finman/financialtransaction/transfer_create.rb', line 43

def counterparty_business_case_uri
  @counterparty_business_case_uri
end

- (`String`) credit_account_number

Number of credit account. Either number or UESURI of account must be set. Not both of them.

Parameters:

(String)

Returns:

(String)



49
50
51

# File 'lib/uu/finman/financialtransaction/transfer_create.rb', line 49

def credit_account_number
  @credit_account_number
end

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

UESURI of credit account artifact. Either number or UESURI of account must be set. Not both of them.

Parameters:

(String, UU::OS::UESURI)

Returns:

(UU::OS::UESURI)



55
56
57

# File 'lib/uu/finman/financialtransaction/transfer_create.rb', line 55

def credit_account_uri
  @credit_account_uri
end

- (`String`) credit_description

Description for credit side.

Parameters:

(String)

Returns:

(String)



60
61
62

# File 'lib/uu/finman/financialtransaction/transfer_create.rb', line 60

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)



65
66
67

# File 'lib/uu/finman/financialtransaction/transfer_create.rb', line 65

def credit_financial_category_uri
  @credit_financial_category_uri
end

- (`String`) credit_side_currency

Code of credit side currency.

Parameters:

(String)

Returns:

(String)



70
71
72

# File 'lib/uu/finman/financialtransaction/transfer_create.rb', line 70

def credit_side_currency
  @credit_side_currency
end

- (`String`) debit_account_number

Number of debit account. Either number or UESURI of account must be set. Not both of them.

Parameters:

(String)

Returns:

(String)



91
92
93

# File 'lib/uu/finman/financialtransaction/transfer_create.rb', line 91

def debit_account_number
  @debit_account_number
end

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

UESURI of debit account artifact. Either number or UESURI of account must be set. Not both of them.

Parameters:

(String, UU::OS::UESURI)

Returns:

(UU::OS::UESURI)



97
98
99

# File 'lib/uu/finman/financialtransaction/transfer_create.rb', line 97

def debit_account_uri
  @debit_account_uri
end

- (`String`) debit_description

Description for debit side.

Parameters:

(String)

Returns:

(String)



102
103
104

# File 'lib/uu/finman/financialtransaction/transfer_create.rb', line 102

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)



107
108
109

# File 'lib/uu/finman/financialtransaction/transfer_create.rb', line 107

def debit_financial_category_uri
  @debit_financial_category_uri
end

- (`String`) debit_side_currency

Code of debit side currency.

Parameters:

(String)

Returns:

(String)



75
76
77

# File 'lib/uu/finman/financialtransaction/transfer_create.rb', line 75

def debit_side_currency
  @debit_side_currency
end

- (`TrueClass`, `FalseClass`) dry_run

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

Parameters:

(TrueClass, FalseClass)

Returns:

(TrueClass, FalseClass)



159
160
161

# File 'lib/uu/finman/financialtransaction/transfer_create.rb', line 159

def dry_run
  @dry_run
end

- (`String`) expected_pay_date

Date the transfer is expected to be payed to. Required attribute. Cannot be null.

Parameters:

(String, Time)

Returns:

(String)



113
114
115

# File 'lib/uu/finman/financialtransaction/transfer_create.rb', line 113

def expected_pay_date
  @expected_pay_date
end

- (`Fixnum`) explicit_amount

Explicit amount with VAT in opposite side currency. Can be set only by role cast in Accounting Authorities.

Parameters:

(Fixnum)

Returns:

(Fixnum)



174
175
176

# File 'lib/uu/finman/financialtransaction/transfer_create.rb', line 174

def explicit_amount
  @explicit_amount
end

- (`Fixnum`) explicit_exchange_rate

Explicit exchange rate. Can be set only by role cast in Accounting Authorities.

Parameters:

(Fixnum)

Returns:

(Fixnum)



169
170
171

# File 'lib/uu/finman/financialtransaction/transfer_create.rb', line 169

def explicit_exchange_rate
  @explicit_exchange_rate
end

- (`String`) financial_transaction_state

Type of advanced state

Parameters:

(String, FinancialTransactionState)

Returns:

(String)



179
180
181

# File 'lib/uu/finman/financialtransaction/transfer_create.rb', line 179

def financial_transaction_state
  @financial_transaction_state
end

- (`String`) financial_transaction_type

Type of financial transaction. Item from enumeration FinancialTransactionType. Cannot be null. Following rules must be obeyed:

If both UESURI of debit and credit account are set, then:

if both accounts are Bank accounts, FinancialTransactionType.NONCASH must be set.
if at least one account is Cash account, FinancialTransactionType.CASH must be set.

Otherwise any choice can be set.

Parameters:

(String, FinancialTransactionType)

Returns:

(String)



124
125
126

# File 'lib/uu/finman/financialtransaction/transfer_create.rb', line 124

def financial_transaction_type
  @financial_transaction_type
end

- (`String`) income_item_code

Code of income item.

Parameters:

(String)

Returns:

(String)



129
130
131

# File 'lib/uu/finman/financialtransaction/transfer_create.rb', line 129

def income_item_code
  @income_item_code
end

- (`TrueClass`, `FalseClass`) is_ready_to_be_paid

Possible values: true or false. By setting to true the transfer will be automatically confirmed on the expected paydate. If not set, default value is 'false'.

Parameters:

(TrueClass, FalseClass)

Returns:

(TrueClass, FalseClass)



141
142
143

# File 'lib/uu/finman/financialtransaction/transfer_create.rb', line 141

def is_ready_to_be_paid
  @is_ready_to_be_paid
end

- (`TrueClass`, `FalseClass`) is_transaction_credit

Possible values: true or false. True indicates type of financial transaction as Credit, false as Debit. If not set, default value is 'true'.

Parameters:

(TrueClass, FalseClass)

Returns:

(TrueClass, FalseClass)



135
136
137

# File 'lib/uu/finman/financialtransaction/transfer_create.rb', line 135

def is_transaction_credit
  @is_transaction_credit
end

- (`String`) name

Name of created Transfer. Required attribute. Cannot be null or empty.

Parameters:

(String)

Returns:

(String)



16
17
18

# File 'lib/uu/finman/financialtransaction/transfer_create.rb', line 16

def name
  @name
end

- (`Fixnum`) realization_probability

Probability of transfer realization in %. Required attribute. Cannot be null.

Parameters:

(Fixnum)

Returns:

(Fixnum)



147
148
149

# File 'lib/uu/finman/financialtransaction/transfer_create.rb', line 147

def realization_probability
  @realization_probability
end

- (`String`) related_links

Related links(URI, label) in JSON format.

Parameters:

(String)

Returns:

(String)



184
185
186

# File 'lib/uu/finman/financialtransaction/transfer_create.rb', line 184

def related_links
  @related_links
end

- (`String`) transaction_currency

Code of transaction currency.

Parameters:

(String)

Returns:

(String)



80
81
82

# File 'lib/uu/finman/financialtransaction/transfer_create.rb', line 80

def transaction_currency
  @transaction_currency
end

- (`String`) variable_symbol

Variable symbol.

Parameters:

(String)

Returns:

(String)



164
165
166

# File 'lib/uu/finman/financialtransaction/transfer_create.rb', line 164

def variable_symbol
  @variable_symbol
end

- (`String`) vat_date

Credit vat date of the transaction.

Parameters:

(String, Time)

Returns:

(String)



85
86
87

# File 'lib/uu/finman/financialtransaction/transfer_create.rb', line 85

def vat_date
  @vat_date
end

- (`Fixnum`) vat_rate

Vat rate. Either amount with vat or vat rate must be set.

Parameters:

(Fixnum)

Returns:

(Fixnum)



153
154
155

# File 'lib/uu/finman/financialtransaction/transfer_create.rb', line 153

def vat_rate
  @vat_rate
end

Class: UU::Finman::FinancialTransaction::TransferCreate

Overview

Instance Attribute Summary (collapse)

Instance Attribute Details

- (Fixnum) amount_with_vat

- (Fixnum) amount_without_vat

- (UU::OS::UESURI) contract_uri

- (String) cost_item_code

- (UU::OS::UESURI) counterparty_business_case_uri

- (String) credit_account_number

- (UU::OS::UESURI) credit_account_uri

- (String) credit_description

- (UU::OS::UESURI) credit_financial_category_uri

- (String) credit_side_currency

- (String) debit_account_number

- (UU::OS::UESURI) debit_account_uri

- (String) debit_description

- (UU::OS::UESURI) debit_financial_category_uri

- (String) debit_side_currency

- (TrueClass, FalseClass) dry_run

- (String) expected_pay_date

- (Fixnum) explicit_amount

- (Fixnum) explicit_exchange_rate

- (String) financial_transaction_state

- (String) financial_transaction_type

- (String) income_item_code

- (TrueClass, FalseClass) is_ready_to_be_paid

- (TrueClass, FalseClass) is_transaction_credit

- (String) name

- (Fixnum) realization_probability

- (String) related_links

- (String) transaction_currency

- (String) variable_symbol

- (String) vat_date

- (Fixnum) vat_rate

- (`Fixnum`) amount_with_vat

- (`Fixnum`) amount_without_vat

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

- (`String`) cost_item_code

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

- (`String`) credit_account_number

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

- (`String`) credit_description

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

- (`String`) credit_side_currency

- (`String`) debit_account_number

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

- (`String`) debit_description

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

- (`String`) debit_side_currency

- (`TrueClass`, `FalseClass`) dry_run

- (`String`) expected_pay_date

- (`Fixnum`) explicit_amount

- (`Fixnum`) explicit_exchange_rate

- (`String`) financial_transaction_state

- (`String`) financial_transaction_type

- (`String`) income_item_code

- (`TrueClass`, `FalseClass`) is_ready_to_be_paid

- (`TrueClass`, `FalseClass`) is_transaction_credit

- (`String`) name

- (`Fixnum`) realization_probability

- (`String`) related_links

- (`String`) transaction_currency

- (`String`) variable_symbol

- (`String`) vat_date

- (`Fixnum`) vat_rate