CreditMemos

Columns

Name

Type

ReadOnly

References

Filterable

Sortable

Description

Id [KEY]

String

True

false

false

The Id of the credit memo.

SyncToken

String

True

false

false

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.

MetaData_CreateTime

Datetime

True

true

true

The time the record was created.

MetaData_LastUpdatedTime

Datetime

True

true

true

The time the record was last updated.

CustomFieldAggregate

String

False

false

false

An XML aggregate of custom fields for the credit memo.

DocNumber

String

False

true

true

The reference number for the transaction.

TxnDate

Date

False

true

true

The date when this transaction occurred.

PrivateNote

String

False

false

false

The private note about the transaction.

LineAggregate

String

False

false

false

An XML aggregate of line items on the credit memo.

TxnTaxDetail_TxnTaxCodeRef

String

False

TaxCodes.Id

false

false

The tax code for the transaction.

TxnTaxDetail_TotalTax

String

False

false

false

The total tax calculated for the transaction, excluding any tax lines manually inserted into the transaction line list.

TxnTaxDetail_TaxLineAggregate

String

False

false

false

An XML aggregate of tax line items.

CustomerRef

String

False

Customers.Id

true

true

The Id of the customer.

CustomerRef_Name

String

True

Customers.DisplayName

false

false

The name of the customer or job.

CustomerMemo

String

False

false

false

The message to the customer, visible on the transaction.

BillAddr_Id

String

False

false

false

The Id of the entity for the address, mainly used for modifying the address. This value is assigned by the data service.

BillAddr_Line1

String

False

false

false

The first line of the address.

BillAddr_Line2

String

False

false

false

The second line of the address.

BillAddr_Line3

String

False

false

false

The third line of the address.

BillAddr_Line4

String

False

false

false

The fourth line of the address.

BillAddr_Line5

String

False

false

false

The fifth line of the address.

BillAddr_City

String

False

false

false

The city name.

BillAddr_Country

String

False

false

false

The country name.

BillAddr_CountrySubDivisionCode

String

False

false

false

The country region. The state name for the USA or the province name for Canada.

BillAddr_PostalCode

String

False

false

false

The postal code. The zip code for the USA and Canada.

BillAddr_Note

String

False

false

false

The note for the customer.

BillAddr_Lat

String

False

false

false

The latitude coordinate of the geocoded billing address.

BillAddr_Long

String

False

false

false

The longitude coordinate of the geocoded billing address.

ShipAddr_Id

String

False

false

false

The Id of the entity for hte address.

ShipAddr_Line1

String

False

false

false

The first line of the shipping address.

ShipAddr_Line2

String

False

false

false

The second line of the shipping address.

ShipAddr_Line3

String

False

false

false

The third line of the shipping address.

ShipAddr_Line4

String

False

false

false

The fourth line of the shipping address.

ShipAddr_Line5

String

False

false

false

The fifth line of the shipping address.

ShipAddr_City

String

False

false

false

The city name

ShipAddr_Country

String

False

false

false

The country name

ShipAddr_CountrySubDivisionCode

String

False

false

false

The region within a country.

ShipAddr_PostalCode

String

False

false

false

The postal code.

ShipAddr_Lat

String

False

false

false

The latitude coordinate of the geocoded shipping address.

ShipAddr_Long

String

False

false

false

The longitude coordinate of the geocoded shipping address.

ClassRef

String

False

Class.Id

true

false

The Id of the class associated with the transaction.

ClassRef_Name

String

True

Class.FullyQualifiedName

false

false

The name of the class associated with the transaction.

SalesTermRef

String

False

Terms.Id

true

false

The Id of the sales term associated with the transaction.

SalesTermRef_Name

String

True

Terms.Name

false

false

The name of the sales term associated with the transaction.

TotalAmt

Decimal

False

true

true

The total amount of the transaction. This includes the total of all the charges, allowances, and taxes.

PrintStatus

String

False

false

false

The print status of the credit memo.

The allowed values are NotSet, NeedToPrint, PrintComplete.

The default value is NotSet.

EmailStatus

String

False

false

false

The email status of the invoice.

The allowed values are NotSent, NeedToSend, EmailSent.

The default value is NotSet.

DepositToAccountRef

String

False

Accounts.Id

false

false

The asset account where the payment money is deposited. If you do not specify this account, QuickBooks Online uses the Undeposited Funds account.

DepositToAccountRef_Name

String

True

Accounts.Name

false

false

Name of the asset account where the payment money is deposited. If you do not specify this account, QuickBooks Online uses the Undeposited Funds account.

RemainingCredit

Decimal

False

false

false

The total credit amount still available to be applied towards the payment.

DepartmentRef

String

False

Departments.Id

false

false

The Id of the location of the transaction.

DepartmentRef_Name

String

True

Departments.Name

false

false

The name of the location of the transaction.

BillEmail_Address

String

False

false

false

The email address where the invoice is sent. If the value of EmailStatus is NeedToSend, BillEmail is a required input.

ApplyTaxAfterDiscount

Boolean

False

false

false

This field sets whether discounts are applied before taxes are calculated.

CurrencyRef

String

False

false

false

The Id of the currency used in the transaction.

CurrencyRef_Name

String

True

false

false

The name of the currency used in the transaction.

ExchangeRate

Decimal

False

false

false

The currency exchange rate. This field is valid only if the company file is set up to use the multicurrency feature. In QuickBooks, exchange rates are always recorded as the number of home currency units it takes to equal one foreign currency unit. This field is available for the UK, AU, IN, and CA editions.

GlobalTaxCalculation

String

False

false

false

The method used to apply the tax. This field is valid in only the UK, AU, IN, and CA editions.

The allowed values are TaxExcluded, TaxInclusive, NotApplicable.

HomeTotalAmt

Decimal

True

false

false

The total amount of the transaction, expressed in the home currency. This includes the total of all the charges, allowances, and taxes. This field is valid in the UK, AU, IN, and CA editions.

PreviousCreditMemoLineItemsNextCustomers

Last updated