class CyberSource::Ptsv2paymentsOrderInformationInvoiceDetails

Attributes

barcode_number[RW]

Barcode Number.

commodity_code[RW]

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)

expiration_date[RW]

Expiration Date.

invoice_date[RW]

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.

invoice_number[RW]

Invoice Number.

merchandise_code[RW]

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_.

purchase_contact_name[RW]

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)

purchase_order_date[RW]

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)

purchase_order_number[RW]

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)

reference_data_code[RW]

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.

reference_data_number[RW]

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.

sales_slip_number[RW]

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.

taxable[RW]

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

transaction_advice_addendum[RW]
vat_invoice_reference_number[RW]

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)

Public Class Methods

attribute_map() click to toggle source

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

# 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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# 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
swagger_types() click to toggle source

Attribute type mapping.

# 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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb, line 252
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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb, line 308
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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb, line 374
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb, line 287
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
commodity_code=(commodity_code) click to toggle source

Custom attribute writer method with validation @param [Object] commodity_code Value to be assigned

# File lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb, line 218
def commodity_code=(commodity_code)
  @commodity_code = commodity_code
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb, line 274
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb, line 280
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
invoice_date=(invoice_date) click to toggle source

Custom attribute writer method with validation @param [Object] invoice_date Value to be assigned

# File lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb, line 246
def invoice_date=(invoice_date)
  @invoice_date = invoice_date
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb, line 176
def list_invalid_properties
  invalid_properties = Array.new
  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

  invalid_properties
end
purchase_contact_name=(purchase_contact_name) click to toggle source

Custom attribute writer method with validation @param [Object] purchase_contact_name Value to be assigned

# File lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb, line 206
def purchase_contact_name=(purchase_contact_name)
  @purchase_contact_name = purchase_contact_name
end
purchase_order_date=(purchase_order_date) click to toggle source

Custom attribute writer method with validation @param [Object] purchase_order_date Value to be assigned

# File lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb, line 200
def purchase_order_date=(purchase_order_date)
  @purchase_order_date = purchase_order_date
end
purchase_order_number=(purchase_order_number) click to toggle source

Custom attribute writer method with validation @param [Object] purchase_order_number Value to be assigned

# File lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb, line 194
def purchase_order_number=(purchase_order_number)
  @purchase_order_number = purchase_order_number
end
reference_data_code=(reference_data_code) click to toggle source

Custom attribute writer method with validation @param [Object] reference_data_code Value to be assigned

# File lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb, line 224
def reference_data_code=(reference_data_code)
  @reference_data_code = reference_data_code
end
reference_data_number=(reference_data_number) click to toggle source

Custom attribute writer method with validation @param [Object] reference_data_number Value to be assigned

# File lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb, line 230
def reference_data_number=(reference_data_number)
  @reference_data_number = reference_data_number
end
sales_slip_number=(sales_slip_number) click to toggle source

Custom attribute writer method with validation @param [Object] sales_slip_number Value to be assigned

# File lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb, line 236
def sales_slip_number=(sales_slip_number)
  if !sales_slip_number.nil? && sales_slip_number > 99999
    fail ArgumentError, 'invalid value for "sales_slip_number", must be smaller than or equal to 99999.'
  end

  @sales_slip_number = sales_slip_number
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb, line 354
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb, line 360
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb, line 348
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb, line 187
def valid?
  return false if !@sales_slip_number.nil? && @sales_slip_number > 99999
  true
end
vat_invoice_reference_number=(vat_invoice_reference_number) click to toggle source

Custom attribute writer method with validation @param [Object] vat_invoice_reference_number Value to be assigned

# File lib/cybersource_rest_client/models/ptsv2payments_order_information_invoice_details.rb, line 212
def vat_invoice_reference_number=(vat_invoice_reference_number)
  @vat_invoice_reference_number = vat_invoice_reference_number
end