JDBC Driver for QuickBooks Online

Build 25.0.9434

CreditMemos

Maintains records of customer credit memos that are issued to adjust invoices, apply customer credits, or refund amounts for returned goods or overpayments.

Table Specific Information

CreditMemos may be inserted, queried, or updated via the CreditMemos or CreditMemoLineItems tables. CreditMemos may be deleted by using the CreditMemos table.

Select

All filterable columns support the following operators:

  • =
  • !=
  • >=
  • <=
  • >
  • <
  • IN
  • LIKE
  • CONTAINS

The driver processes other filters client-side within the driver.

Insert

To add a CreditMemo, specify a Customer and at least one Line Item. The LineAggregate column may be used to specify an XML aggregate of Line Item data. Each _ denotes hierarchy. Use <Line> at the base level. The contents of LineAggregate will be sent to the API as is. All values for each field in the aggregate should adhere to the API's specifications (e.g. for dates in format yyyy-MM-dd, for date times in format yyyy-MM-dd'T'HH:mm:sszzz). The columns that may be used in the aggregates begin with the prefix 'Line_' to indicate they are part of the line item. Use the Line_ column along with the DocNumber to indicate which lines go with which CreditMemos. For example: 

INSERT INTO CreditMemos (CustomerRef, LineAggregate) 
VALUES ('4', '
<Line><Amount>0.01</Amount><DetailType>SalesItemLineDetail</DetailType><SalesItemLineDetail><ItemRef>2</ItemRef></SalesItemLineDetail></Line>
<Line><Amount>0.02</Amount><DetailType>SalesItemLineDetail</DetailType><SalesItemLineDetail><ItemRef>3</ItemRef></SalesItemLineDetail></Line>
')

Columns

Name Type ReadOnly References Filterable Sortable Description
Id [KEY] String True False False

Specifies the unique identifier (Id) of the credit memo.

SyncToken String True False False

Specifies the version number that is used to lock the credit memo object for use by one application at a time. When an application modifies an object, its sync token is incremented. Attempts to modify an object with an older sync token fail.

MetaData_CreateTime Datetime True True True

Specifies the date and time when the credit-memo record was created in the source domain.

MetaData_LastUpdatedTime Datetime True True True

Specifies the date and time when the credit-memo record was last updated in the source domain.

CustomFieldAggregate String False False False

Specifies an XML aggregate of custom fields that are associated with the credit memo.

DocNumber String False True True

Specifies the reference number for the credit-memo transaction.

TxnDate Date False True True

Specifies the date when the credit-memo transaction occurred.

PrivateNote String False False False

Specifies a private note about the credit-memo transaction.

LineAggregate String False False False

Specifies an XML aggregate of line items on the credit memo.

TxnTaxDetail_TxnTaxCodeRef String False

TaxCodes.Id

False False

Specifies the tax code for the credit-memo transaction.

TxnTaxDetail_TotalTax String False False False

Specifies the total tax calculated for the credit-memo transaction, excluding any tax lines manually inserted into the transaction line list.

TxnTaxDetail_TaxLineAggregate String False False False

Specifies an XML aggregate of tax line items that is associated with the credit-memo transaction.

CustomerRef String False

Customers.Id

True False

Specifies the unique Id of the customer that is associated with the credit-memo transaction.

CustomerRef_Name String True

Customers.DisplayName

False False

Specifies the name of the customer or job that is associated with the credit-memo transaction.

CustomerMemo String False False False

Specifies the message to the customer that is visible on the credit-memo transaction.

BillAddr_Id String False False False

Specifies the unique Id of the entity for the billing address, mainly used for modifying the address.

BillAddr_Line1 String False False False

Specifies the first line of the billing address.

BillAddr_Line2 String False False False

Specifies the second line of the billing address.

BillAddr_Line3 String False False False

Specifies the third line of the billing address.

BillAddr_Line4 String False False False

Specifies the fourth line of the billing address.

BillAddr_Line5 String False False False

Specifies the fifth line of the billing address.

BillAddr_City String False False False

Specifies the city name in the billing address.

BillAddr_Country String False False False

Specifies the country name in the billing address.

BillAddr_CountrySubDivisionCode String False False False

Specifies the region within the country. This field represents the state name for the USA or the province name for Canada.

BillAddr_PostalCode String False False False

Specifies the postal code in the billing address. This field represents the ZIP code for the USA and Canada.

BillAddr_Lat String False False False

Specifies the latitude coordinate of the geocoded billing address.

BillAddr_Long String False False False

Specifies the longitude coordinate of the geocoded billing address.

ShipAddr_Id String False False False

Specifies the unique Id of the entity for the shipping address.

ShipAddr_Line1 String False False False

Specifies the first line of the shipping address.

ShipAddr_Line2 String False False False

Specifies the second line of the shipping address.

ShipAddr_Line3 String False False False

Specifies the third line of the shipping address.

ShipAddr_Line4 String False False False

Specifies the fourth line of the shipping address.

ShipAddr_Line5 String False False False

Specifies the fifth line of the shipping address.

ShipAddr_City String False False False

Specifies the city name in the shipping address.

ShipAddr_Country String False False False

Specifies the country name in the shipping address.

ShipAddr_CountrySubDivisionCode String False False False

Specifies the region within the country in the shipping address.

ShipAddr_PostalCode String False False False

Specifies the postal code in the shipping address.

ShipAddr_Lat String False False False

Specifies the latitude coordinate of the geocoded shipping address.

ShipAddr_Long String False False False

Specifies the longitude coordinate of the geocoded shipping address.

ClassRef String False

Class.Id

True False

Specifies the unique Id of the class that is associated with the credit-memo transaction.

ClassRef_Name String True

Class.FullyQualifiedName

False False

Specifies the name of the class that is associated with the credit-memo transaction.

SalesTermRef String False

Terms.Id

True False

Specifies the unique Id of the sales term that is associated with the credit-memo transaction.

SalesTermRef_Name String True

Terms.Name

False False

Specifies the name of the sales term that is associated with the credit-memo transaction.

TotalAmt Decimal False True True

Specifies the total amount of the credit-memo transaction, including all charges, allowances, and taxes.

PrintStatus String False False False

Specifies the print status of the credit memo.

The allowed values are NotSet, NeedToPrint, PrintComplete.

The default value is NotSet.

EmailStatus String False False False

Specifies the email status of the credit-memo transaction.

The allowed values are NotSent, NeedToSend, EmailSent.

The default value is NotSet.

RemainingCredit Decimal False False False

Specifies the total credit amount that is still available to be applied towards payment.

DepartmentRef String False

Departments.Id

False False

Specifies the unique Id of the location that is associated with the credit-memo transaction.

DepartmentRef_Name String True

Departments.Name

False False

Specifies the name of the location that is associated with the credit-memo transaction.

BillEmail_Address String False False False

Specifies the email address where the credit memo is sent. If the value of the EmailStatus parameter is NeedToSend, this field is a required input.

ApplyTaxAfterDiscount Boolean False False False

Specifies whether discounts are applied before taxes are calculated.

CurrencyRef String False False False

Specifies the unique Id of the currency that is used in the credit-memo transaction.

CurrencyRef_Name String True False False

Specifies the name of the currency that is used in the credit-memo transaction.

ExchangeRate Decimal False False False

Specifies the currency exchange rate that is applied when the credit-memo transaction occurred. This field is valid only if the company file is set up to use the multicurrency feature and is available for the UK, AU, and CA editions.

GlobalTaxCalculation String False False False

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

The allowed values are TaxExcluded, TaxInclusive, NotApplicable.

HomeTotalAmt Decimal True False False

Specifies the total amount of the credit-memo transaction expressed in the home currency, including all charges, allowances, and taxes. This field is valid only in the UK, AU, and CA editions.

TransactionLocationType String False False False

Specifies the account location for the credit-memo transaction. This field is valid only in the FR edition.

The allowed values are WithinFrance, FranceOverseas, OutsideFranceWithEU, OutsideEU.

InvoiceRef String False

Invoices.Id

False False

Specifies the unique Id of the invoice that is associated with the credit-memo transaction.

InvoiceRef_Name String True

Invoices.Name

False False

Specifies the name of the invoice that is associated with the credit-memo transaction.

ProjectRef String False True False

Specifies the unique Id of the project that is associated with the credit-memo transaction.

PaymentMethodRef String True

PaymentMethods.Id

False False

Specifies the unique Id of the payment method that is associated with the credit-memo transaction.

PaymentMethodRef_Name String True

PaymentMethods.Name

False False

Specifies the name of the payment method that is associated with the credit-memo transaction.

HomeBalance Decimal True False False

Specifies the amount of the credit memo balance that is expressed in the home currency.

RecurDataRef String True False False

Specifies the unique Id of the recurring transaction template from which the credit memo was created.

TaxExemptionRef String True False False

Specifies the tax exemption Id for the customer that is associated with the credit-memo transaction. This identifier is typically issued by the state.

Balance Decimal True True False

Specifies the balance reflecting any payments made against the credit-memo transaction. This field is initially set to the total amount.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434