node-quickbooks

You can control the result set of query functions using keys within the optional first argument object.

Sorting

Use the asc or desc keys. The value should be the column name you wish to sort on.

qbo.findAttachables({
  desc: 'MetaData.LastUpdatedTime'
}, function(e, attachables) {
  console.log(e, attachables)
})

Pagination

Use limit (number of rows to return) and offset (number of rows to skip).

qbo.findAttachables({
  limit: 10,
  offset: 10
}, function(e, attachables) {
  console.log(e, attachables)
})

Fetch All Records

By default, the maximum limit is 1000 records. To transparently fetch all available records (issuing multiple requests as needed), set fetchAll: true.

qbo.findCustomers({
  fetchAll: true
}, function(e, customers) {
  console.log(customers)
})

Row Counts

To get the total count of rows instead of the full result set, pass count: true.

qbo.findAttachables({
  count: true
}, function(e, attachables) {
  console.log(e, attachables)
})

When using find* methods or the underlying query logic, you can pass criteria to filter results. The library converts these into a SQL WHERE clause.

Supported Criteria Types:

1. String: A direct SQL fragment. Note that the library handles some character escaping.
2. Object: A map where keys are field names and values are the filter values. A single-valued object is converted to where key = 'value'. Multiple keys are joined with AND.
3. Array of Objects: Allows for more complex filtering. Each object in the array represents a criterion.

Special Fields in Criteria:

• limit: Sets the maximum number of results (default is 1000).
• offset: Sets the starting position (default is 1).
• fetchAll: A boolean. If true, the library will automatically perform multiple requests to fetch all available records by incrementing the offset.
• desc / asc: Used for ordering results (e.g., { desc: true }).
• count: If a criterion object contains a count property, the query is transformed into a SELECT COUNT(*) query.

Use the delete[EntityName] methods to remove records from QuickBooks. You can pass either the persistent entity object or the entity's Id. If you pass an Id, the library will automatically issue an extra GET request to retrieve the entity before attempting deletion.

Supported entities include:

• deleteEstimate(idOrEntity, callback)
• deleteInvoice(idOrEntity, callback)
• deleteJournalCode(idOrEntity, callback)
• deleteJournalEntry(idOrEntity, callback)
• deletePayment(idOrEntity, callback)
• deletePurchase(idOrEntity, callback)
• deletePurchaseOrder(idOrEntity, callback)
• deleteRefundReceipt(idOrEntity, callback)
• deleteSalesReceipt(idOrEntity, callback)
• deleteTimeActivity(idOrEntity, callback)
• deleteTransfer(idOrEntity, callback)
• deleteVendorCredit(idOrEntity, callback)

Arguments:

• idOrEntity: The persistent entity object or the Id of the entity.
• callback: A function called with (error, status), where status is the status of the persistent entity.

Use the update[EntityName] methods to update existing objects in QuickBooks.

Requirements:

• The object passed to the method must be the persistent version of the entity, including its Id and SyncToken fields.
• All methods use a callback(error, updatedObject) pattern.

Special Update Behaviors:

• Voiding Invoices, Payments, and Sales Receipts: To void an Invoice, Payment, or SalesReceipt, include void: true within the object.
• Updating Items: The updateItem(object, callback) method accepts an optional boolean property doNotUpdateAccountOnTxns on the Item object. If set to true, it suppresses updating the income or expense account on existing transactions associated with that Item. Note: This value is compared using .toString(), so you must use the literal strings 'true' or 'false' (or boolean true/false depending on implementation context) rather than truthy/falsy integers like 1 or 0.