Credit Memo

12min

When processing a Credit Memo, use the requestJSON to pass the Credit Memo data. The returned response will contain a responseJSON section with the Credit Memo response returned by Breadwinner for 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
﻿AddressWrapper﻿﻿
Identifies the e-mail address where the invoice is sent
BillEmail
﻿BillEmailClass﻿﻿
Identifies the e-mail address where the invoice is sent
ClassRef
﻿value_name﻿﻿
Reference to the Class associated with the transaction.
CurrencyRef
﻿value_name﻿﻿
Reference to the currency in which all amounts on the associated transaction are expressed
CustomerMemo
﻿CustomerMemo﻿﻿
User-entered message to the customer; this message is visible to end user on their transactions
CustomerRef*﻿
﻿value_name﻿﻿
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
﻿value_name﻿﻿
A reference to a Department object specifying the location of the transaction
DiscountLineDetail
﻿DiscountLineDetails﻿﻿
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
﻿Metadata﻿﻿
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
﻿value_name﻿﻿
﻿
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
﻿AddressWrapper﻿﻿
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
﻿value_name﻿﻿
﻿
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
﻿value_name﻿﻿
﻿
BillableStatus
String
﻿
ClassRef
﻿value_name﻿﻿
﻿
CustomerRef
﻿value_name﻿﻿
﻿
ItemRef
﻿value_name﻿﻿
﻿
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
﻿value_name﻿﻿
﻿
DiscountPercent
Decimal
﻿
PercentBased
Boolean
﻿
ItemBasedExpenseLineDetail
Field Name
Data Type 
Description
BillableStatus
String
﻿
ClassRef
﻿value_name﻿﻿
﻿
CustomerRef
﻿value_name﻿﻿
﻿
ItemRef
﻿value_name﻿﻿
﻿
MarkupInfo
﻿MarkInformation﻿﻿
﻿
Qty
Decimal
﻿
ReceivedQuantity
Decimal
﻿
ServiceDate
String
﻿
TaxAmount
Decimal
﻿
TaxInclusiveAmt
Decimal
﻿
UnitPrice
Decimal
﻿
SalesItemLineDetail
Field Name
Data Type 
Description
ClassRef
﻿value_name﻿﻿
﻿
ItemRef
﻿value_name﻿﻿
﻿
Qty
Decimal
﻿
ServiceDate
String
﻿
TaxCodeRef
﻿value_name﻿﻿
﻿
UnitPrice
Decimal
﻿
TxnTaxDetail
Field Name
Data Type 
Description
TaxLine
TaxLine[]
﻿
TotalTax
Decimal
﻿
TxnTaxCodeRef
﻿value_name﻿﻿
﻿
CustomerMemo
Field Name
Data Type 
Description
value
String
User-entered message to the customer; this message is visible to the end user on their transactions.

Field Name	Data Type	Description
Balance	Decimal	The balance reflecting any payments made against the transaction. Read Only
BillAddr	AddressWrapper	Identifies the e-mail address where the invoice is sent
BillEmail	BillEmailClass	Identifies the e-mail address where the invoice is sent
ClassRef	value_name	Reference to the Class associated with the transaction.
CurrencyRef	value_name	Reference to the currency in which all amounts on the associated transaction are expressed
CustomerMemo	CustomerMemo	User-entered message to the customer; this message is visible to end user on their transactions
CustomerRef*	value_name	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	value_name	A reference to a Department object specifying the location of the transaction
DiscountLineDetail	DiscountLineDetails	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	Metadata	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	value_name
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	AddressWrapper	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

Field Name	Data Type	Description
Address	String

Field Name	Data Type	Description
DefinitionId	String
Name	String
Type	String
StringValue	String

Field Name	Data Type	Description
DiscountAccountRef	value_name
DiscountPercent	Decimal
PercentBased	Boolean

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

Field Name	Data Type	Description
AccountRef	value_name
BillableStatus	String
ClassRef	value_name
CustomerRef	value_name
ItemRef	value_name
MarkupInfo	MarkInformation
Qty	Decimal
ServiceDate	String
TaxAmount	Decimal
TaxInclusiveAmt	Decimal
UnitPrice	Decimal

Field Name	Data Type	Description
Percent	Decimal

Field Name	Data Type	Description
DiscountAccountRef	value_name
DiscountPercent	Decimal
PercentBased	Boolean

Field Name	Data Type	Description
BillableStatus	String
ClassRef	value_name
CustomerRef	value_name
ItemRef	value_name
MarkupInfo	MarkInformation
Qty	Decimal
ReceivedQuantity	Decimal
ServiceDate	String
TaxAmount	Decimal
TaxInclusiveAmt	Decimal
UnitPrice	Decimal

Field Name	Data Type	Description
ClassRef	value_name
ItemRef	value_name
Qty	Decimal
ServiceDate	String
TaxCodeRef	value_name
UnitPrice	Decimal

Field Name	Data Type	Description
TaxLine	TaxLine[]
TotalTax	Decimal
TxnTaxCodeRef	value_name

Field Name	Data Type	Description
value	String	User-entered message to the customer; this message is visible to the end user on their transactions.

Updated 14 May 2024

Did this page help you?

Update

Read