qbxml

qbxml is a QBXML parser and validation tool. QBXML is used when integrating with QuickBooks Desktop. If you use QuickBooks Online, look elsewhere.

Installation

Add this line to your application's Gemfile:

gem 'qbxml'

And then execute:

$ bundle

Or install it yourself as:

$ gem install qbxml

Usage

Initialization

The QBXML supported depends on whether you use QuickBooks (:qb) or QuickBooks Point of Sale (:qbpos) and on the version of QuickBooks used.

q = Qbxml.new(:qb, '7.0')

API Introspection

Return all types defined in the schema

q.types

Return all types matching a certain pattern

q.types('Customer')

q.types(/Customer/)

Print the xml template for a specific type

puts q.describe('CustomerModRq')

QBXML To Ruby

Convert valid QBXML to a ruby hash

q.from_qbxml(xml)

Ruby To QBXML

Convert a ruby hash to QBXML, skipping validation

q.to_qbxml(hsh)

Convert a ruby hash to QBXML and validate all types

q.to_qbxml(hsh, validate: true)

Caveats

QuickBooks only supports ISO-8859-1 characters. Any characters outside of ISO-8859-1 will become question marks in QuickBooks.

Contributing

• Fork it
• Create your feature branch (git checkout -b my-new-feature)
• Commit your changes (git commit -am 'Add some feature')
• Push to the branch (git push origin my-new-feature)
• Create new Pull Request