---
title: Credit Memo
slug: quickbooks/credit-memo
description: Learn how to request a Credit Memo and understand the parameters of the Credit Memo object in QuickBooks. This document provides detailed information on various parameters such as balance, billing address, email, currency, and more. Explore data types and
docTags:
createdAt: 2021-10-29T11:15:08.000Z
---
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* | [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* | [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. |