Retrieve company file preferences

Changed on Apr 20, 2026

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

Request

Base URL
https://api.conductor.is/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/conductor-is/apis/conductor-api/docs/quickbooks-desktop/preferences/get.ts
A function with typed inputs. Its response is checked against the schema.

Headers

Conductor-End-User-Idstring required

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

Example:end_usr_1234567abcdefg

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
  }
}

Changes

Apr 20, 202610d4e9ebd1df Revision changes
- breaking
  response property accounting/closingDate list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property accounting/defaultTransactionClass list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property appAccessRights/automaticLoginUserName list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property financeCharges/annualInterestRate list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property financeCharges/minimumFinanceCharge list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property salesAndCustomers/defaultMarkupPercentage list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  response property salesAndCustomers/defaultShipmentOrigin list-of-types was widened by adding types null to media type application/json of response 200
- breaking
  the / response's property type changed from object null to no type for status
- breaking
  the / response's property type changed from object null to no type for status
- breaking
  the / response's property type changed from object null to no type for status
- breaking
  removed the required property // from the response with the status
- breaking
  removed the required property // from the response with the status
- breaking
  removed the required property // from the response with the status
- breaking
  removed the required property // from the response with the status
- breaking
  removed the required property // from the response with the status
- breaking
  removed the required property // from the response with the status
- info
  added subschema #2 to the response property anyOf list for the response status
- info
  added subschema #2 to the response property anyOf list for the response status
- info
  added subschema #2 to the response property anyOf list for the response status
- info
  added subschema #2 to the / response property anyOf list for the response status
- info
  added subschema #2 to the response property anyOf list for the response status
- info
  added subschema #2 to the response property anyOf list for the response status
- info
  added subschema #1 subschema #2 to the / response property anyOf list for the response status
- info
  added subschema #1 subschema #2 to the / response property anyOf list for the response status
- info
  added subschema #1 subschema #2 to the / response property anyOf list for the response status
- info
  removed the accounts enum value from the / response property for the response status
- info
  removed the items enum value from the / response property for the response status
- info
  removed the names enum value from the / response property for the response status
- info
  removed the none enum value from the / response property for the response status
- info
  removed the undefined enum value from the / response property for the response status
- info
  removed subschema #2 from the response property oneOf list for the response status
- info
  removed subschema #2 from the response property oneOf list for the response status
- info
  removed subschema #2 from the response property oneOf list for the response status
- info
  removed subschema #2 from the / response property oneOf list for the response status
- info
  removed subschema #2 from the response property oneOf list for the response status
- info
  removed subschema #2 from the response property oneOf list for the response status
Apr 20, 20268e0b7df2044d Revision changes
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  added subschema #2 to the response property oneOf list for the response status
- breaking
  added subschema #2 to the response property oneOf list for the response status
- breaking
  added subschema #2 to the response property oneOf list for the response status
- breaking
  added subschema #2 to the / response property oneOf list for the response status
- breaking
  added subschema #2 to the response property oneOf list for the response status
- breaking
  added subschema #2 to the response property oneOf list for the response status
- breaking
  the / response's property type changed from no type to object null for status
- breaking
  the / response's property type changed from no type to object null for status
- breaking
  the / response's property type changed from no type to object null for status
- warning
  added the new accounts enum value to the / response property for the response status
- warning
  added the new items enum value to the / response property for the response status
- warning
  added the new names enum value to the / response property for the response status
- warning
  added the new none enum value to the / response property for the response status
- warning
  added the new undefined enum value to the / response property for the response status
- info
  removed subschema #2 from the response property anyOf list for the response status
- info
  removed subschema #2 from the response property anyOf list for the response status
- info
  removed subschema #2 from the response property anyOf list for the response status
- info
  removed subschema #2 from the / response property anyOf list for the response status
- info
  removed subschema #2 from the response property anyOf list for the response status
- info
  removed subschema #2 from the response property anyOf list for the response status
- info
  removed subschema #1 subschema #2 from the / response property anyOf list for the response status
- info
  removed subschema #1 subschema #2 from the / response property anyOf list for the response status
- info
  removed subschema #1 subschema #2 from the / response property anyOf list for the response status
- info
  response property accounting/closingDate list-of-types was narrowed by removing types null from media type application/json of response 200
- info
  response property accounting/defaultTransactionClass list-of-types was narrowed by removing types null from media type application/json of response 200
- info
  response property appAccessRights/automaticLoginUserName list-of-types was narrowed by removing types null from media type application/json of response 200
- info
  response property financeCharges/annualInterestRate list-of-types was narrowed by removing types null from media type application/json of response 200
- info
  response property financeCharges/minimumFinanceCharge list-of-types was narrowed by removing types null from media type application/json of response 200
- info
  response property salesAndCustomers/defaultMarkupPercentage list-of-types was narrowed by removing types null from media type application/json of response 200
- info
  response property salesAndCustomers/defaultShipmentOrigin list-of-types was narrowed by removing types null from media type application/json of response 200
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status

Operation history (4 revisions)