Class: CyberSource::Ptsv2paymentsOrderInformationInvoiceDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2paymentsOrderInformationInvoiceDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb', line 105

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key

  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'invoiceNumber')
    self.invoice_number = attributes[:'invoiceNumber']
  end

  if attributes.has_key?(:'barcodeNumber')
    self.barcode_number = attributes[:'barcodeNumber']
  end

  if attributes.has_key?(:'expirationDate')
    self.expiration_date = attributes[:'expirationDate']
  end

  if attributes.has_key?(:'purchaseOrderNumber')
    self.purchase_order_number = attributes[:'purchaseOrderNumber']
  end

  if attributes.has_key?(:'purchaseOrderDate')
    self.purchase_order_date = attributes[:'purchaseOrderDate']
  end

  if attributes.has_key?(:'purchaseContactName')
    self.purchase_contact_name = attributes[:'purchaseContactName']
  end

  if attributes.has_key?(:'taxable')
    self.taxable = attributes[:'taxable']
  end

  if attributes.has_key?(:'vatInvoiceReferenceNumber')
    self.vat_invoice_reference_number = attributes[:'vatInvoiceReferenceNumber']
  end

  if attributes.has_key?(:'commodityCode')
    self.commodity_code = attributes[:'commodityCode']
  end

  if attributes.has_key?(:'merchandiseCode')
    self.merchandise_code = attributes[:'merchandiseCode']
  end

  if attributes.has_key?(:'transactionAdviceAddendum')
    if (value = attributes[:'transactionAdviceAddendum']).is_a?(Array)
      self.transaction_advice_addendum = value
    end
  end

  if attributes.has_key?(:'referenceDataCode')
    self.reference_data_code = attributes[:'referenceDataCode']
  end

  if attributes.has_key?(:'referenceDataNumber')
    self.reference_data_number = attributes[:'referenceDataNumber']
  end

  if attributes.has_key?(:'salesSlipNumber')
    self.sales_slip_number = attributes[:'salesSlipNumber']
  end

  if attributes.has_key?(:'invoiceDate')
    self.invoice_date = attributes[:'invoiceDate']
  end
end

Instance Attribute Details

#barcode_number ⇒ Object

Barcode Number.



21
22
23
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb', line 21

def barcode_number
  @barcode_number
end

#commodity_code ⇒ Object

International description code of the overall order’s goods or services or the Categorizes purchases for VAT reporting. Contact your acquirer for a list of codes. For processor-specific information, see the ‘summary_commodity_code` field in [Level II and Level III Processing Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)



42
43
44
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb', line 42

def commodity_code
  @commodity_code
end

#expiration_date ⇒ Object

Expiration Date.



24
25
26
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb', line 24

def expiration_date
  @expiration_date
end

#invoice_date ⇒ Object

Date of the tax calculation. Use format YYYYMMDD. You can provide a date in the past if you are calculating tax for a refund and want to know what the tax was on the date the order was placed. You can provide a date in the future if you are calculating the tax for a future date, such as an upcoming tax holiday. The default is the date, in Pacific time, that the bank receives the request. Keep this in mind if you are in a different time zone and want the tax calculated with the rates that are applicable on a specific date. #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes.



59
60
61
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb', line 59

def invoice_date
  @invoice_date
end

#invoice_number ⇒ Object

Invoice Number.



18
19
20
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb', line 18

def invoice_number
  @invoice_number
end

#merchandise_code ⇒ Object

Identifier for the merchandise. This field is supported only on the processors listed in this field description. #### American Express Direct Possible value: - 1000: Gift card #### CyberSource through VisaNet This value must be right justified. In Japan, this value is called a _goods code_. #### JCN Gateway This value must be right justified. In Japan, this value is called a _goods code_.



45
46
47
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb', line 45

def merchandise_code
  @merchandise_code
end

#purchase_contact_name ⇒ Object

The name of the individual or the company contacted for company authorized purchases. For processor-specific information, see the ‘authorized_contact_name` field in [Level II and Level III Processing Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)



33
34
35
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb', line 33

def purchase_contact_name
  @purchase_contact_name
end

#purchase_order_date ⇒ Object

Date the order was processed. ‘Format: YYYY-MM-DD`. For processor-specific information, see the `purchaser_order_date` field in [Level II and Level III Processing Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)



30
31
32
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb', line 30

def purchase_order_date
  @purchase_order_date
end

#purchase_order_number ⇒ Object

Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource recommends that you do not populate the field with all zeros or nines. For processor-specific information, see the ‘user_po` field in [Level II and Level III Processing Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)



27
28
29
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb', line 27

def purchase_order_number
  @purchase_order_number
end

#reference_data_code ⇒ Object

Code that identifies the value of the ‘referenceDataNumber` field. For the possible values, see "Reference Data Codes" in [Level II and Level III Processing Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/). This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor.



50
51
52
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb', line 50

def reference_data_code
  @reference_data_code
end

#reference_data_number ⇒ Object

Reference number. The meaning of this value is identified by the value of the ‘referenceDataCode` field. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor.



53
54
55
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb', line 53

def reference_data_number
  @reference_data_number
end

#sales_slip_number ⇒ Object

Transaction identifier that is generated. You have the option of printing the sales slip number on the receipt. This field is supported only on Cybersource through Visanet and JCN gateway. Optional field. #### Card Present processing message If you included this field in the request, the returned value is the value that you sent in the request. If you did not include this field in the request, the system generated this value for you. The difference between this reply field and the ‘processorInformation.systemTraceAuditNumber` field is that the system generates the system trace audit number (STAN), and you must print the receipt number on the receipt; whereas you can generate the sales slip number, and you can choose to print the sales slip number on the receipt.



56
57
58
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb', line 56

def sales_slip_number
  @sales_slip_number
end

#taxable ⇒ Object

Flag that indicates whether an order is taxable. This value must be true if the sum of all lineItems[].taxAmount values > 0. If you do not include any ‘lineItems[].taxAmount` values in your request, CyberSource does not include `invoiceDetails.taxable` in the data it sends to the processor. For processor-specific information, see the `tax_indicator` field in [Level II and Level III Processing Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) Possible values: - true - false



36
37
38
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb', line 36

def taxable
  @taxable
end

#transaction_advice_addendum ⇒ Object

Returns the value of attribute transaction_advice_addendum.



47
48
49
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb', line 47

def transaction_advice_addendum
  @transaction_advice_addendum
end

#vat_invoice_reference_number ⇒ Object

VAT invoice number associated with the transaction. For processor-specific information, see the ‘vat_invoice_ref_number` field in [Level II and Level III Processing Using the SCMP API.](apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)



39
40
41
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb', line 39

def vat_invoice_reference_number
  @vat_invoice_reference_number
end

Class Method Details

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb', line 62

def self.attribute_map
  {
    :'invoice_number' => :'invoiceNumber',
    :'barcode_number' => :'barcodeNumber',
    :'expiration_date' => :'expirationDate',
    :'purchase_order_number' => :'purchaseOrderNumber',
    :'purchase_order_date' => :'purchaseOrderDate',
    :'purchase_contact_name' => :'purchaseContactName',
    :'taxable' => :'taxable',
    :'vat_invoice_reference_number' => :'vatInvoiceReferenceNumber',
    :'commodity_code' => :'commodityCode',
    :'merchandise_code' => :'merchandiseCode',
    :'transaction_advice_addendum' => :'transactionAdviceAddendum',
    :'reference_data_code' => :'referenceDataCode',
    :'reference_data_number' => :'referenceDataNumber',
    :'sales_slip_number' => :'salesSlipNumber',
    :'invoice_date' => :'invoiceDate'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb', line 83

def self.swagger_types
  {
    :'invoice_number' => :'String',
    :'barcode_number' => :'String',
    :'expiration_date' => :'String',
    :'purchase_order_number' => :'String',
    :'purchase_order_date' => :'String',
    :'purchase_contact_name' => :'String',
    :'taxable' => :'BOOLEAN',
    :'vat_invoice_reference_number' => :'String',
    :'commodity_code' => :'String',
    :'merchandise_code' => :'Integer',
    :'transaction_advice_addendum' => :'Array<Ptsv2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum>',
    :'reference_data_code' => :'String',
    :'reference_data_number' => :'String',
    :'sales_slip_number' => :'Integer',
    :'invoice_date' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb', line 324

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      invoice_number == o.invoice_number &&
      barcode_number == o.barcode_number &&
      expiration_date == o.expiration_date &&
      purchase_order_number == o.purchase_order_number &&
      purchase_order_date == o.purchase_order_date &&
      purchase_contact_name == o.purchase_contact_name &&
      taxable == o.taxable &&
      vat_invoice_reference_number == o.vat_invoice_reference_number &&
      commodity_code == o.commodity_code &&
      merchandise_code == o.merchandise_code &&
      transaction_advice_addendum == o.transaction_advice_addendum &&
      reference_data_code == o.reference_data_code &&
      reference_data_number == o.reference_data_number &&
      sales_slip_number == o.sales_slip_number &&
      invoice_date == o.invoice_date
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



380
381
382
383
384
385
386
387
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
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb', line 380

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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

    temp_model = CyberSource.const_get(type).new
    temp_model.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



446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb', line 446

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



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb', line 359

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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 # or else data not found in attributes(hash), not an issue as the data can be optional

  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


346
347
348
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb', line 346

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



352
353
354
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb', line 352

def hash
  [invoice_number, barcode_number, expiration_date, purchase_order_number, purchase_order_date, purchase_contact_name, taxable, vat_invoice_reference_number, commodity_code, merchandise_code, transaction_advice_addendum, reference_data_code, reference_data_number, sales_slip_number, invoice_date].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



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
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb', line 176

def list_invalid_properties
  invalid_properties = Array.new
  if !@purchase_order_number.nil? && @purchase_order_number.to_s.length > 25
    invalid_properties.push('invalid value for "purchase_order_number", the character length must be smaller than or equal to 25.')
  end

  if !@purchase_order_date.nil? && @purchase_order_date.to_s.length > 10
    invalid_properties.push('invalid value for "purchase_order_date", the character length must be smaller than or equal to 10.')
  end

  if !@purchase_contact_name.nil? && @purchase_contact_name.to_s.length > 36
    invalid_properties.push('invalid value for "purchase_contact_name", the character length must be smaller than or equal to 36.')
  end

  if !@vat_invoice_reference_number.nil? && @vat_invoice_reference_number.to_s.length > 15
    invalid_properties.push('invalid value for "vat_invoice_reference_number", the character length must be smaller than or equal to 15.')
  end

  if !@commodity_code.nil? && @commodity_code.to_s.length > 4
    invalid_properties.push('invalid value for "commodity_code", the character length must be smaller than or equal to 4.')
  end

  if !@reference_data_code.nil? && @reference_data_code.to_s.length > 3
    invalid_properties.push('invalid value for "reference_data_code", the character length must be smaller than or equal to 3.')
  end

  if !@reference_data_number.nil? && @reference_data_number.to_s.length > 30
    invalid_properties.push('invalid value for "reference_data_number", the character length must be smaller than or equal to 30.')
  end

  if !@sales_slip_number.nil? && @sales_slip_number > 99999
    invalid_properties.push('invalid value for "sales_slip_number", must be smaller than or equal to 99999.')
  end

  if !@invoice_date.nil? && @invoice_date.to_s.length > 8
    invalid_properties.push('invalid value for "invoice_date", the character length must be smaller than or equal to 8.')
  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



426
427
428
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb', line 426

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



432
433
434
435
436
437
438
439
440
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb', line 432

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



420
421
422
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb', line 420

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



219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb', line 219

def valid?
  return false if !@purchase_order_number.nil? && @purchase_order_number.to_s.length > 25
  return false if !@purchase_order_date.nil? && @purchase_order_date.to_s.length > 10
  return false if !@purchase_contact_name.nil? && @purchase_contact_name.to_s.length > 36
  return false if !@vat_invoice_reference_number.nil? && @vat_invoice_reference_number.to_s.length > 15
  return false if !@commodity_code.nil? && @commodity_code.to_s.length > 4
  return false if !@reference_data_code.nil? && @reference_data_code.to_s.length > 3
  return false if !@reference_data_number.nil? && @reference_data_number.to_s.length > 30
  return false if !@sales_slip_number.nil? && @sales_slip_number > 99999
  return false if !@invoice_date.nil? && @invoice_date.to_s.length > 8
  true
end