v48

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-262621423.8 MB

Retrieve company file preferences

Returns the preferences that the QuickBooks administrator has set for all users of the connected company file. Note that preferences cannot be modified through the API, only through the QuickBooks Desktop user interface.

get/quickbooks-desktop/preferences

Headers

Conductor-End-User-Idstring required

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

Example:end_usr_1234567abcdefg

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

Response

Returns an object with the company file's preferences.

Example response

{
  "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"
    },
    "calculateChargesFrom": "due_date"
  },
  "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
    }
  },
  "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
  },
  "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
  }
}