Module: Invoicexpress::Client::CreditNotes

Included in:
Invoicexpress::Client
Defined in:
lib/invoicexpress/client/credit_notes.rb

Instance Method Summary collapse

Instance Method Details

#create_credit_note(credit_note, options = {}) ⇒ Invoicexpress::Models::CreditNote

Creates a new credit note. Also allows to create a new client and/or new items in the same request. If the client name does not exist a new one is created. If items do not exist with the given names, new ones will be created. If item name already exists, the item is updated with the new values. Regarding item taxes, if the tax name is not found, no tax is applyed to that item. Portuguese accounts should also send the IVA exemption reason if the invoice contains exempt items(IVA 0%)

Parameters:

Returns:

Raises:

  • Invoicexpress::Unauthorized When the client is unauthorized

  • Invoicexpress::UnprocessableEntity When there are errors on the submission



60
61
62
63
64
65
 
# File 'lib/invoicexpress/client/credit_notes.rb', line 60

def create_credit_note(credit_note, options={})
  raise(ArgumentError, "credit note has the wrong type") unless credit_note.is_a?(Invoicexpress::Models::CreditNote)

  params = { :klass => Invoicexpress::Models::CreditNote, :body  => credit_note }
  post("credit_notes.xml", params.merge(options))
end

#credit_note(credit_note_id, options = {}) ⇒ Invoicexpress::Models::CreditNote

Returns all the information about a credit note:

  • Basic information (date, status, sequence number)

  • Client

  • Document items

  • Document timeline

Document timeline is composed by:

  • Date, time and the user who created it

  • Type of the event

The complete list of timeline events is:

  • create

  • edited

  • send_email

  • canceled

  • deleted

  • settled

  • second_copy

  • archived

  • unarchived

  • comment

Parameters:

  • credit_note_id (String) —

    Requested credit note id

Returns:

Raises:

  • Invoicexpress::Unauthorized When the client is unauthorized

  • Invoicexpress::NotFound When the credit_note doesn’t exist



43
44
45
46
47
 
# File 'lib/invoicexpress/client/credit_notes.rb', line 43

def credit_note(credit_note_id, options={})
  params = { :klass => Invoicexpress::Models::CreditNote }

  get("credit_notes/#{credit_note_id}.xml", params.merge(options))
end

#credit_note_mail(credit_note_id, message, options = {}) ⇒ Object

Sends the credit note through email

Parameters:

Raises:

  • Invoicexpress::Unauthorized When the client is unauthorized

  • Invoicexpress::UnprocessableEntity When there are errors on the submission

  • Invoicexpress::NotFound When the credit note doesn’t exist



119
120
121
122
123
124
 
# File 'lib/invoicexpress/client/credit_notes.rb', line 119

def credit_note_mail(credit_note_id, message, options={})
  raise(ArgumentError, "message has the wrong type") unless message.is_a?(Invoicexpress::Models::Message)

  params = { :body => message, :klass => Invoicexpress::Models::CreditNote }
  put("credit_notes/#{credit_note_id}/email-document.xml", params.merge(options))
end

#credit_notes(options = {}) ⇒ Invoicexpress::Models::CreditNotes

Returns all your credit notes

Parameters:

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

    a customizable set of options

Options Hash (options):

  • page (Integer) — default: 1 —

    You can ask a specific page of credit notes

Returns:

Raises:

  • Invoicexpress::Unauthorized When the client is unauthorized



13
14
15
16
17
 
# File 'lib/invoicexpress/client/credit_notes.rb', line 13

def credit_notes(options={})
  params = { :page => 1, :klass => Invoicexpress::Models::CreditNote }

  get("credit_notes.xml", params.merge(options))
end

#update_credit_note(credit_note, options = {}) ⇒ Object

Updates a credit note It also allows you to create a new client and/or items in the same request. If the client name does not exist a new client is created. Regarding item taxes, if the tax name is not found, no tax will be applied to that item. If item does not exist with the given name, a new one will be created. If item exists it will be updated with the new values Be careful when updating the document items, any missing items from the original document will be deleted.

Parameters:

Raises:

  • Invoicexpress::Unauthorized When the client is unauthorized

  • Invoicexpress::UnprocessableEntity When there are errors on the submission

  • Invoicexpress::NotFound When the credit note doesn’t exist



79
80
81
82
83
84
85
86
 
# File 'lib/invoicexpress/client/credit_notes.rb', line 79

def update_credit_note(credit_note, options={})
  raise(ArgumentError, "credit note has the wrong type") unless credit_note.is_a?(Invoicexpress::Models::CreditNote)
  if !credit_note.id
    raise ArgumentError, "CreditNote ID is required"
  end
  params = { :klass => Invoicexpress::Models::CreditNote, :body => credit_note.to_core }
  put("credit_notes/#{credit_note.id}.xml", params.merge(options))
end

#update_credit_note_state(credit_note_id, credit_note_state, options = {}) ⇒ Invoicexpress::Models::CreditNote

Changes the state of a credit note. Possible state transitions:

  • draft to final – finalized

  • draft to deleted – deleted

  • settled to final – unsettled

  • final to second copy – second_copy

  • final or second copy to canceled – canceled

  • final or second copy to settled – settled

Any other transitions will fail. When canceling a credit note you must specify a reason.

Parameters:

Returns:

Raises:

  • Invoicexpress::Unauthorized When the client is unauthorized

  • Invoicexpress::UnprocessableEntity When there are errors on the submission

  • Invoicexpress::NotFound When the credit note doesn’t exist



105
106
107
108
109
110
 
# File 'lib/invoicexpress/client/credit_notes.rb', line 105

def update_credit_note_state(credit_note_id, credit_note_state, options={})
  raise(ArgumentError, "credit note state has the wrong type") unless credit_note_state.is_a?(Invoicexpress::Models::InvoiceState)

  params = { :klass => Invoicexpress::Models::CreditNote, :body => credit_note_state }
  put("credit_notes/#{credit_note_id}/change-state.xml", params.merge(options))
end