Class: MfkOpenapiRubyClient::Transaction

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

Overview

取引です。

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Transaction

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/mfk_openapi_ruby_client/models/transaction.rb', line 174

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MfkOpenapiRubyClient::Transaction` 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::Transaction`. 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?(:'accepted_at')
    self.accepted_at = attributes[:'accepted_at']
  end

  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')
    self.billing = attributes[:'billing']
  end

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  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?(:'object')
    self.object = attributes[:'object']
  end

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

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

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

Instance Attribute Details

#accepted_at ⇒ Object

債権譲受日時です。



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

def accepted_at
  @accepted_at
end

#amount ⇒ Object

取引の合計金額です。**税込**金額になります。



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

def amount
  @amount
end

#amounts_per_tax_rate_type ⇒ Object

各税率種別毎の**税込**の合計金額です。各税率種別の取引明細行の小計を合計した値の税込金額になっています。



26
27
28
 
# File 'lib/mfk_openapi_ruby_client/models/transaction.rb', line 26

def amounts_per_tax_rate_type
  @amounts_per_tax_rate_type
end

#billing ⇒ Object

請求対象であるかをboolean値で表します。‘true`の場合請求対象で、`false`の場合は請求対象ではないことを表します。



29
30
31
 
# File 'lib/mfk_openapi_ruby_client/models/transaction.rb', line 29

def billing
  @billing
end

#billing_accepted_at ⇒ Object

請求依頼受領日時です。請求対象になった日時を表します。請求対象でない場合は空になります。



32
33
34
 
# File 'lib/mfk_openapi_ruby_client/models/transaction.rb', line 32

def billing_accepted_at
  @billing_accepted_at
end

#billing_condition ⇒ Object

Returns the value of attribute billing_condition.



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

def billing_condition
  @billing_condition
end

#billing_id ⇒ Object

請求IDです。請求書にまとめられる単位のIDです。同じ請求IDを持つ取引とまとめられて請求書に記載されます。



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

def billing_id
  @billing_id
end

#canceled_at ⇒ Object

取引がキャンセルされた日時です。未キャンセルの場合は空になります。



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

def canceled_at
  @canceled_at
end

#created_at ⇒ Object

取引が登録された日時です。



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

def created_at
  @created_at
end

#customer_id ⇒ Object

顧客IDです。



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

def customer_id
  @customer_id
end

#date ⇒ Object

取引日です。売り手様と顧客様の間で取引を行った日付です。



52
53
54
 
# File 'lib/mfk_openapi_ruby_client/models/transaction.rb', line 52

def date
  @date
end

#destination_id ⇒ Object

請求先IDです。取引の請求先を示します。



49
50
51
 
# File 'lib/mfk_openapi_ruby_client/models/transaction.rb', line 49

def destination_id
  @destination_id
end

#due_date ⇒ Object

支払期限です。この日付を超えてMoney Forward Kessaiへの入金が確認できない場合は未入金になります。



55
56
57
 
# File 'lib/mfk_openapi_ruby_client/models/transaction.rb', line 55

def due_date
  @due_date
end

#id ⇒ Object

取引IDです。一意の識別子として自動で付与されます。



58
59
60
 
# File 'lib/mfk_openapi_ruby_client/models/transaction.rb', line 58

def id
  @id
end

#invoice_delivery_methods ⇒ Object

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



61
62
63
 
# File 'lib/mfk_openapi_ruby_client/models/transaction.rb', line 61

def invoice_delivery_methods
  @invoice_delivery_methods
end

#issue_date ⇒ Object

請求書発行日です。請求書発送日については<a href="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" target="_blank">請求書発行日について</a>を参照ください。



64
65
66
 
# File 'lib/mfk_openapi_ruby_client/models/transaction.rb', line 64

def issue_date
  @issue_date
end

#number ⇒ Object

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



67
68
69
 
# File 'lib/mfk_openapi_ruby_client/models/transaction.rb', line 67

def number
  @number
end

#object ⇒ Object

このObjectの種別を示します。ここでは必ず‘transaction`が入ります。



70
71
72
 
# File 'lib/mfk_openapi_ruby_client/models/transaction.rb', line 70

def object
  @object
end

#status ⇒ Object

取引ステータスです。審査中(‘unexamined`)、審査通過(`passed`)、審査否決(`rejected`)、キャンセル済(`canceled`)があります。



73
74
75
 
# File 'lib/mfk_openapi_ruby_client/models/transaction.rb', line 73

def status
  @status
end

#transaction_details ⇒ Object

取引明細行です。



76
77
78
 
# File 'lib/mfk_openapi_ruby_client/models/transaction.rb', line 76

def transaction_details
  @transaction_details
end

#uri ⇒ Object

取引URIです。すべてのリソースで一意の識別子として自動で付与されます。



79
80
81
 
# File 'lib/mfk_openapi_ruby_client/models/transaction.rb', line 79

def uri
  @uri
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



131
132
133
 
# File 'lib/mfk_openapi_ruby_client/models/transaction.rb', line 131

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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
 
# File 'lib/mfk_openapi_ruby_client/models/transaction.rb', line 104

def self.attribute_map
  {
    :'accepted_at' => :'accepted_at',
    :'amount' => :'amount',
    :'amounts_per_tax_rate_type' => :'amounts_per_tax_rate_type',
    :'billing' => :'billing',
    :'billing_accepted_at' => :'billing_accepted_at',
    :'billing_condition' => :'billing_condition',
    :'billing_id' => :'billing_id',
    :'canceled_at' => :'canceled_at',
    :'created_at' => :'created_at',
    :'customer_id' => :'customer_id',
    :'destination_id' => :'destination_id',
    :'date' => :'date',
    :'due_date' => :'due_date',
    :'id' => :'id',
    :'invoice_delivery_methods' => :'invoice_delivery_methods',
    :'issue_date' => :'issue_date',
    :'number' => :'number',
    :'object' => :'object',
    :'status' => :'status',
    :'transaction_details' => :'transaction_details',
    :'uri' => :'uri'
  }
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



358
359
360
 
# File 'lib/mfk_openapi_ruby_client/models/transaction.rb', line 358

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



163
164
165
166
167
168
169
170
 
# File 'lib/mfk_openapi_ruby_client/models/transaction.rb', line 163

def self.openapi_nullable
  Set.new([
    :'accepted_at',
    :'billing',
    :'billing_accepted_at',
    :'canceled_at',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/mfk_openapi_ruby_client/models/transaction.rb', line 136

def self.openapi_types
  {
    :'accepted_at' => :'Time',
    :'amount' => :'Integer',
    :'amounts_per_tax_rate_type' => :'Array<AmountPerTaxRateType>',
    :'billing' => :'Boolean',
    :'billing_accepted_at' => :'Time',
    :'billing_condition' => :'BillingCondition',
    :'billing_id' => :'String',
    :'canceled_at' => :'Time',
    :'created_at' => :'Time',
    :'customer_id' => :'String',
    :'destination_id' => :'String',
    :'date' => :'Date',
    :'due_date' => :'Date',
    :'id' => :'String',
    :'invoice_delivery_methods' => :'Array<InvoiceDeliveryMethod>',
    :'issue_date' => :'Date',
    :'number' => :'String',
    :'object' => :'String',
    :'status' => :'String',
    :'transaction_details' => :'Array<TransactionDetail>',
    :'uri' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/mfk_openapi_ruby_client/models/transaction.rb', line 317

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      accepted_at == o.accepted_at &&
      amount == o.amount &&
      amounts_per_tax_rate_type == o.amounts_per_tax_rate_type &&
      billing == o.billing &&
      billing_accepted_at == o.billing_accepted_at &&
      billing_condition == o.billing_condition &&
      billing_id == o.billing_id &&
      canceled_at == o.canceled_at &&
      created_at == o.created_at &&
      customer_id == o.customer_id &&
      destination_id == o.destination_id &&
      date == o.date &&
      due_date == o.due_date &&
      id == o.id &&
      invoice_delivery_methods == o.invoice_delivery_methods &&
      issue_date == o.issue_date &&
      number == o.number &&
      object == o.object &&
      status == o.status &&
      transaction_details == o.transaction_details &&
      uri == o.uri
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



388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/mfk_openapi_ruby_client/models/transaction.rb', line 388

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



459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/mfk_openapi_ruby_client/models/transaction.rb', line 459

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



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/mfk_openapi_ruby_client/models/transaction.rb', line 365

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


345
346
347
 
# File 'lib/mfk_openapi_ruby_client/models/transaction.rb', line 345

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



351
352
353
 
# File 'lib/mfk_openapi_ruby_client/models/transaction.rb', line 351

def hash
  [accepted_at, amount, amounts_per_tax_rate_type, billing, billing_accepted_at, billing_condition, billing_id, canceled_at, created_at, customer_id, destination_id, date, due_date, id, invoice_delivery_methods, issue_date, number, object, status, transaction_details, uri].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



280
281
282
283
 
# File 'lib/mfk_openapi_ruby_client/models/transaction.rb', line 280

def list_invalid_properties
  invalid_properties = Array.new
  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



435
436
437
 
# File 'lib/mfk_openapi_ruby_client/models/transaction.rb', line 435

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



441
442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/mfk_openapi_ruby_client/models/transaction.rb', line 441

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



429
430
431
 
# File 'lib/mfk_openapi_ruby_client/models/transaction.rb', line 429

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



287
288
289
290
291
292
293
 
# File 'lib/mfk_openapi_ruby_client/models/transaction.rb', line 287

def valid?
  object_validator = EnumAttributeValidator.new('String', ["transaction"])
  return false unless object_validator.valid?(@object)
  status_validator = EnumAttributeValidator.new('String', ["unexamined", "passed", "rejected", "canceled"])
  return false unless status_validator.valid?(@status)
  true
end