Skip to main content
GET
/
quickbooks-desktop
/
preferences
JavaScript
import Conductor from 'conductor-node';

const conductor = new Conductor({
  apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted
});

const preferences = await conductor.qbd.preferences.retrieve({
  conductorEndUserId: 'end_usr_1234567abcdefg',
});

console.log(preferences.accounting);
{
  "accounting": {
    "isUsingAccountNumbers": true,
    "isRequiringAccounts": true,
    "isUsingClassTracking": true,
    "defaultTransactionClass": "accounts",
    "isUsingAuditTrail": true,
    "isAssigningJournalEntryNumbers": true,
    "closingDate": "2024-12-31"
  },
  "financeCharges": {
    "annualInterestRate": 0.05,
    "minimumFinanceCharge": 100,
    "gracePeriod": 30,
    "financeChargeAccount": {
      "id": "80000001-1234567890",
      "fullName": "Interest Income"
    },
    "isAssessingForOverdueCharges": false,
    "calculateChargesFrom": "due_date",
    "isMarkedToBePrinted": false
  },
  "jobsAndEstimates": {
    "isUsingEstimates": true,
    "isUsingProgressInvoicing": true,
    "isPrintingItemsWithZeroAmounts": true
  },
  "multiCurrency": {
    "isMultiCurrencyEnabled": true,
    "homeCurrency": {
      "id": "80000001-1234567890",
      "fullName": "USD"
    }
  },
  "multiLocationInventory": {
    "isMultiLocationInventoryAvailable": true,
    "isMultiLocationInventoryEnabled": true
  },
  "purchasesAndVendors": {
    "isUsingInventory": true,
    "daysBillsAreDue": 30,
    "isAutomaticallyUsingDiscounts": true,
    "defaultDiscountAccount": {
      "id": "80000001-1234567890",
      "fullName": "Discount Account"
    }
  },
  "reports": {
    "agingReportBasis": "age_from_due_date",
    "summaryReportBasis": "accrual"
  },
  "salesAndCustomers": {
    "defaultShippingMethod": {
      "id": "80000001-1234567890",
      "fullName": "FedEx Ground"
    },
    "defaultShipmentOrigin": "San Francisco, CA",
    "defaultMarkupPercentage": "25",
    "isTrackingReimbursedExpensesAsIncome": true,
    "isAutoApplyingPayments": true,
    "priceLevels": {
      "isUsingPriceLevels": true,
      "isRoundingSalesPriceUp": false
    }
  },
  "salesTax": {
    "defaultItemSalesTax": {
      "id": "80000001-1234567890",
      "fullName": "State Sales Tax"
    },
    "salesTaxReportingFrequency": "quarterly",
    "defaultTaxableSalesTaxCode": {
      "id": "80000001-1234567890",
      "fullName": "Tax"
    },
    "defaultNonTaxableSalesTaxCode": {
      "id": "80000001-1234567890",
      "fullName": "Non"
    },
    "isUsingVendorTaxCode": true,
    "isUsingCustomerTaxCode": true,
    "isUsingTaxInclusivePrices": false
  },
  "timeTracking": {
    "firstDayOfWeek": "monday"
  },
  "appAccessRights": {
    "isAutomaticLoginAllowed": true,
    "automaticLoginUserName": "admin",
    "isPersonalDataAccessAllowed": true
  },
  "itemsAndInventory": {
    "isEnhancedInventoryReceivingEnabled": true,
    "inventoryTrackingMethod": "serial_number",
    "isInventoryExpirationDateEnabled": true,
    "isTrackingOnSalesTransactionsEnabled": true,
    "isTrackingOnPurchaseTransactionsEnabled": true,
    "isTrackingOnInventoryAdjustmentEnabled": true,
    "isTrackingOnBuildAssemblyEnabled": true,
    "isFifoEnabled": true,
    "fifoEffectiveDate": "2023-01-01",
    "isBinTrackingEnabled": true,
    "isBarcodeEnabled": true
  }
}

Authorizations

​
Authorization
string
header
required

Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}").

Headers

​
Conductor-End-User-Id
string
required

The ID of the End-User to receive this request.

Example:

"end_usr_1234567abcdefg"

Response

200 - application/json

Returns an object with the company file's preferences.

​
accounting
The Accounting Preferences object · object
required

The accounting preferences for this company file.

​
financeCharges
The Finance Charge Preferences object · object
required

The finance charge preferences for this company file. These settings determine how late payment charges are calculated and applied to customer accounts.

​
jobsAndEstimates
The Jobs and Estimates Preferences object · object
required

The jobs and estimates preferences for this company file.

​
multiCurrency
The Multi-Currency Preferences object · object
required

The multi-currency preferences for this company file.

​
multiLocationInventory
The Multi-Location Inventory Preferences object · object
required

The multi-location inventory preferences for this company file.

​
purchasesAndVendors
The Purchases and Vendors Preferences object · object
required

The purchases and vendors preferences for this company file.

​
reports
The Reports Preferences object · object
required

The reporting preferences for this company file.

​
salesAndCustomers
The Sales and Customers Preferences object · object
required

The sales and customers preferences for this company file.

​
salesTax
The Sales Tax Preferences object · object
required

The sales-tax preferences for this company file. If sales tax is turned off in the user interface (that is, if "No" is selected for "Do You Charge Sales Tax?" in the sales tax preferences), then this field will be null.

​
timeTracking
Time tracking preferences · object
required

The time-tracking preferences for this company file. If time tracking is turned off in the user interface (that is, if "No" is selected for "Do You Track Time?" in the time tracking preferences), then this field will be null.

​
appAccessRights
The Current App Access Rights object · object
required

The current application access rights for this company file.

​
itemsAndInventory
The Items and Inventory Preferences object · object
required

The item inventory preferences for this company file.