Class: UU::Finman::FinancialTransaction::PaymentSetAttributes

Inherits:

OS::REST::DTO

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

show all

Defined in:

lib/uu/finman/financialtransaction/payment_set_attributes.rb

Overview

DTO for setAttributes command of Financial Transaction.

Instance Attribute Summary (collapse)

- (Fixnum) amount_with_vat

Amount of the Financial Transaction with vat.
- (Fixnum) amount_without_vat

Amount of the Financial Transaction without vat.
- (String) constant_symbol

Constant symbol.
- (UU::OS::UESURI) contract_uri

UESURI of Contract.
- (String) cost_item_code

Code of cost item.
- (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_vat_date

Credit vat date of the transaction.
- (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_vat_date

Debit vat date of the transaction.
- (String) due_date

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

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

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

Explicit exchange rate.
- (FinancialTransactionType) financial_transaction_type

Type of financial transaction.
- (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 financial transaction.
- (TrueClass, FalseClass) is_planned

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

Name of Financial Transaction.
- (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) variable_symbol

Variable symbol.
- (Fixnum) vat_rate

Vat rate.

Instance Attribute Details

- (`Fixnum`) amount_with_vat

Amount of the Financial Transaction with vat.

Parameters:

(Fixnum)

Returns:

(Fixnum)



29
30
31

# File 'lib/uu/finman/financialtransaction/payment_set_attributes.rb', line 29

def amount_with_vat
  @amount_with_vat
end

- (`Fixnum`) amount_without_vat

Amount of the Financial Transaction without vat.

Parameters:

(Fixnum)

Returns:

(Fixnum)



24
25
26

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

def amount_without_vat
  @amount_without_vat
end

- (`String`) constant_symbol

Constant symbol.

Parameters:

(String)

Returns:

(String)



34
35
36

# File 'lib/uu/finman/financialtransaction/payment_set_attributes.rb', line 34

def constant_symbol
  @constant_symbol
end

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

UESURI of Contract.

Parameters:

(String, UU::OS::UESURI)

Returns:

(UU::OS::UESURI)



39
40
41

# File 'lib/uu/finman/financialtransaction/payment_set_attributes.rb', line 39

def contract_uri
  @contract_uri
end

- (`String`) cost_item_code

Code of cost item.

Parameters:

(String)

Returns:

(String)



44
45
46

# File 'lib/uu/finman/financialtransaction/payment_set_attributes.rb', line 44

def cost_item_code
  @cost_item_code
end

- (`String`) credit_account_number

Number of credit account.

Parameters:

(String)

Returns:

(String)



49
50
51

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

def credit_account_number
  @credit_account_number
end

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

UESURI of credit account artifact.

Parameters:

(String, UU::OS::UESURI)

Returns:

(UU::OS::UESURI)



54
55
56

# File 'lib/uu/finman/financialtransaction/payment_set_attributes.rb', line 54

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.

Parameters:

(String, UU::OS::UESURI)

Returns:

(UU::OS::UESURI)



59
60
61

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

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)



64
65
66

# File 'lib/uu/finman/financialtransaction/payment_set_attributes.rb', line 64

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)



69
70
71

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

def credit_financial_category_uri
  @credit_financial_category_uri
end

- (`String`) credit_vat_date

Credit vat date of the transaction.

Parameters:

(String, Time)

Returns:

(String)



74
75
76

# File 'lib/uu/finman/financialtransaction/payment_set_attributes.rb', line 74

def credit_vat_date
  @credit_vat_date
end

- (`String`) debit_account_number

Number of debit account.

Parameters:

(String)

Returns:

(String)



79
80
81

# File 'lib/uu/finman/financialtransaction/payment_set_attributes.rb', line 79

def debit_account_number
  @debit_account_number
end

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

UESURI of debit account artifact.

Parameters:

(String, UU::OS::UESURI)

Returns:

(UU::OS::UESURI)



84
85
86

# File 'lib/uu/finman/financialtransaction/payment_set_attributes.rb', line 84

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.

Parameters:

(String, UU::OS::UESURI)

Returns:

(UU::OS::UESURI)



89
90
91

# File 'lib/uu/finman/financialtransaction/payment_set_attributes.rb', line 89

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)



94
95
96

# File 'lib/uu/finman/financialtransaction/payment_set_attributes.rb', line 94

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)



99
100
101

# File 'lib/uu/finman/financialtransaction/payment_set_attributes.rb', line 99

def debit_financial_category_uri
  @debit_financial_category_uri
end

- (`String`) debit_vat_date

Debit vat date of the transaction.

Parameters:

(String, Time)

Returns:

(String)



104
105
106

# File 'lib/uu/finman/financialtransaction/payment_set_attributes.rb', line 104

def debit_vat_date
  @debit_vat_date
end

- (`String`) due_date

Date the payment is due to be paid.

Parameters:

(String, Time)

Returns:

(String)



109
110
111

# File 'lib/uu/finman/financialtransaction/payment_set_attributes.rb', line 109

def due_date
  @due_date
end

- (`String`) expected_pay_date

Date the payment is expected to be payed to.

Parameters:

(String, Time)

Returns:

(String)



114
115
116

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

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)



176
177
178

# File 'lib/uu/finman/financialtransaction/payment_set_attributes.rb', line 176

def explicit_amount
  @explicit_amount
end

- (`Fixnum`) explicit_exchange_rate

Explicit exchange rate. Can be set only by role cast in Accounting Authorities. Set to 0 to unset explicit exchange rate.

Parameters:

(Fixnum)

Returns:

(Fixnum)



171
172
173

# File 'lib/uu/finman/financialtransaction/payment_set_attributes.rb', line 171

def explicit_exchange_rate
  @explicit_exchange_rate
end

- (`FinancialTransactionType`) financial_transaction_type

Type of financial transaction. CASH or NONCASH.

Parameters:

(FinancialTransactionType)

Returns:

(FinancialTransactionType)



124
125
126

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

def financial_transaction_type
  @financial_transaction_type
end

- (`String`) for_acceptance_date

Date the accept payment activity will be planned to.

Parameters:

(String, Time)

Returns:

(String)



119
120
121

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

def for_acceptance_date
  @for_acceptance_date
end

- (`String`) income_item_code

Code of income item.

Parameters:

(String)

Returns:

(String)



129
130
131

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

def income_item_code
  @income_item_code
end

- (`String`) invoice_number

Invoice number of financial transaction.

Parameters:

(String)

Returns:

(String)



134
135
136

# File 'lib/uu/finman/financialtransaction/payment_set_attributes.rb', line 134

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)



140
141
142

# File 'lib/uu/finman/financialtransaction/payment_set_attributes.rb', line 140

def is_planned
  @is_planned
end

- (`String`) name

Name of Financial Transaction. Cannot be empty.

Parameters:

(String)

Returns:

(String)



19
20
21

# File 'lib/uu/finman/financialtransaction/payment_set_attributes.rb', line 19

def name
  @name
end

- (`String`) protocol_date

Date of invoicing to the counterparty.

Parameters:

(String, Time)

Returns:

(String)



145
146
147

# File 'lib/uu/finman/financialtransaction/payment_set_attributes.rb', line 145

def protocol_date
  @protocol_date
end

- (`Fixnum`) realization_probability

Probability of payment realization in %.

Parameters:

(Fixnum)

Returns:

(Fixnum)



150
151
152

# File 'lib/uu/finman/financialtransaction/payment_set_attributes.rb', line 150

def realization_probability
  @realization_probability
end

- (`String`) related_links

Related links(URI, label) in JSON format.

Parameters:

(String)

Returns:

(String)



181
182
183

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

def related_links
  @related_links
end

- (`String`) specific_symbol

Specific symbol.

Parameters:

(String)

Returns:

(String)



155
156
157

# File 'lib/uu/finman/financialtransaction/payment_set_attributes.rb', line 155

def specific_symbol
  @specific_symbol
end

- (`String`) variable_symbol

Variable symbol.

Parameters:

(String)

Returns:

(String)



160
161
162

# File 'lib/uu/finman/financialtransaction/payment_set_attributes.rb', line 160

def variable_symbol
  @variable_symbol
end

- (`Fixnum`) vat_rate

Vat rate.

Parameters:

(Fixnum)

Returns:

(Fixnum)



165
166
167

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

def vat_rate
  @vat_rate
end

Class: UU::Finman::FinancialTransaction::PaymentSetAttributes

Overview

Instance Attribute Summary (collapse)

Instance Attribute Details

- (Fixnum) amount_with_vat

- (Fixnum) amount_without_vat

- (String) constant_symbol

- (UU::OS::UESURI) contract_uri

- (String) cost_item_code

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

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

- (String) due_date

- (String) expected_pay_date

- (Fixnum) explicit_amount

- (Fixnum) explicit_exchange_rate

- (FinancialTransactionType) financial_transaction_type

- (String) for_acceptance_date

- (String) income_item_code

- (String) invoice_number

- (TrueClass, FalseClass) is_planned

- (String) name

- (String) protocol_date

- (Fixnum) realization_probability

- (String) related_links

- (String) specific_symbol

- (String) variable_symbol

- (Fixnum) vat_rate

- (`Fixnum`) amount_with_vat

- (`Fixnum`) amount_without_vat

- (`String`) constant_symbol

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

- (`String`) cost_item_code

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

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

- (`String`) due_date

- (`String`) expected_pay_date

- (`Fixnum`) explicit_amount

- (`Fixnum`) explicit_exchange_rate

- (`FinancialTransactionType`) financial_transaction_type

- (`String`) for_acceptance_date

- (`String`) income_item_code

- (`String`) invoice_number

- (`TrueClass`, `FalseClass`) is_planned

- (`String`) name

- (`String`) protocol_date

- (`Fixnum`) realization_probability

- (`String`) related_links

- (`String`) specific_symbol

- (`String`) variable_symbol

- (`Fixnum`) vat_rate