Class: XeroGateway::Gateway
- Inherits:
-
Object
- Object
- XeroGateway::Gateway
- Extended by:
- Forwardable
- Defined in:
- lib/xero_gateway/gateway.rb
Direct Known Subclasses
Constant Summary
Constants included from Http
Http::OPEN_TIMEOUT, Http::READ_TIMEOUT, Http::ROOT_CA_FILE
Instance Attribute Summary collapse
-
#client ⇒ Object
Returns the value of attribute client.
-
#logger ⇒ Object
Returns the value of attribute logger.
-
#payroll_url ⇒ Object
Returns the value of attribute payroll_url.
-
#xero_url ⇒ Object
Returns the value of attribute xero_url.
Instance Method Summary collapse
-
#build_contact(contact = {}) ⇒ Object
Factory method for building new Contact objects associated with this gateway.
-
#build_credit_note(credit_note = {}) ⇒ Object
Factory method for building new CreditNote objects associated with this gateway.
-
#build_invoice(invoice = {}) ⇒ Object
Factory method for building new Invoice objects associated with this gateway.
-
#create_bank_transaction(bank_transaction) ⇒ Object
Creates a bank transaction in Xero based on a bank transaction object.
-
#create_contact(contact) ⇒ Object
Creates a contact in Xero.
-
#create_credit_note(credit_note) ⇒ Object
Creates an credit_note in Xero based on an credit_note object.
-
#create_credit_notes(credit_notes) ⇒ Object
Creates an array of credit_notes with a single API request.
-
#create_invoice(invoice) ⇒ Object
Creates an invoice in Xero based on an invoice object.
-
#create_invoices(invoices) ⇒ Object
Creates an array of invoices with a single API request.
-
#create_manual_journal(manual_journal) ⇒ Object
Creates a manual journal in Xero based on a manual journal object.
-
#create_payment(payment) ⇒ Object
Create Payment record in Xero.
-
#get_accounts ⇒ Object
Gets all accounts for a specific organization in Xero.
-
#get_accounts_list(load_on_init = true) ⇒ Object
Returns a XeroGateway::AccountsList object that makes working with the Xero list of accounts easier and allows caching the results.
-
#get_bank_transaction(bank_transaction_id) ⇒ Object
Retrieves a single bank transaction.
-
#get_bank_transactions(options = {}) ⇒ Object
Retrieves all bank transactions from Xero.
-
#get_contact_by_id(contact_id) ⇒ Object
Retrieve a contact from Xero Usage get_contact_by_id(contact_id).
-
#get_contact_by_number(contact_number) ⇒ Object
Retrieve a contact from Xero Usage get_contact_by_id(contact_id).
-
#get_contact_group_by_id(contact_group_id) ⇒ Object
Retreives a contact group by its id.
-
#get_contact_groups(options = {}) ⇒ Object
Retreives all contact groups from Xero.
-
#get_contacts(options = {}) ⇒ Object
Retrieve all contacts from Xero.
-
#get_credit_note(credit_note_id_or_number) ⇒ Object
Retrieves a single credit_note.
-
#get_credit_notes(options = {}) ⇒ Object
Retrieves all credit_notes from Xero.
-
#get_currencies ⇒ Object
Gets all currencies for a specific organisation in Xero.
-
#get_invoice(invoice_id_or_number, format = :xml) ⇒ Object
Retrieves a single invoice.
-
#get_invoices(options = {}) ⇒ Object
Retrieves all invoices from Xero.
-
#get_items ⇒ Object
Gets all Items for a specific organisation in Xero.
-
#get_manual_journal(manual_journal_id) ⇒ Object
Retrieves a single manual journal.
-
#get_manual_journals(options = {}) ⇒ Object
Retrieves all manual journals from Xero.
-
#get_organisation ⇒ Object
Gets Organisation details.
-
#get_pay_runs(options = {}) ⇒ Object
Get the Pay Runs for a specific organization in Xero.
-
#get_payment(payment_id, options = {}) ⇒ Object
Gets a single Payment for a specific organsation in Xero.
-
#get_payments(options = {}) ⇒ Object
Gets all Payments for a specific organisation in Xero.
-
#get_payroll_calendars(options = {}) ⇒ Object
Get the Payroll calendars for a specific organization in Xero.
-
#get_report(id_or_name, options = {}) ⇒ Object
Retrieves reports from Xero.
-
#get_tax_rates ⇒ Object
Gets all Tax Rates for a specific organisation in Xero.
-
#get_tracking_categories ⇒ Object
Gets all tracking categories for a specific organization in Xero.
-
#initialize(consumer_key, consumer_secret, options = {}) ⇒ Gateway
constructor
The consumer key and secret here correspond to those provided to you by Xero inside the API Previewer.
-
#update_bank_transaction(bank_transaction) ⇒ Object
Updates an existing Xero bank transaction.
-
#update_contact(contact) ⇒ Object
Updates an existing Xero contact.
-
#update_contacts(contacts) ⇒ Object
Updates an array of contacts in a single API operation.
-
#update_invoice(invoice) ⇒ Object
Updates an existing Xero invoice.
-
#update_manual_journal(manual_journal) ⇒ Object
Updates an existing Xero manual journal.
Methods included from Dates
Methods included from Http
#http_get, #http_post, #http_put
Constructor Details
#initialize(consumer_key, consumer_secret, options = {}) ⇒ Gateway
The consumer key and secret here correspond to those provided to you by Xero inside the API Previewer.
15 16 17 18 19 |
# File 'lib/xero_gateway/gateway.rb', line 15 def initialize(consumer_key, consumer_secret, = {}) @xero_url = [:xero_url] || "https://api.xero.com/api.xro/2.0" @payroll_url = [:payroll_url] || "https://api.xero.com/payroll.xro/1.0" @client = OAuth.new(consumer_key, consumer_secret, ) end |
Instance Attribute Details
#client ⇒ Object
Returns the value of attribute client.
7 8 9 |
# File 'lib/xero_gateway/gateway.rb', line 7 def client @client end |
#logger ⇒ Object
Returns the value of attribute logger.
7 8 9 |
# File 'lib/xero_gateway/gateway.rb', line 7 def logger @logger end |
#payroll_url ⇒ Object
Returns the value of attribute payroll_url.
7 8 9 |
# File 'lib/xero_gateway/gateway.rb', line 7 def payroll_url @payroll_url end |
#xero_url ⇒ Object
Returns the value of attribute xero_url.
7 8 9 |
# File 'lib/xero_gateway/gateway.rb', line 7 def xero_url @xero_url end |
Instance Method Details
#build_contact(contact = {}) ⇒ Object
Factory method for building new Contact objects associated with this gateway.
61 62 63 64 65 66 67 |
# File 'lib/xero_gateway/gateway.rb', line 61 def build_contact(contact = {}) case contact when Contact then contact.gateway = self when Hash then contact = Contact.new(contact.merge({:gateway => self})) end contact end |
#build_credit_note(credit_note = {}) ⇒ Object
Factory method for building new CreditNote objects associated with this gateway.
324 325 326 327 328 329 330 |
# File 'lib/xero_gateway/gateway.rb', line 324 def build_credit_note(credit_note = {}) case credit_note when CreditNote then credit_note.gateway = self when Hash then credit_note = CreditNote.new(credit_note.merge(:gateway => self)) end credit_note end |
#build_invoice(invoice = {}) ⇒ Object
Factory method for building new Invoice objects associated with this gateway.
211 212 213 214 215 216 217 |
# File 'lib/xero_gateway/gateway.rb', line 211 def build_invoice(invoice = {}) case invoice when Invoice then invoice.gateway = self when Hash then invoice = Invoice.new(invoice.merge(:gateway => self)) end invoice end |
#create_bank_transaction(bank_transaction) ⇒ Object
Creates a bank transaction in Xero based on a bank transaction object.
Bank transaction and line item totals are calculated automatically.
Usage :
bank_transaction = XeroGateway::BankTransaction.new({
:type => "RECEIVE",
:date => 1.month.from_now,
:reference => "YOUR INVOICE NUMBER",
})
bank_transaction.contact = XeroGateway::Contact.new(:name => "THE NAME OF THE CONTACT")
bank_transaction.contact.phone.number = "12345"
bank_transaction.contact.address.line_1 = "LINE 1 OF THE ADDRESS"
bank_transaction.line_items << XeroGateway::LineItem.new(
:description => "THE DESCRIPTION OF THE LINE ITEM",
:unit_amount => 100,
:tax_amount => 12.5,
:tracking_category => "THE TRACKING CATEGORY FOR THE LINE ITEM",
:tracking_option => "THE TRACKING OPTION FOR THE LINE ITEM"
)
bank_transaction.bank_account = XeroGateway::Account.new(:code => 'BANK-ABC)
create_bank_transaction(bank_transaction)
421 422 423 |
# File 'lib/xero_gateway/gateway.rb', line 421 def create_bank_transaction(bank_transaction) save_bank_transaction(bank_transaction) end |
#create_contact(contact) ⇒ Object
Creates a contact in Xero
Usage :
contact = XeroGateway::Contact.new(:name => “THE NAME OF THE CONTACT #Time.now.to_i”) contact.email = “[email protected]” contact.phone.number = “12345” contact.address.line_1 = “LINE 1 OF THE ADDRESS” contact.address.line_2 = “LINE 2 OF THE ADDRESS” contact.address.line_3 = “LINE 3 OF THE ADDRESS” contact.address.line_4 = “LINE 4 OF THE ADDRESS” contact.address.city = “WELLINGTON” contact.address.region = “WELLINGTON” contact.address.country = “NEW ZEALAND” contact.address.post_code = “6021”
create_contact(contact)
87 88 89 |
# File 'lib/xero_gateway/gateway.rb', line 87 def create_contact(contact) save_contact(contact) end |
#create_credit_note(credit_note) ⇒ Object
Creates an credit_note in Xero based on an credit_note object.
CreditNote and line item totals are calculated automatically.
Usage :
credit_note = XeroGateway::CreditNote.new({
:credit_note_type => "ACCREC",
:due_date => 1.month.from_now,
:credit_note_number => "YOUR CREDIT_NOTE NUMBER",
:reference => "YOUR REFERENCE (NOT NECESSARILY UNIQUE!)",
:line_amount_types => "Inclusive"
})
credit_note.contact = XeroGateway::Contact.new(:name => "THE NAME OF THE CONTACT")
credit_note.contact.phone.number = "12345"
credit_note.contact.address.line_1 = "LINE 1 OF THE ADDRESS"
credit_note.line_items << XeroGateway::LineItem.new(
:description => "THE DESCRIPTION OF THE LINE ITEM",
:unit_amount => 100,
:tax_amount => 12.5,
:tracking_category => "THE TRACKING CATEGORY FOR THE LINE ITEM",
:tracking_option => "THE TRACKING OPTION FOR THE LINE ITEM"
)
create_credit_note(credit_note)
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 |
# File 'lib/xero_gateway/gateway.rb', line 357 def create_credit_note(credit_note) request_xml = credit_note.to_xml response_xml = http_put(@client, "#{@xero_url}/CreditNotes", request_xml) response = parse_response(response_xml, {:request_xml => request_xml}, {:request_signature => 'PUT/credit_note'}) # Xero returns credit_notes inside an <CreditNotes> tag, even though there's only ever # one for this request response.response_item = response.credit_notes.first if response.success? && response.credit_note && response.credit_note.credit_note_id credit_note.credit_note_id = response.credit_note.credit_note_id end response end |
#create_credit_notes(credit_notes) ⇒ Object
Creates an array of credit_notes with a single API request.
Usage :
credit_notes = [XeroGateway::CreditNote.new(...), XeroGateway::CreditNote.new(...)]
result = gateway.create_credit_notes(credit_notes)
380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 |
# File 'lib/xero_gateway/gateway.rb', line 380 def create_credit_notes(credit_notes) b = Builder::XmlMarkup.new request_xml = b.CreditNotes { credit_notes.each do | credit_note | credit_note.to_xml(b) end } response_xml = http_put(@client, "#{@xero_url}/CreditNotes", request_xml, {}) response = parse_response(response_xml, {:request_xml => request_xml}, {:request_signature => 'PUT/credit_notes'}) response.credit_notes.each_with_index do | response_credit_note, index | credit_notes[index].credit_note_id = response_credit_note.credit_note_id if response_credit_note && response_credit_note.credit_note_id end response end |
#create_invoice(invoice) ⇒ Object
Creates an invoice in Xero based on an invoice object.
Invoice and line item totals are calculated automatically.
Usage :
invoice = XeroGateway::Invoice.new({
:invoice_type => "ACCREC",
:due_date => 1.month.from_now,
:invoice_number => "YOUR INVOICE NUMBER",
:reference => "YOUR REFERENCE (NOT NECESSARILY UNIQUE!)",
:line_amount_types => "Inclusive"
})
invoice.contact = XeroGateway::Contact.new(:name => "THE NAME OF THE CONTACT")
invoice.contact.phone.number = "12345"
invoice.contact.address.line_1 = "LINE 1 OF THE ADDRESS"
invoice.line_items << XeroGateway::LineItem.new(
:description => "THE DESCRIPTION OF THE LINE ITEM",
:unit_amount => 100,
:tax_amount => 12.5,
:tracking_category => "THE TRACKING CATEGORY FOR THE LINE ITEM",
:tracking_option => "THE TRACKING OPTION FOR THE LINE ITEM"
)
create_invoice(invoice)
244 245 246 |
# File 'lib/xero_gateway/gateway.rb', line 244 def create_invoice(invoice) save_invoice(invoice) end |
#create_invoices(invoices) ⇒ Object
Creates an array of invoices with a single API request.
Usage :
invoices = [XeroGateway::Invoice.new(...), XeroGateway::Invoice.new(...)]
result = gateway.create_invoices(invoices)
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 |
# File 'lib/xero_gateway/gateway.rb', line 270 def create_invoices(invoices) b = Builder::XmlMarkup.new request_xml = b.Invoices { invoices.each do | invoice | invoice.to_xml(b) end } response_xml = http_put(@client, "#{@xero_url}/Invoices?SummarizeErrors=false", request_xml, {}) response = parse_response(response_xml, {:request_xml => request_xml}, {:request_signature => 'PUT/invoices'}) response.invoices.each_with_index do | response_invoice, index | invoices[index].invoice_id = response_invoice.invoice_id if response_invoice && response_invoice.invoice_id end response end |
#create_manual_journal(manual_journal) ⇒ Object
Creates a manual journal in Xero based on a manual journal object.
Manual journal and line item totals are calculated automatically.
Usage : # TODO
475 476 477 |
# File 'lib/xero_gateway/gateway.rb', line 475 def create_manual_journal(manual_journal) save_manual_journal(manual_journal) end |
#create_payment(payment) ⇒ Object
Create Payment record in Xero
579 580 581 582 583 584 585 586 587 588 |
# File 'lib/xero_gateway/gateway.rb', line 579 def create_payment(payment) b = Builder::XmlMarkup.new request_xml = b.Payments do payment.to_xml(b) end response_xml = http_put(@client, "#{xero_url}/Payments", request_xml) parse_response(response_xml, {:request_xml => request_xml}, {:request_signature => 'PUT/payments'}) end |
#get_accounts ⇒ Object
Gets all accounts for a specific organization in Xero.
522 523 524 525 |
# File 'lib/xero_gateway/gateway.rb', line 522 def get_accounts response_xml = http_get(@client, "#{xero_url}/Accounts") parse_response(response_xml, {}, {:request_signature => 'GET/accounts'}) end |
#get_accounts_list(load_on_init = true) ⇒ Object
Returns a XeroGateway::AccountsList object that makes working with the Xero list of accounts easier and allows caching the results.
531 532 533 |
# File 'lib/xero_gateway/gateway.rb', line 531 def get_accounts_list(load_on_init = true) AccountsList.new(self, load_on_init) end |
#get_bank_transaction(bank_transaction_id) ⇒ Object
Retrieves a single bank transaction
Usage : get_bank_transaction(“297c2dc5-cc47-4afd-8ec8-74990b8761e9”) # By ID
get_bank_transaction("OIT-12345") # By number
462 463 464 465 466 467 |
# File 'lib/xero_gateway/gateway.rb', line 462 def get_bank_transaction(bank_transaction_id) request_params = {} url = "#{@xero_url}/BankTransactions/#{CGI.escape(bank_transaction_id)}" response_xml = http_get(@client, url, request_params) parse_response(response_xml, {:request_params => request_params}, {:request_signature => 'GET/BankTransaction'}) end |
#get_bank_transactions(options = {}) ⇒ Object
Retrieves all bank transactions from Xero
Usage : get_bank_transactions
get_bank_transactions(:bank_transaction_id => " 297c2dc5-cc47-4afd-8ec8-74990b8761e9")
Note : modified_since is in UTC format (i.e. Brisbane is UTC+10)
445 446 447 448 449 450 451 452 453 454 455 456 |
# File 'lib/xero_gateway/gateway.rb', line 445 def get_bank_transactions( = {}) request_params = {} request_params[:BankTransactionID] = [:bank_transaction_id] if [:bank_transaction_id] request_params[:ModifiedAfter] = [:modified_since] if [:modified_since] request_params[:order] = [:order] if [:order] request_params[:where] = [:where] if [:where] request_params[:page] = [:page] if [:page] response_xml = http_get(@client, "#{@xero_url}/BankTransactions", request_params) parse_response(response_xml, {:request_params => request_params}, {:request_signature => 'GET/BankTransactions'}) end |
#get_contact_by_id(contact_id) ⇒ Object
Retrieve a contact from Xero Usage get_contact_by_id(contact_id)
50 51 52 |
# File 'lib/xero_gateway/gateway.rb', line 50 def get_contact_by_id(contact_id) get_contact(contact_id) end |
#get_contact_by_number(contact_number) ⇒ Object
Retrieve a contact from Xero Usage get_contact_by_id(contact_id)
56 57 58 |
# File 'lib/xero_gateway/gateway.rb', line 56 def get_contact_by_number(contact_number) get_contact(nil, contact_number) end |
#get_contact_group_by_id(contact_group_id) ⇒ Object
Retreives a contact group by its id.
149 150 151 152 153 154 |
# File 'lib/xero_gateway/gateway.rb', line 149 def get_contact_group_by_id(contact_group_id) request_params = { :ContactGroupID => contact_group_id } response_xml = http_get(@client, "#{@xero_url}/ContactGroups/#{CGI.escape(contact_group_id)}", request_params) parse_response(response_xml, {:request_params => request_params}, {:request_signature => 'GET/contactgroup'}) end |
#get_contact_groups(options = {}) ⇒ Object
Retreives all contact groups from Xero
Usage:
groups = gateway.get_contact_groups()
136 137 138 139 140 141 142 143 144 145 146 |
# File 'lib/xero_gateway/gateway.rb', line 136 def get_contact_groups( = {}) request_params = {} request_params[:ContactGroupID] = [:contact_group_id] if [:contact_group_id] request_params[:order] = [:order] if [:order] request_params[:where] = [:where] if [:where] response_xml = http_get(@client, "#{@xero_url}/ContactGroups", request_params) parse_response(response_xml, {:request_params => request_params}, {:request_signature => 'GET/contactgroups'}) end |
#get_contacts(options = {}) ⇒ Object
Retrieve all contacts from Xero
Usage : get_contacts(:order => :name)
get_contacts(:modified_since => Time)
Note : modified_since is in UTC format (i.e. Brisbane is UTC+10)
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
# File 'lib/xero_gateway/gateway.rb', line 28 def get_contacts( = {}) request_params = {} if ![:updated_after].nil? warn '[warning] :updated_after is depracated in XeroGateway#get_contacts. Use :modified_since' [:modified_since] = .delete(:updated_after) end request_params[:ContactID] = [:contact_id] if [:contact_id] request_params[:ContactNumber] = [:contact_number] if [:contact_number] request_params[:order] = [:order] if [:order] request_params[:ModifiedAfter] = [:modified_since] if [:modified_since] request_params[:where] = [:where] if [:where] request_params[:page] = [:page] if [:page] response_xml = http_get(@client, "#{@xero_url}/Contacts", request_params) parse_response(response_xml, {:request_params => request_params}, {:request_signature => 'GET/contacts'}) end |
#get_credit_note(credit_note_id_or_number) ⇒ Object
Retrieves a single credit_note
Usage : get_credit_note(“297c2dc5-cc47-4afd-8ec8-74990b8761e9”) # By ID
get_credit_note("OIT-12345") # By number
313 314 315 316 317 318 319 320 321 |
# File 'lib/xero_gateway/gateway.rb', line 313 def get_credit_note(credit_note_id_or_number) request_params = {} url = "#{@xero_url}/CreditNotes/#{CGI.escape(credit_note_id_or_number)}" response_xml = http_get(@client, url, request_params) parse_response(response_xml, {:request_params => request_params}, {:request_signature => 'GET/CreditNote'}) end |
#get_credit_notes(options = {}) ⇒ Object
Retrieves all credit_notes from Xero
Usage : get_credit_notes
get_credit_notes(:credit_note_id => " 297c2dc5-cc47-4afd-8ec8-74990b8761e9")
Note : modified_since is in UTC format (i.e. Brisbane is UTC+10)
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 |
# File 'lib/xero_gateway/gateway.rb', line 293 def get_credit_notes( = {}) request_params = {} request_params[:CreditNoteID] = [:credit_note_id] if [:credit_note_id] request_params[:CreditNoteNumber] = [:credit_note_number] if [:credit_note_number] request_params[:order] = [:order] if [:order] request_params[:ModifiedAfter] = [:modified_since] if [:modified_since] request_params[:where] = [:where] if [:where] response_xml = http_get(@client, "#{@xero_url}/CreditNotes", request_params) parse_response(response_xml, {:request_params => request_params}, {:request_signature => 'GET/CreditNotes'}) end |
#get_currencies ⇒ Object
Gets all currencies for a specific organisation in Xero
555 556 557 558 |
# File 'lib/xero_gateway/gateway.rb', line 555 def get_currencies response_xml = http_get(@client, "#{xero_url}/Currencies") parse_response(response_xml, {}, {:request_signature => 'GET/currencies'}) end |
#get_invoice(invoice_id_or_number, format = :xml) ⇒ Object
Retrieves a single invoice
You can get a PDF-formatted invoice by specifying :pdf as the format argument
Usage : get_invoice(“297c2dc5-cc47-4afd-8ec8-74990b8761e9”) # By ID
get_invoice("OIT-12345") # By number
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 |
# File 'lib/xero_gateway/gateway.rb', line 190 def get_invoice(invoice_id_or_number, format = :xml) request_params = {} headers = {} headers.merge!("Accept" => "application/pdf") if format == :pdf url = "#{@xero_url}/Invoices/#{CGI.escape(invoice_id_or_number)}" response = http_get(@client, url, request_params, headers) if format == :pdf Tempfile.open(invoice_id_or_number) do |f| f.write(response) f end else parse_response(response, {:request_params => request_params}, {:request_signature => 'GET/Invoice'}) end end |
#get_invoices(options = {}) ⇒ Object
Retrieves all invoices from Xero
Usage : get_invoices
get_invoices(:invoice_id => "297c2dc5-cc47-4afd-8ec8-74990b8761e9")
get_invoices(:invoice_number => "175")
get_invoices(:contact_ids => ["297c2dc5-cc47-4afd-8ec8-74990b8761e9"] )
Note : modified_since is in UTC format (i.e. Brisbane is UTC+10)
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 |
# File 'lib/xero_gateway/gateway.rb', line 164 def get_invoices( = {}) request_params = {} request_params[:InvoiceID] = [:invoice_id] if [:invoice_id] request_params[:InvoiceNumber] = [:invoice_number] if [:invoice_number] request_params[:order] = [:order] if [:order] request_params[:ModifiedAfter] = [:modified_since] if [:modified_since] request_params[:IDs] = Array([:invoice_ids]).join(",") if [:invoice_ids] request_params[:InvoiceNumbers] = Array([:invoice_numbers]).join(",") if [:invoice_numbers] request_params[:ContactIDs] = Array([:contact_ids]).join(",") if [:contact_ids] request_params[:page] = [:page] if [:page] request_params[:where] = [:where] if [:where] response_xml = http_get(@client, "#{@xero_url}/Invoices", request_params) parse_response(response_xml, {:request_params => request_params}, {:request_signature => 'GET/Invoices'}) end |
#get_items ⇒ Object
Gets all Items for a specific organisation in Xero
571 572 573 574 |
# File 'lib/xero_gateway/gateway.rb', line 571 def get_items response_xml = http_get(@client, "#{xero_url}/Items") parse_response(response_xml, {}, {:request_signature => 'GET/items'}) end |
#get_manual_journal(manual_journal_id) ⇒ Object
Retrieves a single manual journal
Usage : get_manual_journal(“297c2dc5-cc47-4afd-8ec8-74990b8761e9”) # By ID
get_manual_journal("OIT-12345") # By number
512 513 514 515 516 517 |
# File 'lib/xero_gateway/gateway.rb', line 512 def get_manual_journal(manual_journal_id) request_params = {} url = "#{@xero_url}/ManualJournals/#{CGI.escape(manual_journal_id)}" response_xml = http_get(@client, url, request_params) parse_response(response_xml, {:request_params => request_params}, {:request_signature => 'GET/ManualJournal'}) end |
#get_manual_journals(options = {}) ⇒ Object
Retrieves all manual journals from Xero
Usage : get_manual_journal
getmanual_journal(:manual_journal_id => " 297c2dc5-cc47-4afd-8ec8-74990b8761e9")
Note : modified_since is in UTC format (i.e. Brisbane is UTC+10)
498 499 500 501 502 503 504 505 506 |
# File 'lib/xero_gateway/gateway.rb', line 498 def get_manual_journals( = {}) request_params = {} request_params[:ManualJournalID] = [:manual_journal_id] if [:manual_journal_id] request_params[:ModifiedAfter] = [:modified_since] if [:modified_since] response_xml = http_get(@client, "#{@xero_url}/ManualJournals", request_params) parse_response(response_xml, {:request_params => request_params}, {:request_signature => 'GET/ManualJournals'}) end |
#get_organisation ⇒ Object
Gets Organisation details
547 548 549 550 |
# File 'lib/xero_gateway/gateway.rb', line 547 def get_organisation response_xml = http_get(@client, "#{xero_url}/Organisation") parse_response(response_xml, {}, {:request_signature => 'GET/organisation'}) end |
#get_pay_runs(options = {}) ⇒ Object
Get the Pay Runs for a specific organization in Xero
626 627 628 629 630 |
# File 'lib/xero_gateway/gateway.rb', line 626 def get_pay_runs( = {}) request_params = {} response_xml = http_get(client, "#{@payroll_url}/PayRuns", request_params) parse_response(response_xml, {:request_params => request_params}, {:request_signature => 'GET/pay_runs'}) end |
#get_payment(payment_id, options = {}) ⇒ Object
Gets a single Payment for a specific organsation in Xero
608 609 610 611 612 |
# File 'lib/xero_gateway/gateway.rb', line 608 def get_payment(payment_id, = {}) request_params = {} response_xml = http_get(client, "#{@xero_url}/Payments/#{payment_id}", request_params) parse_response(response_xml, {:request_params => request_params}, {:request_signature => 'GET/payments'}) end |
#get_payments(options = {}) ⇒ Object
Gets all Payments for a specific organisation in Xero
593 594 595 596 597 598 599 600 601 602 |
# File 'lib/xero_gateway/gateway.rb', line 593 def get_payments( = {}) request_params = {} request_params[:PaymentID] = [:payment_id] if [:payment_id] request_params[:ModifiedAfter] = [:modified_since] if [:modified_since] request_params[:order] = [:order] if [:order] request_params[:where] = [:where] if [:where] response_xml = http_get(@client, "#{@xero_url}/Payments", request_params) parse_response(response_xml, {:request_params => request_params}, {:request_signature => 'GET/payments'}) end |
#get_payroll_calendars(options = {}) ⇒ Object
Get the Payroll calendars for a specific organization in Xero
617 618 619 620 621 |
# File 'lib/xero_gateway/gateway.rb', line 617 def get_payroll_calendars( = {}) request_params = {} response_xml = http_get(client, "#{@payroll_url}/PayrollCalendars", request_params) parse_response(response_xml, {:request_params => request_params}, {:request_signature => 'GET/payroll_calendars'}) end |
#get_report(id_or_name, options = {}) ⇒ Object
Retrieves reports from Xero
Usage : get_report(“BankStatement”, bank_account_id: “AC993F75-035B-433C-82E0-7B7A2D40802C”)
get_report("297c2dc5-cc47-4afd-8ec8-74990b8761e9", bank_account_id: "AC993F75-035B-433C-82E0-7B7A2D40802C")
636 637 638 639 640 641 642 643 644 |
# File 'lib/xero_gateway/gateway.rb', line 636 def get_report(id_or_name, ={}) request_params = .inject({}) do |params, (key, val)| xero_key = key.to_s.camelize.gsub(/id/i, "ID").to_sym params[xero_key] = val params end response_xml = http_get(@client, "#{@xero_url}/reports/#{id_or_name}", request_params) parse_response(response_xml, {:request_params => request_params}, {:request_signature => 'GET/reports'}) end |
#get_tax_rates ⇒ Object
Gets all Tax Rates for a specific organisation in Xero
563 564 565 566 |
# File 'lib/xero_gateway/gateway.rb', line 563 def get_tax_rates response_xml = http_get(@client, "#{xero_url}/TaxRates") parse_response(response_xml, {}, {:request_signature => 'GET/tax_rates'}) end |
#get_tracking_categories ⇒ Object
Gets all tracking categories for a specific organization in Xero.
538 539 540 541 542 |
# File 'lib/xero_gateway/gateway.rb', line 538 def get_tracking_categories response_xml = http_get(@client, "#{xero_url}/TrackingCategories") parse_response(response_xml, {}, {:request_signature => 'GET/TrackingCategories'}) end |
#update_bank_transaction(bank_transaction) ⇒ Object
Updates an existing Xero bank transaction
Usage :
bank_transaction = xero_gateway.get_bank_transaction(some_bank_transaction_id) bank_transaction.due_date = Date.today
xero_gateway.update_bank_transaction(bank_transaction)
434 435 436 437 |
# File 'lib/xero_gateway/gateway.rb', line 434 def update_bank_transaction(bank_transaction) raise "bank_transaction_id is required for updating bank transactions" if bank_transaction.bank_transaction_id.nil? save_bank_transaction(bank_transaction) end |
#update_contact(contact) ⇒ Object
Updates an existing Xero contact
Usage :
contact = xero_gateway.get_contact(some_contact_id) contact.email = “a_new_email_ddress”
xero_gateway.update_contact(contact)
100 101 102 103 |
# File 'lib/xero_gateway/gateway.rb', line 100 def update_contact(contact) raise "contact_id or contact_number is required for updating contacts" if contact.contact_id.nil? and contact.contact_number.nil? save_contact(contact) end |
#update_contacts(contacts) ⇒ Object
Updates an array of contacts in a single API operation.
Usage :
contacts = [XeroGateway::Contact.new(:name => 'Joe Bloggs'), XeroGateway::Contact.new(:name => 'Jane Doe')]
result = gateway.update_contacts(contacts)
Will update contacts with matching contact_id, contact_number or name or create if they don’t exist.
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 |
# File 'lib/xero_gateway/gateway.rb', line 114 def update_contacts(contacts) b = Builder::XmlMarkup.new request_xml = b.Contacts { contacts.each do | contact | contact.to_xml(b) end } response_xml = http_post(@client, "#{@xero_url}/Contacts", request_xml, {}) response = parse_response(response_xml, {:request_xml => request_xml}, {:request_signature => 'POST/contacts'}) response.contacts.each_with_index do | response_contact, index | contacts[index].contact_id = response_contact.contact_id if response_contact && response_contact.contact_id end response end |
#update_invoice(invoice) ⇒ Object
Updates an existing Xero invoice
Usage :
invoice = xero_gateway.get_invoice(some_invoice_id) invoice.due_date = Date.today
xero_gateway.update_invoice(invoice)
258 259 260 261 |
# File 'lib/xero_gateway/gateway.rb', line 258 def update_invoice(invoice) raise "invoice_id is required for updating invoices" if invoice.invoice_id.nil? save_invoice(invoice) end |
#update_manual_journal(manual_journal) ⇒ Object
Updates an existing Xero manual journal
Usage :
manual_journal = xero_gateway.get_manual_journal(some_manual_journal_id)
xero_gateway.update_manual_journal(manual_journal)
487 488 489 490 |
# File 'lib/xero_gateway/gateway.rb', line 487 def update_manual_journal(manual_journal) raise "manual_journal_id is required for updating manual journals" if manual_journal.manual_journal_id.nil? save_manual_journal(manual_journal) end |