freshbooks-classic

freshbooks-classic

freshbooks-classic is a node.js module providing a wrapper to the vintage version of FreshBooks API.

All API methods are documented at FreshBooks if you find any discrepancy between the docs and this wrapper feel free to file an Issue.

Installation

$ npm install --save freshbooks-classic

or

$ yarn add freshbooks-classic

Example

const FreshBooks = require('freshbooks-classic')
const {invoice} = new FreshBooks(api_url, api_token)

invoice.get(invoice_id, function(err, invoice){
  if(err){
    //returns if an error has occured, ie invoice_id doesn't exist.
    return console.log(err)
  }
  console.log(`Invoice Number: ${invoice.number}`)
})

Features / Goals

• no native modules.
• must work on browser, aws-lambda, and node v6+.

Credits

This library is a rewrite of the freshbooks.js, written by Marc Loney, and forked in 2015 by Flow XO.

Implementation Roadmap

• FreshBooks.category
• FreshBooks.client
• FreshBooks.estimate
• FreshBooks.expense
• FreshBooks.gateway
• FreshBooks.invoice
• FreshBooks.item
• FreshBooks.language
• FreshBooks.payment
• FreshBooks.project
• FreshBooks.recurring
• FreshBooks.staff
• FreshBooks.task
• FreshBooks.tax
• FreshBooks.timeEntry
• cleanup excess obscurity

License

(The MIT License)

Copyright (c) 2018 Leonardo Dino

Permission is hereby granted, free of charge, to any person obtaininga 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.