api.md

AuthSessions

Types:

• AuthSession

Methods:

• client.authSessions.create({ ...params }) -> AuthSession
• client.authSessions.retrieve(id) -> AuthSession

EndUsers

Types:

• EndUser
• EndUserListResponse
• EndUserDeleteResponse
• EndUserPassthroughResponse
• EndUserPingResponse

Methods:

• client.endUsers.create({ ...params }) -> EndUser
• client.endUsers.retrieve(id) -> EndUser
• client.endUsers.list() -> EndUserListResponse
• client.endUsers.delete(id) -> EndUserDeleteResponse
• client.endUsers.passthrough(id, integrationSlug, { ...params }) -> EndUserPassthroughResponse
• client.endUsers.ping(id, integrationSlug) -> EndUserPingResponse

Qbd

Accounts

Types:

• Account
• AccountListResponse

Methods:

• client.qbd.accounts.create({ ...params }) -> Account
• client.qbd.accounts.retrieve(id, { ...params }) -> Account
• client.qbd.accounts.update(id, { ...params }) -> Account
• client.qbd.accounts.list({ ...params }) -> AccountListResponse

BillCheckPayments

Types:

• BillCheckPayment
• BillCheckPaymentDeleteResponse

Methods:

• client.qbd.billCheckPayments.create({ ...params }) -> BillCheckPayment
• client.qbd.billCheckPayments.retrieve(id, { ...params }) -> BillCheckPayment
• client.qbd.billCheckPayments.update(id, { ...params }) -> BillCheckPayment
• client.qbd.billCheckPayments.list({ ...params }) -> BillCheckPaymentsCursorPage
• client.qbd.billCheckPayments.delete(id, { ...params }) -> BillCheckPaymentDeleteResponse

BillCreditCardPayments

Types:

• BillCreditCardPayment
• BillCreditCardPaymentDeleteResponse

Methods:

• client.qbd.billCreditCardPayments.create({ ...params }) -> BillCreditCardPayment
• client.qbd.billCreditCardPayments.retrieve(id, { ...params }) -> BillCreditCardPayment
• client.qbd.billCreditCardPayments.list({ ...params }) -> BillCreditCardPaymentsCursorPage
• client.qbd.billCreditCardPayments.delete(id, { ...params }) -> BillCreditCardPaymentDeleteResponse

Bills

Types:

• Bill
• BillDeleteResponse

Methods:

• client.qbd.bills.create({ ...params }) -> Bill
• client.qbd.bills.retrieve(id, { ...params }) -> Bill
• client.qbd.bills.update(id, { ...params }) -> Bill
• client.qbd.bills.list({ ...params }) -> BillsCursorPage
• client.qbd.bills.delete(id, { ...params }) -> BillDeleteResponse

Checks

Types:

• Check
• CheckDeleteResponse

Methods:

• client.qbd.checks.create({ ...params }) -> Check
• client.qbd.checks.retrieve(id, { ...params }) -> Check
• client.qbd.checks.update(id, { ...params }) -> Check
• client.qbd.checks.list({ ...params }) -> ChecksCursorPage
• client.qbd.checks.delete(id, { ...params }) -> CheckDeleteResponse

Classes

Types:

• Class
• ClassListResponse

Methods:

• client.qbd.classes.create({ ...params }) -> Class
• client.qbd.classes.retrieve(id, { ...params }) -> Class
• client.qbd.classes.update(id, { ...params }) -> Class
• client.qbd.classes.list({ ...params }) -> ClassListResponse

CreditCardCharges

Types:

• CreditCardCharge
• CreditCardChargeDeleteResponse

Methods:

• client.qbd.creditCardCharges.create({ ...params }) -> CreditCardCharge
• client.qbd.creditCardCharges.retrieve(id, { ...params }) -> CreditCardCharge
• client.qbd.creditCardCharges.update(id, { ...params }) -> CreditCardCharge
• client.qbd.creditCardCharges.list({ ...params }) -> CreditCardChargesCursorPage
• client.qbd.creditCardCharges.delete(id, { ...params }) -> CreditCardChargeDeleteResponse

CreditCardCredits

Types:

• CreditCardCredit
• CreditCardCreditDeleteResponse

Methods:

• client.qbd.creditCardCredits.create({ ...params }) -> CreditCardCredit
• client.qbd.creditCardCredits.retrieve(id, { ...params }) -> CreditCardCredit
• client.qbd.creditCardCredits.update(id, { ...params }) -> CreditCardCredit
• client.qbd.creditCardCredits.list({ ...params }) -> CreditCardCreditsCursorPage
• client.qbd.creditCardCredits.delete(id, { ...params }) -> CreditCardCreditDeleteResponse

CreditMemos

Types:

• CreditMemo
• CreditMemoDeleteResponse

Methods:

• client.qbd.creditMemos.create({ ...params }) -> CreditMemo
• client.qbd.creditMemos.retrieve(id, { ...params }) -> CreditMemo
• client.qbd.creditMemos.update(id, { ...params }) -> CreditMemo
• client.qbd.creditMemos.list({ ...params }) -> CreditMemosCursorPage
• client.qbd.creditMemos.delete(id, { ...params }) -> CreditMemoDeleteResponse

Customers

Types:

• Customer

Methods:

• client.qbd.customers.create({ ...params }) -> Customer
• client.qbd.customers.retrieve(id, { ...params }) -> Customer
• client.qbd.customers.update(id, { ...params }) -> Customer
• client.qbd.customers.list({ ...params }) -> CustomersCursorPage

DateDrivenTerms

Types:

• DateDrivenTerm
• DateDrivenTermListResponse

Methods:

• client.qbd.dateDrivenTerms.create({ ...params }) -> DateDrivenTerm
• client.qbd.dateDrivenTerms.retrieve(id, { ...params }) -> DateDrivenTerm
• client.qbd.dateDrivenTerms.list({ ...params }) -> DateDrivenTermListResponse

DiscountItems

Types:

• DiscountItem

Methods:

• client.qbd.discountItems.create({ ...params }) -> DiscountItem
• client.qbd.discountItems.retrieve(id, { ...params }) -> DiscountItem
• client.qbd.discountItems.update(id, { ...params }) -> DiscountItem
• client.qbd.discountItems.list({ ...params }) -> DiscountItemsCursorPage

Employees

Types:

• Employee

Methods:

• client.qbd.employees.create({ ...params }) -> Employee
• client.qbd.employees.retrieve(id, { ...params }) -> Employee
• client.qbd.employees.update(id, { ...params }) -> Employee
• client.qbd.employees.list({ ...params }) -> EmployeesCursorPage

Estimates

Types:

• Estimate
• EstimateDeleteResponse

Methods:

• client.qbd.estimates.create({ ...params }) -> Estimate
• client.qbd.estimates.retrieve(id, { ...params }) -> Estimate
• client.qbd.estimates.update(id, { ...params }) -> Estimate
• client.qbd.estimates.list({ ...params }) -> EstimatesCursorPage
• client.qbd.estimates.delete(id, { ...params }) -> EstimateDeleteResponse

InventoryAdjustments

Types:

• InventoryAdjustment
• InventoryAdjustmentListResponse
• InventoryAdjustmentDeleteResponse

Methods:

• client.qbd.inventoryAdjustments.create({ ...params }) -> InventoryAdjustment
• client.qbd.inventoryAdjustments.retrieve(id, { ...params }) -> InventoryAdjustment
• client.qbd.inventoryAdjustments.update(id, { ...params }) -> InventoryAdjustment
• client.qbd.inventoryAdjustments.list({ ...params }) -> InventoryAdjustmentListResponse
• client.qbd.inventoryAdjustments.delete(id, { ...params }) -> InventoryAdjustmentDeleteResponse

InventoryAssemblyItems

Types:

• InventoryAssemblyItem

Methods:

• client.qbd.inventoryAssemblyItems.create({ ...params }) -> InventoryAssemblyItem
• client.qbd.inventoryAssemblyItems.retrieve(id, { ...params }) -> InventoryAssemblyItem
• client.qbd.inventoryAssemblyItems.update(id, { ...params }) -> InventoryAssemblyItem
• client.qbd.inventoryAssemblyItems.list({ ...params }) -> InventoryAssemblyItemsCursorPage

InventoryItems

Types:

• InventoryItem

Methods:

• client.qbd.inventoryItems.create({ ...params }) -> InventoryItem
• client.qbd.inventoryItems.retrieve(id, { ...params }) -> InventoryItem
• client.qbd.inventoryItems.update(id, { ...params }) -> InventoryItem
• client.qbd.inventoryItems.list({ ...params }) -> InventoryItemsCursorPage

InventorySites

Types:

• InventorySite
• InventorySiteListResponse

Methods:

• client.qbd.inventorySites.create({ ...params }) -> InventorySite
• client.qbd.inventorySites.retrieve(id, { ...params }) -> InventorySite
• client.qbd.inventorySites.update(id, { ...params }) -> InventorySite
• client.qbd.inventorySites.list({ ...params }) -> InventorySiteListResponse

Invoices

Types:

• Invoice
• InvoiceDeleteResponse

Methods:

• client.qbd.invoices.create({ ...params }) -> Invoice
• client.qbd.invoices.retrieve(id, { ...params }) -> Invoice
• client.qbd.invoices.update(id, { ...params }) -> Invoice
• client.qbd.invoices.list({ ...params }) -> InvoicesCursorPage
• client.qbd.invoices.delete(id, { ...params }) -> InvoiceDeleteResponse

JournalEntries

Types:

• JournalEntry
• JournalEntryDeleteResponse

Methods:

• client.qbd.journalEntries.create({ ...params }) -> JournalEntry
• client.qbd.journalEntries.retrieve(id, { ...params }) -> JournalEntry
• client.qbd.journalEntries.update(id, { ...params }) -> JournalEntry
• client.qbd.journalEntries.list({ ...params }) -> JournalEntriesCursorPage
• client.qbd.journalEntries.delete(id, { ...params }) -> JournalEntryDeleteResponse

NonInventoryItems

Types:

• NonInventoryItem

Methods:

• client.qbd.nonInventoryItems.create({ ...params }) -> NonInventoryItem
• client.qbd.nonInventoryItems.retrieve(id, { ...params }) -> NonInventoryItem
• client.qbd.nonInventoryItems.update(id, { ...params }) -> NonInventoryItem
• client.qbd.nonInventoryItems.list({ ...params }) -> NonInventoryItemsCursorPage

PayrollWageItems

Types:

• PayrollWageItem

Methods:

• client.qbd.payrollWageItems.create({ ...params }) -> PayrollWageItem
• client.qbd.payrollWageItems.retrieve(id, { ...params }) -> PayrollWageItem
• client.qbd.payrollWageItems.list({ ...params }) -> PayrollWageItemsCursorPage

PurchaseOrders

Types:

• PurchaseOrder
• PurchaseOrderDeleteResponse

Methods:

• client.qbd.purchaseOrders.create({ ...params }) -> PurchaseOrder
• client.qbd.purchaseOrders.retrieve(id, { ...params }) -> PurchaseOrder
• client.qbd.purchaseOrders.update(id, { ...params }) -> PurchaseOrder
• client.qbd.purchaseOrders.list({ ...params }) -> PurchaseOrdersCursorPage
• client.qbd.purchaseOrders.delete(id, { ...params }) -> PurchaseOrderDeleteResponse

ReceivePayments

Types:

• ReceivePayment
• ReceivePaymentDeleteResponse

Methods:

• client.qbd.receivePayments.create({ ...params }) -> ReceivePayment
• client.qbd.receivePayments.retrieve(id, { ...params }) -> ReceivePayment
• client.qbd.receivePayments.update(id, { ...params }) -> ReceivePayment
• client.qbd.receivePayments.list({ ...params }) -> ReceivePaymentsCursorPage
• client.qbd.receivePayments.delete(id, { ...params }) -> ReceivePaymentDeleteResponse

SalesOrders

Types:

• SalesOrder
• SalesOrderDeleteResponse

Methods:

• client.qbd.salesOrders.create({ ...params }) -> SalesOrder
• client.qbd.salesOrders.retrieve(id, { ...params }) -> SalesOrder
• client.qbd.salesOrders.update(id, { ...params }) -> SalesOrder
• client.qbd.salesOrders.list({ ...params }) -> SalesOrdersCursorPage
• client.qbd.salesOrders.delete(id, { ...params }) -> SalesOrderDeleteResponse

SalesReceipts

Types:

• SalesReceipt
• SalesReceiptDeleteResponse

Methods:

• client.qbd.salesReceipts.create({ ...params }) -> SalesReceipt
• client.qbd.salesReceipts.retrieve(id, { ...params }) -> SalesReceipt
• client.qbd.salesReceipts.update(id, { ...params }) -> SalesReceipt
• client.qbd.salesReceipts.list({ ...params }) -> SalesReceiptsCursorPage
• client.qbd.salesReceipts.delete(id, { ...params }) -> SalesReceiptDeleteResponse

SalesRepresentatives

Types:

• SalesRepresentative
• SalesRepresentativeListResponse

Methods:

• client.qbd.salesRepresentatives.create({ ...params }) -> SalesRepresentative
• client.qbd.salesRepresentatives.retrieve(id, { ...params }) -> SalesRepresentative
• client.qbd.salesRepresentatives.update(id, { ...params }) -> SalesRepresentative
• client.qbd.salesRepresentatives.list({ ...params }) -> SalesRepresentativeListResponse

SalesTaxCodes

Types:

• SalesTaxCode
• SalesTaxCodeListResponse

Methods:

• client.qbd.salesTaxCodes.create({ ...params }) -> SalesTaxCode
• client.qbd.salesTaxCodes.retrieve(id, { ...params }) -> SalesTaxCode
• client.qbd.salesTaxCodes.update(id, { ...params }) -> SalesTaxCode
• client.qbd.salesTaxCodes.list({ ...params }) -> SalesTaxCodeListResponse

SalesTaxItems

Types:

• SalesTaxItem

Methods:

• client.qbd.salesTaxItems.create({ ...params }) -> SalesTaxItem
• client.qbd.salesTaxItems.retrieve(id, { ...params }) -> SalesTaxItem
• client.qbd.salesTaxItems.update(id, { ...params }) -> SalesTaxItem
• client.qbd.salesTaxItems.list({ ...params }) -> SalesTaxItemsCursorPage

ServiceItems

Types:

• ServiceItem

Methods:

• client.qbd.serviceItems.create({ ...params }) -> ServiceItem
• client.qbd.serviceItems.retrieve(id, { ...params }) -> ServiceItem
• client.qbd.serviceItems.update(id, { ...params }) -> ServiceItem
• client.qbd.serviceItems.list({ ...params }) -> ServiceItemsCursorPage

StandardTerms

Types:

• StandardTerm
• StandardTermListResponse

Methods:

• client.qbd.standardTerms.create({ ...params }) -> StandardTerm
• client.qbd.standardTerms.retrieve(id, { ...params }) -> StandardTerm
• client.qbd.standardTerms.list({ ...params }) -> StandardTermListResponse

SubtotalItems

Types:

• SubtotalItem

Methods:

• client.qbd.subtotalItems.create({ ...params }) -> SubtotalItem
• client.qbd.subtotalItems.retrieve(id, { ...params }) -> SubtotalItem
• client.qbd.subtotalItems.update(id, { ...params }) -> SubtotalItem
• client.qbd.subtotalItems.list({ ...params }) -> SubtotalItemsCursorPage

Transfers

Types:

• Transfer

Methods:

• client.qbd.transfers.create({ ...params }) -> Transfer
• client.qbd.transfers.retrieve(id, { ...params }) -> Transfer
• client.qbd.transfers.update(id, { ...params }) -> Transfer
• client.qbd.transfers.list({ ...params }) -> TransfersCursorPage

VendorCredits

Types:

• VendorCredit
• VendorCreditDeleteResponse

Methods:

• client.qbd.vendorCredits.create({ ...params }) -> VendorCredit
• client.qbd.vendorCredits.retrieve(id, { ...params }) -> VendorCredit
• client.qbd.vendorCredits.update(id, { ...params }) -> VendorCredit
• client.qbd.vendorCredits.list({ ...params }) -> VendorCreditsCursorPage
• client.qbd.vendorCredits.delete(id, { ...params }) -> VendorCreditDeleteResponse

Vendors

Types:

• Vendor

Methods:

• client.qbd.vendors.create({ ...params }) -> Vendor
• client.qbd.vendors.retrieve(id, { ...params }) -> Vendor
• client.qbd.vendors.update(id, { ...params }) -> Vendor
• client.qbd.vendors.list({ ...params }) -> VendorsCursorPage