Preferences
Retrieve company file preferences
QuickBooks Desktop API
Core Resources
- Auth Sessions
- End Users
Utilities
Transactions
- All Transactions
- Bill Check Payments
- Bill Credit Card Payments
- Bills
- Checks
- Credit Card Charges
- Credit Card Credits
- Credit Memos
- Estimates
- Inventory Adjustments
- Invoices
- Item Receipts
- Journal Entries
- Purchase Orders
- Receive-Payments
- Sales Orders
- Sales Receipts
- Time Tracking Activities
- Transfers
- Vendor Credits
General
- Account Tax Lines
- Accounts
- Classes
- Company
- Customers / Jobs
- Date-Driven Terms
- Employees
- Inventory Sites
- Payment Methods
- Payroll Wage Items
- Preferences
- Price Levels
- Sales Representatives
- Sales-Tax Codes
- Standard Terms
- Vendors
Items
- Discount Items
- Inventory Assembly Items
- Inventory Items
- Item Groups
- Item Sites
- Non-Inventory Items
- Sales-Tax Items
- Service Items
- Subtotal Items
Preferences
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
import Conductor from 'conductor-node';
const client = new Conductor({
apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted
});
async function main() {
const preferences = await client.qbd.preferences.retrieve({ conductorEndUserId: 'end_usr_1234567abcdefg' });
console.log(preferences.accounting);
}
main();
{
"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
Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}"
).
Headers
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.
The response is of type object
.
import Conductor from 'conductor-node';
const client = new Conductor({
apiKey: process.env['CONDUCTOR_SECRET_KEY'], // This is the default and can be omitted
});
async function main() {
const preferences = await client.qbd.preferences.retrieve({ conductorEndUserId: 'end_usr_1234567abcdefg' });
console.log(preferences.accounting);
}
main();
{
"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
}
}