Credit Memo

12min

When requesting a Credit Memo, use the requestJSON to pass the Credit Memo data, and the response will have responseJSON which stores the Credit Memos response returned by QuickBooks.
The Credit Memo object has the following parameters.
Credit Memo
Field Name
Data Type 
Description
Balance
Decimal
The balance reflecting any payments made against the transaction. Read Only
BillAddr
﻿Common Data Types﻿﻿
Identifies the e-mail address where the invoice is sent
BillEmail
﻿BillEmailClass﻿
Identifies the e-mail address where the invoice is sent
ClassRef
﻿Common Data Types﻿﻿
Reference to the Class associated with the transaction.
CurrencyRef
﻿Common Data Types﻿﻿
Reference to the currency in which all amounts on the associated transaction are expressed
CustomerMemo
﻿Common Data Types﻿﻿
User-entered message to the customer; this message is visible to end user on their transactions
CustomerRef*﻿
﻿Common Data Types﻿﻿
The ID (Unique QuickBooks Online ID) for the referenced customer/vendor
CustomField
﻿CustomFieldDetails﻿
One of, up to three custom fields for the transaction. Available for custom fields so configured for the company
DepartmentRef
﻿Common Data Types﻿﻿
A reference to a Department object specifying the location of the transaction
DiscountLineDetail
﻿DiscountDetails﻿
Discount detail type for the entire transaction
DocNumber
String
﻿
EmailStatus
String
Email status of the invoice. Valid values: NotSet, NeedToSend, EmailSent
ExchangeRate
Decimal
The number of home currency units it takes to equal one unit of currency specified by CurrencyRef
GlobalTaxCalculation
String
Fixed values (NotApplicable, TaxInclusive)
HomeBalance
Decimal
Read Only
Line*﻿
﻿LineItem﻿
Individual line items of a transaction
Metadata
﻿Common Data Types﻿﻿
Descriptive information about the object. The MetaData values are set by Data Services and are read only
PrivateNote
String
User entered, organization-private note about the transaction
PaymentMethodRef
﻿Common Data Types﻿﻿
﻿
PaymentRefNum
String
﻿
Salesforce_Account_Id
String
To map Credit Memo with Salesforce Account
Salesforce_Opportunity_Id
String
To map Credit Memo with Salesforce Opportunity.
ShipAddr
﻿Common Data Types﻿﻿
Identifies the address where the goods must be shipped
SyncToken
String
Version number of the object. It is used to lock an object for use by one app at a time. Read Only
TotalAmt
Decimal
Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. Read Only
TxnDate
String
The date entered by the user when this transaction occurred. (add by converting date to string)
TxnTaxDetail
﻿TxnTaxDetail﻿
This data type provides information for taxes charged on the transaction as a whole.
Type
String
﻿
BillEmailClass
Field Name
Data Type 
Description
Address
String
﻿
CustomFieldDetails 
Field Name
Data Type 
Description
DefinitionId
String
﻿
Name
String
﻿
Type
String
﻿
StringValue
String
﻿
DiscountDetails
Field Name
Data Type 
Description
DiscountAccountRef
﻿Common Data Types﻿﻿
﻿
DiscountPercent
Decimal
﻿
PercentBased
Boolean
﻿
LineItem 
Field Name
Data Type 
Description
AccountBasedExpenseLineDetail
﻿AccountBasedExpenseLineDetail﻿
﻿
Amount
Decimal
﻿
Description
String
﻿
DetailType
String
﻿
DiscountLineDetail
﻿DiscountLineDetail﻿
﻿
Id
String
﻿
ItemBasedExpenseLineDetail
﻿ItemBasedExpenseLineDetail﻿
﻿
LineNum
Integer
﻿
SalesItemLineDetail
﻿SalesItemLineDetail﻿
﻿
TaxInclusiveAmt
Decimal
﻿
AccountBasedExpenseLineDetail
Field Name
Data Type 
Description
AccountRef
﻿Common Data Types﻿﻿
﻿
BillableStatus
String
﻿
ClassRef
﻿Common Data Types﻿﻿
﻿
CustomerRef
﻿Common Data Types﻿﻿
﻿
ItemRef
﻿Common Data Types﻿﻿
﻿
MarkupInfo
﻿MarkInformation﻿
﻿
Qty
Decimal
﻿
ServiceDate
String
﻿
TaxAmount
Decimal
﻿
TaxInclusiveAmt
Decimal
﻿
UnitPrice
Decimal
﻿
MarkInformation
Field Name
Data Type 
Description
Percent
Decimal
﻿
DiscountLineDetail
Field Name
Data Type 
Description
DiscountAccountRef
﻿Common Data Types﻿﻿
﻿
DiscountPercent
Decimal
﻿
PercentBased
Boolean
﻿
ItemBasedExpenseLineDetail
Field Name
Data Type 
Description
BillableStatus
String
﻿
ClassRef
﻿Common Data Types﻿﻿
﻿
CustomerRef
﻿Common Data Types﻿﻿
﻿
ItemRef
﻿Common Data Types﻿﻿
﻿
MarkupInfo
﻿MarkInformation﻿
﻿
Qty
Decimal
﻿
ReceivedQuantity
Decimal
﻿
ServiceDate
String
﻿
TaxAmount
Decimal
﻿
TaxInclusiveAmt
Decimal
﻿
UnitPrice
Decimal
﻿
SalesItemLineDetail
Field Name
Data Type 
Description
ClassRef
﻿Common Data Types﻿﻿
﻿
ItemRef
﻿Common Data Types﻿﻿
﻿
Qty
Decimal
﻿
ServiceDate
String
﻿
TaxCodeRef
﻿Common Data Types﻿﻿
﻿
UnitPrice
Decimal
﻿
TxnTaxDetail
Field Name
Data Type 
Description
TaxLine
TaxLine[]
﻿
TotalTax
Decimal
﻿
TxnTaxCodeRef
﻿Common Data Types﻿﻿
﻿
﻿