npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

node-quickbooks-promise

v1.0.5

Published

Promisify node-quickbooks api

Downloads

43

Readme

node-quickbooks-promise

Overlay of node-quickbooks that replaces callback API with promises

Example

const QuickBooks = require("node-quickbooks-promise");
const qbo = new QuickBooks({/*credential object just as in node-quickbooks*/});
const accessToken = await qbo.refreshAccessToken();
const customers = await qbo.findCustomers({ Id: "1234" });
const customer = customer.QueryResponse.Customer[0]
console.log(`Hi my customer's name is ${customer.Name}`)

Installation

yarn add node-quickbooks-promise
# or...
npm i s node-quickbooks-promise

API

QuickBooks

Kind: global class

new QuickBooks()

Quickbooks integration class from node-quickbooks

quickBooks.revokeAccess

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

Kind: instance property of QuickBooks

| Param | Description | | --- | --- | | useRefresh | boolean - Indicates which token to use: true to use the refresh token, false to use the access token. |

quickBooks.getUserInfo

Get user info (OAuth2).

Kind: instance property of QuickBooks

quickBooks.batch

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 property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | items | object | JavaScript array of batch items |

quickBooks.changeDataCapture

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

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | entities | object | Comma separated list or JavaScript array of entities to search for changes | | since | object | JavaScript Date or string representation of the form '2012-07-20T22:25:51-07:00' to look back for changes until |

quickBooks.upload

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

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | filename | string | the name of the file | | contentType | string | the mime type of the file | | stream | object | ReadableStream of file contents | | entityType | object | optional string name of the QBO entity the Attachable will be linked to (e.g. Invoice) | | entityId | object | optional Id of the QBO entity the Attachable will be linked to |

quickBooks.createAccount

Creates the Account in QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | account | object | The unsaved account, to be persisted in QuickBooks |

quickBooks.createAttachable

Creates the Attachable in QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | attachable | object | The unsaved attachable, to be persisted in QuickBooks |

quickBooks.createBill

Creates the Bill in QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | bill | object | The unsaved bill, to be persisted in QuickBooks |

quickBooks.createBillPayment

Creates the BillPayment in QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | billPayment | object | The unsaved billPayment, to be persisted in QuickBooks |

quickBooks.createClass

Creates the Class in QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | class | object | The unsaved class, to be persisted in QuickBooks |

quickBooks.createCreditMemo

Creates the CreditMemo in QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | creditMemo | object | The unsaved creditMemo, to be persisted in QuickBooks |

quickBooks.createCustomer

Creates the Customer in QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | customer | object | The unsaved customer, to be persisted in QuickBooks |

quickBooks.createDepartment

Creates the Department in QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | department | object | The unsaved department, to be persisted in QuickBooks |

quickBooks.createDeposit

Creates the Deposit in QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | deposit | object | The unsaved Deposit, to be persisted in QuickBooks |

quickBooks.createEmployee

Creates the Employee in QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | employee | object | The unsaved employee, to be persisted in QuickBooks |

quickBooks.createEstimate

Creates the Estimate in QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | estimate | object | The unsaved estimate, to be persisted in QuickBooks |

quickBooks.createInvoice

Creates the Invoice in QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | invoice | object | The unsaved invoice, to be persisted in QuickBooks |

quickBooks.createItem

Creates the Item in QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | item | object | The unsaved item, to be persisted in QuickBooks |

quickBooks.createJournalCode

Creates the JournalCode in QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | journalCode | object | The unsaved journalCode, to be persisted in QuickBooks |

quickBooks.createJournalEntry

Creates the JournalEntry in QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | journalEntry | object | The unsaved journalEntry, to be persisted in QuickBooks |

quickBooks.createPayment

Creates the Payment in QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | payment | object | The unsaved payment, to be persisted in QuickBooks |

quickBooks.createPaymentMethod

Creates the PaymentMethod in QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | paymentMethod | object | The unsaved paymentMethod, to be persisted in QuickBooks |

quickBooks.createPurchase

Creates the Purchase in QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | purchase | object | The unsaved purchase, to be persisted in QuickBooks |

quickBooks.createPurchaseOrder

Creates the PurchaseOrder in QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | purchaseOrder | object | The unsaved purchaseOrder, to be persisted in QuickBooks |

quickBooks.createRefundReceipt

Creates the RefundReceipt in QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | refundReceipt | object | The unsaved refundReceipt, to be persisted in QuickBooks |

quickBooks.createSalesReceipt

Creates the SalesReceipt in QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | salesReceipt | object | The unsaved salesReceipt, to be persisted in QuickBooks |

quickBooks.createTaxAgency

Creates the TaxAgency in QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | taxAgency | object | The unsaved taxAgency, to be persisted in QuickBooks |

quickBooks.createTaxService

Creates the TaxService in QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | taxService | object | The unsaved taxService, to be persisted in QuickBooks |

quickBooks.createTerm

Creates the Term in QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | term | object | The unsaved term, to be persisted in QuickBooks |

quickBooks.createTimeActivity

Creates the TimeActivity in QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | timeActivity | object | The unsaved timeActivity, to be persisted in QuickBooks |

quickBooks.createTransfer

Creates the Transfer in QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | transfer | object | The unsaved Transfer, to be persisted in QuickBooks |

quickBooks.createVendor

Creates the Vendor in QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | vendor | object | The unsaved vendor, to be persisted in QuickBooks |

quickBooks.createVendorCredit

Creates the VendorCredit in QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | vendorCredit | object | The unsaved vendorCredit, to be persisted in QuickBooks |

quickBooks.getAccount

Retrieves the Account from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | Id | string | The Id of persistent Account |

quickBooks.getAttachable

Retrieves the Attachable from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | Id | string | The Id of persistent Attachable |

quickBooks.getBill

Retrieves the Bill from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | Id | string | The Id of persistent Bill |

quickBooks.getBillPayment

Retrieves the BillPayment from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | Id | string | The Id of persistent BillPayment |

quickBooks.getClass

Retrieves the Class from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | Id | string | The Id of persistent Class |

quickBooks.getCompanyInfo

Retrieves the CompanyInfo from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | Id | string | The Id of persistent CompanyInfo |

quickBooks.getCreditMemo

Retrieves the CreditMemo from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | Id | string | The Id of persistent CreditMemo |

quickBooks.getCustomer

Retrieves the Customer from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | Id | string | The Id of persistent Customer |

quickBooks.getDepartment

Retrieves the Department from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | Id | string | The Id of persistent Department |

quickBooks.getDeposit

Retrieves the Deposit from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | Id | string | The Id of persistent Deposit |

quickBooks.getEmployee

Retrieves the Employee from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | Id | string | The Id of persistent Employee |

quickBooks.getEstimate

Retrieves the Estimate from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | Id | string | The Id of persistent Estimate |

quickBooks.getExchangeRate

Retrieves an ExchangeRate from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | options | object | An object with options including the required sourcecurrencycode parameter and optional asofdate parameter. |

quickBooks.getEstimatePdf

Retrieves the Estimate PDF from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | Id | string | The Id of persistent Estimate |

quickBooks.sendEstimatePdf

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

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | Id | string | The Id of persistent Estimate | | sendTo | string | optional email address to send the PDF to. If not provided, address supplied in Estimate.BillEmail.EmailAddress will be used |

quickBooks.getInvoice

Retrieves the Invoice from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | Id | string | The Id of persistent Invoice |

quickBooks.getInvoicePdf

Retrieves the Invoice PDF from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | Id | string | The Id of persistent Invoice |

quickBooks.sendInvoicePdf

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

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | Id | string | The Id of persistent Invoice | | sendTo | string | optional email address to send the PDF to. If not provided, address supplied in Invoice.BillEmail.EmailAddress will be used |

quickBooks.getItem

Retrieves the Item from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | Id | string | The Id of persistent Item |

quickBooks.getJournalCode

Retrieves the JournalCode from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | Id | string | The Id of persistent JournalCode |

quickBooks.getJournalEntry

Retrieves the JournalEntry from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | Id | string | The Id of persistent JournalEntry |

quickBooks.getPayment

Retrieves the Payment from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | Id | string | The Id of persistent Payment |

quickBooks.getPaymentMethod

Retrieves the PaymentMethod from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | Id | string | The Id of persistent PaymentMethod |

quickBooks.getPreferences

Retrieves the Preferences from QuickBooks

Kind: instance property of QuickBooks

quickBooks.getPurchase

Retrieves the Purchase from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | Id | string | The Id of persistent Purchase |

quickBooks.getPurchaseOrder

Retrieves the PurchaseOrder from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | Id | string | The Id of persistent PurchaseOrder |

quickBooks.getRefundReceipt

Retrieves the RefundReceipt from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | Id | string | The Id of persistent RefundReceipt |

quickBooks.getReports

Retrieves the Reports from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | Id | string | The Id of persistent Reports |

quickBooks.getSalesReceipt

Retrieves the SalesReceipt from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | Id | string | The Id of persistent SalesReceipt |

quickBooks.getSalesReceiptPdf

Retrieves the SalesReceipt PDF from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | Id | string | The Id of persistent SalesReceipt |

quickBooks.sendSalesReceiptPdf

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

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | Id | string | The Id of persistent SalesReceipt | | sendTo | string | optional email address to send the PDF to. If not provided, address supplied in SalesReceipt.BillEmail.EmailAddress will be used |

quickBooks.getTaxAgency

Retrieves the TaxAgency from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | Id | string | The Id of persistent TaxAgency |

quickBooks.getTaxCode

Retrieves the TaxCode from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | Id | string | The Id of persistent TaxCode |

quickBooks.getTaxRate

Retrieves the TaxRate from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | Id | string | The Id of persistent TaxRate |

quickBooks.getTerm

Retrieves the Term from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | Id | string | The Id of persistent Term |

quickBooks.getTimeActivity

Retrieves the TimeActivity from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | Id | string | The Id of persistent TimeActivity |

quickBooks.getTransfer

Retrieves the Transfer from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | Id | string | The Id of persistent Term |

quickBooks.getVendor

Retrieves the Vendor from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | Id | string | The Id of persistent Vendor |

quickBooks.getVendorCredit

Retrieves the VendorCredit from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | Id | string | The Id of persistent VendorCredit |

quickBooks.updateAccount

Updates QuickBooks version of Account

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | account | object | The persistent Account, including Id and SyncToken fields |

quickBooks.updateAttachable

Updates QuickBooks version of Attachable

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | attachable | object | The persistent Attachable, including Id and SyncToken fields |

quickBooks.updateBill

Updates QuickBooks version of Bill

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | bill | object | The persistent Bill, including Id and SyncToken fields |

quickBooks.updateBillPayment

Updates QuickBooks version of BillPayment

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | billPayment | object | The persistent BillPayment, including Id and SyncToken fields |

quickBooks.updateClass

Updates QuickBooks version of Class

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | class | object | The persistent Class, including Id and SyncToken fields |

quickBooks.updateCompanyInfo

Updates QuickBooks version of CompanyInfo

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | companyInfo | object | The persistent CompanyInfo, including Id and SyncToken fields |

quickBooks.updateCreditMemo

Updates QuickBooks version of CreditMemo

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | creditMemo | object | The persistent CreditMemo, including Id and SyncToken fields |

quickBooks.updateCustomer

Updates QuickBooks version of Customer

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | customer | object | The persistent Customer, including Id and SyncToken fields |

quickBooks.updateDepartment

Updates QuickBooks version of Department

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | department | object | The persistent Department, including Id and SyncToken fields |

quickBooks.updateDeposit

Updates QuickBooks version of Deposit

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | deposit | object | The persistent Deposit, including Id and SyncToken fields |

quickBooks.updateEmployee

Updates QuickBooks version of Employee

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | employee | object | The persistent Employee, including Id and SyncToken fields |

quickBooks.updateEstimate

Updates QuickBooks version of Estimate

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | estimate | object | The persistent Estimate, including Id and SyncToken fields |

quickBooks.updateInvoice

Updates QuickBooks version of Invoice

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | invoice | object | The persistent Invoice, including Id and SyncToken fields |

quickBooks.updateItem

Updates QuickBooks version of Item

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | item | object | The persistent Item, including Id and SyncToken fields |

quickBooks.updateJournalCode

Updates QuickBooks version of JournalCode

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | journalCode | object | The persistent JournalCode, including Id and SyncToken fields |

quickBooks.updateJournalEntry

Updates QuickBooks version of JournalEntry

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | journalEntry | object | The persistent JournalEntry, including Id and SyncToken fields |

quickBooks.updatePayment

Updates QuickBooks version of Payment

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | payment | object | The persistent Payment, including Id and SyncToken fields |

quickBooks.updatePaymentMethod

Updates QuickBooks version of PaymentMethod

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | paymentMethod | object | The persistent PaymentMethod, including Id and SyncToken fields |

quickBooks.updatePreferences

Updates QuickBooks version of Preferences

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | preferences | object | The persistent Preferences, including Id and SyncToken fields |

quickBooks.updatePurchase

Updates QuickBooks version of Purchase

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | purchase | object | The persistent Purchase, including Id and SyncToken fields |

quickBooks.updatePurchaseOrder

Updates QuickBooks version of PurchaseOrder

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | purchaseOrder | object | The persistent PurchaseOrder, including Id and SyncToken fields |

quickBooks.updateRefundReceipt

Updates QuickBooks version of RefundReceipt

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | refundReceipt | object | The persistent RefundReceipt, including Id and SyncToken fields |

quickBooks.updateSalesReceipt

Updates QuickBooks version of SalesReceipt

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | salesReceipt | object | The persistent SalesReceipt, including Id and SyncToken fields |

quickBooks.updateTaxAgency

Updates QuickBooks version of TaxAgency

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | taxAgency | object | The persistent TaxAgency, including Id and SyncToken fields |

quickBooks.updateTaxCode

Updates QuickBooks version of TaxCode

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | taxCode | object | The persistent TaxCode, including Id and SyncToken fields |

quickBooks.updateTaxRate

Updates QuickBooks version of TaxRate

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | taxRate | object | The persistent TaxRate, including Id and SyncToken fields |

quickBooks.updateTerm

Updates QuickBooks version of Term

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | term | object | The persistent Term, including Id and SyncToken fields |

quickBooks.updateTimeActivity

Updates QuickBooks version of TimeActivity

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | timeActivity | object | The persistent TimeActivity, including Id and SyncToken fields |

quickBooks.updateTransfer

Updates QuickBooks version of Transfer

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | Transfer | object | The persistent Transfer, including Id and SyncToken fields |

quickBooks.updateVendor

Updates QuickBooks version of Vendor

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | vendor | object | The persistent Vendor, including Id and SyncToken fields |

quickBooks.updateVendorCredit

Updates QuickBooks version of VendorCredit

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | vendorCredit | object | The persistent VendorCredit, including Id and SyncToken fields |

quickBooks.updateExchangeRate

Updates QuickBooks version of ExchangeRate

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | exchangeRate | object | The persistent ExchangeRate, including Id and SyncToken fields |

quickBooks.deleteAttachable

Deletes the Attachable from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | idOrEntity | object | The persistent Attachable to be deleted, or the Id of the Attachable, in which case an extra GET request will be issued to first retrieve the Attachable |

quickBooks.deleteBill

Deletes the Bill from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | idOrEntity | object | The persistent Bill to be deleted, or the Id of the Bill, in which case an extra GET request will be issued to first retrieve the Bill |

quickBooks.deleteBillPayment

Deletes the BillPayment from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | idOrEntity | object | The persistent BillPayment to be deleted, or the Id of the BillPayment, in which case an extra GET request will be issued to first retrieve the BillPayment |

quickBooks.deleteCreditMemo

Deletes the CreditMemo from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | idOrEntity | object | The persistent CreditMemo to be deleted, or the Id of the CreditMemo, in which case an extra GET request will be issued to first retrieve the CreditMemo |

quickBooks.deleteDeposit

Deletes the Deposit from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | idOrEntity | object | The persistent Deposit to be deleted, or the Id of the Deposit, in which case an extra GET request will be issued to first retrieve the Deposit |

quickBooks.deleteEstimate

Deletes the Estimate from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | idOrEntity | object | The persistent Estimate to be deleted, or the Id of the Estimate, in which case an extra GET request will be issued to first retrieve the Estimate |

quickBooks.deleteInvoice

Deletes the Invoice from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | idOrEntity | object | The persistent Invoice to be deleted, or the Id of the Invoice, in which case an extra GET request will be issued to first retrieve the Invoice |

quickBooks.deleteJournalCode

Deletes the JournalCode from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | idOrEntity | object | The persistent JournalCode to be deleted, or the Id of the JournalCode, in which case an extra GET request will be issued to first retrieve the JournalCode |

quickBooks.deleteJournalEntry

Deletes the JournalEntry from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | idOrEntity | object | The persistent JournalEntry to be deleted, or the Id of the JournalEntry, in which case an extra GET request will be issued to first retrieve the JournalEntry |

quickBooks.deletePayment

Deletes the Payment from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | idOrEntity | object | The persistent Payment to be deleted, or the Id of the Payment, in which case an extra GET request will be issued to first retrieve the Payment |

quickBooks.deletePurchase

Deletes the Purchase from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | idOrEntity | object | The persistent Purchase to be deleted, or the Id of the Purchase, in which case an extra GET request will be issued to first retrieve the Purchase |

quickBooks.deletePurchaseOrder

Deletes the PurchaseOrder from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | idOrEntity | object | The persistent PurchaseOrder to be deleted, or the Id of the PurchaseOrder, in which case an extra GET request will be issued to first retrieve the PurchaseOrder |

quickBooks.deleteRefundReceipt

Deletes the RefundReceipt from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | idOrEntity | object | The persistent RefundReceipt to be deleted, or the Id of the RefundReceipt, in which case an extra GET request will be issued to first retrieve the RefundReceipt |

quickBooks.deleteSalesReceipt

Deletes the SalesReceipt from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | idOrEntity | object | The persistent SalesReceipt to be deleted, or the Id of the SalesReceipt, in which case an extra GET request will be issued to first retrieve the SalesReceipt |

quickBooks.deleteTimeActivity

Deletes the TimeActivity from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | idOrEntity | object | The persistent TimeActivity to be deleted, or the Id of the TimeActivity, in which case an extra GET request will be issued to first retrieve the TimeActivity |

quickBooks.deleteTransfer

Deletes the Transfer from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | idOrEntity | object | The persistent Transfer to be deleted, or the Id of the Transfer, in which case an extra GET request will be issued to first retrieve the Transfer |

quickBooks.deleteVendorCredit

Deletes the VendorCredit from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | idOrEntity | object | The persistent VendorCredit to be deleted, or the Id of the VendorCredit, in which case an extra GET request will be issued to first retrieve the VendorCredit |

quickBooks.voidInvoice

Voids the Invoice from QuickBooks

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | idOrEntity | object | The persistent Invoice to be voided, or the Id of the Invoice, in which case an extra GET request will be issued to first retrieve the Invoice |

quickBooks.voidPayment

Voids QuickBooks version of Payment

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | payment | object | The persistent Payment, including Id and SyncToken fields |

quickBooks.findAccounts

Finds all Accounts in QuickBooks, optionally matching the specified criteria

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | criteria | object | (Optional) String or single-valued map converted to a where clause of the form "where key = 'value'" |

quickBooks.findAttachables

Finds all Attachables in QuickBooks, optionally matching the specified criteria

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | criteria | object | (Optional) String or single-valued map converted to a where clause of the form "where key = 'value'" |

quickBooks.findBills

Finds all Bills in QuickBooks, optionally matching the specified criteria

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | criteria | object | (Optional) String or single-valued map converted to a where clause of the form "where key = 'value'" |

quickBooks.findBillPayments

Finds all BillPayments in QuickBooks, optionally matching the specified criteria

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | criteria | object | (Optional) String or single-valued map converted to a where clause of the form "where key = 'value'" |

quickBooks.findBudgets

Finds all Budgets in QuickBooks, optionally matching the specified criteria

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | criteria | object | (Optional) String or single-valued map converted to a where clause of the form "where key = 'value'" |

quickBooks.findClasses

Finds all Classs in QuickBooks, optionally matching the specified criteria

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | criteria | object | (Optional) String or single-valued map converted to a where clause of the form "where key = 'value'" |

quickBooks.findCompanyInfos

Finds all CompanyInfos in QuickBooks, optionally matching the specified criteria

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | criteria | object | (Optional) String or single-valued map converted to a where clause of the form "where key = 'value'" |

quickBooks.findCreditMemos

Finds all CreditMemos in QuickBooks, optionally matching the specified criteria

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | criteria | object | (Optional) String or single-valued map converted to a where clause of the form "where key = 'value'" |

quickBooks.findCustomers

Finds all Customers in QuickBooks, optionally matching the specified criteria

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | criteria | object | (Optional) String or single-valued map converted to a where clause of the form "where key = 'value'" |

quickBooks.findDepartments

Finds all Departments in QuickBooks, optionally matching the specified criteria

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | criteria | object | (Optional) String or single-valued map converted to a where clause of the form "where key = 'value'" |

quickBooks.findDeposits

Finds all Deposits in QuickBooks, optionally matching the specified criteria

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | criteria | object | (Optional) String or single-valued map converted to a where clause of the form "where key = 'value'" |

quickBooks.findEmployees

Finds all Employees in QuickBooks, optionally matching the specified criteria

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | criteria | object | (Optional) String or single-valued map converted to a where clause of the form "where key = 'value'" |

quickBooks.findEstimates

Finds all Estimates in QuickBooks, optionally matching the specified criteria

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | criteria | object | (Optional) String or single-valued map converted to a where clause of the form "where key = 'value'" |

quickBooks.findInvoices

Finds all Invoices in QuickBooks, optionally matching the specified criteria

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | criteria | object | (Optional) String or single-valued map converted to a where clause of the form "where key = 'value'" |

quickBooks.findItems

Finds all Items in QuickBooks, optionally matching the specified criteria

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | criteria | object | (Optional) String or single-valued map converted to a where clause of the form "where key = 'value'" |

quickBooks.findJournalCodes

Finds all JournalCodes in QuickBooks, optionally matching the specified criteria

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | criteria | object | (Optional) String or single-valued map converted to a where clause of the form "where key = 'value'" |

quickBooks.findJournalEntries

Finds all JournalEntrys in QuickBooks, optionally matching the specified criteria

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | criteria | object | (Optional) String or single-valued map converted to a where clause of the form "where key = 'value'" |

quickBooks.findPayments

Finds all Payments in QuickBooks, optionally matching the specified criteria

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | criteria | object | (Optional) String or single-valued map converted to a where clause of the form "where key = 'value'" |

quickBooks.findPaymentMethods

Finds all PaymentMethods in QuickBooks, optionally matching the specified criteria

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | criteria | object | (Optional) String or single-valued map converted to a where clause of the form "where key = 'value'" |

quickBooks.findPreferenceses

Finds all Preferencess in QuickBooks, optionally matching the specified criteria

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | criteria | object | (Optional) String or single-valued map converted to a where clause of the form "where key = 'value'" |

quickBooks.findPurchases

Finds all Purchases in QuickBooks, optionally matching the specified criteria

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | criteria | object | (Optional) String or single-valued map converted to a where clause of the form "where key = 'value'" |

quickBooks.findPurchaseOrders

Finds all PurchaseOrders in QuickBooks, optionally matching the specified criteria

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | criteria | object | (Optional) String or single-valued map converted to a where clause of the form "where key = 'value'" |

quickBooks.findRefundReceipts

Finds all RefundReceipts in QuickBooks, optionally matching the specified criteria

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | criteria | object | (Optional) String or single-valued map converted to a where clause of the form "where key = 'value'" |

quickBooks.findSalesReceipts

Finds all SalesReceipts in QuickBooks, optionally matching the specified criteria

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | criteria | object | (Optional) String or single-valued map converted to a where clause of the form "where key = 'value'" |

quickBooks.findTaxAgencies

Finds all TaxAgencys in QuickBooks, optionally matching the specified criteria

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | criteria | object | (Optional) String or single-valued map converted to a where clause of the form "where key = 'value'" |

quickBooks.findTaxCodes

Finds all TaxCodes in QuickBooks, optionally matching the specified criteria

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | criteria | object | (Optional) String or single-valued map converted to a where clause of the form "where key = 'value'" |

quickBooks.findTaxRates

Finds all TaxRates in QuickBooks, optionally matching the specified criteria

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | criteria | object | (Optional) String or single-valued map converted to a where clause of the form "where key = 'value'" |

quickBooks.findTerms

Finds all Terms in QuickBooks, optionally matching the specified criteria

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | criteria | object | (Optional) String or single-valued map converted to a where clause of the form "where key = 'value'" |

quickBooks.findTimeActivities

Finds all TimeActivitys in QuickBooks, optionally matching the specified criteria

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | criteria | object | (Optional) String or single-valued map converted to a where clause of the form "where key = 'value'" |

quickBooks.findTransfers

Finds all Transfers in QuickBooks, optionally matching the specified criteria

Kind: instance property of QuickBooks

| Param | Type | Description | | --- | --- | --- | | criteria | object | (Optional) String or sing