Class: UU::Finman::FinancialTransaction::FastPaymentCreate

Inherits:

OS::REST::DTO

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

show all

Defined in:

lib/uu/finman/financialtransaction/fast_payment_create.rb

Overview

DTO for create command of Fast Payment.

Instance Attribute Summary (collapse)

- (UU::OS::UESURI) account_from_opposite_territory

UESURI Account from opposite territory.
- (Fixnum) amount_with_vat

Amount of the Fast Payment with vat.
- (Fixnum) amount_without_vat

Amount of the Fast Payment without vat.
- (TrueClass, FalseClass) close_after_creation

Close after crea-tion.
- (String) constant_symbol

Constant symbol.
- (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.
- (UU::OS::UESURI) credit_business_case_from_opposite_territory

UESURI of credit business case from opposite territory.
- (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.
- (UU::OS::UESURI) debit_business_case_from_opposite_territory

UESURI of debit business case from opposite territory.
- (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) due_date

Date the payment is due to be paid.
- (String) expected_pay_date

Date the payment is expected to be paid to.
- (Fixnum) explicit_amount

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

Explicit exchange rate.
- (String) financial_transaction_type

Type of Fast Payment.
- (String) income_item_code

Code of income item.
- (String) invoice_number

Invoice number of Fast Payment.
- (TrueClass, FalseClass) is_transaction_credit

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

Name of created Payment.
- (TrueClass, FalseClass) pay_after_creation

Pay after creation.
- (String) protocol_date

Date of invoicing to the counterparty.
- (Fixnum) realization_probability

Probability of Fast Payment realization in %.
- (String) related_links

Related links(URI, label) in JSON format.
- (TrueClass, FalseClass) skip_fair_pay_integration

Skip FairPay integration.
- (String) specific_symbol

Specific symbol.
- (String) transaction_currency

Code of transaction currency.
- (String) variable_symbol

Variable symbol.
- (String) vat_date

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

Vat rate.

Instance Attribute Details

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

UESURI Account from opposite territory. Usable only for interterritorial payments.

Parameters:

(String, UU::OS::UESURI)

Returns:

(UU::OS::UESURI)



26
27
28

# File 'lib/uu/finman/financialtransaction/fast_payment_create.rb', line 26

def account_from_opposite_territory
  @account_from_opposite_territory
end

- (`Fixnum`) amount_with_vat

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

Parameters:

(Fixnum)

Returns:

(Fixnum)



38
39
40

# File 'lib/uu/finman/financialtransaction/fast_payment_create.rb', line 38

def amount_with_vat
  @amount_with_vat
end

- (`Fixnum`) amount_without_vat

Amount of the Fast Payment without vat. Required attribute. Cannot be null.

Parameters:

(Fixnum)

Returns:

(Fixnum)



32
33
34

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

def amount_without_vat
  @amount_without_vat
end

- (`TrueClass`, `FalseClass`) close_after_creation

Close after crea-tion

Parameters:

(TrueClass, FalseClass)

Returns:

(TrueClass, FalseClass)



190
191
192

# File 'lib/uu/finman/financialtransaction/fast_payment_create.rb', line 190

def close_after_creation
  @close_after_creation
end

- (`String`) constant_symbol

Constant symbol.

Parameters:

(String)

Returns:

(String)



43
44
45

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

def constant_symbol
  @constant_symbol
end

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

UESURI of Contract.

Parameters:

(String, UU::OS::UESURI)

Returns:

(UU::OS::UESURI)



48
49
50

# File 'lib/uu/finman/financialtransaction/fast_payment_create.rb', line 48

def contract_uri
  @contract_uri
end

- (`String`) cost_item_code

Code of cost item.

Parameters:

(String)

Returns:

(String)



53
54
55

# File 'lib/uu/finman/financialtransaction/fast_payment_create.rb', line 53

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. Required attribute. Cannot be null.

Parameters:

(String, UU::OS::UESURI)

Returns:

(UU::OS::UESURI)



59
60
61

# File 'lib/uu/finman/financialtransaction/fast_payment_create.rb', line 59

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)



65
66
67

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

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)



71
72
73

# File 'lib/uu/finman/financialtransaction/fast_payment_create.rb', line 71

def credit_account_uri
  @credit_account_uri
end

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

UESURI of credit business case from opposite territory. Usable only for interterritorial payments.

Parameters:

(String, UU::OS::UESURI)

Returns:

(UU::OS::UESURI)



77
78
79

# File 'lib/uu/finman/financialtransaction/fast_payment_create.rb', line 77

def credit_business_case_from_opposite_territory
  @credit_business_case_from_opposite_territory
end

- (`String`) credit_description

Description for credit side.

Parameters:

(String)

Returns:

(String)



82
83
84

# File 'lib/uu/finman/financialtransaction/fast_payment_create.rb', line 82

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)



87
88
89

# File 'lib/uu/finman/financialtransaction/fast_payment_create.rb', line 87

def credit_financial_category_uri
  @credit_financial_category_uri
end

- (`String`) credit_side_currency

Code of credit side currency.

Parameters:

(String)

Returns:

(String)



92
93
94

# File 'lib/uu/finman/financialtransaction/fast_payment_create.rb', line 92

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)



108
109
110

# File 'lib/uu/finman/financialtransaction/fast_payment_create.rb', line 108

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)



114
115
116

# File 'lib/uu/finman/financialtransaction/fast_payment_create.rb', line 114

def debit_account_uri
  @debit_account_uri
end

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

UESURI of debit business case from opposite territory. Usable only for interterritorial payments.

Parameters:

(String, UU::OS::UESURI)

Returns:

(UU::OS::UESURI)



120
121
122

# File 'lib/uu/finman/financialtransaction/fast_payment_create.rb', line 120

def debit_business_case_from_opposite_territory
  @debit_business_case_from_opposite_territory
end

- (`String`) debit_description

Description for debit side.

Parameters:

(String)

Returns:

(String)



125
126
127

# File 'lib/uu/finman/financialtransaction/fast_payment_create.rb', line 125

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)



130
131
132

# File 'lib/uu/finman/financialtransaction/fast_payment_create.rb', line 130

def debit_financial_category_uri
  @debit_financial_category_uri
end

- (`String`) debit_side_currency

Code of debit side currency.

Parameters:

(String)

Returns:

(String)



97
98
99

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

def debit_side_currency
  @debit_side_currency
end

- (`TrueClass`, `FalseClass`) dry_run

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

Parameters:

(TrueClass, FalseClass)

Returns:

(TrueClass, FalseClass)



206
207
208

# File 'lib/uu/finman/financialtransaction/fast_payment_create.rb', line 206

def dry_run
  @dry_run
end

- (`String`) due_date

Date the payment is due to be paid. Required attribute. Cannot be null.

Parameters:

(String, Time)

Returns:

(String)



136
137
138

# File 'lib/uu/finman/financialtransaction/fast_payment_create.rb', line 136

def due_date
  @due_date
end

- (`String`) expected_pay_date

Date the payment is expected to be paid to. Required attribute. Cannot be null.

Parameters:

(String, Time)

Returns:

(String)



142
143
144

# File 'lib/uu/finman/financialtransaction/fast_payment_create.rb', line 142

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)



233
234
235

# File 'lib/uu/finman/financialtransaction/fast_payment_create.rb', line 233

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)



228
229
230

# File 'lib/uu/finman/financialtransaction/fast_payment_create.rb', line 228

def explicit_exchange_rate
  @explicit_exchange_rate
end

- (`String`) financial_transaction_type

Type of Fast Payment. Item from enumeration UU::Finman::FinancialTransaction::FinancialTransactionType. Required attribute. 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)



153
154
155

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

def financial_transaction_type
  @financial_transaction_type
end

- (`String`) income_item_code

Code of income item.

Parameters:

(String)

Returns:

(String)



158
159
160

# File 'lib/uu/finman/financialtransaction/fast_payment_create.rb', line 158

def income_item_code
  @income_item_code
end

- (`String`) invoice_number

Invoice number of Fast Payment.

Parameters:

(String)

Returns:

(String)



163
164
165

# File 'lib/uu/finman/financialtransaction/fast_payment_create.rb', line 163

def invoice_number
  @invoice_number
end

- (`TrueClass`, `FalseClass`) is_transaction_credit

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

Parameters:

(TrueClass, FalseClass)

Returns:

(TrueClass, FalseClass)



212
213
214

# File 'lib/uu/finman/financialtransaction/fast_payment_create.rb', line 212

def is_transaction_credit
  @is_transaction_credit
end

- (`String`) name

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

Parameters:

(String)

Returns:

(String)



20
21
22

# File 'lib/uu/finman/financialtransaction/fast_payment_create.rb', line 20

def name
  @name
end

- (`TrueClass`, `FalseClass`) pay_after_creation

Pay after creation

Parameters:

(TrueClass, FalseClass)

Returns:

(TrueClass, FalseClass)



195
196
197

# File 'lib/uu/finman/financialtransaction/fast_payment_create.rb', line 195

def pay_after_creation
  @pay_after_creation
end

- (`String`) protocol_date

Date of invoicing to the counterparty. Required attribute. Cannot be null.

Parameters:

(String, Time)

Returns:

(String)



218
219
220

# File 'lib/uu/finman/financialtransaction/fast_payment_create.rb', line 218

def protocol_date
  @protocol_date
end

- (`Fixnum`) realization_probability

Probability of Fast Payment realization in %. Required attribute. Cannot be null.

Parameters:

(Fixnum)

Returns:

(Fixnum)



169
170
171

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

def realization_probability
  @realization_probability
end

- (`String`) related_links

Related links(URI, label) in JSON format.

Parameters:

(String)

Returns:

(String)



238
239
240

# File 'lib/uu/finman/financialtransaction/fast_payment_create.rb', line 238

def related_links
  @related_links
end

- (`TrueClass`, `FalseClass`) skip_fair_pay_integration

Skip FairPay integration

Parameters:

(TrueClass, FalseClass)

Returns:

(TrueClass, FalseClass)



200
201
202

# File 'lib/uu/finman/financialtransaction/fast_payment_create.rb', line 200

def skip_fair_pay_integration
  @skip_fair_pay_integration
end

- (`String`) specific_symbol

Specific symbol.

Parameters:

(String)

Returns:

(String)



174
175
176

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

def specific_symbol
  @specific_symbol
end

- (`String`) transaction_currency

Code of transaction currency.

Parameters:

(String)

Returns:

(String)



102
103
104

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

def transaction_currency
  @transaction_currency
end

- (`String`) variable_symbol

Variable symbol.

Parameters:

(String)

Returns:

(String)



179
180
181

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

def variable_symbol
  @variable_symbol
end

- (`String`) vat_date

Credit vat date of the payment.

Parameters:

(String, Time)

Returns:

(String)



223
224
225

# File 'lib/uu/finman/financialtransaction/fast_payment_create.rb', line 223

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)



185
186
187

# File 'lib/uu/finman/financialtransaction/fast_payment_create.rb', line 185

def vat_rate
  @vat_rate
end

Class: UU::Finman::FinancialTransaction::FastPaymentCreate

Overview

Instance Attribute Summary (collapse)

Instance Attribute Details

- (UU::OS::UESURI) account_from_opposite_territory

- (Fixnum) amount_with_vat

- (Fixnum) amount_without_vat

- (TrueClass, FalseClass) close_after_creation

- (String) constant_symbol

- (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

- (UU::OS::UESURI) credit_business_case_from_opposite_territory

- (String) credit_description

- (UU::OS::UESURI) credit_financial_category_uri

- (String) credit_side_currency

- (String) debit_account_number

- (UU::OS::UESURI) debit_account_uri

- (UU::OS::UESURI) debit_business_case_from_opposite_territory

- (String) debit_description

- (UU::OS::UESURI) debit_financial_category_uri

- (String) debit_side_currency

- (TrueClass, FalseClass) dry_run

- (String) due_date

- (String) expected_pay_date

- (Fixnum) explicit_amount

- (Fixnum) explicit_exchange_rate

- (String) financial_transaction_type

- (String) income_item_code

- (String) invoice_number

- (TrueClass, FalseClass) is_transaction_credit

- (String) name

- (TrueClass, FalseClass) pay_after_creation

- (String) protocol_date

- (Fixnum) realization_probability

- (String) related_links

- (TrueClass, FalseClass) skip_fair_pay_integration

- (String) specific_symbol

- (String) transaction_currency

- (String) variable_symbol

- (String) vat_date

- (Fixnum) vat_rate

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

- (`Fixnum`) amount_with_vat

- (`Fixnum`) amount_without_vat

- (`TrueClass`, `FalseClass`) close_after_creation

- (`String`) constant_symbol

- (`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

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

- (`String`) credit_description

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

- (`String`) credit_side_currency

- (`String`) debit_account_number

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

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

- (`String`) debit_description

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

- (`String`) debit_side_currency

- (`TrueClass`, `FalseClass`) dry_run

- (`String`) due_date

- (`String`) expected_pay_date

- (`Fixnum`) explicit_amount

- (`Fixnum`) explicit_exchange_rate

- (`String`) financial_transaction_type

- (`String`) income_item_code

- (`String`) invoice_number

- (`TrueClass`, `FalseClass`) is_transaction_credit

- (`String`) name

- (`TrueClass`, `FalseClass`) pay_after_creation

- (`String`) protocol_date

- (`Fixnum`) realization_probability

- (`String`) related_links

- (`TrueClass`, `FalseClass`) skip_fair_pay_integration

- (`String`) specific_symbol

- (`String`) transaction_currency

- (`String`) variable_symbol

- (`String`) vat_date

- (`Fixnum`) vat_rate