Overlay of node-quickbooks
that replaces callback API with promises
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}`)
yarn add node-quickbooks-promise
# or...
npm i s node-quickbooks-promise
Kind: global class
- QuickBooks
- new QuickBooks()
- .revokeAccess
- .getUserInfo
- .batch
- .changeDataCapture
- .upload
- .createAccount
- .createAttachable
- .createBill
- .createBillPayment
- .createClass
- .createCreditMemo
- .createCustomer
- .createDepartment
- .createDeposit
- .createEmployee
- .createEstimate
- .createInvoice
- .createItem
- .createJournalCode
- .createJournalEntry
- .createPayment
- .createPaymentMethod
- .createPurchase
- .createPurchaseOrder
- .createRefundReceipt
- .createSalesReceipt
- .createTaxAgency
- .createTaxService
- .createTerm
- .createTimeActivity
- .createTransfer
- .createVendor
- .createVendorCredit
- .getAccount
- .getAttachable
- .getBill
- .getBillPayment
- .getClass
- .getCompanyInfo
- .getCompanyCurrency
- .getCreditMemo
- .getCustomer
- .getCustomerType
- .getDepartment
- .getDeposit
- .getEmployee
- .getEstimate
- .getExchangeRate
- .getEstimatePdf
- .sendEstimatePdf
- .getInvoice
- .getInvoicePdf
- .sendInvoicePdf
- .getCreditMemoPdf
- .sendCreditMemoPdf
- .sendPurchaseOrder
- .getItem
- .getJournalCode
- .getJournalEntry
- .getPayment
- .getPaymentMethod
- .getPreferences
- .getPurchase
- .getPurchaseOrder
- .getRefundReceipt
- .getReports
- .getSalesReceipt
- .getSalesReceiptPdf
- .sendSalesReceiptPdf
- .getTaxAgency
- .getTaxCode
- .getTaxRate
- .getTerm
- .getTimeActivity
- .getTransfer
- .getVendor
- .getVendorCredit
- .updateAccount
- .updateAttachable
- .updateBill
- .updateBillPayment
- .updateClass
- .updateCompanyInfo
- .updateCreditMemo
- .updateCustomer
- .updateDepartment
- .updateDeposit
- .updateEmployee
- .updateEstimate
- .updateInvoice
- .updateItem
- .updateJournalCode
- .updateJournalEntry
- .updatePayment
- .updatePaymentMethod
- .updatePreferences
- .updatePurchase
- .updatePurchaseOrder
- .updateRefundReceipt
- .updateSalesReceipt
- .updateTaxAgency
- .updateTaxCode
- .updateTaxRate
- .updateTerm
- .updateTimeActivity
- .updateTransfer
- .updateVendor
- .updateVendorCredit
- .updateExchangeRate
- .deleteAttachable
- .deleteBill
- .deleteBillPayment
- .deleteCreditMemo
- .deleteDeposit
- .deleteEstimate
- .deleteInvoice
- .deleteJournalCode
- .deleteJournalEntry
- .deletePayment
- .deletePurchase
- .deletePurchaseOrder
- .deleteRefundReceipt
- .deleteSalesReceipt
- .deleteTimeActivity
- .deleteTransfer
- .deleteVendorCredit
- .voidInvoice
- .voidPayment
- .findAccounts
- .findAttachables
- .findBills
- .findBillPayments
- .findBudgets
- .findClasses
- .findCompanyInfos
- .findCompanyCurrencies
- .findCreditMemos
- .findCustomers
- .findCustomerTypes
- .findDepartments
- .findDeposits
- .findEmployees
- .findEstimates
- .findInvoices
- .findItems
- .findJournalCodes
- .findJournalEntries
- .findPayments
- .findPaymentMethods
- .findPreferenceses
- .findPurchases
- .findPurchaseOrders
- .findRefundReceipts
- .findSalesReceipts
- .findTaxAgencies
- .findTaxCodes
- .findTaxRates
- .findTerms
- .findTimeActivities
- .findTransfers
- .findVendors
- .findVendorCredits
- .findExchangeRates
- .reportBalanceSheet
- .reportProfitAndLoss
- .reportProfitAndLossDetail
- .reportTrialBalance
- .reportTrialBalanceFR
- .reportCashFlow
- .reportInventoryValuationSummary
- .reportCustomerSales
- .reportItemSales
- .reportCustomerIncome
- .reportCustomerBalance
- .reportCustomerBalanceDetail
- .reportAgedReceivables
- .reportAgedReceivableDetail
- .reportVendorBalance
- .reportVendorBalanceDetail
- .reportAgedPayables
- .reportAgedPayableDetail
- .reportVendorExpenses
- .reportTransactionList
- .reportGeneralLedgerDetail
- .reportTaxSummary
- .reportDepartmentSales
- .reportClassSales
- .reportAccountListDetail
- .reportJournalReport
Quickbooks integration class from node-quickbooks
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. |
Get user info (OAuth2).
Kind: instance property of QuickBooks
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 30.
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
items | object |
JavaScript array of batch items |
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 |
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 |
Creates the Account in QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
account | object |
The unsaved account, to be persisted in QuickBooks |
Creates the Attachable in QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
attachable | object |
The unsaved attachable, to be persisted in QuickBooks |
Creates the Bill in QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
bill | object |
The unsaved bill, to be persisted in QuickBooks |
Creates the BillPayment in QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
billPayment | object |
The unsaved billPayment, to be persisted in QuickBooks |
Creates the Class in QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
class | object |
The unsaved class, to be persisted in QuickBooks |
Creates the CreditMemo in QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
creditMemo | object |
The unsaved creditMemo, to be persisted in QuickBooks |
Creates the Customer in QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
customer | object |
The unsaved customer, to be persisted in QuickBooks |
Creates the Department in QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
department | object |
The unsaved department, to be persisted in QuickBooks |
Creates the Deposit in QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
deposit | object |
The unsaved Deposit, to be persisted in QuickBooks |
Creates the Employee in QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
employee | object |
The unsaved employee, to be persisted in QuickBooks |
Creates the Estimate in QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
estimate | object |
The unsaved estimate, to be persisted in QuickBooks |
Creates the Invoice in QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
invoice | object |
The unsaved invoice, to be persisted in QuickBooks |
Creates the Item in QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
item | object |
The unsaved item, to be persisted in QuickBooks |
Creates the JournalCode in QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
journalCode | object |
The unsaved journalCode, to be persisted in QuickBooks |
Creates the JournalEntry in QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
journalEntry | object |
The unsaved journalEntry, to be persisted in QuickBooks |
Creates the Payment in QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
payment | object |
The unsaved payment, to be persisted in QuickBooks |
Creates the PaymentMethod in QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
paymentMethod | object |
The unsaved paymentMethod, to be persisted in QuickBooks |
Creates the Purchase in QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
purchase | object |
The unsaved purchase, to be persisted in QuickBooks |
Creates the PurchaseOrder in QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
purchaseOrder | object |
The unsaved purchaseOrder, to be persisted in QuickBooks |
Creates the RefundReceipt in QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
refundReceipt | object |
The unsaved refundReceipt, to be persisted in QuickBooks |
Creates the SalesReceipt in QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
salesReceipt | object |
The unsaved salesReceipt, to be persisted in QuickBooks |
Creates the TaxAgency in QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
taxAgency | object |
The unsaved taxAgency, to be persisted in QuickBooks |
Creates the TaxService in QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
taxService | object |
The unsaved taxService, to be persisted in QuickBooks |
Creates the Term in QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
term | object |
The unsaved term, to be persisted in QuickBooks |
Creates the TimeActivity in QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
timeActivity | object |
The unsaved timeActivity, to be persisted in QuickBooks |
Creates the Transfer in QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
transfer | object |
The unsaved Transfer, to be persisted in QuickBooks |
Creates the Vendor in QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
vendor | object |
The unsaved vendor, to be persisted in QuickBooks |
Creates the VendorCredit in QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
vendorCredit | object |
The unsaved vendorCredit, to be persisted in QuickBooks |
Retrieves the Account from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
Id | string |
The Id of persistent Account |
Retrieves the Attachable from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
Id | string |
The Id of persistent Attachable |
Retrieves the Bill from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
Id | string |
The Id of persistent Bill |
Retrieves the BillPayment from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
Id | string |
The Id of persistent BillPayment |
Retrieves the Class from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
Id | string |
The Id of persistent Class |
Retrieves the CompanyInfo from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
Id | string |
The Id of persistent CompanyInfo |
Retrieves the CompanyCurrency from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
Id | string |
The Id of persistent CompanyCurrency |
Retrieves the CreditMemo from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
Id | string |
The Id of persistent CreditMemo |
Retrieves the Customer from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
Id | string |
The Id of persistent Customer |
Retrieves the CustomerType from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
Id | string |
The Id of persistent CustomerType |
Retrieves the Department from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
Id | string |
The Id of persistent Department |
Retrieves the Deposit from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
Id | string |
The Id of persistent Deposit |
Retrieves the Employee from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
Id | string |
The Id of persistent Employee |
Retrieves the Estimate from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
Id | string |
The Id of persistent Estimate |
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. |
Retrieves the Estimate PDF from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
Id | string |
The Id of persistent Estimate |
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 |
Retrieves the Invoice from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
Id | string |
The Id of persistent Invoice |
Retrieves the Invoice PDF from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
Id | string |
The Id of persistent Invoice |
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 |
Retrieves the Credit Memo PDF from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
Id | string |
The Id of persistent Credit Memo |
Emails the Credit Memo PDF from QuickBooks to the address supplied in CreditMemo.BillEmail.EmailAddress or the specified 'sendTo' address
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
Id | string |
The Id of persistent Credit Memo |
sendTo | string |
optional email address to send the PDF to. If not provided, address supplied in CreditMemo.BillEmail.EmailAddress will be used |
Emails the Purchase Order from QuickBooks to the address supplied in PurchaseOrder.POEmail.Address or the specified 'sendTo' address
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
Id | string |
The Id of persistent Purchase Order |
sendTo | string |
optional email address to send the PDF to. If not provided, address supplied in PurchaseOrder.POEmail.Address will be used |
Retrieves the Item from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
Id | string |
The Id of persistent Item |
Retrieves the JournalCode from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
Id | string |
The Id of persistent JournalCode |
Retrieves the JournalEntry from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
Id | string |
The Id of persistent JournalEntry |
Retrieves the Payment from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
Id | string |
The Id of persistent Payment |
Retrieves the PaymentMethod from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
Id | string |
The Id of persistent PaymentMethod |
Retrieves the Preferences from QuickBooks
Kind: instance property of QuickBooks
Retrieves the Purchase from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
Id | string |
The Id of persistent Purchase |
Retrieves the PurchaseOrder from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
Id | string |
The Id of persistent PurchaseOrder |
Retrieves the RefundReceipt from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
Id | string |
The Id of persistent RefundReceipt |
Retrieves the Reports from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
Id | string |
The Id of persistent Reports |
Retrieves the SalesReceipt from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
Id | string |
The Id of persistent SalesReceipt |
Retrieves the SalesReceipt PDF from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
Id | string |
The Id of persistent SalesReceipt |
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 |
Retrieves the TaxAgency from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
Id | string |
The Id of persistent TaxAgency |
Retrieves the TaxCode from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
Id | string |
The Id of persistent TaxCode |
Retrieves the TaxRate from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
Id | string |
The Id of persistent TaxRate |
Retrieves the Term from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
Id | string |
The Id of persistent Term |
Retrieves the TimeActivity from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
Id | string |
The Id of persistent TimeActivity |
Retrieves the Transfer from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
Id | string |
The Id of persistent Term |
Retrieves the Vendor from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
Id | string |
The Id of persistent Vendor |
Retrieves the VendorCredit from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
Id | string |
The Id of persistent VendorCredit |
Updates QuickBooks version of Account
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
account | object |
The persistent Account, including Id and SyncToken fields |
Updates QuickBooks version of Attachable
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
attachable | object |
The persistent Attachable, including Id and SyncToken fields |
Updates QuickBooks version of Bill
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
bill | object |
The persistent Bill, including Id and SyncToken fields |
Updates QuickBooks version of BillPayment
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
billPayment | object |
The persistent BillPayment, including Id and SyncToken fields |
Updates QuickBooks version of Class
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
class | object |
The persistent Class, including Id and SyncToken fields |
Updates QuickBooks version of CompanyInfo
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
companyInfo | object |
The persistent CompanyInfo, including Id and SyncToken fields |
Updates QuickBooks version of CreditMemo
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
creditMemo | object |
The persistent CreditMemo, including Id and SyncToken fields |
Updates QuickBooks version of Customer
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
customer | object |
The persistent Customer, including Id and SyncToken fields |
Updates QuickBooks version of Department
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
department | object |
The persistent Department, including Id and SyncToken fields |
Updates QuickBooks version of Deposit
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
deposit | object |
The persistent Deposit, including Id and SyncToken fields |
Updates QuickBooks version of Employee
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
employee | object |
The persistent Employee, including Id and SyncToken fields |
Updates QuickBooks version of Estimate
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
estimate | object |
The persistent Estimate, including Id and SyncToken fields |
Updates QuickBooks version of Invoice
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
invoice | object |
The persistent Invoice, including Id and SyncToken fields |
Updates QuickBooks version of Item
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
item | object |
The persistent Item, including Id and SyncToken fields |
Updates QuickBooks version of JournalCode
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
journalCode | object |
The persistent JournalCode, including Id and SyncToken fields |
Updates QuickBooks version of JournalEntry
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
journalEntry | object |
The persistent JournalEntry, including Id and SyncToken fields |
Updates QuickBooks version of Payment
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
payment | object |
The persistent Payment, including Id and SyncToken fields |
Updates QuickBooks version of PaymentMethod
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
paymentMethod | object |
The persistent PaymentMethod, including Id and SyncToken fields |
Updates QuickBooks version of Preferences
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
preferences | object |
The persistent Preferences, including Id and SyncToken fields |
Updates QuickBooks version of Purchase
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
purchase | object |
The persistent Purchase, including Id and SyncToken fields |
Updates QuickBooks version of PurchaseOrder
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
purchaseOrder | object |
The persistent PurchaseOrder, including Id and SyncToken fields |
Updates QuickBooks version of RefundReceipt
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
refundReceipt | object |
The persistent RefundReceipt, including Id and SyncToken fields |
Updates QuickBooks version of SalesReceipt
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
salesReceipt | object |
The persistent SalesReceipt, including Id and SyncToken fields |
Updates QuickBooks version of TaxAgency
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
taxAgency | object |
The persistent TaxAgency, including Id and SyncToken fields |
Updates QuickBooks version of TaxCode
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
taxCode | object |
The persistent TaxCode, including Id and SyncToken fields |
Updates QuickBooks version of TaxRate
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
taxRate | object |
The persistent TaxRate, including Id and SyncToken fields |
Updates QuickBooks version of Term
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
term | object |
The persistent Term, including Id and SyncToken fields |
Updates QuickBooks version of TimeActivity
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
timeActivity | object |
The persistent TimeActivity, including Id and SyncToken fields |
Updates QuickBooks version of Transfer
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
Transfer | object |
The persistent Transfer, including Id and SyncToken fields |
Updates QuickBooks version of Vendor
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
vendor | object |
The persistent Vendor, including Id and SyncToken fields |
Updates QuickBooks version of VendorCredit
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
vendorCredit | object |
The persistent VendorCredit, including Id and SyncToken fields |
Updates QuickBooks version of ExchangeRate
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
exchangeRate | object |
The persistent ExchangeRate, including Id and SyncToken fields |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
Voids QuickBooks version of Payment
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
payment | object |
The persistent Payment, including Id and SyncToken fields |
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'" |
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'" |
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'" |
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'" |
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'" |
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'" |
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'" |
Finds all CompanyCurrencies 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'" |
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'" |
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'" |
Finds all CustomerTypes 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'" |
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'" |
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'" |
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'" |
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'" |
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'" |
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'" |
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'" |
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'" |
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'" |
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'" |
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'" |
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'" |
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'" |
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'" |
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'" |
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'" |
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'" |
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'" |
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'" |
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'" |
Finds all Transfers 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'" |
Finds all Vendors 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'" |
Finds all VendorCredits 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'" |
Finds all ExchangeRates 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'" |
Retrieves the BalanceSheet Report from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
options | object |
(Optional) Map of key-value pairs passed as options to the Report |
Retrieves the ProfitAndLoss Report from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
options | object |
(Optional) Map of key-value pairs passed as options to the Report |
Retrieves the ProfitAndLossDetail Report from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
options | object |
(Optional) Map of key-value pairs passed as options to the Report |
Retrieves the TrialBalance Report from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
options | object |
(Optional) Map of key-value pairs passed as options to the Report |
Retrieves the TrialBalanceFR Report from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
options | object |
(Optional) Map of key-value pairs passed as options to the Report |
Retrieves the CashFlow Report from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
options | object |
(Optional) Map of key-value pairs passed as options to the Report |
Retrieves the InventoryValuationSummary Report from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
options | object |
(Optional) Map of key-value pairs passed as options to the Report |
Retrieves the CustomerSales Report from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
options | object |
(Optional) Map of key-value pairs passed as options to the Report |
Retrieves the ItemSales Report from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
options | object |
(Optional) Map of key-value pairs passed as options to the Report |
Retrieves the CustomerIncome Report from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
options | object |
(Optional) Map of key-value pairs passed as options to the Report |
Retrieves the CustomerBalance Report from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
options | object |
(Optional) Map of key-value pairs passed as options to the Report |
Retrieves the CustomerBalanceDetail Report from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
options | object |
(Optional) Map of key-value pairs passed as options to the Report |
Retrieves the AgedReceivables Report from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
options | object |
(Optional) Map of key-value pairs passed as options to the Report |
Retrieves the AgedReceivableDetail Report from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
options | object |
(Optional) Map of key-value pairs passed as options to the Report |
Retrieves the VendorBalance Report from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
options | object |
(Optional) Map of key-value pairs passed as options to the Report |
Retrieves the VendorBalanceDetail Report from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
options | object |
(Optional) Map of key-value pairs passed as options to the Report |
Retrieves the AgedPayables Report from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
options | object |
(Optional) Map of key-value pairs passed as options to the Report |
Retrieves the AgedPayableDetail Report from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
options | object |
(Optional) Map of key-value pairs passed as options to the Report |
Retrieves the VendorExpenses Report from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
options | object |
(Optional) Map of key-value pairs passed as options to the Report |
Retrieves the TransactionList Report from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
options | object |
(Optional) Map of key-value pairs passed as options to the Report |
Retrieves the GeneralLedgerDetail Report from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
options | object |
(Optional) Map of key-value pairs passed as options to the Report |
Retrieves the TaxSummary Report from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
options | object |
(Optional) Map of key-value pairs passed as options to the Report |
Retrieves the DepartmentSales Report from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
options | object |
(Optional) Map of key-value pairs passed as options to the Report |
Retrieves the ClassSales Report from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
options | object |
(Optional) Map of key-value pairs passed as options to the Report |
Retrieves the AccountListDetail Report from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
options | object |
(Optional) Map of key-value pairs passed as options to the Report |
Retrieves the JournalReport Report from QuickBooks
Kind: instance property of QuickBooks
Param | Type | Description |
---|---|---|
options | object |
(Optional) Map of key-value pairs passed as options to the Report |
This is an automatically-generated codebase - including this README
! To see how it is built,
yarn build
Or check out the makePromises.js
to see how the analysis is done.