class XeroGateway::CreditNote
Constants
- CREDIT_NOTE_STATUS
- CREDIT_NOTE_TYPE
- GUID_REGEX
- LINE_AMOUNT_TYPES
Attributes
All accessible fields
All accessible fields
All accessible fields
All accessible fields
All accessible fields
Any errors that occurred when the valid?
method called.
All accessible fields
Xero::Gateway associated with this credit_note.
All accessible fields
Represents whether the line_items
have been downloaded when getting from GET /API.XRO/2.0/CreditNotes
All accessible fields
All accessible fields
All accessible fields
All accessible fields
Public Class Methods
TODO UpdatedDateUTC
# File lib/xero_gateway/credit_note.rb, line 186 def self.from_xml(credit_note_element, gateway = nil, options = {}) credit_note = CreditNote.new(options.merge({:gateway => gateway})) credit_note_element.children.each do |element| case(element.name) when "CreditNoteID" then credit_note.credit_note_id = element.text when "CreditNoteNumber" then credit_note.credit_note_number = element.text when "Type" then credit_note.type = element.text when "CurrencyCode" then credit_note.currency_code = element.text when "Contact" then credit_note.contact = Contact.from_xml(element) when "Date" then credit_note.date = parse_date(element.text) when "Status" then credit_note.status = element.text when "Reference" then credit_note.reference = element.text when "LineAmountTypes" then credit_note.line_amount_types = element.text when "LineItems" then element.children.each {|line_item| credit_note.line_items_downloaded = true; credit_note.line_items << LineItem.from_xml(line_item) } when "SubTotal" then credit_note.sub_total = BigDecimal(element.text) when "TotalTax" then credit_note.total_tax = BigDecimal(element.text) when "Total" then credit_note.total = BigDecimal(element.text) when "Payments" then element.children.each { | payment | credit_note.payments << Payment.from_xml(payment) } when "AmountDue" then credit_note.amount_due = BigDecimal(element.text) when "AmountPaid" then credit_note.amount_paid = BigDecimal(element.text) when "AmountCredited" then credit_note.amount_credited = BigDecimal(element.text) end end credit_note end
# File lib/xero_gateway/credit_note.rb, line 42 def initialize(params = {}) @errors ||= [] @payments ||= [] # Check if the line items have been downloaded. @line_items_downloaded = (params.delete(:line_items_downloaded) == true) params = { :line_amount_types => "Inclusive" }.merge(params) params.each do |k,v| self.send("#{k}=", v) end @line_items ||= [] end
Public Instance Methods
# File lib/xero_gateway/credit_note.rb, line 146 def ==(other) ["credit_note_number", "type", "status", "reference", "currency_code", "line_amount_types", "contact", "line_items"].each do |field| return false if send(field) != other.send(field) end ["date"].each do |field| return false if send(field).to_s != other.send(field).to_s end return true end
Helper method to check if the credit_note is accounts payable.
# File lib/xero_gateway/credit_note.rb, line 108 def accounts_payable? type == 'ACCPAYCREDIT' end
Helper method to check if the credit_note is accounts receivable.
# File lib/xero_gateway/credit_note.rb, line 113 def accounts_receivable? type == 'ACCRECCREDIT' end
Helper method to create the associated contact object.
# File lib/xero_gateway/credit_note.rb, line 99 def build_contact(params = {}) self.contact = gateway ? gateway.build_contact(params) : Contact.new(params) end
# File lib/xero_gateway/credit_note.rb, line 103 def contact @contact ||= build_contact end
Creates this credit_note record (using gateway.create_credit_note) with the associated gateway. If no gateway set, raise a NoGatewayError
exception.
# File lib/xero_gateway/credit_note.rb, line 159 def create raise NoGatewayError unless gateway gateway.create_credit_note(self) end
If line items are not downloaded, then attempt a download now (if this record was found to begin with).
# File lib/xero_gateway/credit_note.rb, line 123 def line_items if line_items_downloaded? @line_items # There is an credit_note_is so we can assume this record was loaded from Xero. # attempt to download the line_item records. elsif credit_note_id =~ GUID_REGEX raise NoGatewayError unless @gateway response = @gateway.get_credit_note(credit_note_id) raise CreditNoteNotFoundError, "CreditNote with ID #{credit_note_id} not found in Xero." unless response.success? && response.credit_note.is_a?(XeroGateway::CreditNote) @line_items = response.credit_note.line_items @line_items_downloaded = true @line_items # Otherwise, this is a new credit_note, so return the line_items reference. else @line_items end end
Whether or not the line_items
have been downloaded (GET/credit_notes does not download line items).
# File lib/xero_gateway/credit_note.rb, line 118 def line_items_downloaded? @line_items_downloaded end
# File lib/xero_gateway/credit_note.rb, line 167 def to_xml(b = Builder::XmlMarkup.new) b.CreditNote { b.Type self.type contact.to_xml(b) b.Date CreditNote.format_date(self.date || Date.today) b.Status self.status if self.status b.CreditNoteNumber self.credit_note_number if credit_note_number b.Reference self.reference if self.reference b.CurrencyCode self.currency_code if self.currency_code b.LineAmountTypes self.line_amount_types b.LineItems { self.line_items.each do |line_item| line_item.to_xml(b) end } } end
Validate the Address
record according to what will be valid by the gateway.
Usage:
address.valid? # Returns true/false Additionally sets address.errors array to an array of field/error.
# File lib/xero_gateway/credit_note.rb, line 66 def valid? @errors = [] if !credit_note_id.nil? && credit_note_id !~ GUID_REGEX @errors << ['credit_note_id', 'must be blank or a valid Xero GUID'] end if status && !CREDIT_NOTE_STATUS[status] @errors << ['status', "must be one of #{CREDIT_NOTE_STATUS.keys.join('/')}"] end if line_amount_types && !LINE_AMOUNT_TYPES[line_amount_types] @errors << ['line_amount_types', "must be one of #{LINE_AMOUNT_TYPES.keys.join('/')}"] end unless date @errors << ['credit_note_date', "can't be blank"] end # Make sure contact is valid. unless @contact && @contact.valid? @errors << ['contact', 'is invalid'] end # Make sure all line_items are valid. unless line_items.all? { | line_item | line_item.valid? } @errors << ['line_items', "at least one line item invalid"] end @errors.size == 0 end