Class: UU::Finman::FinancialTransaction::CreditNoteCreate

Inherits:

OS::REST::DTO

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

show all

Defined in:

lib/uu/finman/financialtransaction/credit_note_create.rb

Overview

DTO for create command of Credit note.

Instance Attribute Summary (collapse)

- (UU::OS::UESURI) account_from_opposite_territory

UESURI Account from opposite territory.
- (Fixnum) amount_with_vat

Amount of the Credit note with vat.
- (Fixnum) amount_without_vat

Amount of the Credit note without vat.
- (String) client_account_number

Number of client account.
- (UU::OS::UESURI) client_account_uri

UESURI of client account artifact.
- (UU::OS::UESURI) client_business_case_from_opposite_territory

UESURI of client business case from opposite territory.
- (String) client_description

Description for client side.
- (UU::OS::UESURI) client_financial_category_uri

UESURI of client financial category.
- (String) client_side_currency

Code of client side currency.
- (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.
- (TrueClass, FalseClass) dry_run

Dry run.
- (String) due_date

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

Date the transaction 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.
- (String) invoice_number

Invoice number of credit note.
- (TrueClass, FalseClass) is_credit_note_outgoing

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

Name of created Credit note.
- (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.
- (TrueClass, FalseClass) request_approval_by_manager

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

Specific symbol.
- (Fixnum) supplier_account_number

Number of supplier account.
- (UU::OS::UESURI) supplier_account_uri

UESURI of supplier account artifact.
- (UU::OS::UESURI) supplier_business_case_from_opposite_territory

UESURI of supplier business case from opposite territory.
- (String) supplier_description

Description for supplier side.
- (UU::OS::UESURI) supplier_financial_category_uri

UESURI of supplier financial category.
- (String) supplier_side_currency

Code of credit side currency.
- (String) transaction_currency

Code of transaction currency.
- (String) variable_symbol

Variable symbol.
- (String) vat_date

Vat date of the transaction.
- (Fixnum) vat_rate

Vat rate.
- (TrueClass, FalseClass) wait_for_acceptance_by_accountant

Possible values: true or false.

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)



21
22
23

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

def account_from_opposite_territory
  @account_from_opposite_territory
end

- (`Fixnum`) amount_with_vat

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

Parameters:

(Fixnum)

Returns:

(Fixnum)



33
34
35

# File 'lib/uu/finman/financialtransaction/credit_note_create.rb', line 33

def amount_with_vat
  @amount_with_vat
end

- (`Fixnum`) amount_without_vat

Amount of the Credit note without vat. Required attribute. Required attribute. Cannot be null.

Parameters:

(Fixnum)

Returns:

(Fixnum)



27
28
29

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

def amount_without_vat
  @amount_without_vat
end

- (`String`) client_account_number

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

Parameters:

(String)

Returns:

(String)



60
61
62

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

def client_account_number
  @client_account_number
end

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

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

Parameters:

(String, UU::OS::UESURI)

Returns:

(UU::OS::UESURI)



66
67
68

# File 'lib/uu/finman/financialtransaction/credit_note_create.rb', line 66

def client_account_uri
  @client_account_uri
end

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

UESURI of client business case from opposite territory.

Parameters:

(String, UU::OS::UESURI)

Returns:

(UU::OS::UESURI)



71
72
73

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

def client_business_case_from_opposite_territory
  @client_business_case_from_opposite_territory
end

- (`String`) client_description

Description for client side.

Parameters:

(String)

Returns:

(String)



76
77
78

# File 'lib/uu/finman/financialtransaction/credit_note_create.rb', line 76

def client_description
  @client_description
end

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

UESURI of client financial category.

Parameters:

(String, UU::OS::UESURI)

Returns:

(UU::OS::UESURI)



81
82
83

# File 'lib/uu/finman/financialtransaction/credit_note_create.rb', line 81

def client_financial_category_uri
  @client_financial_category_uri
end

- (`String`) client_side_currency

Code of client side currency.

Parameters:

(String)

Returns:

(String)



91
92
93

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

def client_side_currency
  @client_side_currency
end

- (`String`) constant_symbol

Constant symbol.

Parameters:

(String)

Returns:

(String)



38
39
40

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

def constant_symbol
  @constant_symbol
end

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

UESURI of Contract.

Parameters:

(String, UU::OS::UESURI)

Returns:

(UU::OS::UESURI)



43
44
45

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

def contract_uri
  @contract_uri
end

- (`String`) cost_item_code

Code of cost item.

Parameters:

(String)

Returns:

(String)



48
49
50

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

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)



54
55
56

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

def counterparty_business_case_uri
  @counterparty_business_case_uri
end

- (`TrueClass`, `FalseClass`) dry_run

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

Parameters:

(TrueClass, FalseClass)

Returns:

(TrueClass, FalseClass)



217
218
219

# File 'lib/uu/finman/financialtransaction/credit_note_create.rb', line 217

def dry_run
  @dry_run
end

- (`String`) due_date

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

Parameters:

(String, Time)

Returns:

(String)



135
136
137

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

def due_date
  @due_date
end

- (`String`) expected_pay_date

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

Parameters:

(String, Time)

Returns:

(String)



141
142
143

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

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)



227
228
229

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

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)



222
223
224

# File 'lib/uu/finman/financialtransaction/credit_note_create.rb', line 222

def explicit_exchange_rate
  @explicit_exchange_rate
end

- (`String`) financial_transaction_state

Type of advanced state

Parameters:

(String, FinancialTransactionState)

Returns:

(String)



232
233
234

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

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, FinancialTransactionCreate)

Returns:

(String)



152
153
154

# File 'lib/uu/finman/financialtransaction/credit_note_create.rb', line 152

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/credit_note_create.rb', line 158

def income_item_code
  @income_item_code
end

- (`String`) invoice_number

Invoice number of credit note. Ignored for transfers.

Parameters:

(String)

Returns:

(String)



164
165
166

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

def invoice_number
  @invoice_number
end

- (`TrueClass`, `FalseClass`) is_credit_note_outgoing

Possible values: true or false. True indicates type of credit note as Outgoing, false as Incoming. If not set, default value is 'true'.

Parameters:

(TrueClass, FalseClass)

Returns:

(TrueClass, FalseClass)



170
171
172

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

def is_credit_note_outgoing
  @is_credit_note_outgoing
end

- (`String`) name

Name of created Credit note. Required attribute. Cannot be null or empty. Its value is automatically trimmed. Cannot be null nor empty string nor longer than 250 characters. The create command fails otherwise.

Parameters:

(String)

Returns:

(String)



15
16
17

# File 'lib/uu/finman/financialtransaction/credit_note_create.rb', line 15

def name
  @name
end

- (`String`) protocol_date

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

Parameters:

(String, Time)

Returns:

(String)



176
177
178

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

def protocol_date
  @protocol_date
end

- (`Fixnum`) realization_probability

Probability of payment realization in %.

Parameters:

(Fixnum)

Returns:

(Fixnum)



181
182
183

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

def realization_probability
  @realization_probability
end

- (`String`) related_links

Related links(URI, label) in JSON format.

Parameters:

(String)

Returns:

(String)



237
238
239

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

def related_links
  @related_links
end

- (`TrueClass`, `FalseClass`) request_approval_by_manager

Possible values: true or false. Specifies whether is it needed to approve the credit note by competent manager. If not set, default value is 'false'.

Parameters:

(TrueClass, FalseClass)

Returns:

(TrueClass, FalseClass)



188
189
190

# File 'lib/uu/finman/financialtransaction/credit_note_create.rb', line 188

def request_approval_by_manager
  @request_approval_by_manager
end

- (`String`) specific_symbol

Specific symbol.

Parameters:

(String)

Returns:

(String)



193
194
195

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

def specific_symbol
  @specific_symbol
end

- (`Fixnum`) supplier_account_number

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

Parameters:

(Fixnum)

Returns:

(Fixnum)



108
109
110

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

def supplier_account_number
  @supplier_account_number
end

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

UESURI of supplier 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/credit_note_create.rb', line 114

def supplier_account_uri
  @supplier_account_uri
end

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

UESURI of supplier business case from opposite territory.

Parameters:

(String, UU::OS::UESURI)

Returns:

(UU::OS::UESURI)



119
120
121

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

def supplier_business_case_from_opposite_territory
  @supplier_business_case_from_opposite_territory
end

- (`String`) supplier_description

Description for supplier side.

Parameters:

(String)

Returns:

(String)



124
125
126

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

def supplier_description
  @supplier_description
end

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

UESURI of supplier financial category.

Parameters:

(String, UU::OS::UESURI)

Returns:

(UU::OS::UESURI)



129
130
131

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

def supplier_financial_category_uri
  @supplier_financial_category_uri
end

- (`String`) supplier_side_currency

Code of credit side currency.

Parameters:

(String)

Returns:

(String)



86
87
88

# File 'lib/uu/finman/financialtransaction/credit_note_create.rb', line 86

def supplier_side_currency
  @supplier_side_currency
end

- (`String`) transaction_currency

Code of transaction currency.

Parameters:

(String)

Returns:

(String)



96
97
98

# File 'lib/uu/finman/financialtransaction/credit_note_create.rb', line 96

def transaction_currency
  @transaction_currency
end

- (`String`) variable_symbol

Variable symbol.

Parameters:

(String)

Returns:

(String)



198
199
200

# File 'lib/uu/finman/financialtransaction/credit_note_create.rb', line 198

def variable_symbol
  @variable_symbol
end

- (`String`) vat_date

Vat date of the transaction. Required attribute. Cannot be null.

Parameters:

(String, Time)

Returns:

(String)



102
103
104

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

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)



204
205
206

# File 'lib/uu/finman/financialtransaction/credit_note_create.rb', line 204

def vat_rate
  @vat_rate
end

- (`TrueClass`, `FalseClass`) wait_for_acceptance_by_accountant

Possible values: true or false. Specifies whether it is needed to confirm the acceptance of the credit note by client's accountant. If not set, default value is 'false'.

Parameters:

(TrueClass, FalseClass)

Returns:

(TrueClass, FalseClass)



211
212
213

# File 'lib/uu/finman/financialtransaction/credit_note_create.rb', line 211

def wait_for_acceptance_by_accountant
  @wait_for_acceptance_by_accountant
end

Class: UU::Finman::FinancialTransaction::CreditNoteCreate

Overview

Instance Attribute Summary (collapse)

Instance Attribute Details

- (UU::OS::UESURI) account_from_opposite_territory

- (Fixnum) amount_with_vat

- (Fixnum) amount_without_vat

- (String) client_account_number

- (UU::OS::UESURI) client_account_uri

- (UU::OS::UESURI) client_business_case_from_opposite_territory

- (String) client_description

- (UU::OS::UESURI) client_financial_category_uri

- (String) client_side_currency

- (String) constant_symbol

- (UU::OS::UESURI) contract_uri

- (String) cost_item_code

- (UU::OS::UESURI) counterparty_business_case_uri

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

- (String) invoice_number

- (TrueClass, FalseClass) is_credit_note_outgoing

- (String) name

- (String) protocol_date

- (Fixnum) realization_probability

- (String) related_links

- (TrueClass, FalseClass) request_approval_by_manager

- (String) specific_symbol

- (Fixnum) supplier_account_number

- (UU::OS::UESURI) supplier_account_uri

- (UU::OS::UESURI) supplier_business_case_from_opposite_territory

- (String) supplier_description

- (UU::OS::UESURI) supplier_financial_category_uri

- (String) supplier_side_currency

- (String) transaction_currency

- (String) variable_symbol

- (String) vat_date

- (Fixnum) vat_rate

- (TrueClass, FalseClass) wait_for_acceptance_by_accountant

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

- (`Fixnum`) amount_with_vat

- (`Fixnum`) amount_without_vat

- (`String`) client_account_number

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

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

- (`String`) client_description

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

- (`String`) client_side_currency

- (`String`) constant_symbol

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

- (`String`) cost_item_code

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

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

- (`String`) invoice_number

- (`TrueClass`, `FalseClass`) is_credit_note_outgoing

- (`String`) name

- (`String`) protocol_date

- (`Fixnum`) realization_probability

- (`String`) related_links

- (`TrueClass`, `FalseClass`) request_approval_by_manager

- (`String`) specific_symbol

- (`Fixnum`) supplier_account_number

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

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

- (`String`) supplier_description

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

- (`String`) supplier_side_currency

- (`String`) transaction_currency

- (`String`) variable_symbol

- (`String`) vat_date

- (`Fixnum`) vat_rate

- (`TrueClass`, `FalseClass`) wait_for_acceptance_by_accountant