GET
/
quickbooks-desktop
/
preferences
JavaScript
import Conductor from 'conductor-node';

const conductor = new Conductor({
  apiKey: 'sk_conductor_...',
});

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 EndUser to receive this request (e.g., "Conductor-End-User-Id: {{END_USER_ID}}").

Example:

"end_usr_1234567abcdefg"

Response

200 - application/json

Returns an object with the company file's preferences.

​
accounting
object
required

The accounting preferences for this company file.

​
financeCharges
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
object
required

The jobs and estimates preferences for this company file.

​
multiCurrency
object | null
required

The multi-currency preferences for this company file.

​
multiLocationInventory
object | null
required

The multi-location inventory preferences for this company file.

​
purchasesAndVendors
object
required

The purchases and vendors preferences for this company file.

​
reports
object
required

The reporting preferences for this company file.

​
salesAndCustomers
object
required

The sales and customers preferences for this company file.

​
salesTax
object | null
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
object | null
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
object
required

The current application access rights for this company file.

​
itemsAndInventory
object | null
required

The item inventory preferences for this company file.