class XeroRuby::Accounting::Invoice

Constants

ACCPAY
ACCPAYCREDIT
ACCREC
ACCRECCREDIT
APOVERPAYMENT
APPREPAYMENT
AROVERPAYMENT
ARPREPAYMENT
AUTHORISED
DELETED
DRAFT
SUBMITTED
VOIDED

Attributes

amount_credited[RW]

Sum of all credit notes, over-payments and pre-payments applied to invoice

amount_due[RW]

Amount remaining to be paid on invoice

amount_paid[RW]

Sum of payments received for invoice

attachments[RW]

Displays array of attachments from the API

branding_theme_id[RW]
cis_deduction[RW]

CIS deduction for UK contractors

cis_rate[RW]

CIS Deduction rate for the organisation

contact[RW]
credit_notes[RW]

Details of credit notes that have been applied to an invoice

currency_code[RW]
currency_rate[RW]

The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used. (max length = [18].)

date[RW]

Date invoice was issued – YYYY-MM-DD. If the Date element is not specified it will default to the current date based on the timezone setting of the organisation

due_date[RW]

Date invoice is due – YYYY-MM-DD

expected_payment_date[RW]

Shown on sales invoices (Accounts Receivable) when this has been set

fully_paid_on_date[RW]

The date the invoice was fully paid. Only returned on fully paid invoices

has_attachments[RW]

boolean to indicate if an invoice has an attachment

has_errors[RW]

A boolean to indicate if a invoice has an validation errors

invoice_id[RW]

Xero generated unique identifier for invoice

invoice_number[RW]

ACCREC – Unique alpha numeric code identifying invoice (when missing will auto-generate from your Organisation Invoice Settings) (max length = 255)

is_discounted[RW]

boolean to indicate if an invoice has a discount

line_amount_types[RW]
line_items[RW]

See LineItems

overpayments[RW]
payments[RW]

See Payments

planned_payment_date[RW]

Shown on bills (Accounts Payable) when this has been set

prepayments[RW]
reference[RW]

ACCREC only – additional reference number

repeating_invoice_id[RW]

Xero generated unique identifier for repeating invoices

sent_to_contact[RW]

Boolean to set whether the invoice in the Xero app should be marked as “sent”. This can be set only on invoices that have been approved

status[RW]

See Invoice Status Codes

status_attribute_string[RW]

A string to indicate if a invoice status

sub_total[RW]

Total of invoice excluding taxes

total[RW]

Total of Invoice tax inclusive (i.e. SubTotal + TotalTax). This will be ignored if it doesn’t equal the sum of the LineAmounts

total_discount[RW]

Total of discounts applied on the invoice line items

total_tax[RW]

Total tax on invoice

type[RW]

See Invoice Types

updated_date_utc[RW]

Last modified date UTC format

url[RW]

URL link to a source document – shown as “Go to [appName]” in the Xero app

validation_errors[RW]

Displays array of validation error messages from the API

warnings[RW]

Displays array of warning messages from the API

Public Class Methods

attribute_map() click to toggle source

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

# File lib/xero-ruby/models/accounting/invoice.rb, line 176
def self.attribute_map
  {
    :'type' => :'Type',
    :'contact' => :'Contact',
    :'line_items' => :'LineItems',
    :'date' => :'Date',
    :'due_date' => :'DueDate',
    :'line_amount_types' => :'LineAmountTypes',
    :'invoice_number' => :'InvoiceNumber',
    :'reference' => :'Reference',
    :'branding_theme_id' => :'BrandingThemeID',
    :'url' => :'Url',
    :'currency_code' => :'CurrencyCode',
    :'currency_rate' => :'CurrencyRate',
    :'status' => :'Status',
    :'sent_to_contact' => :'SentToContact',
    :'expected_payment_date' => :'ExpectedPaymentDate',
    :'planned_payment_date' => :'PlannedPaymentDate',
    :'cis_deduction' => :'CISDeduction',
    :'cis_rate' => :'CISRate',
    :'sub_total' => :'SubTotal',
    :'total_tax' => :'TotalTax',
    :'total' => :'Total',
    :'total_discount' => :'TotalDiscount',
    :'invoice_id' => :'InvoiceID',
    :'repeating_invoice_id' => :'RepeatingInvoiceID',
    :'has_attachments' => :'HasAttachments',
    :'is_discounted' => :'IsDiscounted',
    :'payments' => :'Payments',
    :'prepayments' => :'Prepayments',
    :'overpayments' => :'Overpayments',
    :'amount_due' => :'AmountDue',
    :'amount_paid' => :'AmountPaid',
    :'fully_paid_on_date' => :'FullyPaidOnDate',
    :'amount_credited' => :'AmountCredited',
    :'updated_date_utc' => :'UpdatedDateUTC',
    :'credit_notes' => :'CreditNotes',
    :'attachments' => :'Attachments',
    :'has_errors' => :'HasErrors',
    :'status_attribute_string' => :'StatusAttributeString',
    :'validation_errors' => :'ValidationErrors',
    :'warnings' => :'Warnings'
  }
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/xero-ruby/models/accounting/invoice.rb, line 577
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

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

# File lib/xero-ruby/models/accounting/invoice.rb, line 269
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::Accounting::Invoice` 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 `XeroRuby::Accounting::Invoice`. 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?(:'type')
    self.type = attributes[:'type']
  end

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

  if attributes.key?(:'line_items')
    if (value = attributes[:'line_items']).is_a?(Array)
      self.line_items = value
    end
  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?(:'line_amount_types')
    self.line_amount_types = attributes[:'line_amount_types']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'has_attachments')
    self.has_attachments = attributes[:'has_attachments']
  else
    self.has_attachments = false
  end

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'has_errors')
    self.has_errors = attributes[:'has_errors']
  else
    self.has_errors = false
  end

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

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

  if attributes.key?(:'warnings')
    if (value = attributes[:'warnings']).is_a?(Array)
      self.warnings = value
    end
  end
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/xero-ruby/models/accounting/invoice.rb, line 222
def self.openapi_types
  {
    :'type' => :'String',
    :'contact' => :'Contact',
    :'line_items' => :'Array<LineItem>',
    :'date' => :'Date',
    :'due_date' => :'Date',
    :'line_amount_types' => :'LineAmountTypes',
    :'invoice_number' => :'String',
    :'reference' => :'String',
    :'branding_theme_id' => :'String',
    :'url' => :'String',
    :'currency_code' => :'CurrencyCode',
    :'currency_rate' => :'BigDecimal',
    :'status' => :'String',
    :'sent_to_contact' => :'Boolean',
    :'expected_payment_date' => :'Date',
    :'planned_payment_date' => :'Date',
    :'cis_deduction' => :'BigDecimal',
    :'cis_rate' => :'BigDecimal',
    :'sub_total' => :'BigDecimal',
    :'total_tax' => :'BigDecimal',
    :'total' => :'BigDecimal',
    :'total_discount' => :'BigDecimal',
    :'invoice_id' => :'String',
    :'repeating_invoice_id' => :'String',
    :'has_attachments' => :'Boolean',
    :'is_discounted' => :'Boolean',
    :'payments' => :'Array<Payment>',
    :'prepayments' => :'Array<Prepayment>',
    :'overpayments' => :'Array<Overpayment>',
    :'amount_due' => :'BigDecimal',
    :'amount_paid' => :'BigDecimal',
    :'fully_paid_on_date' => :'Date',
    :'amount_credited' => :'BigDecimal',
    :'updated_date_utc' => :'DateTime',
    :'credit_notes' => :'Array<CreditNote>',
    :'attachments' => :'Array<Attachment>',
    :'has_errors' => :'Boolean',
    :'status_attribute_string' => :'String',
    :'validation_errors' => :'Array<ValidationError>',
    :'warnings' => :'Array<ValidationError>'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/xero-ruby/models/accounting/invoice.rb, line 517
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      contact == o.contact &&
      line_items == o.line_items &&
      date == o.date &&
      due_date == o.due_date &&
      line_amount_types == o.line_amount_types &&
      invoice_number == o.invoice_number &&
      reference == o.reference &&
      branding_theme_id == o.branding_theme_id &&
      url == o.url &&
      currency_code == o.currency_code &&
      currency_rate == o.currency_rate &&
      status == o.status &&
      sent_to_contact == o.sent_to_contact &&
      expected_payment_date == o.expected_payment_date &&
      planned_payment_date == o.planned_payment_date &&
      cis_deduction == o.cis_deduction &&
      cis_rate == o.cis_rate &&
      sub_total == o.sub_total &&
      total_tax == o.total_tax &&
      total == o.total &&
      total_discount == o.total_discount &&
      invoice_id == o.invoice_id &&
      repeating_invoice_id == o.repeating_invoice_id &&
      has_attachments == o.has_attachments &&
      is_discounted == o.is_discounted &&
      payments == o.payments &&
      prepayments == o.prepayments &&
      overpayments == o.overpayments &&
      amount_due == o.amount_due &&
      amount_paid == o.amount_paid &&
      fully_paid_on_date == o.fully_paid_on_date &&
      amount_credited == o.amount_credited &&
      updated_date_utc == o.updated_date_utc &&
      credit_notes == o.credit_notes &&
      attachments == o.attachments &&
      has_errors == o.has_errors &&
      status_attribute_string == o.status_attribute_string &&
      validation_errors == o.validation_errors &&
      warnings == o.warnings
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/xero-ruby/models/accounting/invoice.rb, line 605
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(parse_date(value))
  when :Date
    Date.parse(parse_date(value))
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BigDecimal
    BigDecimal(value.to_s)
  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
    XeroRuby::Accounting.const_get(type).build_from_hash(value)
  end
end
_to_hash(value, downcase: false) 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/xero-ruby/models/accounting/invoice.rb, line 678
def _to_hash(value, downcase: false)
  if value.is_a?(Array)
    value.map do |v|
      v.to_hash(downcase: downcase)
    end
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.map { |k, v| hash[k] = _to_hash(v, downcase: downcase) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash(downcase: downcase)
  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/xero-ruby/models/accounting/invoice.rb, line 584
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(o) click to toggle source

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

# File lib/xero-ruby/models/accounting/invoice.rb, line 564
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/xero-ruby/models/accounting/invoice.rb, line 570
def hash
  [type, contact, line_items, date, due_date, line_amount_types, invoice_number, reference, branding_theme_id, url, currency_code, currency_rate, status, sent_to_contact, expected_payment_date, planned_payment_date, cis_deduction, cis_rate, sub_total, total_tax, total, total_discount, invoice_id, repeating_invoice_id, has_attachments, is_discounted, payments, prepayments, overpayments, amount_due, amount_paid, fully_paid_on_date, amount_credited, updated_date_utc, credit_notes, attachments, has_errors, status_attribute_string, validation_errors, warnings].hash
end
invoice_number=(invoice_number) click to toggle source

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

# File lib/xero-ruby/models/accounting/invoice.rb, line 497
def invoice_number=(invoice_number)
  if !invoice_number.nil? && invoice_number.to_s.length > 255
    fail ArgumentError, 'invalid value for "invoice_number", the character length must be smaller than or equal to 255.'
  end

  @invoice_number = invoice_number
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/xero-ruby/models/accounting/invoice.rb, line 465
def list_invalid_properties
  invalid_properties = Array.new
  if !@invoice_number.nil? && @invoice_number.to_s.length > 255
    invalid_properties.push('invalid value for "invoice_number", the character length must be smaller than or equal to 255.')
  end

  invalid_properties
end
parse_date(datestring) click to toggle source
# File lib/xero-ruby/models/accounting/invoice.rb, line 694
def parse_date(datestring)
  if datestring.include?('Date')
    date_pattern = /\/Date\((-?\d+)(\+\d+)?\)\//
    original, date, timezone = *date_pattern.match(datestring)
    date = (date.to_i / 1000)
    Time.at(date).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
  elsif /(\d\d\d\d)-(\d\d)/.match(datestring) # handles dates w/out Days: YYYY-MM*-DD
    Time.parse(datestring + '-01').strftime('%Y-%m-%dT%H:%M:%S').to_s
  else # handle date 'types' for small subset of payroll API's
    Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s
  end
end
status=(status) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned

# File lib/xero-ruby/models/accounting/invoice.rb, line 507
def status=(status)
  validator = EnumAttributeValidator.new('String', ["DRAFT", "SUBMITTED", "DELETED", "AUTHORISED", "PAID", "VOIDED"])
  unless validator.valid?(status)
    fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
  end
  @status = status
end
to_attributes() click to toggle source

Returns the object in the form of hash with snake_case

# File lib/xero-ruby/models/accounting/invoice.rb, line 670
def to_attributes
  to_hash(downcase: true)
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/xero-ruby/models/accounting/invoice.rb, line 652
def to_body
  to_hash
end
to_hash(downcase: false) click to toggle source

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

# File lib/xero-ruby/models/accounting/invoice.rb, line 658
def to_hash(downcase: false)
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    key = downcase ? attr : param
    hash[key] = _to_hash(value, downcase: downcase)
  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/xero-ruby/models/accounting/invoice.rb, line 646
def to_s
  to_hash.to_s
end
type=(type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned

# File lib/xero-ruby/models/accounting/invoice.rb, line 487
def type=(type)
  validator = EnumAttributeValidator.new('String', ["ACCPAY", "ACCPAYCREDIT", "APOVERPAYMENT", "APPREPAYMENT", "ACCREC", "ACCRECCREDIT", "AROVERPAYMENT", "ARPREPAYMENT"])
  unless validator.valid?(type)
    fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
  end
  @type = type
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/xero-ruby/models/accounting/invoice.rb, line 476
def valid?
  type_validator = EnumAttributeValidator.new('String', ["ACCPAY", "ACCPAYCREDIT", "APOVERPAYMENT", "APPREPAYMENT", "ACCREC", "ACCRECCREDIT", "AROVERPAYMENT", "ARPREPAYMENT"])
  return false unless type_validator.valid?(@type)
  return false if !@invoice_number.nil? && @invoice_number.to_s.length > 255
  status_validator = EnumAttributeValidator.new('String', ["DRAFT", "SUBMITTED", "DELETED", "AUTHORISED", "PAID", "VOIDED"])
  return false unless status_validator.valid?(@status)
  true
end