On Nov 10, 2022 version 2 was released which no longer supports Ruby 2.5.
| quickbooks-ruby | branch | ruby |
|---|---|---|
| 1 | master | <= 2.5 |
| 2 | 2-stable | >= 2.6.0 |
Integration with Quickbooks Online via the Intuit Data Services v3 REST API.
This library communicates with the Quickbooks Data Services v3 API, documented at:
0.1.0 introduced a backwards-incompatible change in how boolean attributes are handled. As of 0.1.0 any boolean like:
xml_accessor :active?, :from => 'Active'
will be accessible via active?. Thereby eliminating custom code like:
defactive?active.to_s == 'true'endNow a call to active? that is not set will return nil. Otherwise it return true / false.
Moreover, there is no longer a getter method e.g. active (without the trailing ?).
This has been tested on 2.x
Ruby 1.9.x is not supported.
Gems:
oauth2roxml: Workhorse for (de)serializing objects between Ruby & XMLnokogiri: XML parsingactive_model: For validations
Add this line to your application's Gemfile:
gem 'quickbooks-ruby'
And then execute:
$ bundle
Or install it yourself as:
$ gem install quickbooks-ruby
An API app provides two sets of OAuth key for production and development. Since October 22, 2014, only Sandbox Companies are allowed to connected to the QBO via the development key. The end-point for sandbox mode is https://sandbox-quickbooks.api.intuit.com.
By default, the gem runs in production mode. If you prefer to develop / test the integration with the development key, you need to config the gem to run in sandbox mode:
Quickbooks.sandbox_mode=trueWhat follows is an example using Rails but the principles can be adapted to any other framework / pure Ruby.
Create a Rails initializer (config/initializers/quickbooks-ruby.rb) with:
oauth_params={site: "https://appcenter.intuit.com/connect/oauth2",authorize_url: "https://appcenter.intuit.com/connect/oauth2",token_url: "https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer"}oauth2_client=OAuth2::Client.new(ENV['OAUTH_CLIENT_ID'],ENV['OAUTH_CLIENT_SECRET'],oauth_params)Your Controller action (the grantUrl above) should look like this:
defauthenticateredirect_uri=quickbooks_oauth_callback_urlgrant_url=oauth2_client.auth_code.authorize_url(redirect_uri: redirect_uri,response_type: "code",state: SecureRandom.hex(12),scope: "com.intuit.quickbooks.accounting")redirect_togrant_urlendWhere quickbooks_oauth_callback_url is the absolute URL of your application that Intuit should send the user when authentication succeeds.
That action should look like:
defoauth_callbackifparams[:state].present?# use the state value to retrieve from your backend any information you need to identify the customer in your systemredirect_uri=quickbooks_oauth_callback_urlifresp=oauth2_client.auth_code.get_token(params[:code],redirect_uri: redirect_uri)# save your tokens here. For example:# quickbooks_credentials.update_attributes(access_token: resp.token, refresh_token: resp.refresh_token, realm_id: params[:realmId])endendendYour Redirect URI needs to be publicly accessible. If you are still in development and running everything via localhost you will need to use a tool like Ngrok to expose your localhost to a public URL with HTTPS.
Most likely you will want to persist the OAuth access credentials so that users don't need to re-authorize your application in every session.
An example database table could have fields likes:
access_token text,
access_token_expires_at datetime,
refresh_token text,
refresh_token_expires_at datetime,
realm_id textOnce you have your user's OAuth access and refresh token string values you can create an access token object to issue requests:
qb_access_token=quickbooks_credentials.access_tokenqb_refresh_token=quickbooks_credentials.refresh_tokenaccess_token=OAuth2::AccessToken.new(oauth2_client,qb_access_token,refresh_token: qb_refresh_token)Each access token is only valid for one hour. The access token and refresh token can be refreshed directly by using OAuth Client:
new_access_token_object=access_token.refresh!The token must be assigned to a variable to prevent the loss of your new access token, which will void your credentials and a new set of credentials have to be acquired by authorizing the application again. You should then persist it to your storage.
Unauthorized (expired) access to the API will raise a OAuth2::Error error.
For more information on access token expiration and refresh token expiration, please refer to the official documentation.
You will need to continuously refresh access tokens and ensure token validity. Access Tokens expire after 1 hour.
My personal architecture in a Rails application is similar to this:
# app/models/concerns/quickbooks_oauth.rbmoduleQuickbooksOauthextendActiveSupport::Concern#== Instance Methodsdefperform_authenticated_request(&block)attempts=0beginyieldoauth_access_tokenrescueOAuth2::Error,Quickbooks::AuthorizationFailure=>exRails.logger.info("QuickbooksOauth.perform: #{ex.message}")# to prevent an infinite loop here keep a counter and bail out after N times...attempts += 1raise"QuickbooksOauth:ExceededAuthAttempts"ifattempts >= 3# check if its an invalid_grant first, but assume it is for nowrefresh_token!retryendenddefrefresh_token!t=oauth_access_tokenrefreshed=t.refresh!ifrefreshed.params['x_refresh_token_expires_in'].to_i > 0oauth2_refresh_token_expires_at=Time.now + refreshed.params['x_refresh_token_expires_in'].to_i.secondselseoauth2_refresh_token_expires_at=100.days.from_nowendupdate!(oauth2_access_token: refreshed.token,oauth2_access_token_expires_at: Time.at(refreshed.expires_at),oauth2_refresh_token: refreshed.refresh_token,oauth2_refresh_token_expires_at: oauth2_refresh_token_expires_at)enddefoauth_clientself.class.construct_oauth2_clientenddefoauth_access_tokenOAuth2::AccessToken.new(oauth_client,oauth2_access_token,refresh_token: oauth2_refresh_token)enddefconsumeroauth_access_tokenendmoduleClassMethodsdefconstruct_oauth2_clientoptions={site: "https://appcenter.intuit.com/connect/oauth2",authorize_url: "https://appcenter.intuit.com/connect/oauth2",token_url: "https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer"}OAuth2::Client.new(ENV['INTUIT_OAUTH2_CLIENT_ID'],ENV['INTUIT_OAUTH2_CLIENT_SECRET'],options)endendendAnd then I have an IntuitAccount model with attributes:
oauth2_access_token | text | | |
oauth2_access_token_expires_at | timestamp without time zone | | |
oauth2_refresh_token | text | | |
oauth2_refresh_token_expires_at | timestamp without time zone | | |
track_purchase_order_quantity | boolean | | not null | false
And then finally include this concern in the model:
classIntuitAccount < ActiveRecord::BaseincludeQuickbooksOauthendPulled together usage is:
intuit_account=IntuitAccount.find(x)intuit_account.perform_authenticated_requestdo |access_token|
# do something here, likeservice=Quickbooks::Service::Customer.newservice.company_id="123"# also known as RealmIDservice.access_token=access_token# the OAuth Access Token you have from abovecustomers=service.query()endThe general approach is you first instantiate a Service object based on the entity you would like to retrieve. Lets retrieve a list of Customers:
service=Quickbooks::Service::Customer.newservice.company_id="123"# also known as RealmIDservice.access_token=access_token# the OAuth Access Token you have from above# Equivalent to Quickbooks::Service::Customer.new(:company_id => "123", :access_token => access_token)customers=service.query()# Called without args you get the first page of results# yieldscustomers.entries=[ .. arrayofQuickbooks::Model::Customerobjects .. ]customers.start_position=1# the current position in the paginated setcustomers.max_results=20# the maximum number of results in this query setUnder the hood Intuit uses a simple SQL-like dialect for retrieving objects, the above no-arg use of query() issued a Select * From Customer.
You can issue your own query by passing the complete and valid query as the first argument:
customers.query("Select Id, GivenName From Customer")Each Entity has different fields you can retrieve & filter on. Refer to Intuit documentation for details.
Do not pass pagination parameters in your query - pass them as additional options, using :page and :per_page:
# to use the default querycustomers.query(nil,:page=>2,:per_page=>25)# to use a custom query: find customers updated recently and only select a few attributesquery="Select Id, GivenName From Customer Where Metadata.LastUpdatedTime>'2013-03-13T14:50:22-08:00' Order By Metadata.LastUpdatedTime"customers.query(query,:page=>2,:per_page=>25)Often one needs to retrieve multiple pages of records of an Entity type
and loop over them all. Fortunately there is the query_in_batches collection method:
query=nilCustomer.query_in_batches(query,per_page: 1000)do |batch|
batch.eachdo |customer|
# ...endendThe first argument to query_in_batches is the query (which
can be nil to retrieve the default items in that collection).
If you're are running a custom Query then pass it instead.
The second argument is the options, which are optional.
By default, the options are per_page: 1000.
You may retrieve an array of objects like so:
customers=service.allUnlike other query functions which return a Quickbooks::Collection object, the all method returns an array of objects.
You can retrieve a specific Intuit object like so:
customer=service.fetch_by_id("99")putscustomer.company_name=>"Acme Enterprises"The find_by(attribute, value) method allows you to retrieve objects with a simple WHERE query using a single attribute. The attribute may be given as a symbol or a string.
Symbols will be automatically camelcased to match the Quickbooks API field names.
customer=service.find_by(:family_name,"Doe")orcustomer=service.find_by("FamilyName","Doe")By default updating an object will un-set any attributes that are NOT specified in the update request. That is, the update is NOT sparse by default. Thus, be careful as you might accidentally unset attributes that you did not specify.
Example:
# fetch a Customer to change their namecustomer=service.fetch_by_id("99")customer.company_name="Neo Pets"service.update(customer)In the above example since we retrieved all fields and then just changed a single attribute, we have given the "complete" entity back to Intuit and effectively only the name is changed.
If you don't have the complete object on hand and only want to change a couple of attributes without un-setting what you are not specifying than you want to use a sparse update:
# update a Customer's name when we only know their IDcustomer=Quickbooks::Model::Customer.newcustomer.id=99customer.company_name="New Company Name"service.update(customer,:sparse=>true)Some models require a reference to be set, to a Customer, or an Item, etc. In the Quickbooks API these references
are labeled via a property like CustomerRef. In quickbooks-ruby the assignment of these references is done
by using the setter on the _id property.
For example, to specify a Customer with ID 99 on an Invoice you would do this:
invoice=Quickbooks::Model::Invoice.newinvoice.customer_id=99This will automatically set a CustomerRef XML packet with a value of 99.
The QBO API documentation states that SalesReceipt has a ShipMethodRef attribute. Normally, all attributes of a Ref type
take an pseudo-integer argument, representing the foreign ID, which in turn point to a valid object with that ID.
I say pseudo because they look like Integers but Intuit has made it clear they should be handled as strings.
Anyways, its subtle but the value for a SalesReceipt#ShipMethodRef while it is a BaseReference needs to be set manually:
shipping_reference=Quickbooks::Model::BaseReference.new('FedEx',name: 'FedEx')receipt.ship_method_ref=shipping_referenceA complete example on generating a basic invoice:
# Given a Customer with ID=99 lets invoice them for an Item with ID=500invoice=Quickbooks::Model::Invoice.newinvoice.customer_id=99invoice.txn_date=Date.civil(2013,11,20)invoice.doc_number="1001"# my custom Invoice # - can leave blank to have Intuit auto-generate itline_item=Quickbooks::Model::InvoiceLineItem.newline_item.amount=50line_item.description="Plush Baby Doll"line_item.sales_item!do |detail|
detail.unit_price=50detail.quantity=1detail.item_id=500# Item ID hereendinvoice.line_items << line_itemservice=Quickbooks::Service::Invoice.newservice.company_id="123"service.access_token=access_tokencreated_invoice=service.create(invoice)putscreated_invoice.id=>234Notes: line_item.amount must equal the unit_price * quantity in the sales detail packet - otherwise Intuit will raise an exception.
Example (code fragments) of adding a bundle line item, to an invoice:
items=service.find_by(:sku,'AHH_SWEETS')bundle=items.entries.first# be sure to check if you found the bundle you want# ...line_item=Quickbooks::Model::InvoiceLineItem.newline_item.description=bundle.descriptionline_item.group_line_detail!do |detail|
detail.id=bundle.iddetail.group_item_ref=Quickbooks::Model::BaseReference.new(bundle.name,value: bundle.id)detail.quantity=1bundle.item_group_details.line_items.eachdo |l|
g_line_item=Quickbooks::Model::InvoiceLineItem.newg_line_item.amount=50g_line_item.sales_item!do |gl|
gl.item_id=l.idgl.quantity=1gl.unit_price=50enddetail.line_items << g_line_itemendendinvoice.line_items << line_itemThe Quickbooks API offers a send invoice feature that sends the specified invoice model via email. By default the email is sent to the bill_email on the invoice. This feature returns an invoice model with updated email_status and delivery_info as shown below:
invoice=invoice_service.fetch_by_id("1")sent_invoice=invoice_service.send(invoice)putssent_invoice.email_status=>EmailSentputssent_invoice.delivery_info.delivery_type=>Emailputssent_invoice.delivery_info.delivery_time=>Wed,25Feb201518:56:04UTC +00:00It is possible to email the invoice to an altermate email address by including the email as a second parameter in the invoice.send method. When a new email address is provided the invoice model that is returned will have the bill_email set to the new email address as show below:
invoice=invoice_service.fetch_by_id("1")sent_invoice=invoice_service.send(invoice,"name@domain.com")putssend_invoice.bill_email.address=>name@domain.comNotes: Quickbooks has global company settings to customize the send invoice email message content and format.
#Invoices, SalesReceipts etc can also be defined in a single commandsalesreceipt=Quickbooks::Model::SalesReceipt.new({customer_id: 99,txn_date: Date.civil(2013,11,20),payment_ref_number: "111",#optional payment reference number/string - e.g. stripe tokendeposit_to_account_id: 222,#The ID of the Account entity you want the SalesReceipt to be deposited topayment_method_id: 333#The ID of the PaymentMethod entity you want to be used for this transaction})salesreceipt.auto_doc_number!#allows Intuit to auto-generate the transaction numberline_item=Quickbooks::Model::Line.newline_item.amount=50line_item.description="Plush Baby Doll"line_item.sales_item!do |detail|
detail.unit_price=50detail.quantity=1detail.item_id=500# Item (Product/Service) ID hereendsalesreceipt.line_items << line_itemservice=Quickbooks::Service::SalesReceipt.new({access_token: access_token,company_id: "123"})created_receipt=service.create(salesreceipt)Notes: In order to auto-generate transaction numbers using salesreceipt.auto_doc_number!, the 'Custom Transaction Numbers' setting under Company Settings>Sales Form Entry must be unchecked within the Quickbooks account you are posting to.
Use Service#delete which returns a boolean on whether the delete operation succeeded or not.
service.delete(customer)=>returnsbooleanEmail attributes are not just strings, they are top-level objects, e.g. EmailAddress on a Customer for instance.
A Customer has a setter method to make assigning an email address easier.
customer=Quickbooks::Model::Customer.newcustomer.email_address="foo@example.com"Like Email Addresses, telephone numbers are not just basic strings but are top-level objects.
phone1=Quickbooks::Model::TelephoneNumber.newphone1.free_form_number="97335530394"customer.mobile_phone=phone1Addresses are also top-level objects, so they must be instantiated and set.
address=Quickbooks::Model::PhysicalAddress.newaddress.line1="2200 Mission St."address.line2="Suite 201"address.city="Santa Cruz"address.country_sub_division_code="CA"# State, in United Statesaddress.postal_code="95060"customer.billing_address=addressYou can batch operations such creating an Invoice, updating a Customer, etc. The maximum batch size is 25 objects.
How to use:
batch_req=Quickbooks::Model::BatchRequest.newcustomer=Quickbooks::Model::Customer.new# build the customer as needed
...
item=Quickbooks::Model::Item.new# build the item as needed
...
batch_req.add("bId1",customer,"create")batch_req.add("bId2",item,"create")# Add more items to create/update as needed, up to 25batch_service=Quickbooks::Service::Batch.newbatch_response=batch_service.make_request(batch_req)batch_response.response_items.eachdo |res|
putsres.bIdputsres.fault? ? "error" : "success"endFor complete details on Batch Operations see: https://developer.intuit.com/docs/api/accounting/batch
Intuit requires that complex queries be escaped in a certain way. To make it easier to build queries that will be accepted I have provided a basic Query builder.
util=Quickbooks::Util::QueryBuilder.new# the method signature is: clause(field, operator, value)clause1=util.clause("DisplayName","LIKE","%O'Halloran")clause2=util.clause("CompanyName","=","Smith")service.query("SELECT * FROM Customer WHERE #{clause1} AND #{clause2}")The Quickbooks API supports two different types of attachments, depending on whether you have an actual file to upload or just want to upload "meta-data" about an operation.
meta=Quickbooks::Model::Attachable.newmeta.file_name="monkey.jpg"meta.note="A note"meta.content_type="image/jpeg"entity=Quickbooks::Model::BaseReference.new(3,type: 'Customer')meta.attachable_ref=Quickbooks::Model::AttachableRef.new(entity)Note: No actual file is being attached, we are just describing a file.
upload_service=Quickbooks::Service::Upload.new# args:# local-path to file# file mime-type# (optional) instance of Quickbooks::Model::Attachable - metadataresult=upload_service.upload("tmp/monkey.jpg","image/jpeg",attachable_metadata)If successful result will be an instance of the Attachable model:
puts attach.temp_download_uri
=> "https://intuit-qbo-prod-29.s3.amazonaws.com/12345%2Fattachments%2Fmonkey-1423760870606.jpg?Expires=1423761772&AWSAcc ... snip ..."
To download a PDF of an Invoice:
service=Quickbooks::Service::Invoice.new# or use the SalesReceipt service# +invoice+ is an instance of Quickbooks::Model::Invoiceraw_pdf_data=service.pdf(invoice)# write it to diskFile.open("invoice.pdf","wb")do |file|
file.write(raw_pdf_data)endQuickbooks has an api called Change Data Capture that provides a way of finding out which Entities have recently changed, as deleted entities will not be returned by a standard query. It is possible to request changes up to 30 days ago.
The primary method for querying to ChangeDataCapture is through Quickbooks::Service::ChangeDataCapture.
Quickbooks::Model::ChangeDataCapture also supports parsing the XML response into a hash of entity types through the all_types method.
service=Quickbooks::Service::ChangeDataCapture.new
...
# define the list of entities to queryentities=["Invoice","Bill","Payment"]#etcchanged=service.since(entities,Time.now.utc - 5.days)
...
# parse the XML to a list of Quickbooks::Modelschanged_as_hash=changed.all_typesDeleted entities can be found in the XML by checking their @status is "Deleted". In the return from the all_types method, deleted items will be of type Quickbooks::Model::ChangeModel.
see: https://developer.intuit.com/docs/0100_quickbooks_online/0200_dev_guides/accounting/change_data_capture for more information.
ChangeModel alternative Change Data Capture For Invoices, Customers, Vendors, Items, Payments, Purchases and Credit Memos
It is possible to get a sparse summary of which Invoice, Customer, Vendor, Item, Payment, Purchase or Credit Memo Entries have recently changed. It is possible to request changes up to 30 days ago.
service=Quickbooks::Service::InvoiceChange.new
...
changed=service.since(Time.now.utc - 5.days)customer_service=Quickbooks::Service::CustomerChange.new
...
customer_changed=customer_service.since(Time.now.utc - 5.days)vendor_service=Quickbooks::Service::VendorChange.new
...
vendor_changed=vendor_service.since(Time.now.utc - 5.days)item_service=Quickbooks::Service::ItemChange.new
...
item_changed=item_service.since(Time.now.utc - 5.days)see: https://developer.intuit.com/docs/0100_quickbooks_online/0200_dev_guides/accounting/change_data_capture for more information.
Quickbooks has an API called the Reports API that provides abilities such as: business and sales overview; vendor and customer balances; review expenses and purchases and more. See the specs for examples of how to leverage.
Intuit started the v3 API supporting both XML and JSON. However, new
v3 API services such as Tax Servicewill only support
JSON. This gem has
roots in the v2 API, which was XML only, and hence was constructed supporting XML only.
Set the default log enablement:
Quickbooks.log=trueConfigure a service instance to log (or not) independently:
customer_service=Quickbooks::Service::Customer.newcustomer_service.log=trueBy default, logging is directed at STDOUT, but another target may be defined, e.g. in Rails
Quickbooks.logger=Rails.loggerQuickbooks.log=true# Pretty-printing logged xml is true by defaultQuickbooks.log_xml_pretty_print=falseWhile logging is helpful the best debugging (in my opinion) is available by using a HTTP proxy such as Charles Proxy.
To enable HTTP proxying, add something like the following connection_opts when you generate your OAuth Client:
oauth_params={site: "https://appcenter.intuit.com/connect/oauth2",authorize_url: "https://appcenter.intuit.com/connect/oauth2",token_url: "https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer",connection_opts: {proxy: {uri: "http://127.0.0.1:8888"},ssl: {verify: false}# assuming a self-signed cert is used by your proxy}}oauth2_client=OAuth2::Client.new(ENV['OAUTH_CLIENT_ID'],ENV['OAUTH_CLIENT_SECRET'],oauth_params)| Entity | Create | Update | Query | Delete | Fetch by ID | Other |
|---|---|---|---|---|---|---|
| Account | yes | yes | yes | yes | yes | |
| Attachable | no | no | no | no | no | |
| Bill | yes | yes | yes | yes | yes | |
| Bill Payment | yes | yes | yes | yes | yes | |
| Class | yes | yes | yes | yes | yes | |
| Company Info | n/a | n/a | yes | n/a | yes | |
| Credit Memo | yes | yes | yes | yes | no | |
| Customer | yes | yes | yes | yes | yes | |
| Department | yes | yes | yes | yes | yes | |
| Deposit | yes | yes | yes | yes | yes | |
| Employee | yes | yes | yes | yes | yes | |
| Entitlements | no | no | no | no | no | |
| Estimate | yes | yes | yes | yes | yes | |
| Invoice | yes | yes | yes | yes | yes | |
| Item | yes | yes | yes | yes | yes | |
| Journal Entry | yes | yes | yes | yes | yes | |
| Payment | yes | yes | yes | yes | yes | |
| PaymentMethod | yes | yes | yes | yes | yes | |
| Preferences | n/a | no | yes | n/a | yes | |
| Purchase | yes | yes | yes | yes | yes | |
| Purchase Order | yes | yes | yes | yes | yes | |
| Refund Receipt | yes | yes | yes | yes | yes | |
| Sales Receipt | yes | yes | yes | yes | yes | |
| Sales Rep | no | no | no | no | no | |
| Sales Tax | no | no | no | no | no | |
| Sales Term | no | no | no | no | no | |
| Tax Agency | yes | yes | yes | yes | yes | |
| Tax Code | no | no | yes | no | no | |
| Tax Rate | yes | yes | yes | no | no | |
| *Tax Service | yes | yes | no | no | no | |
| Term | yes | yes | yes | yes | yes | |
| Time Activity | yes | yes | yes | yes | yes | |
| Tracking Class | no | no | no | no | no | |
| Vendor | yes | yes | yes | yes | yes | |
| Vendor Credit | yes | yes | yes | yes | yes |
*JSON only
quickbooks-ruby-base: Complements quickbooks-ruby by providing a base class to handle routine tasks like creating a model, service, and displaying information.
qbo_rails: Simple Rails error handling and QuickBooks Online "Id" persistence. Uses quickbooks-ruby.
- Implement other Line Item types, e.g.
DescriptionLineDetailfor Invoices - Full JSON support
Cody Caughlan
quickbooks-ruby has been a community effort and I am extremely thankful for all the amazing contributors.
The MIT License
Copyright (c) 2013
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.