import Conductor from 'conductor-node';
const conductor = new Conductor({
apiKey: 'My API Key',
});
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
}
}
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.
import Conductor from 'conductor-node';
const conductor = new Conductor({
apiKey: 'My API Key',
});
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
}
}
Your Conductor secret key using Bearer auth (e.g., "Authorization: Bearer {{YOUR_SECRET_KEY}}"
).
The ID of the EndUser to receive this request (e.g., "Conductor-End-User-Id: {{END_USER_ID}}"
).
"end_usr_1234567abcdefg"
Returns an object with the company file's preferences.
The response is of type object
.