QuickBooks: Read a credit memo — response body — Credit Memo

API reference · Contract 2026-10-20

SDK schema: Read a credit memo — response body — Credit Memo

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: allowed
ApplyTaxAfterDiscount	JSON	Optional	If false or null, calculate the sales tax first, and then apply the discount. If true, subtract the discount first and then calculate the sales tax. US versions of QuickBooks only.
ApplyTaxAfterDiscount (anyOf 1)	boolean	Alternative
ApplyTaxAfterDiscount (anyOf 2)	string	Alternative	Known values: true, false
Balance	JSON	Optional	The balance reflecting any payments made against the transaction. Initially set to the value of TotalAmt . A Balance of 0 indicates the invoice is fully paid. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true
Balance (anyOf 1)	JSON	Alternative
Balance (anyOf 1) (anyOf 1)	number	Alternative
Balance (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Balance (anyOf 2)	string	Alternative
BillAddr	Model	Optional	Expand Create a vendor — request body — body Bill Addr Bill-to address of the credit memo. If BillAddr is not specified, and a default Customer:BillingAddr is specified in QuickBooks for this customer, the default bill-to address is used by QuickBooks. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
BillEmail	Model	Optional	Expand Full update companyinfo — request body — body Email Identifies the e-mail address where the credit-memo is sent. If EmailStatus=NeedToSend , BillEmail is a required input. Conditionally required
ClassRef	Model	Optional	Expand Read an item — response body — Item Class Ref Reference to the Class associated with the transaction. Available if Preferences.AccountingInfoPrefs.ClassTrackingPerLine is set to true . Query the Class name list resource to determine the appropriate Class object for this reference. Use Class.Id and Class.Name from that object for ClassRef.value and ClassRef.name , respectively.
CurrencyRef	Model	Optional	Expand Read a bill — response body — Bill Currency Ref Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true . Read more about multicurrency support here . Required if multicurrency is enabled for the company. Conditionally required
CustomField	array	Optional	One of, up to three custom fields for the transaction. Available for custom fields so configured for the company. Check Preferences.SalesFormsPrefs.CustomField and Preferences.VendorAndPurchasesPrefs.POCustomField for custom fields currenly configured. Click here to learn about managing custom fields.
CustomField[]	Model	Each item	Expand Read an invoice — response body — Invoice Custom Field item
CustomerMemo	Model	Optional	Expand Read an invoice — response body — Invoice Customer Memo User-entered message to the customer; this message is visible to end user on their transactions.
CustomerRef	Model	Optional	Expand Read an item — response body — Item Class Ref Reference to a customer or job. Query the Customer name list resource to determine the appropriate Customer object for this reference. Use Customer.Id and Customer.DisplayName from that object for CustomerRef.value and CustomerRef.name , respectively.
DepartmentRef	Model	Optional	Expand Read an item — response body — Item Class Ref A reference to a Department object specifying the location of the transaction. Available if Preferences.AccountingInfoPrefs.TrackDepartments is set to true . Query the Department name list resource to determine the appropriate department object for this reference. Use Department.Id and Department.Name from that object for DepartmentRef.value and DepartmentRef.name , respectively.
DocNumber	string	Optional	Reference number for the transaction. If not explicitly provided at create time, this field is populated based on the setting of Preferences:CustomTxnNumber as follows: If Preferences:CustomTxnNumber is true a custom value can be provided. If no value is supplied, the resulting DocNumber is null. If Preferences:CustomTxnNumber is false, resulting DocNumber is system generated by incrementing the last number by 1. If Preferences:CustomTxnNumber is false then do not send a value as it can lead to unwanted duplicates. If a DocNumber value is sent for an Update operation, then it just updates that particular invoice and does not alter the internal system DocNumber. Note: DocNumber is an optional field for all locales except France. For France locale if Preferences:CustomTxnNumber is enabled it will not be automatically generated and is a required field.
EmailStatus	string	Optional	Email status of the credit-memo. Valid values: NotSet , NeedToSend , EmailSent
ExchangeRate	JSON	Optional	The number of home currency units it takes to equal one unit of currency specified by CurrencyRef . Applicable if multicurrency is enabled for the company. Decimal string
ExchangeRate (anyOf 1)	JSON	Alternative
ExchangeRate (anyOf 1) (anyOf 1)	number	Alternative
ExchangeRate (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
ExchangeRate (anyOf 2)	string	Alternative
GlobalTaxCalculation	string	Optional	Method in which tax is applied. Allowed values are: TaxExcluded , TaxInclusive , and NotApplicable . Not applicable to US companies; required for non-US companies. Conditionally required
HomeBalance	JSON	Optional	Convenience field containing the amount in Balance expressed in terms of the home currency. Calculated by QuickBooks business logic. Value is valid only when CurrencyRef is specified. Applicable if multicurrency is enabled for the company. Decimal string Read only: true
HomeBalance (anyOf 1)	JSON	Alternative
HomeBalance (anyOf 1) (anyOf 1)	number	Alternative
HomeBalance (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
HomeBalance (anyOf 2)	string	Alternative
HomeTotalAmt	JSON	Optional	Total amount of the transaction in the home currency. Includes the total of all the charges, allowances and taxes. Calculated by QuickBooks business logic. Value is valid only when CurrencyRef is specified. Applicable if multicurrency is enabled for the company. Decimal string Read only: true
HomeTotalAmt (anyOf 1)	JSON	Alternative
HomeTotalAmt (anyOf 1) (anyOf 1)	number	Alternative
HomeTotalAmt (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
HomeTotalAmt (anyOf 2)	string	Alternative
Id	string	Optional	Unique identifier for this object. Read only: true
Line	array	Optional	Individual line items of a transaction. Valid Line types include: SalesItemLine , GroupLine , DescriptionOnlyLine , DiscountLine and SubTotalLine
Line[]	JSON	Each item
Line[] (anyOf 1)	Model	Alternative	Expand Read an invoice — response body — Invoice Line item Amount, Custom Extensions, Description, Detail Type, Id, Line Num, Sales Item Line Detail
Line[] (anyOf 2)	Model	Alternative	Expand Read an invoice — response body — Invoice Line item Custom Extensions, Description, Detail Type, Group Line Detail, Id, Line Num
Line[] (anyOf 3)	Model	Alternative	Expand Read an invoice — response body — Invoice Line item Amount, Description, Description Line Detail, Detail Type, Id, Line Num
Line[] (anyOf 4)	Model	Alternative	Expand Read an invoice — response body — Invoice Line item Amount, Description, Detail Type, Discount Line Detail, Id, Line Num
Line[] (anyOf 5)	Model	Alternative	Expand Read an invoice — response body — Invoice Line item Amount, Description, Detail Type, Id, Line Num, Sub Total Line Detail
MetaData	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
PaymentMethodRef	Model	Optional	Expand Read an item — response body — Item Class Ref Reference to a PaymentMethod associated with this transaction. Query the PaymentMethod name list resource to determine the appropriate PaymentMethod object for this reference. Use PaymentMethod.Id and PaymentMethod.Name from that object for PaymentMethodRef.value and PaymentMethodRef.name , respectively. Read only: true
PrintStatus	string	Optional	Printing status of the credit-memo. Valid values: NotSet , NeedToPrint , PrintComplete .
PrivateNote	string	Optional	User entered, organization-private note about the transaction. This note does not appear on the deposit form.
ProjectRef	Model	Optional	Expand Read an item — response body — Item Class Ref Reference to the Project ID associated with this transaction. Conditionally required
RecurDataRef	Model	Optional	Expand Read an item — response body — Item Class Ref A reference to the Recurring Transaction. It captures what recurring transaction template the CreditMemo was created from. Read only: true
RemainingCredit	JSON	Optional	Indicates the total credit amount still available to apply towards the payment. Decimal string Read only: true
RemainingCredit (anyOf 1)	JSON	Alternative
RemainingCredit (anyOf 1) (anyOf 1)	number	Alternative
RemainingCredit (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
RemainingCredit (anyOf 2)	string	Alternative
SalesTermRef	Model	Optional	Expand Read an item — response body — Item Class Ref Reference to the sales term associated with the transaction. Query the Term name list resource to determine the appropriate Term object for this reference. Use Term.Id and Term.Name from that object for SalesTermRef.value and SalesTermRef.name , respectively.
ShipAddr	Model	Optional	Expand Create a vendor — request body — body Bill Addr Identifies the address where the goods must be shipped. If ShipAddr is not specified, and a default Customer:ShippingAddr is specified in QuickBooks for this customer, the default ship-to address will be used by QuickBooks. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created: Line1 and Line2 elements are populated with the customer name and company name. Original Line1 through Line 5 contents, City , SubDivisionCode , and PostalCode flow into Line3 through Line5 as a free format strings.
SyncToken	string	Optional	Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online. Read only: true
TaxExemptionRef	Model	Optional	Expand Read an item — response body — Item Class Ref Reference to the TaxExepmtion ID associated with this object. Available for companies that have automated sales tax enabled. TaxExemptionRef.Name : The Tax Exemption Id for the customer to which this object is associated. This Id is typically issued by the state. TaxExemptionRef.value : The system-generated Id of the exemption type. For internal use only. Read only: true
TotalAmt	JSON	Optional	Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string
TotalAmt (anyOf 1)	JSON	Alternative
TotalAmt (anyOf 1) (anyOf 1)	number	Alternative
TotalAmt (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
TotalAmt (anyOf 2)	string	Alternative
TxnDate	string	Optional	The date entered by the user when this transaction occurred. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default.
TxnTaxDetail	Model	Optional	Expand Read a bill — response body — Bill Txn Tax Detail This data type provides information for taxes charged on the transaction as a whole. It captures the details sales taxes calculated for the transaction based on the tax codes referenced by the transaction. This can be calculated by QuickBooks business logic or you may supply it when adding a transaction. See Global tax model for more information about this element. If sales tax is disabled ( Preferences.TaxPrefs.UsingSalesTax is set to false ) then TxnTaxDetail is ignored and not stored.

Referenced models: Read a bill — response body — Bill Currency Ref, Read an invoice — response body — Invoice Custom Field item, Read an invoice — response body — Invoice Line item Amount, Description, Description Line Detail, Detail Type, Id, Line Num, Read an invoice — response body — Invoice Line item Amount, Description, Detail Type, Discount Line Detail, Id, Line Num, Full update companyinfo — request body — body Email, Read an invoice — response body — Invoice Line item Custom Extensions, Description, Detail Type, Group Line Detail, Id, Line Num, Read an invoice — response body — Invoice Customer Memo, Read a bill — response body — Bill Meta Data, Create a vendor — request body — body Bill Addr, Read an item — response body — Item Class Ref, Read an invoice — response body — Invoice Line item Amount, Custom Extensions, Description, Detail Type, Id, Line Num, Sales Item Line Detail, Read an invoice — response body — Invoice Line item Amount, Description, Detail Type, Id, Line Num, Sub Total Line Detail, Read a bill — response body — Bill Txn Tax Detail