Credit Memo
12 min
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 docid\ goasztqi8wczgotekytek identifies the e mail address where the invoice is sent billemail billemailclass docid\ x6nlsr2vqhr25341roqd0 identifies the e mail address where the invoice is sent classref value name docid\ goasztqi8wczgotekytek reference to the class associated with the transaction currencyref value name docid\ goasztqi8wczgotekytek reference to the currency in which all amounts on the associated transaction are expressed customermemo customermemo docid\ x6nlsr2vqhr25341roqd0 user entered message to the customer; this message is visible to end user on their transactions customerref \<font color="#e00707"> \</font> value name docid\ goasztqi8wczgotekytek the id (unique quickbooks online id) for the referenced customer/vendor customfield customfielddetails docid\ x6nlsr2vqhr25341roqd0 one of, up to three custom fields for the transaction available for custom fields so configured for the company departmentref value name docid\ goasztqi8wczgotekytek a reference to a department object specifying the location of the transaction discountlinedetail discountlinedetails docid\ x6nlsr2vqhr25341roqd0 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 \<font color="#e00707"> \</font> lineitem docid\ x6nlsr2vqhr25341roqd0 individual line items of a transaction metadata metadata docid\ goasztqi8wczgotekytek 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 docid\ goasztqi8wczgotekytek 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 docid\ goasztqi8wczgotekytek identifies the address where the goods must be shipped sparse boolean allows updating only specified properties of an object while leaving unspecified properties unchanged 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 docid\ x6nlsr2vqhr25341roqd0 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 docid\ goasztqi8wczgotekytek discountpercent decimal percentbased boolean lineitem field name data type description accountbasedexpenselinedetail accountbasedexpenselinedetail docid\ x6nlsr2vqhr25341roqd0 amount decimal description string detailtype string discountlinedetail discountlinedetail docid\ x6nlsr2vqhr25341roqd0 id string itembasedexpenselinedetail itembasedexpenselinedetail docid\ x6nlsr2vqhr25341roqd0 linenum integer salesitemlinedetail salesitemlinedetail docid\ x6nlsr2vqhr25341roqd0 taxinclusiveamt decimal accountbasedexpenselinedetail field name data type description accountref value name docid\ goasztqi8wczgotekytek billablestatus string classref value name docid\ goasztqi8wczgotekytek customerref value name docid\ goasztqi8wczgotekytek itemref value name docid\ goasztqi8wczgotekytek markupinfo markinformation docid\ x6nlsr2vqhr25341roqd0 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 docid\ goasztqi8wczgotekytek discountpercent decimal percentbased boolean itembasedexpenselinedetail field name data type description billablestatus string classref value name docid\ goasztqi8wczgotekytek customerref value name docid\ goasztqi8wczgotekytek itemref value name docid\ goasztqi8wczgotekytek markupinfo markinformation docid\ x6nlsr2vqhr25341roqd0 qty decimal receivedquantity decimal servicedate string taxamount decimal taxinclusiveamt decimal unitprice decimal salesitemlinedetail field name data type description classref value name docid\ goasztqi8wczgotekytek itemref value name docid\ goasztqi8wczgotekytek qty decimal servicedate string taxcoderef value name docid\ goasztqi8wczgotekytek unitprice decimal txntaxdetail field name data type description taxline taxline\[] totaltax decimal txntaxcoderef value name docid\ goasztqi8wczgotekytek 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
