Class: MfkOpenapiRubyClient::Billing

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

Overview

請求です。取引のうち、請求先・支払期限・請求書発行日・取引登録方式が同一の取引が同じ請求にまとめられます。

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Billing

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
152
153
154
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
 
# File 'lib/mfk_openapi_ruby_client/models/billing.rb', line 125

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

請求の**税込**の合計金額です。請求に含まれる取引金額の合計です。



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

def amount
  @amount
end

#amounts_per_tax_rate_type ⇒ Object

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



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

def amounts_per_tax_rate_type
  @amounts_per_tax_rate_type
end

#customer_id ⇒ Object

顧客IDです。請求の顧客を示します。



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

def customer_id
  @customer_id
end

#destination_id ⇒ Object

請求先IDです。請求先を示します。



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

def destination_id
  @destination_id
end

#due_date ⇒ Object

支払期限です。



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

def due_date
  @due_date
end

#id ⇒ Object

請求IDです。一意の識別子として自動で付与されます。請求先ID・支払期限・請求書発行日・取引登録方式が同一の取引がこの請求によってまとめられます。請求書は請求をもとに発行されます。



35
36
37
 
# File 'lib/mfk_openapi_ruby_client/models/billing.rb', line 35

def id
  @id
end

#invoice_delivery_methods ⇒ Object

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



38
39
40
 
# File 'lib/mfk_openapi_ruby_client/models/billing.rb', line 38

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)をご参照ください。



41
42
43
 
# File 'lib/mfk_openapi_ruby_client/models/billing.rb', line 41

def issue_date
  @issue_date
end

#object ⇒ Object

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



44
45
46
 
# File 'lib/mfk_openapi_ruby_client/models/billing.rb', line 44

def object
  @object
end

#status ⇒ Object

請求ステータスです。請求予定(‘scheduled`)、請求書発行済(`invoice_issued`) 、口座振替通知済(`account_transfer_notified`)で指定されます。



47
48
49
 
# File 'lib/mfk_openapi_ruby_client/models/billing.rb', line 47

def status
  @status
end

#unpaid ⇒ Object

Returns the value of attribute unpaid.



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

def unpaid
  @unpaid
end

#uri ⇒ Object

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



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

def uri
  @uri
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



95
96
97
 
# File 'lib/mfk_openapi_ruby_client/models/billing.rb', line 95

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/mfk_openapi_ruby_client/models/billing.rb', line 77

def self.attribute_map
  {
    :'amount' => :'amount',
    :'amounts_per_tax_rate_type' => :'amounts_per_tax_rate_type',
    :'customer_id' => :'customer_id',
    :'destination_id' => :'destination_id',
    :'due_date' => :'due_date',
    :'id' => :'id',
    :'invoice_delivery_methods' => :'invoice_delivery_methods',
    :'issue_date' => :'issue_date',
    :'object' => :'object',
    :'status' => :'status',
    :'unpaid' => :'unpaid',
    :'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



262
263
264
 
# File 'lib/mfk_openapi_ruby_client/models/billing.rb', line 262

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



118
119
120
121
 
# File 'lib/mfk_openapi_ruby_client/models/billing.rb', line 118

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

.openapi_types ⇒ Object

Attribute type mapping.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/mfk_openapi_ruby_client/models/billing.rb', line 100

def self.openapi_types
  {
    :'amount' => :'Integer',
    :'amounts_per_tax_rate_type' => :'Array<AmountPerTaxRateType>',
    :'customer_id' => :'String',
    :'destination_id' => :'String',
    :'due_date' => :'Date',
    :'id' => :'String',
    :'invoice_delivery_methods' => :'Array<InvoiceDeliveryMethod>',
    :'issue_date' => :'Date',
    :'object' => :'String',
    :'status' => :'String',
    :'unpaid' => :'BillingUnpaid',
    :'uri' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/mfk_openapi_ruby_client/models/billing.rb', line 230

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 &&
      customer_id == o.customer_id &&
      destination_id == o.destination_id &&
      due_date == o.due_date &&
      id == o.id &&
      invoice_delivery_methods == o.invoice_delivery_methods &&
      issue_date == o.issue_date &&
      object == o.object &&
      status == o.status &&
      unpaid == o.unpaid &&
      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



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/mfk_openapi_ruby_client/models/billing.rb', line 292

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



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

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



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/mfk_openapi_ruby_client/models/billing.rb', line 269

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


249
250
251
 
# File 'lib/mfk_openapi_ruby_client/models/billing.rb', line 249

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



255
256
257
 
# File 'lib/mfk_openapi_ruby_client/models/billing.rb', line 255

def hash
  [amount, amounts_per_tax_rate_type, customer_id, destination_id, due_date, id, invoice_delivery_methods, issue_date, object, status, unpaid, 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



193
194
195
196
 
# File 'lib/mfk_openapi_ruby_client/models/billing.rb', line 193

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



339
340
341
 
# File 'lib/mfk_openapi_ruby_client/models/billing.rb', line 339

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



345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/mfk_openapi_ruby_client/models/billing.rb', line 345

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



333
334
335
 
# File 'lib/mfk_openapi_ruby_client/models/billing.rb', line 333

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



200
201
202
203
204
205
206
 
# File 'lib/mfk_openapi_ruby_client/models/billing.rb', line 200

def valid?
  object_validator = EnumAttributeValidator.new('String', ["billing"])
  return false unless object_validator.valid?(@object)
  status_validator = EnumAttributeValidator.new('String', ["scheduled", "invoice_issued", "account_transfer_notified"])
  return false unless status_validator.valid?(@status)
  true
end