Class: Quickbooks::Service::Invoice

Inherits:
BaseService show all
Defined in:
lib/quickbooks/service/invoice.rb

Constant Summary

Constants inherited from BaseService

BaseService::BASE_DOMAIN, BaseService::HTTP_ACCEPT, BaseService::HTTP_ACCEPT_ENCODING, BaseService::HTTP_CONTENT_TYPE, BaseService::SANDBOX_DOMAIN, BaseService::XML_NS

Instance Attribute Summary

Attributes inherited from BaseService

#after_request, #around_request, #base_uri, #before_request, #company_id, #last_response_intuit_tid, #last_response_xml, #oauth

Instance Method Summary collapse

Methods inherited from BaseService

#access_token=, #default_model_query, #initialize, #is_json?, #is_pdf?, #realm_id=, #rebuild_connection!, #url_for_base

Methods included from ServiceCrud

#all, #create, #delete_by_query_string, #exists?, #find_by, #query, #query_in_batches

Methods included from Util::Logging

#log, #log?, #log_xml

Constructor Details

This class inherits a constructor from Quickbooks::Service::BaseService

Instance Method Details

#delete(invoice) ⇒ Object 



5
6
7
 
# File 'lib/quickbooks/service/invoice.rb', line 5

def delete(invoice)
  delete_by_query_string(invoice)
end

#fetch_by_id(id, params = {}) ⇒ Object 



13
14
15
16
 
# File 'lib/quickbooks/service/invoice.rb', line 13

def fetch_by_id(id, params = {})
  url = "#{url_for_base}/invoice/#{id}?minorversion=#{Quickbooks::Model::Invoice::MINORVERSION}"
  fetch_object(model, url, params)
end

#pdf(invoice) ⇒ Object 



34
35
36
37
38
 
# File 'lib/quickbooks/service/invoice.rb', line 34

def pdf(invoice)
  url = "#{url_for_resource(model::REST_RESOURCE)}/#{invoice.id}/pdf"
  response = do_http_raw_get(url, {}, {'Accept' => 'application/pdf'})
  response.plain_body
end

#send(invoice, email_address = nil) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
 
# File 'lib/quickbooks/service/invoice.rb', line 23

def send(invoice, email_address=nil)
  query = email_address.present? ? "?sendTo=#{email_address}" : ""
  url = "#{url_for_resource(model::REST_RESOURCE)}/#{invoice.id}/send#{query}"
  response = do_http_post(url, "", {}, { 'Content-Type' => 'application/octet-stream' })
  if response.code.to_i == 200
    model.from_xml(parse_singular_entity_response(model, response.plain_body))
  else
    nil
  end
end

#url_for_query(query = nil, start_position = 1, max_results = 20, options = {}) ⇒ Object 



18
19
20
21
 
# File 'lib/quickbooks/service/invoice.rb', line 18

def url_for_query(query = nil, start_position = 1, max_results = 20, options = {})
  url = super(query, start_position, max_results, options)
  "#{url}&minorversion=#{Quickbooks::Model::Invoice::MINORVERSION}"
end

#url_for_resource(resource) ⇒ Object 



9
10
11
 
# File 'lib/quickbooks/service/invoice.rb', line 9

def url_for_resource(resource)
  url = super(resource)
end

#void(invoice, options = {}) ⇒ Object 



40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/quickbooks/service/invoice.rb', line 40

def void(invoice, options = {})
  url = "#{url_for_resource(model::REST_RESOURCE)}?operation=void"

  xml = invoice.to_xml_ns(options)
  response = do_http_post(url, valid_xml_document(xml))
  if response.code.to_i == 200
    model.from_xml(parse_singular_entity_response(model, response.plain_body))
  else
    false
  end
end