Skip to content

QuickBooks: Read preferences — response body — Preferences Sales Forms Prefs

Read preferences: response body, field Preferences / SalesFormsPrefs. Complete fields and constraints for contract 2026-10-20.

API reference · Contract 2026-10-20

SDK schema: Read preferences — response body — Preferences Sales Forms Prefs

FieldTypePresenceDescription and constraints
$objectRootAdditional keys: allowed
AllowDepositJSONOptionalEnables specifying Deposit.
AllowDeposit (anyOf 1)booleanAlternative
AllowDeposit (anyOf 2)stringAlternativeKnown values: true, false
AllowDiscountJSONOptionalEnables specifying Discount.
AllowDiscount (anyOf 1)booleanAlternative
AllowDiscount (anyOf 2)stringAlternativeKnown values: true, false
AllowEstimatesJSONOptionalEnables specifying Estimates.
AllowEstimates (anyOf 1)booleanAlternative
AllowEstimates (anyOf 2)stringAlternativeKnown values: true, false
AllowServiceDateJSONOptionalEnables specifying service date.
AllowServiceDate (anyOf 1)booleanAlternative
AllowServiceDate (anyOf 2)stringAlternativeKnown values: true, false
AllowShippingJSONOptionalEnables specifying shipping info.
AllowShipping (anyOf 1)booleanAlternative
AllowShipping (anyOf 2)stringAlternativeKnown values: true, false
AutoApplyCreditJSONOptionalAutomatically applies credits to the next invoice you create for the same customer. Most companies turn on this setting.
Read only: true
AutoApplyCredit (anyOf 1)booleanAlternative
AutoApplyCredit (anyOf 2)stringAlternativeKnown values: true, false
CustomFieldarrayOptional
CustomField[]objectEach itemAdditional keys: allowed
CustomField[].CustomFieldarrayOptional
CustomField[].CustomField[]JSONEach item
CustomField[].CustomField[] (anyOf 1)ModelAlternativeExpand Read preferences — response body — Preferences Sales Forms Prefs Custom Field item Custom Field item Boolean Value, Name, Type
CustomField[].CustomField[] (anyOf 2)ModelAlternativeExpand Full update preferences — request body — body Sales Forms Prefs Custom Field item Custom Field item Name, String Value, Type
CustomTxnNumbersJSONOptionalEnables the ability to specify custom transaction numbers for sales transactions.
CustomTxnNumbers (anyOf 1)booleanAlternative
CustomTxnNumbers (anyOf 2)stringAlternativeKnown values: true, false
DefaultCustomerMessagestringOptionalDefault customer message.
DefaultDiscountAccountstringOptional
DefaultShippingAccountJSONOptionalDefault shipping account.
DefaultShippingAccount (anyOf 1)booleanAlternative
DefaultShippingAccount (anyOf 2)stringAlternativeKnown values: true, false
DefaultTermsModelOptionalExpand Read an item — response body — Item Class Ref
Default sales terms.
ETransactionAttachPDFJSONOptionalSpecifies whether sales form PDF should be attached with ETransaction mails.
ETransactionAttachPDF (anyOf 1)booleanAlternative
ETransactionAttachPDF (anyOf 2)stringAlternativeKnown values: true, false
ETransactionEnabledStatusstringOptionalEnables ETransaction status.
Read only: true
ETransactionPaymentEnabledJSONOptionalEnables ETransaction payment.
ETransactionPaymentEnabled (anyOf 1)booleanAlternative
ETransactionPaymentEnabled (anyOf 2)stringAlternativeKnown values: true, false
EmailCopyToCompanyJSONOptionalIf set to true, the QuickBooks company is cc’ed on all email sent to customers for sales transactions. Email used is that defined with CompanyInfo.Email.Address .
EmailCopyToCompany (anyOf 1)booleanAlternative
EmailCopyToCompany (anyOf 2)stringAlternativeKnown values: true, false
EstimateMessagestringOptionalMessage to the customers on estimates.
Read only: true
IPNSupportEnabledJSONOptionalIPN support enabled. No longer used and is being deprecated.
Read only: true
IPNSupportEnabled (anyOf 1)booleanAlternative
IPNSupportEnabled (anyOf 2)stringAlternativeKnown values: true, false
SalesEmailBccModelOptionalExpand Full update companyinfo — request body — body Email
Default blind carbon copy email address where invoices are sent. Override this setting with the Invoice.BillEmailBcc attribute. Max 200 characters. Ignored if address is invalid.
SalesEmailCcModelOptionalExpand Full update companyinfo — request body — body Email
Default carbon copy email address where invoices are sent. Override this setting with the Invoice.BillEmailCc attribute. Max 200 characters. Ignored if address is invalid.
UsingPriceLevelsJSONOptionalIf set to true, price levels are enabled for sales transactions. Full price level support available via QuickBooks UI, only, in April 2017.
Read only: true
UsingPriceLevels (anyOf 1)booleanAlternative
UsingPriceLevels (anyOf 2)stringAlternativeKnown values: true, false
UsingProgressInvoicingJSONOptionalEnables Progress Invoicing
Read only: true
UsingProgressInvoicing (anyOf 1)booleanAlternative
UsingProgressInvoicing (anyOf 2)stringAlternativeKnown values: true, false

Referenced models: Read preferences — response body — Preferences Sales Forms Prefs Custom Field item Custom Field item Boolean Value, Name, Type, Full update preferences — request body — body Sales Forms Prefs Custom Field item Custom Field item Name, String Value, Type, Full update companyinfo — request body — body Email, Read an item — response body — Item Class Ref

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.