Class: UU::Finman::FinancialTransaction::PaymentCreate

Inherits:

OS::REST::DTO

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

show all

Defined in:

lib/uu/finman/financialtransaction/payment_create.rb

Overview

DTO for create command of Payment.

Instance Attribute Summary (collapse)

- (UU::OS::UESURI) account_from_opposite_territory

UESURI Account from opposite territory.
- (Fixnum) amount_with_vat

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

Amount of the Payment without vat.
- (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_state

Type of advanced state.
- (String) financial_transaction_type

Type of Payment.
- (String) for_acceptance_date

Date the accept payment activity will be planned to.
- (String) income_item_code

Code of income item.
- (String) invoice_number

Invoice number of Payment.
- (TrueClass, FalseClass) is_planned

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

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

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

Name of created Payment.
- (String) protocol_date

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

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

Related links(URI, label) in JSON format.
- (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)



24
25
26

# File 'lib/uu/finman/financialtransaction/payment_create.rb', line 24

def account_from_opposite_territory
  @account_from_opposite_territory
end

- (`Fixnum`) amount_with_vat

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

Parameters:

(Fixnum)

Returns:

(Fixnum)



36
37
38

# File 'lib/uu/finman/financialtransaction/payment_create.rb', line 36

def amount_with_vat
  @amount_with_vat
end

- (`Fixnum`) amount_without_vat

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

Parameters:

(Fixnum)

Returns:

(Fixnum)



30
31
32

# File 'lib/uu/finman/financialtransaction/payment_create.rb', line 30

def amount_without_vat
  @amount_without_vat
end

- (`String`) constant_symbol

Constant symbol.

Parameters:

(String)

Returns:

(String)



41
42
43

# File 'lib/uu/finman/financialtransaction/payment_create.rb', line 41

def constant_symbol
  @constant_symbol
end

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

UESURI of Contract.

Parameters:

(String, UU::OS::UESURI)

Returns:

(UU::OS::UESURI)



46
47
48

# File 'lib/uu/finman/financialtransaction/payment_create.rb', line 46

def contract_uri
  @contract_uri
end

- (`String`) cost_item_code

Code of cost item.

Parameters:

(String)

Returns:

(String)



51
52
53

# File 'lib/uu/finman/financialtransaction/payment_create.rb', line 51

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)



57
58
59

# File 'lib/uu/finman/financialtransaction/payment_create.rb', line 57

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)



63
64
65

# File 'lib/uu/finman/financialtransaction/payment_create.rb', line 63

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)



69
70
71

# File 'lib/uu/finman/financialtransaction/payment_create.rb', line 69

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)



75
76
77

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

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)



80
81
82

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

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)



85
86
87

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

def credit_financial_category_uri
  @credit_financial_category_uri
end

- (`String`) credit_side_currency

Code of credit side currency.

Parameters:

(String)

Returns:

(String)



90
91
92

# File 'lib/uu/finman/financialtransaction/payment_create.rb', line 90

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)



113
114
115

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

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)



119
120
121

# File 'lib/uu/finman/financialtransaction/payment_create.rb', line 119

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)



125
126
127

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

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)



130
131
132

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

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)



135
136
137

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

def debit_financial_category_uri
  @debit_financial_category_uri
end

- (`String`) debit_side_currency

Code of debit side currency.

Parameters:

(String)

Returns:

(String)



95
96
97

# File 'lib/uu/finman/financialtransaction/payment_create.rb', line 95

def debit_side_currency
  @debit_side_currency
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)



227
228
229

# File 'lib/uu/finman/financialtransaction/payment_create.rb', line 227

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)



141
142
143

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

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)



147
148
149

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

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)



237
238
239

# File 'lib/uu/finman/financialtransaction/payment_create.rb', line 237

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)



232
233
234

# File 'lib/uu/finman/financialtransaction/payment_create.rb', line 232

def explicit_exchange_rate
  @explicit_exchange_rate
end

- (`String`) financial_transaction_state

Type of advanced state

Parameters:

(String, FinancialTransactionState)

Returns:

(String)



242
243
244

# File 'lib/uu/finman/financialtransaction/payment_create.rb', line 242

def financial_transaction_state
  @financial_transaction_state
end

- (`String`) financial_transaction_type

Type of Payment. Item from enumeration 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)



158
159
160

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

def financial_transaction_type
  @financial_transaction_type
end

- (`String`) for_acceptance_date

Date the accept payment activity will be planned to. isReadyForAcceptance attribute must be set to 'true' to use this value. if isReadyForAcceptance attribute is set to 'true', this value must be set.

Parameters:

(String, Time)

Returns:

(String)



165
166
167

# File 'lib/uu/finman/financialtransaction/payment_create.rb', line 165

def for_acceptance_date
  @for_acceptance_date
end

- (`String`) income_item_code

Code of income item.

Parameters:

(String)

Returns:

(String)



170
171
172

# File 'lib/uu/finman/financialtransaction/payment_create.rb', line 170

def income_item_code
  @income_item_code
end

- (`String`) invoice_number

Invoice number of Payment.

Parameters:

(String)

Returns:

(String)



175
176
177

# File 'lib/uu/finman/financialtransaction/payment_create.rb', line 175

def invoice_number
  @invoice_number
end

- (`TrueClass`, `FalseClass`) is_planned

Possible values: true or false. True states that the payment is only planned and needs to be specified more precisely.

Parameters:

(TrueClass, FalseClass)

Returns:

(TrueClass, FalseClass)



187
188
189

# File 'lib/uu/finman/financialtransaction/payment_create.rb', line 187

def is_planned
  @is_planned
end

- (`TrueClass`, `FalseClass`) is_ready_for_acceptance

Possible values: true or false. By setting to true, system automatically requests it's acceptance. If not set, default value is 'false'.

Parameters:

(TrueClass, FalseClass)

Returns:

(TrueClass, FalseClass)



193
194
195

# File 'lib/uu/finman/financialtransaction/payment_create.rb', line 193

def is_ready_for_acceptance
  @is_ready_for_acceptance
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)



181
182
183

# File 'lib/uu/finman/financialtransaction/payment_create.rb', line 181

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)



18
19
20

# File 'lib/uu/finman/financialtransaction/payment_create.rb', line 18

def name
  @name
end

- (`String`) protocol_date

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

Parameters:

(String, Time)

Returns:

(String)



199
200
201

# File 'lib/uu/finman/financialtransaction/payment_create.rb', line 199

def protocol_date
  @protocol_date
end

- (`Fixnum`) realization_probability

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

Parameters:

(Fixnum)

Returns:

(Fixnum)



205
206
207

# File 'lib/uu/finman/financialtransaction/payment_create.rb', line 205

def realization_probability
  @realization_probability
end

- (`String`) related_links

Related links(URI, label) in JSON format.

Parameters:

(String)

Returns:

(String)



247
248
249

# File 'lib/uu/finman/financialtransaction/payment_create.rb', line 247

def related_links
  @related_links
end

- (`String`) specific_symbol

Specific symbol.

Parameters:

(String)

Returns:

(String)



210
211
212

# File 'lib/uu/finman/financialtransaction/payment_create.rb', line 210

def specific_symbol
  @specific_symbol
end

- (`String`) transaction_currency

Code of transaction currency.

Parameters:

(String)

Returns:

(String)



100
101
102

# File 'lib/uu/finman/financialtransaction/payment_create.rb', line 100

def transaction_currency
  @transaction_currency
end

- (`String`) variable_symbol

Variable symbol.

Parameters:

(String)

Returns:

(String)



215
216
217

# File 'lib/uu/finman/financialtransaction/payment_create.rb', line 215

def variable_symbol
  @variable_symbol
end

- (`String`) vat_date

Credit vat date of the payment. Required attribute. Cannot be null.

Parameters:

(String, Time)

Returns:

(String)



107
108
109

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

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)



221
222
223

# File 'lib/uu/finman/financialtransaction/payment_create.rb', line 221

def vat_rate
  @vat_rate
end

Class: UU::Finman::FinancialTransaction::PaymentCreate

Overview

Instance Attribute Summary (collapse)

Instance Attribute Details

- (UU::OS::UESURI) account_from_opposite_territory

- (Fixnum) amount_with_vat

- (Fixnum) amount_without_vat

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

- (String) financial_transaction_type

- (String) for_acceptance_date

- (String) income_item_code

- (String) invoice_number

- (TrueClass, FalseClass) is_planned

- (TrueClass, FalseClass) is_ready_for_acceptance

- (TrueClass, FalseClass) is_transaction_credit

- (String) name

- (String) protocol_date

- (Fixnum) realization_probability

- (String) related_links

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

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

- (`String`) financial_transaction_type

- (`String`) for_acceptance_date

- (`String`) income_item_code

- (`String`) invoice_number

- (`TrueClass`, `FalseClass`) is_planned

- (`TrueClass`, `FalseClass`) is_ready_for_acceptance

- (`TrueClass`, `FalseClass`) is_transaction_credit

- (`String`) name

- (`String`) protocol_date

- (`Fixnum`) realization_probability

- (`String`) related_links

- (`String`) specific_symbol

- (`String`) transaction_currency

- (`String`) variable_symbol

- (`String`) vat_date

- (`Fixnum`) vat_rate