Overview

This library was created for Quickbooks OAuth2. It converted a lot of node-quickbooks into promises.

Will handle the authentication and auto renew Access Tokens when they are expired.

Example grabbing resource

const QuickBooks = require("quickbooks-node-promise");
const qbo = new QuickBooks(appConfig, realmID);
const customers = await qbo.findCustomers({ Id: "1234" });
const customer = customer.QueryResponse.Customer[0]
console.log(`Hi my customer's name is ${customer.Name}`)

Setup

Check the example for node express setup endpoints

Install

npm i quickbooks-node-promise

Create Store Strategy

The store strategy is used to Save and Retreive token information. Both methods return a promise.

class QBStoreStrategy {
  /**
   * Uses a realmID to lookup the token information.
   * Should return back in an object
   * 
   * @param {number} realmID the quickbooks companyID
   * @returns {object} Promise
   */
  getQBToken({ realmID }) {
    return new Promise((resolve) => {
      // Get token infomraiton using realmID here

      // Return object which includes the access_expire_timestamp & refresh_expire_timestamp
      let newToken = {
        realmID: my_realm_id // optional but nice to have
        access_token: my_access_token,
        refresh_token: my_refresh_token,
        access_expire_timestamp: my_access_expire_timestamp,
        refresh_expire_timestamp: my_refresh_expire_timestamp,
        id_token: my_id_token // (Optional) Used only for user OpenID verification
      }
      resolve(newToken)
    })
  }

  /**
   * Used to store the new token information
   * Will be looked up using the realmID   
   * 
   * @param {number} realmID the quickbooks companyID
   * @param {object} token
   * @param {string} token.access_token used to access quickbooks resource
   * @param {string} token.refresh_token This should be securely stored
   * @param {number} token.expires_in access_token expire time in seconds, 3600 usually
   * @param {number} token.x_refresh_token_expires_in refresh_token expire time in seconds.
   * @param {string} token.id_token (Optional) OpenID user token - sent only on original access, not included in refresh token
   * @param {string} token.token_type This will be "Bearer"
   * @param {object} access_expire_timestamp JS Date object when the access_token expires, calculated from expires_in
   * @param {object} refresh_expire_timestamp JS Date object when the refresh_token expires, calculated from x_refresh_token_expires_in
   * @returns {object} Promise
   */
  storeQBToken({ realmID, token, access_expire_timestamp, refresh_expire_timestamp }) {
    return new Promise((resolve) => {
      // Store information to DB or your location here now
      saveToDB({
        realmID: realmID
        access_token: token.access_token,
        refresh_token: token.refresh_token,
        access_expire_timestamp: access_expire_timestamp,
        refresh_expire_timestamp: refresh_expire_timestamp,
        id_token: my_id_token // (Optional) Used only for user OpenID verification
      })

      // Return object which includes the access_expire_timestamp & refresh_expire_timestamp
      let newToken = {
        realmID: my_realm_id
        access_token: my_access_token,
        refresh_token: my_refresh_token,
        access_expire_timestamp: my_access_expire_timestamp,
        refresh_expire_timestamp: my_refresh_expire_timestamp,
        id_token: my_id_token // (Optional) Used only for user OpenID verification
      }
      resolve(newToken)
    })
  }
}

Config setup

A config setup is needed for each app. Some values have defaults but should supply your own

// QB config
QBAppconfig = {
  appKey: QB_APP_KEY,
  appSecret: QB_APP_SECRET,
  redirectUrl: QB_REDIRECT_URL,
  minorversion: 37, /* default if ommited is 37, check for your version in the documents */
  useProduction: QB_USE_PROD, /* default is false */
  debug: (NODE_ENV == "production" ? false : true), /* default is false */
  storeStrategy: new QBStoreStrategy(),  // if ommited uses storage inside the created object
  scope: [
    QuickBooks.scopes.Accounting,
    QuickBooks.scopes.OpenId,
    QuickBooks.scopes.Profile,
    QuickBooks.scopes.Email,
    QuickBooks.scopes.Phone,
    QuickBooks.scopes.Address
  ]
}

Scopes available:

QuickBooks.scopes = {
  Accounting: 'com.intuit.quickbooks.accounting',
  Payment: 'com.intuit.quickbooks.payment',
  Payroll: 'com.intuit.quickbooks.payroll',
  TimeTracking: 'com.intuit.quickbooks.payroll.timetracking',
  Benefits: 'com.intuit.quickbooks.payroll.benefits',
  Profile: 'profile',
  Email:  'email',
  Phone: 'phone',
  Address: 'address',
  OpenId: 'openid',
  Intuit_name: 'intuit_name'
}

QuickBooks Methods

Kind: global class

• QuickBooks
  • new QuickBooks(appConfig, realmID)
  • instance
    • .authorizeUrl() ΓçÆ string
    • .createToken(authCode, realmID) ΓçÆ object
    • .saveToken(token)
    • .getToken()
    • .refreshWithAccessToken(token) ΓçÆ Token
    • .refreshAccessToken() ΓçÆ Token
    • .revokeAccess(useRefresh)
    • .validateIdToken()
    • .getPublicKey(modulus, exponent)
    • .getUserInfo()
    • .batch(items)
    • .changeDataCapture(entities, since)
    • .upload(filename, contentType, stream, entityType, entityId)
    • .createAccount(account)
    • .createAttachable(attachable)
    • .createBill(bill)
    • .createBillPayment(billPayment)
    • .createClass(class)
    • .createCreditMemo(creditMemo)
    • .createCustomer(customer)
    • .createDepartment(department)
    • .createDeposit(deposit)
    • .createEmployee(employee)
    • .createEstimate(estimate)
    • .createInvoice(invoice)
    • .createItem(item)
    • .createJournalCode(journalCode)
    • .createJournalEntry(journalEntry)
    • .createPayment(payment)
    • .createPaymentMethod(paymentMethod)
    • .createPurchase(purchase)
    • .createPurchaseOrder(purchaseOrder)
    • .createRefundReceipt(refundReceipt)
    • .createSalesReceipt(salesReceipt)
    • .createTaxAgency(taxAgency)
    • .createTaxService(taxService)
    • .createTerm(term)
    • .createTimeActivity(timeActivity)
    • .createTransfer(transfer)
    • .createVendor(vendor)
    • .createVendorCredit(vendorCredit)
    • .getAccount(Id)
    • .getAttachable(Id)
    • .getBill(Id)
    • .getBillPayment(Id)
    • .getClass(Id)
    • .getCompanyInfo(Id)
    • .getCreditMemo(Id)
    • .getCustomer(Id)
    • .getDepartment(Id)
    • .getDeposit(Id)
    • .getEmployee(Id)
    • .getEstimate(Id)
    • .getExchangeRate(options)
    • .getEstimatePdf(Id)
    • .sendEstimatePdf(Id, sendTo)
    • .getInvoice(Id)
    • .getInvoicePdf(Id)
    • .sendInvoicePdf(Id, sendTo)
    • .getItem(Id)
    • .getJournalCode(Id)
    • .getJournalEntry(Id)
    • .getPayment(Id)
    • .getPaymentMethod(Id)
    • .getPreferences()
    • .getPurchase(Id)
    • .getPurchaseOrder(Id)
    • .getRefundReceipt(Id)
    • .getReports(Id)
    • .getSalesReceipt(Id)
    • .getSalesReceiptPdf(Id)
    • .sendSalesReceiptPdf(Id, sendTo)
    • .getTaxAgency(Id)
    • .getTaxCode(Id)
    • .getTaxRate(Id)
    • .getTerm(Id)
    • .getTimeActivity(Id)
    • .getTransfer(Id)
    • .getVendor(Id)
    • .getVendorCredit(Id)
    • .updateAccount(account)
    • .updateAttachable(attachable)
    • .updateBill(bill)
    • .updateBillPayment(billPayment)
    • .updateClass(class)
    • .updateCompanyInfo(companyInfo)
    • .updateCreditMemo(creditMemo)
    • .updateCustomer(customer)
    • .updateDepartment(department)
    • .updateDeposit(deposit)
    • .updateEmployee(employee)
    • .updateEstimate(estimate)
    • .updateInvoice(invoice)
    • .updateItem(item)
    • .updateJournalCode(journalCode)
    • .updateJournalEntry(journalEntry)
    • .updatePayment(payment)
    • .updatePaymentMethod(paymentMethod)
    • .updatePreferences(preferences)
    • .updatePurchase(purchase)
    • .updatePurchaseOrder(purchaseOrder)
    • .updateRefundReceipt(refundReceipt)
    • .updateSalesReceipt(salesReceipt)
    • .updateTaxAgency(taxAgency)
    • .updateTaxCode(taxCode)
    • .updateTaxRate(taxRate)
    • .updateTerm(term)
    • .updateTimeActivity(timeActivity)
    • .updateTransfer(Transfer)
    • .updateVendor(vendor)
    • .updateVendorCredit(vendorCredit)
    • .updateExchangeRate(exchangeRate)
    • .deleteAttachable(idOrEntity)
    • .deleteBill(idOrEntity)
    • .deleteBillPayment(idOrEntity)
    • .deleteCreditMemo(idOrEntity)
    • .deleteDeposit(idOrEntity)
    • .deleteEstimate(idOrEntity)
    • .deleteInvoice(idOrEntity)
    • .deleteJournalCode(idOrEntity)
    • .deleteJournalEntry(idOrEntity)
    • .deletePayment(idOrEntity)
    • .deletePurchase(idOrEntity)
    • .deletePurchaseOrder(idOrEntity)
    • .deleteRefundReceipt(idOrEntity)
    • .deleteSalesReceipt(idOrEntity)
    • .deleteTimeActivity(idOrEntity)
    • .deleteTransfer(idOrEntity)
    • .deleteVendorCredit(idOrEntity)
    • .voidInvoice(idOrEntity)
    • .voidPayment(payment)
    • .findAccounts(criteria)
    • .findAttachables(criteria)
    • .findBills(criteria)
    • .findBillPayments(criteria)
    • .findBudgets(criteria)
    • .findClasses(criteria)
    • .findCompanyInfos(criteria)
    • .findCreditMemos(criteria)
    • .findCustomers(criteria)
    • .findDepartments(criteria)
    • .findDeposits(criteria)
    • .findEmployees(criteria)
    • .findEstimates(criteria)
    • .findInvoices(criteria)
    • .findItems(criteria)
    • .findJournalCodes(criteria)
    • .findJournalEntries(criteria)
    • .findPayments(criteria)
    • .findPaymentMethods(criteria)
    • .findPreferenceses(criteria)
    • .findPurchases(criteria)
    • .findPurchaseOrders(criteria)
    • .findRefundReceipts(criteria)
    • .findSalesReceipts(criteria)
    • .findTaxAgencies(criteria)
    • .findTaxCodes(criteria)
    • .findTaxRates(criteria)
    • .findTerms(criteria)
    • .findTimeActivities(criteria)
    • .findTransfers(criteria)
    • .findVendors(criteria)
    • .findVendorCredits(criteria)
    • .findExchangeRates(criteria)
    • .reportBalanceSheet(options)
    • .reportProfitAndLoss(options)
    • .reportProfitAndLossDetail(options)
    • .reportTrialBalance(options)
    • .reportCashFlow(options)
    • .reportInventoryValuationSummary(options)
    • .reportCustomerSales(options)
    • .reportItemSales(options)
    • .reportCustomerIncome(options)
    • .reportCustomerBalance(options)
    • .reportCustomerBalanceDetail(options)
    • .reportAgedReceivables(options)
    • .reportAgedReceivableDetail(options)
    • .reportVendorBalance(options)
    • .reportVendorBalanceDetail(options)
    • .reportAgedPayables(options)
    • .reportAgedPayableDetail(options)
    • .reportVendorExpenses(options)
    • .reportTransactionList(options)
    • .reportGeneralLedgerDetail(options)
    • .reportTaxSummary(options)
    • .reportDepartmentSales(options)
    • .reportClassSales(options)
    • .reportAccountListDetail(options)
  • static
    • .authorizeUrl(appConfig) ΓçÆ string
    • .createToken(appConfig, authCode, realmID) ΓçÆ object
    • ._dateNotExpired(expired_timestamp) ΓçÆ boolean
    • .isAccessTokenValid(token) ΓçÆ boolean
    • .isRefreshTokenValid(token) ΓçÆ boolean
    • .saveToken(store, info)
    • .getToken()

new QuickBooks(appConfig, realmID)

Node.js client encapsulating access to the QuickBooks V3 Rest API. An instance of this class should be instantiated on behalf of each user and company accessing the api.

quickBooks.authorizeUrl() ΓçÆ string

Redirect link to Authorization Page

Kind: instance method of QuickBooks
Returns: string - authorize Uri

quickBooks.createToken(authCode, realmID) ΓçÆ object

Creates new token for the realmID from the returned authorization code received in the callback request

Kind: instance method of QuickBooks
Returns: object - new token with expiration dates from storeStrategy

quickBooks.saveToken(token)

Save token

Kind: instance method of QuickBooks

quickBooks.getToken()

Get token

Kind: instance method of QuickBooks

quickBooks.refreshWithAccessToken(token) ΓçÆ Token

Use the refresh token to obtain a new access token.

Kind: instance method of QuickBooks
Returns: Token - returns fresh token with access_token and refresh_token

quickBooks.refreshAccessToken() ΓçÆ Token

Use the refresh token to obtain a new access token.

Kind: instance method of QuickBooks
Returns: Token - returns fresh token with access_token and refresh_token

quickBooks.revokeAccess(useRefresh)

Use either refresh token or access token to revoke access (OAuth2).

Kind: instance method of QuickBooks

quickBooks.validateIdToken()

Validate id_token

Kind: instance method of QuickBooks

quickBooks.getPublicKey(modulus, exponent)

get Public Key

Kind: instance method of QuickBooks

quickBooks.getUserInfo()

Get user info (OAuth2).

Kind: instance method of QuickBooks

quickBooks.batch(items)

Batch operation to enable an application to perform multiple operations in a single request. The following batch items are supported: create update delete query The maximum number of batch items in a single request is 25.

Kind: instance method of QuickBooks

quickBooks.changeDataCapture(entities, since)

The change data capture (CDC) operation returns a list of entities that have changed since a specified time.

Kind: instance method of QuickBooks

quickBooks.upload(filename, contentType, stream, entityType, entityId)

Uploads a file as an Attachable in QBO, optionally linking it to the specified QBO Entity.

Kind: instance method of QuickBooks

quickBooks.createAccount(account)

Creates the Account in QuickBooks

Kind: instance method of QuickBooks

quickBooks.createAttachable(attachable)

Creates the Attachable in QuickBooks

Kind: instance method of QuickBooks

quickBooks.createBill(bill)

Creates the Bill in QuickBooks

Kind: instance method of QuickBooks

quickBooks.createBillPayment(billPayment)

Creates the BillPayment in QuickBooks

Kind: instance method of QuickBooks

quickBooks.createClass(class)

Creates the Class in QuickBooks

Kind: instance method of QuickBooks

quickBooks.createCreditMemo(creditMemo)

Creates the CreditMemo in QuickBooks

Kind: instance method of QuickBooks

quickBooks.createCustomer(customer)

Creates the Customer in QuickBooks

Kind: instance method of QuickBooks

quickBooks.createDepartment(department)

Creates the Department in QuickBooks

Kind: instance method of QuickBooks

quickBooks.createDeposit(deposit)

Creates the Deposit in QuickBooks

Kind: instance method of QuickBooks

quickBooks.createEmployee(employee)

Creates the Employee in QuickBooks

Kind: instance method of QuickBooks

quickBooks.createEstimate(estimate)

Creates the Estimate in QuickBooks

Kind: instance method of QuickBooks

quickBooks.createInvoice(invoice)

Creates the Invoice in QuickBooks

Kind: instance method of QuickBooks

quickBooks.createItem(item)

Creates the Item in QuickBooks

Kind: instance method of QuickBooks

quickBooks.createJournalCode(journalCode)

Creates the JournalCode in QuickBooks

Kind: instance method of QuickBooks

quickBooks.createJournalEntry(journalEntry)

Creates the JournalEntry in QuickBooks

Kind: instance method of QuickBooks

quickBooks.createPayment(payment)

Creates the Payment in QuickBooks

Kind: instance method of QuickBooks

quickBooks.createPaymentMethod(paymentMethod)

Creates the PaymentMethod in QuickBooks

Kind: instance method of QuickBooks

quickBooks.createPurchase(purchase)

Creates the Purchase in QuickBooks

Kind: instance method of QuickBooks

quickBooks.createPurchaseOrder(purchaseOrder)

Creates the PurchaseOrder in QuickBooks

Kind: instance method of QuickBooks

quickBooks.createRefundReceipt(refundReceipt)

Creates the RefundReceipt in QuickBooks

Kind: instance method of QuickBooks

quickBooks.createSalesReceipt(salesReceipt)

Creates the SalesReceipt in QuickBooks

Kind: instance method of QuickBooks

quickBooks.createTaxAgency(taxAgency)

Creates the TaxAgency in QuickBooks

Kind: instance method of QuickBooks

quickBooks.createTaxService(taxService)

Creates the TaxService in QuickBooks

Kind: instance method of QuickBooks

quickBooks.createTerm(term)

Creates the Term in QuickBooks

Kind: instance method of QuickBooks

quickBooks.createTimeActivity(timeActivity)

Creates the TimeActivity in QuickBooks

Kind: instance method of QuickBooks

quickBooks.createTransfer(transfer)

Creates the Transfer in QuickBooks

Kind: instance method of QuickBooks

quickBooks.createVendor(vendor)

Creates the Vendor in QuickBooks

Kind: instance method of QuickBooks

quickBooks.createVendorCredit(vendorCredit)

Creates the VendorCredit in QuickBooks

Kind: instance method of QuickBooks

quickBooks.getAccount(Id)

Retrieves the Account from QuickBooks

Kind: instance method of QuickBooks

quickBooks.getAttachable(Id)

Retrieves the Attachable from QuickBooks

Kind: instance method of QuickBooks

quickBooks.getBill(Id)

Retrieves the Bill from QuickBooks

Kind: instance method of QuickBooks

quickBooks.getBillPayment(Id)

Retrieves the BillPayment from QuickBooks

Kind: instance method of QuickBooks

quickBooks.getClass(Id)

Retrieves the Class from QuickBooks

Kind: instance method of QuickBooks

quickBooks.getCompanyInfo(Id)

Retrieves the CompanyInfo from QuickBooks

Kind: instance method of QuickBooks

quickBooks.getCreditMemo(Id)

Retrieves the CreditMemo from QuickBooks

Kind: instance method of QuickBooks

quickBooks.getCustomer(Id)

Retrieves the Customer from QuickBooks

Kind: instance method of QuickBooks

quickBooks.getDepartment(Id)

Retrieves the Department from QuickBooks

Kind: instance method of QuickBooks

quickBooks.getDeposit(Id)

Retrieves the Deposit from QuickBooks

Kind: instance method of QuickBooks

quickBooks.getEmployee(Id)

Retrieves the Employee from QuickBooks

Kind: instance method of QuickBooks

quickBooks.getEstimate(Id)

Retrieves the Estimate from QuickBooks

Kind: instance method of QuickBooks

quickBooks.getExchangeRate(options)

Retrieves an ExchangeRate from QuickBooks

Kind: instance method of QuickBooks

quickBooks.getEstimatePdf(Id)

Retrieves the Estimate PDF from QuickBooks

Kind: instance method of QuickBooks

quickBooks.sendEstimatePdf(Id, sendTo)

Emails the Estimate PDF from QuickBooks to the address supplied in Estimate.BillEmail.EmailAddress or the specified 'sendTo' address

Kind: instance method of QuickBooks

quickBooks.getInvoice(Id)

Retrieves the Invoice from QuickBooks

Kind: instance method of QuickBooks

quickBooks.getInvoicePdf(Id)

Retrieves the Invoice PDF from QuickBooks

Kind: instance method of QuickBooks

quickBooks.sendInvoicePdf(Id, sendTo)

Emails the Invoice PDF from QuickBooks to the address supplied in Invoice.BillEmail.EmailAddress or the specified 'sendTo' address

Kind: instance method of QuickBooks

quickBooks.getItem(Id)

Retrieves the Item from QuickBooks

Kind: instance method of QuickBooks

quickBooks.getJournalCode(Id)

Retrieves the JournalCode from QuickBooks

Kind: instance method of QuickBooks

quickBooks.getJournalEntry(Id)

Retrieves the JournalEntry from QuickBooks

Kind: instance method of QuickBooks

quickBooks.getPayment(Id)

Retrieves the Payment from QuickBooks

Kind: instance method of QuickBooks

quickBooks.getPaymentMethod(Id)

Retrieves the PaymentMethod from QuickBooks

Kind: instance method of QuickBooks

quickBooks.getPreferences()

Retrieves the Preferences from QuickBooks

Kind: instance method of QuickBooks

quickBooks.getPurchase(Id)

Retrieves the Purchase from QuickBooks

Kind: instance method of QuickBooks

quickBooks.getPurchaseOrder(Id)

Retrieves the PurchaseOrder from QuickBooks

Kind: instance method of QuickBooks

quickBooks.getRefundReceipt(Id)

Retrieves the RefundReceipt from QuickBooks

Kind: instance method of QuickBooks

quickBooks.getReports(Id)

Retrieves the Reports from QuickBooks

Kind: instance method of QuickBooks

quickBooks.getSalesReceipt(Id)

Retrieves the SalesReceipt from QuickBooks

Kind: instance method of QuickBooks

quickBooks.getSalesReceiptPdf(Id)

Retrieves the SalesReceipt PDF from QuickBooks

Kind: instance method of QuickBooks

quickBooks.sendSalesReceiptPdf(Id, sendTo)

Emails the SalesReceipt PDF from QuickBooks to the address supplied in SalesReceipt.BillEmail.EmailAddress or the specified 'sendTo' address

Kind: instance method of QuickBooks

quickBooks.getTaxAgency(Id)

Retrieves the TaxAgency from QuickBooks

Kind: instance method of QuickBooks

quickBooks.getTaxCode(Id)

Retrieves the TaxCode from QuickBooks

Kind: instance method of QuickBooks

quickBooks.getTaxRate(Id)

Retrieves the TaxRate from QuickBooks

Kind: instance method of QuickBooks

quickBooks.getTerm(Id)

Retrieves the Term from QuickBooks

Kind: instance method of QuickBooks

quickBooks.getTimeActivity(Id)

Retrieves the TimeActivity from QuickBooks

Kind: instance method of QuickBooks

quickBooks.getTransfer(Id)

Retrieves the Transfer from QuickBooks

Kind: instance method of QuickBooks

quickBooks.getVendor(Id)

Retrieves the Vendor from QuickBooks

Kind: instance method of QuickBooks

quickBooks.getVendorCredit(Id)

Retrieves the VendorCredit from QuickBooks

Kind: instance method of QuickBooks

quickBooks.updateAccount(account)

Updates QuickBooks version of Account

Kind: instance method of QuickBooks

quickBooks.updateAttachable(attachable)

Updates QuickBooks version of Attachable

Kind: instance method of QuickBooks

quickBooks.updateBill(bill)

Updates QuickBooks version of Bill

Kind: instance method of QuickBooks

quickBooks.updateBillPayment(billPayment)

Updates QuickBooks version of BillPayment

Kind: instance method of QuickBooks

quickBooks.updateClass(class)

Updates QuickBooks version of Class

Kind: instance method of QuickBooks

quickBooks.updateCompanyInfo(companyInfo)

Updates QuickBooks version of CompanyInfo

Kind: instance method of QuickBooks

quickBooks.updateCreditMemo(creditMemo)

Updates QuickBooks version of CreditMemo

Kind: instance method of QuickBooks

quickBooks.updateCustomer(customer)

Updates QuickBooks version of Customer

Kind: instance method of QuickBooks

quickBooks.updateDepartment(department)

Updates QuickBooks version of Department

Kind: instance method of QuickBooks

quickBooks.updateDeposit(deposit)

Updates QuickBooks version of Deposit

Kind: instance method of QuickBooks

quickBooks.updateEmployee(employee)

Updates QuickBooks version of Employee

Kind: instance method of QuickBooks

quickBooks.updateEstimate(estimate)

Updates QuickBooks version of Estimate

Kind: instance method of QuickBooks

quickBooks.updateInvoice(invoice)

Updates QuickBooks version of Invoice

Kind: instance method of QuickBooks

quickBooks.updateItem(item)

Updates QuickBooks version of Item

Kind: instance method of QuickBooks

quickBooks.updateJournalCode(journalCode)

Updates QuickBooks version of JournalCode

Kind: instance method of QuickBooks

quickBooks.updateJournalEntry(journalEntry)

Updates QuickBooks version of JournalEntry

Kind: instance method of QuickBooks

quickBooks.updatePayment(payment)

Updates QuickBooks version of Payment

Kind: instance method of QuickBooks

quickBooks.updatePaymentMethod(paymentMethod)

Updates QuickBooks version of PaymentMethod

Kind: instance method of QuickBooks

quickBooks.updatePreferences(preferences)

Updates QuickBooks version of Preferences

Kind: instance method of QuickBooks

quickBooks.updatePurchase(purchase)

Updates QuickBooks version of Purchase

Kind: instance method of QuickBooks

quickBooks.updatePurchaseOrder(purchaseOrder)

Updates QuickBooks version of PurchaseOrder

Kind: instance method of QuickBooks

quickBooks.updateRefundReceipt(refundReceipt)

Updates QuickBooks version of RefundReceipt

Kind: instance method of QuickBooks

quickBooks.updateSalesReceipt(salesReceipt)

Updates QuickBooks version of SalesReceipt

Kind: instance method of QuickBooks

quickBooks.updateTaxAgency(taxAgency)

Updates QuickBooks version of TaxAgency

Kind: instance method of QuickBooks

quickBooks.updateTaxCode(taxCode)

Updates QuickBooks version of TaxCode

Kind: instance method of QuickBooks

quickBooks.updateTaxRate(taxRate)

Updates QuickBooks version of TaxRate

Kind: instance method of QuickBooks

quickBooks.updateTerm(term)

Updates QuickBooks version of Term

Kind: instance method of QuickBooks

quickBooks.updateTimeActivity(timeActivity)

Updates QuickBooks version of TimeActivity

Kind: instance method of QuickBooks

quickBooks.updateTransfer(Transfer)

Updates QuickBooks version of Transfer

Kind: instance method of QuickBooks

quickBooks.updateVendor(vendor)

Updates QuickBooks version of Vendor

Kind: instance method of QuickBooks

quickBooks.updateVendorCredit(vendorCredit)

Updates QuickBooks version of VendorCredit

Kind: instance method of QuickBooks

quickBooks.updateExchangeRate(exchangeRate)

Updates QuickBooks version of ExchangeRate

Kind: instance method of QuickBooks

quickBooks.deleteAttachable(idOrEntity)

Deletes the Attachable from QuickBooks

Kind: instance method of QuickBooks

quickBooks.deleteBill(idOrEntity)

Deletes the Bill from QuickBooks

Kind: instance method of QuickBooks

quickBooks.deleteBillPayment(idOrEntity)

Deletes the BillPayment from QuickBooks

Kind: instance method of QuickBooks

quickBooks.deleteCreditMemo(idOrEntity)

Deletes the CreditMemo from QuickBooks

Kind: instance method of QuickBooks

quickBooks.deleteDeposit(idOrEntity)

Deletes the Deposit from QuickBooks

Kind: instance method of QuickBooks

quickBooks.deleteEstimate(idOrEntity)

Deletes the Estimate from QuickBooks

Kind: instance method of QuickBooks

quickBooks.deleteInvoice(idOrEntity)

Deletes the Invoice from QuickBooks

Kind: instance method of QuickBooks

quickBooks.deleteJournalCode(idOrEntity)

Deletes the JournalCode from QuickBooks

Kind: instance method of QuickBooks

quickBooks.deleteJournalEntry(idOrEntity)

Deletes the JournalEntry from QuickBooks

Kind: instance method of QuickBooks

quickBooks.deletePayment(idOrEntity)

Deletes the Payment from QuickBooks

Kind: instance method of QuickBooks

quickBooks.deletePurchase(idOrEntity)

Deletes the Purchase from QuickBooks

Kind: instance method of QuickBooks

quickBooks.deletePurchaseOrder(idOrEntity)

Deletes the PurchaseOrder from QuickBooks

Kind: instance method of QuickBooks

quickBooks.deleteRefundReceipt(idOrEntity)

Deletes the RefundReceipt from QuickBooks

Kind: instance method of QuickBooks

quickBooks.deleteSalesReceipt(idOrEntity)

Deletes the SalesReceipt from QuickBooks

Kind: instance method of QuickBooks

quickBooks.deleteTimeActivity(idOrEntity)

Deletes the TimeActivity from QuickBooks

Kind: instance method of QuickBooks

quickBooks.deleteTransfer(idOrEntity)

Deletes the Transfer from QuickBooks

Kind: instance method of QuickBooks

quickBooks.deleteVendorCredit(idOrEntity)

Deletes the VendorCredit from QuickBooks

Kind: instance method of QuickBooks

quickBooks.voidInvoice(idOrEntity)

Voids the Invoice from QuickBooks

Kind: instance method of QuickBooks

quickBooks.voidPayment(payment)

Voids QuickBooks version of Payment

Kind: instance method of QuickBooks

quickBooks.findAccounts(criteria)

Finds all Accounts in QuickBooks, optionally matching the specified criteria

Kind: instance method of QuickBooks

quickBooks.findAttachables(criteria)

Finds all Attachables in QuickBooks, optionally matching the specified criteria

Kind: instance method of QuickBooks

quickBooks.findBills(criteria)

Finds all Bills in QuickBooks, optionally matching the specified criteria

Kind: instance method of QuickBooks

quickBooks.findBillPayments(criteria)

Finds all BillPayments in QuickBooks, optionally matching the specified criteria

Kind: instance method of QuickBooks

quickBooks.findBudgets(criteria)

Finds all Budgets in QuickBooks, optionally matching the specified criteria

Kind: instance method of QuickBooks

quickBooks.findClasses(criteria)

Finds all Classs in QuickBooks, optionally matching the specified criteria

Kind: instance method of QuickBooks

quickBooks.findCompanyInfos(criteria)

Finds all CompanyInfos in QuickBooks, optionally matching the specified criteria

Kind: instance method of QuickBooks

quickBooks.findCreditMemos(criteria)

Finds all CreditMemos in QuickBooks, optionally matching the specified criteria

Kind: instance method of QuickBooks

quickBooks.findCustomers(criteria)

Finds all Customers in QuickBooks, optionally matching the specified criteria

Kind: instance method of QuickBooks

quickBooks.findDepartments(criteria)

Finds all Departments in QuickBooks, optionally matching the specified criteria

Kind: instance method of QuickBooks

quickBooks.findDeposits(criteria)

Finds all Deposits in QuickBooks, optionally matching the specified criteria

Kind: instance method of QuickBooks

quickBooks.findEmployees(criteria)

Finds all Employees in QuickBooks, optionally matching the specified criteria

Kind: instance method of QuickBooks

quickBooks.findEstimates(criteria)

Finds all Estimates in QuickBooks, optionally matching the specified criteria

Kind: instance method of QuickBooks

quickBooks.findInvoices(criteria)

Finds all Invoices in QuickBooks, optionally matching the specified criteria

Kind: instance method of QuickBooks

quickBooks.findItems(criteria)

Finds all Items in QuickBooks, optionally matching the specified criteria

Kind: instance method of QuickBooks

quickBooks.findJournalCodes(criteria)

Finds all JournalCodes in QuickBooks, optionally matching the specified criteria

Kind: instance method of QuickBooks

quickBooks.findJournalEntries(criteria)

Finds all JournalEntrys in QuickBooks, optionally matching the specified criteria

Kind: instance method of QuickBooks

quickBooks.findPayments(criteria)

Finds all Payments in QuickBooks, optionally matching the specified criteria

Kind: instance method of QuickBooks

quickBooks.findPaymentMethods(criteria)

Finds all PaymentMethods in QuickBooks, optionally matching the specified criteria

Kind: instance method of QuickBooks

quickBooks.findPreferenceses(criteria)

Finds all Preferencess in QuickBooks, optionally matching the specified criteria

Kind: instance method of QuickBooks

quickBooks.findPurchases(criteria)

Finds all Purchases in QuickBooks, optionally matching the specified criteria

Kind: instance method of QuickBooks

quickBooks.findPurchaseOrders(criteria)

Finds all PurchaseOrders in QuickBooks, optionally matching the specified criteria

Kind: instance method of QuickBooks

quickBooks.findRefundReceipts(criteria)

Finds all RefundReceipts in QuickBooks, optionally matching the specified criteria

Kind: instance method of QuickBooks

quickBooks.findSalesReceipts(criteria)

Finds all SalesReceipts in QuickBooks, optionally matching the specified criteria

Kind: instance method of QuickBooks

quickBooks.findTaxAgencies(criteria)

Finds all TaxAgencys in QuickBooks, optionally matching the specified criteria

Kind: instance method of QuickBooks

quickBooks.findTaxCodes(criteria)

Finds all TaxCodes in QuickBooks, optionally matching the specified criteria

Kind: instance method of QuickBooks

quickBooks.findTaxRates(criteria)

Finds all TaxRates in QuickBooks, optionally matching the specified criteria

Kind: instance method of QuickBooks

quickBooks.findTerms(criteria)

Finds all Terms in QuickBooks, optionally matching the specified criteria

Kind: instance method of QuickBooks

quickBooks.findTimeActivities(criteria)

Finds all TimeActivitys in QuickBooks, optionally matching the specified criteria

Kind: instance method of QuickBooks

quickBooks.findTransfers(criteria)

Finds all Transfers in QuickBooks, optionally matching the specified criteria

Kind: instance method of QuickBooks

quickBooks.findVendors(criteria)

Finds all Vendors in QuickBooks, optionally matching the specified criteria

Kind: instance method of QuickBooks

quickBooks.findVendorCredits(criteria)

Finds all VendorCredits in QuickBooks, optionally matching the specified criteria

Kind: instance method of QuickBooks

quickBooks.findExchangeRates(criteria)

Finds all ExchangeRates in QuickBooks, optionally matching the specified criteria

Kind: instance method of QuickBooks

quickBooks.reportBalanceSheet(options)

Retrieves the BalanceSheet Report from QuickBooks

Kind: instance method of QuickBooks

quickBooks.reportProfitAndLoss(options)

Retrieves the ProfitAndLoss Report from QuickBooks

Kind: instance method of QuickBooks

quickBooks.reportProfitAndLossDetail(options)

Retrieves the ProfitAndLossDetail Report from QuickBooks

Kind: instance method of QuickBooks

quickBooks.reportTrialBalance(options)

Retrieves the TrialBalance Report from QuickBooks

Kind: instance method of QuickBooks

quickBooks.reportCashFlow(options)

Retrieves the CashFlow Report from QuickBooks

Kind: instance method of QuickBooks

quickBooks.reportInventoryValuationSummary(options)

Retrieves the InventoryValuationSummary Report from QuickBooks

Kind: instance method of QuickBooks

quickBooks.reportCustomerSales(options)

Retrieves the CustomerSales Report from QuickBooks

Kind: instance method of QuickBooks

quickBooks.reportItemSales(options)

Retrieves the ItemSales Report from QuickBooks

Kind: instance method of QuickBooks

quickBooks.reportCustomerIncome(options)

Retrieves the CustomerIncome Report from QuickBooks

Kind: instance method of QuickBooks

quickBooks.reportCustomerBalance(options)

Retrieves the CustomerBalance Report from QuickBooks

Kind: instance method of QuickBooks

quickBooks.reportCustomerBalanceDetail(options)

Retrieves the CustomerBalanceDetail Report from QuickBooks

Kind: instance method of QuickBooks

quickBooks.reportAgedReceivables(options)

Retrieves the AgedReceivables Report from QuickBooks

Kind: instance method of QuickBooks

quickBooks.reportAgedReceivableDetail(options)

Retrieves the AgedReceivableDetail Report from QuickBooks

Kind: instance method of QuickBooks

quickBooks.reportVendorBalance(options)

Retrieves the VendorBalance Report from QuickBooks

Kind: instance method of QuickBooks

quickBooks.reportVendorBalanceDetail(options)

Retrieves the VendorBalanceDetail Report from QuickBooks

Kind: instance method of QuickBooks

quickBooks.reportAgedPayables(options)

Retrieves the AgedPayables Report from QuickBooks

Kind: instance method of QuickBooks

quickBooks.reportAgedPayableDetail(options)

Retrieves the AgedPayableDetail Report from QuickBooks

Kind: instance method of QuickBooks

quickBooks.reportVendorExpenses(options)

Retrieves the VendorExpenses Report from QuickBooks

Kind: instance method of QuickBooks

quickBooks.reportTransactionList(options)

Retrieves the TransactionList Report from QuickBooks

Kind: instance method of QuickBooks

quickBooks.reportGeneralLedgerDetail(options)

Retrieves the GeneralLedgerDetail Report from QuickBooks

Kind: instance method of QuickBooks

quickBooks.reportTaxSummary(options)

Retrieves the TaxSummary Report from QuickBooks

Kind: instance method of QuickBooks

quickBooks.reportDepartmentSales(options)

Retrieves the DepartmentSales Report from QuickBooks

Kind: instance method of QuickBooks

quickBooks.reportClassSales(options)

Retrieves the ClassSales Report from QuickBooks

Kind: instance method of QuickBooks

quickBooks.reportAccountListDetail(options)

Retrieves the AccountListDetail Report from QuickBooks

Kind: instance method of QuickBooks

QuickBooks.authorizeUrl(appConfig) ΓçÆ string

Redirect link to Authorization Page

Kind: static method of QuickBooks
Returns: string - authorize Uri

QuickBooks.createToken(appConfig, authCode, realmID) ΓçÆ object

Creates new token for the realmID from the returned authorization code received in the callback request

Kind: static method of QuickBooks
Returns: object - new token with expiration dates from storeStrategy

QuickBooks._dateNotExpired(expired_timestamp) ΓçÆ boolean

Helper Method to check token expiry { set Token Object }

Kind: static method of QuickBooks

QuickBooks.isAccessTokenValid(token) ΓçÆ boolean

Check if access_token is valid

Kind: static method of QuickBooks
Returns: boolean - token has expired or not

QuickBooks.isRefreshTokenValid(token) ΓçÆ boolean

Check if there is a valid (not expired) access token

Kind: static method of QuickBooks
Returns: boolean - token has expired or not

QuickBooks.saveToken(store, info)

Save token

Kind: static method of QuickBooks

QuickBooks.getToken()

Get token

Kind: static method of QuickBooks