Class: MfkOpenapiRubyClient::TransactionPayload

Inherits:
Object
  • Object
show all
Defined in:
lib/mfk_openapi_ruby_client/models/transaction_payload.rb

Overview

取引登録情報です。取引登録で利用します。

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TransactionPayload

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/mfk_openapi_ruby_client/models/transaction_payload.rb', line 93

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MfkOpenapiRubyClient::TransactionPayload` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `MfkOpenapiRubyClient::TransactionPayload`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'amount')
    self.amount = attributes[:'amount']
  end

  if attributes.key?(:'amounts_per_tax_rate_type')
    if (value = attributes[:'amounts_per_tax_rate_type']).is_a?(Array)
      self.amounts_per_tax_rate_type = value
    end
  end

  if attributes.key?(:'billing_condition')
    self.billing_condition = attributes[:'billing_condition']
  end

  if attributes.key?(:'date')
    self.date = attributes[:'date']
  end

  if attributes.key?(:'destination_id')
    self.destination_id = attributes[:'destination_id']
  end

  if attributes.key?(:'due_date')
    self.due_date = attributes[:'due_date']
  end

  if attributes.key?(:'invoice_delivery_methods')
    if (value = attributes[:'invoice_delivery_methods']).is_a?(Array)
      self.invoice_delivery_methods = value
    end
  end

  if attributes.key?(:'issue_date')
    self.issue_date = attributes[:'issue_date']
  end

  if attributes.key?(:'number')
    self.number = attributes[:'number']
  end

  if attributes.key?(:'transaction_details')
    if (value = attributes[:'transaction_details']).is_a?(Array)
      self.transaction_details = value
    end
  end
end

Instance Attribute Details

#amount ⇒ Object

取引の税込合計金額です。各課税種別毎の税込金額(amounts_per_tax_rate_type)の合計である必要があります。また、負の値を指定することはできません。



20
21
22
 
# File 'lib/mfk_openapi_ruby_client/models/transaction_payload.rb', line 20

def amount
  @amount
end

#amounts_per_tax_rate_type ⇒ Object

各課税種別毎の税込の合計金額です。各課税種別の取引明細行の小計を合計した値の税込金額になっていなければなりません。



23
24
25
 
# File 'lib/mfk_openapi_ruby_client/models/transaction_payload.rb', line 23

def amounts_per_tax_rate_type
  @amounts_per_tax_rate_type
end

#billing_condition ⇒ Object

Returns the value of attribute billing_condition.



25
26
27
 
# File 'lib/mfk_openapi_ruby_client/models/transaction_payload.rb', line 25

def billing_condition
  @billing_condition
end

#date ⇒ Object

取引日です。売り手様と顧客の間で取引を行った日付を指定してください。



28
29
30
 
# File 'lib/mfk_openapi_ruby_client/models/transaction_payload.rb', line 28

def date
  @date
end

#destination_id ⇒ Object

請求先IDです。取引の請求先を指定してください。



31
32
33
 
# File 'lib/mfk_openapi_ruby_client/models/transaction_payload.rb', line 31

def destination_id
  @destination_id
end

#due_date ⇒ Object

支払期限です。



34
35
36
 
# File 'lib/mfk_openapi_ruby_client/models/transaction_payload.rb', line 34

def due_date
  @due_date
end

#invoice_delivery_methods ⇒ Object

請求書送付方法です。郵送(posting) またはメール送付(email)のうちから少なくとも１つを指定してください。どちらも選択された場合、どちらの方法でも送付されます。 また、各取引で指定しなかった送付方法でも、請求にまとまった取引のうちでその送付方法を選択しているものがあれば、そちらの送付方法も採用されます。



37
38
39
 
# File 'lib/mfk_openapi_ruby_client/models/transaction_payload.rb', line 37

def invoice_delivery_methods
  @invoice_delivery_methods
end

#issue_date ⇒ Object

請求書発行日です。請求書が発行される日付を指定します。指定した日付が営業日でない場合は翌営業日になります。また、請求書送付日については(support.mfkessai.co.jp/hc/ja/articles/900002297303-%E8%AB%8B%E6%B1%82%E6%9B%B8%E7%99%BA%E8%A1%8C%E6%97%A5%E3%81%AB%E3%81%A4%E3%81%84%E3%81%A6)を参照ください。



40
41
42
 
# File 'lib/mfk_openapi_ruby_client/models/transaction_payload.rb', line 40

def issue_date
  @issue_date
end

#number ⇒ Object

取引に付与できる任意の取引番号です。Money Forward Kessaiが自動で付与する取引IDとは別で、売り手様が独自に管理する識別子を登録することができます。ただし、売り手様の所有する取引間で一意である必要があります。



43
44
45
 
# File 'lib/mfk_openapi_ruby_client/models/transaction_payload.rb', line 43

def number
  @number
end

#transaction_details ⇒ Object

取引明細行です。



46
47
48
 
# File 'lib/mfk_openapi_ruby_client/models/transaction_payload.rb', line 46

def transaction_details
  @transaction_details
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



65
66
67
 
# File 'lib/mfk_openapi_ruby_client/models/transaction_payload.rb', line 65

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/mfk_openapi_ruby_client/models/transaction_payload.rb', line 49

def self.attribute_map
  {
    :'amount' => :'amount',
    :'amounts_per_tax_rate_type' => :'amounts_per_tax_rate_type',
    :'billing_condition' => :'billing_condition',
    :'date' => :'date',
    :'destination_id' => :'destination_id',
    :'due_date' => :'due_date',
    :'invoice_delivery_methods' => :'invoice_delivery_methods',
    :'issue_date' => :'issue_date',
    :'number' => :'number',
    :'transaction_details' => :'transaction_details'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



393
394
395
 
# File 'lib/mfk_openapi_ruby_client/models/transaction_payload.rb', line 393

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



86
87
88
89
 
# File 'lib/mfk_openapi_ruby_client/models/transaction_payload.rb', line 86

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/mfk_openapi_ruby_client/models/transaction_payload.rb', line 70

def self.openapi_types
  {
    :'amount' => :'Integer',
    :'amounts_per_tax_rate_type' => :'Array<AmountPerTaxRateType>',
    :'billing_condition' => :'BillingCondition',
    :'date' => :'Date',
    :'destination_id' => :'String',
    :'due_date' => :'Date',
    :'invoice_delivery_methods' => :'Array<InvoiceDeliveryMethod>',
    :'issue_date' => :'Date',
    :'number' => :'String',
    :'transaction_details' => :'Array<TransactionDetailPayload>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/mfk_openapi_ruby_client/models/transaction_payload.rb', line 363

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount == o.amount &&
      amounts_per_tax_rate_type == o.amounts_per_tax_rate_type &&
      billing_condition == o.billing_condition &&
      date == o.date &&
      destination_id == o.destination_id &&
      due_date == o.due_date &&
      invoice_delivery_methods == o.invoice_delivery_methods &&
      issue_date == o.issue_date &&
      number == o.number &&
      transaction_details == o.transaction_details
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
 
# File 'lib/mfk_openapi_ruby_client/models/transaction_payload.rb', line 423

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = MfkOpenapiRubyClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



494
495
496
497
498
499
500
501
502
503
504
505
506
 
# File 'lib/mfk_openapi_ruby_client/models/transaction_payload.rb', line 494

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/mfk_openapi_ruby_client/models/transaction_payload.rb', line 400

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


380
381
382
 
# File 'lib/mfk_openapi_ruby_client/models/transaction_payload.rb', line 380

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



386
387
388
 
# File 'lib/mfk_openapi_ruby_client/models/transaction_payload.rb', line 386

def hash
  [amount, amounts_per_tax_rate_type, billing_condition, date, destination_id, due_date, invoice_delivery_methods, issue_date, number, transaction_details].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/mfk_openapi_ruby_client/models/transaction_payload.rb', line 155

def list_invalid_properties
  invalid_properties = Array.new
  if @amount.nil?
    invalid_properties.push('invalid value for "amount", amount cannot be nil.')
  end

  if @amount > 2147483647
    invalid_properties.push('invalid value for "amount", must be smaller than or equal to 2147483647.')
  end

  if @amount < 1
    invalid_properties.push('invalid value for "amount", must be greater than or equal to 1.')
  end

  if @amounts_per_tax_rate_type.nil?
    invalid_properties.push('invalid value for "amounts_per_tax_rate_type", amounts_per_tax_rate_type cannot be nil.')
  end

  if @amounts_per_tax_rate_type.length < 1
    invalid_properties.push('invalid value for "amounts_per_tax_rate_type", number of items must be greater than or equal to 1.')
  end

  if @date.nil?
    invalid_properties.push('invalid value for "date", date cannot be nil.')
  end

  if @destination_id.nil?
    invalid_properties.push('invalid value for "destination_id", destination_id cannot be nil.')
  end

  if @destination_id.to_s.length < 1
    invalid_properties.push('invalid value for "destination_id", the character length must be great than or equal to 1.')
  end

  if @due_date.nil?
    invalid_properties.push('invalid value for "due_date", due_date cannot be nil.')
  end

  if @invoice_delivery_methods.nil?
    invalid_properties.push('invalid value for "invoice_delivery_methods", invoice_delivery_methods cannot be nil.')
  end

  if @invoice_delivery_methods.length > 2
    invalid_properties.push('invalid value for "invoice_delivery_methods", number of items must be less than or equal to 2.')
  end

  if @invoice_delivery_methods.length < 1
    invalid_properties.push('invalid value for "invoice_delivery_methods", number of items must be greater than or equal to 1.')
  end

  if @issue_date.nil?
    invalid_properties.push('invalid value for "issue_date", issue_date cannot be nil.')
  end

  if @number.nil?
    invalid_properties.push('invalid value for "number", number cannot be nil.')
  end

  if @number.to_s.length > 100
    invalid_properties.push('invalid value for "number", the character length must be smaller than or equal to 100.')
  end

  if @number.to_s.length < 1
    invalid_properties.push('invalid value for "number", the character length must be great than or equal to 1.')
  end

  if @transaction_details.nil?
    invalid_properties.push('invalid value for "transaction_details", transaction_details cannot be nil.')
  end

  if @transaction_details.length > 500
    invalid_properties.push('invalid value for "transaction_details", number of items must be less than or equal to 500.')
  end

  if @transaction_details.length < 1
    invalid_properties.push('invalid value for "transaction_details", number of items must be greater than or equal to 1.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



470
471
472
 
# File 'lib/mfk_openapi_ruby_client/models/transaction_payload.rb', line 470

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



476
477
478
479
480
481
482
483
484
485
486
487
488
 
# File 'lib/mfk_openapi_ruby_client/models/transaction_payload.rb', line 476

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



464
465
466
 
# File 'lib/mfk_openapi_ruby_client/models/transaction_payload.rb', line 464

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/mfk_openapi_ruby_client/models/transaction_payload.rb', line 238

def valid?
  return false if @amount.nil?
  return false if @amount > 2147483647
  return false if @amount < 1
  return false if @amounts_per_tax_rate_type.nil?
  return false if @amounts_per_tax_rate_type.length < 1
  return false if @date.nil?
  return false if @destination_id.nil?
  return false if @destination_id.to_s.length < 1
  return false if @due_date.nil?
  return false if @invoice_delivery_methods.nil?
  return false if @invoice_delivery_methods.length > 2
  return false if @invoice_delivery_methods.length < 1
  return false if @issue_date.nil?
  return false if @number.nil?
  return false if @number.to_s.length > 100
  return false if @number.to_s.length < 1
  return false if @transaction_details.nil?
  return false if @transaction_details.length > 500
  return false if @transaction_details.length < 1
  true
end