RefundReceiptLineItems

Captures the line-level details of customer refund receipts, including refunded items, quantities, and amounts to accurately track returns and reimbursements.

Table Specific Information

RefundReceipts may be inserted, queried, or updated via the RefundReceipts or RefundReceiptLineItems tables. RefundReceipts may be deleted by using the RefundReceipts 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 RefundReceipt, specify a Customer, DepositToAccount and at least one Line Item. The following shows an example of inserting multiple RefundReceipts, each with a single line. To insert a RefundReceipt with multiple lines, see the example on the RefundReceipts table.

INSERT INTO RefundReceiptLineItems#TEMP (CustomerRef, DepositToAccountRef, Line_DetailType, Line_SalesItemLineDetail_ItemRef, Line_Amount) VALUES ('4', '45', 'SalesItemLineDetail', '2', 0.01)
INSERT INTO RefundReceiptLineItems#TEMP (CustomerRef, DepositToAccountRef, Line_DetailType, Line_SalesItemLineDetail_ItemRef, Line_Amount) VALUES ('4', '45', 'SalesItemLineDetail', '3', 0.02)
INSERT INTO RefundReceiptLineItems (CustomerRef, DepositToAccountRef, Line_DetailType, Line_SalesItemLineDetail_ItemRef, Line_Amount) SELECT CustomerRef, DepositToAccountRef, Line_DetailType, Line_SalesItemLineDetail_ItemRef, Line_Amount FROM RefundReceiptLineItems#TEMP

To add lines to an existing RefundReceipt, You'll need to specify the RefundReceiptId in the WHERE clause for the INSERT command. For example:

INSERT INTO RefundReceiptLineItems#TEMP (RefundReceiptId, Line_DetailType, Line_SalesItemLineDetail_ItemRef, Line_Amount) VALUES ('1234', 'SalesItemLineDetail', '2', 0.01)
INSERT INTO RefundReceiptLineItems#TEMP (RefundReceiptId, Line_DetailType, Line_SalesItemLineDetail_ItemRef, Line_Amount) VALUES ('1234', 'SalesItemLineDetail', '3', 0.02)
INSERT INTO RefundReceiptLineItems (RefundReceiptId, Line_DetailType, Line_SalesItemLineDetail_ItemRef, Line_Amount) SELECT RefundReceiptId, Line_DetailType, Line_SalesItemLineDetail_ItemRef, Line_Amount FROM RefundReceiptLineItems#TEMP

Update

To update an existing Line Item, you'll need to specify the LineId:

UPDATE RefundReceiptLineItems SET Line_SalesItemLineDetail_Qty = 20 WHERE LineId = '5656'

Delete

To delete existing Line Items, you'll need to set the LineId and RefundReceiptId:

DELETE FROM RefundReceiptLineItems WHERE LineId = '5656' AND RefundReceiptId = '1'

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
LineId [KEY]	String	True		True	False	The unique identifier (Id) that is assigned by QuickBooks Online to this line item on the refund receipt. It is used to reference, update, or reconcile this specific line.
RefundReceiptId [KEY]	String	False	RefundReceipts.Id	True	True	The unique Id of the parent refund-receipt transaction that this line item is linked to. This Id forms the foreign-key relationship back to the main refund-receipt record.
SyncToken	String	True		False	False	The version control token for the parent refund receipt that is used to prevent conflicting updates. QuickBooks Online increments this token each time the transaction or any of its lines is modified, and only the latest token is accepted for edits.
MetaData_CreateTime	Datetime	True		True	True	The date and time stamp (Coordinated Universal Time) when QuickBooks Online created this refund-receipt record.
MetaData_LastUpdatedTime	Datetime	True		True	True	The date and time stamp (Coordinated Universal Time) when this refund-receipt record was last modified in QuickBooks Online.
CustomFieldAggregate	String	False		False	False	An XML aggregate that is serialized into a single string containing all custom field information that is defined for this refund receipt. This collection can include multiple CustomField elements with Name, Type, StringValue, and other sub-elements.
DocNumber	String	False		True	True	The reference number that is assigned to the refund-receipt transaction. If no number is provided, QuickBooks Online assigns the next number in sequence according to the company's numbering preferences.
TxnDate	Date	False		True	True	The posting date that is entered by the user when this refund-receipt transaction occurred. This date determines the accounting period and can differ from the creation date.
PrivateNote	String	False		False	False	An internal note that is recorded on this refund-receipt transaction that is intended for internal use and does not appear on customer-facing forms by default.
Line_Id	String	False		False	False	The unique Id that is assigned by QuickBooks Online to this individual line within the refund receipt (corresponds to Line/Id in the API).
Line_LineNum	String	False		False	False	The sequential line number that QuickBooks Online assigns to this line within the refund receipt. This field is useful for preserving line order when updating.
Line_Description	String	False		False	False	The free-form description of the line item that appears on customer-facing documents and reports.
Line_Amount	Decimal	False		False	False	The monetary amount for this line item that is included in the refund receipt total. This amount includes charges and allowances but excludes tax amounts that are calculated separately.
Line_DetailType	String	False		False	False	The structural type of detail that is used by this line; different detail types (such as SalesItemLineDetail) indicate different types of line items and determine which sub-elements are required.
Line_SalesItemLineDetail_ItemRef	String	False	Items.Id	False	False	The unique Id of the item that is used on this sales line in the refund receipt. Selecting an item determines default accounts and tax behavior.
Line_SalesItemLineDetail_ItemRef_Name	String	True	Items.Name	False	False	The display name of the item that is used on this sales line in the refund receipt.
Line_SalesItemLineDetail_ClassRef	String	False	Class.Id	False	False	The unique Id of the class that is assigned to this sales line for class tracking and reporting.
Line_SalesItemLineDetail_ClassRef_Name	String	True	Class.FullyQualifiedName	False	False	The display name of the class that is assigned to this sales line.
Line_SalesItemLineDetail_UnitPrice	Decimal	False		False	False	The unit price that is applied to the item for this line in the refund receipt. This price can be overridden per line.
Line_SalesItemLineDetail_Qty	Double	False		False	False	The quantity that, when multiplied by unit price, is used to derive the line amount for this sales item in the refund receipt.
Line_SalesItemLineDetail_TaxCodeRef	String	False	TaxCodes.Id	False	False	The unique Id of the tax code that is applied to this sales item line when tax tracking is enabled.
Line_SalesItemLineDetail_ServiceDate	Date	False		False	False	The service date that is associated with this sales item line. This date is often used for reporting service delivery dates separate from the transaction date.
TxnTaxDetail_TxnTaxCodeRef	String	False	TaxCodes.Id	False	False	The unique Id of the overall tax code that is applied to the refund-receipt transaction.
TxnTaxDetail_TotalTax	String	False		False	False	The total tax amount that QuickBooks Online calculates for the refund-receipt transaction, excluding any tax lines manually inserted into the transaction line list.
TxnTaxDetail_TaxLineAggregate	String	False		False	False	An XML aggregate that is serialized into a single string representing all tax line items that QuickBooks Online calculates or applies to this refund-receipt transaction.
CustomerRef	String	False	Customers.Id	True	False	The unique Id of the customer that is linked to this refund-receipt transaction.
CustomerRef_Name	String	True	Customers.DisplayName	False	False	The display name of the customer that is linked to this refund-receipt transaction.
CustomerMemo	String	False		False	False	The message that is entered for the customer and that appears on the refund receipt and in the printed or emailed copy.
BillAddr_Id	String	False		False	False	The unique Id of the billing address entity that is assigned by QuickBooks Online and that is used when modifying the address.
BillAddr_Line1	String	False		False	False	The first line of the billing address that is entered for the customer.
BillAddr_Line2	String	False		False	False	The second line of the billing address that is entered for the customer.
BillAddr_Line3	String	False		False	False	The third line of the billing address that is entered for the customer.
BillAddr_Line4	String	False		False	False	The fourth line of the billing address that is entered for the customer.
BillAddr_Line5	String	False		False	False	The fifth line of the billing address that is entered for the customer.
BillAddr_City	String	False		False	False	The city name that is entered for the billing address.
BillAddr_Country	String	False		False	False	The country name that is entered for the billing address.
BillAddr_CountrySubDivisionCode	String	False		False	False	The region within the country for the billing address. For example, this value is the state name for the USA or the province name for Canada).
BillAddr_PostalCode	String	False		False	False	The postal code that is entered for the billing address. For example, this value is the ZIP code for the USA and the postal code for Canada.
BillAddr_Lat	String	False		False	False	The latitude coordinate that is associated with the geocoded billing address when location data is available.
BillAddr_Long	String	False		False	False	The longitude coordinate that is associated with the geocoded billing address when location data is available.
ShipAddr_Id	String	False		False	False	The unique Id of the shipping address entity that is assigned by QuickBooks Online and that is used when modifying the address.
ShipAddr_Line1	String	False		False	False	The first line of the shipping address that is entered for the customer.
ShipAddr_Line2	String	False		False	False	The second line of the shipping address that is entered for the customer.
ShipAddr_Line3	String	False		False	False	The third line of the shipping address that is entered for the customer.
ShipAddr_Line4	String	False		False	False	The fourth line of the shipping address that is entered for the customer.
ShipAddr_Line5	String	False		False	False	The fifth line of the shipping address that is entered for the customer.
ShipAddr_City	String	False		False	False	The city name that is entered for the shipping address.
ShipAddr_Country	String	False		False	False	The country name that is entered for the shipping address.
ShipAddr_CountrySubDivisionCode	String	False		False	False	The region within the country for the shipping address. For example, this value is the state name for the USA or the province name for Canada.
ShipAddr_PostalCode	String	False		False	False	The postal code that is entered for the shipping address this value is the ZIP code for the USA and the postal code for Canada.
ShipAddr_Lat	String	False		False	False	The latitude coordinate that is associated with the geocoded shipping address when location data is available.
ShipAddr_Long	String	False		False	False	The longitude coordinate that is associated with the geocoded shipping address when location data is available.
ClassRef	String	False	Class.Id	False	False	The unique Id of the class that is associated with this refund-receipt transaction for class tracking and reporting.
ClassRef_Name	String	True	Class.FullyQualifiedName	False	False	The display name of the class that is associated with this refund-receipt transaction.
CheckPayment_CheckNum	String	True		False	False	The check number that is printed on the check and that is stored with this refund-receipt transaction.
CheckPayment_Status	String	False		False	False	The status of the check payment that is determined by QuickBooks Online service or business logic (for example, Authorized, Voided).
CheckPayment_NameOnAccount	String	False		False	False	The name of the person or entity that is holding the account, as printed on the check.
CheckPayment_AcctNum	String	False		False	False	The checking account number that is printed on the check and that is recorded with this refund-receipt transaction.
CheckPayment_BankName	String	True		False	False	The name of the bank on which the check was drawn.
CreditCardPayment_CreditChargeInfo_Type	String	False		False	False	The type of credit card that is used for this payment transaction (for example, Visa, MasterCard, Amex).
CreditCardPayment_CreditChargeInfo_NameOnAcct	String	False		False	False	The name of the account holder that is printed on the card.
CreditCardPayment_CreditChargeInfo_CcExpiryMonth	Integer	False		False	False	The expiration month of the credit card as printed on the card.
CreditCardPayment_CreditChargeInfo_CcExpiryYear	Integer	False		False	False	The four-digit expiration year of the credit card as printed on the card.
CreditCardPayment_CreditChargeInfo_BillAddrStreet	String	False		False	False	The street line of the billing address of the credit-card holder that is used to validate or process the transaction.
CreditCardPayment_CreditChargeInfo_PostalCode	String	False		False	False	The postal code of the billing address of the credit-card holder.
CreditCardPayment_CreditChargeInfo_Amount	Decimal	False		False	False	The amount that is processed using the credit card for this refund-receipt transaction.
CreditCardPayment_CreditChargeInfo_ProcessPayment	Boolean	False		False	False	Indicates whether QuickBooks Online is to store only the credit card information (false or no value) or to store the credit-card payment transaction information in the CreditChargeResponse aggregate (true).
CreditCardPayment_CreditChargeResponse_Status	String	False		False	False	Indicates the status of the payment transaction that is returned from the processor. Possible values include Completed and Unknown.
ShipDate	Date	False		False	False	The date that is entered for the delivery of goods or services that is associated with this refund-receipt transaction.
TotalAmt	Decimal	True		True	True	The total amount of the refund-receipt transaction that includes the sum of all charges, allowances, and taxes applied within the transaction.
ApplyTaxAfterDiscount	Boolean	False		False	False	Indicates whether QuickBooks Online applies discounts before or after calculating tax on this refund-receipt transaction.
DepartmentRef	String	False	Departments.Id	False	False	The unique Id of the department that is linked to this refund-receipt transaction when location tracking is enabled in QuickBooks Online.
DepartmentRef_Name	String	True	Departments.Name	False	False	The display name of the department that is linked to this refund-receipt transaction when location tracking is enabled in QuickBooks Online.
PrintStatus	String	False		False	False	The print status of the refund-receipt transaction (for example, NotSet, NeedToPrint, PrintComplete). The allowed values are NotSet, NeedToPrint, PrintComplete.
BillEmail_Address	String	False		False	False	The email address where the refund receipt is sent. If the value of the EmailStatus attribute is NeedToSend, the billing email address is required.
Balance	Decimal	False		False	False	The remaining balance that is associated with this refund-receipt transaction. This field can indicate whether the transaction is a finance charge, when applicable.
PaymentMethodRef	String	False	PaymentMethods.Id	False	False	The unique Id of the payment method that is associated with this refund-receipt transaction.
PaymentMethodRef_Name	String	True	PaymentMethods.Name	False	False	The display name of the payment method that is associated with this refund-receipt transaction.
PaymentRefNum	String	False		False	False	The reference number that is provided for the payment received on this refund-receipt transaction.
PaymentType	String	False		False	False	The type of payment that is used for the refund-receipt transaction (for example, Cash, Check, CreditCard). The allowed values are Cash, Check, CreditCard, Other.
DepositToAccountRef	String	False	Accounts.Id	False	False	The unique Id of 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	The display 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.
CurrencyRef	String	False		False	False	The unique Id of the currency that is used in the refund-receipt transaction. This field is valid in the UK, AU, and CA editions.
CurrencyRef_Name	String	False		False	False	The display name of the currency in which all amounts on the refund-receipt transaction are expressed. This field is valid in the UK, AU, and CA editions.
ExchangeRate	Decimal	False		False	False	The currency exchange rate that QuickBooks Online applies to convert this refund-receipt transaction amount to the home currency. This field is valid only if the company file is set up to use the multicurrency feature. In QuickBooks Online, 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, and CA editions.
GlobalTaxCalculation	String	False		False	False	The method by which QuickBooks Online applies sales tax to this refund-receipt transaction. This field is valid in the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable.
HomeTotalAmt	Decimal	True		False	False	The total amount of the refund-receipt transaction in the home currency. This includes the total of all charges, allowances, and taxes applied within the transaction. This field is valid in the UK, AU, and CA editions.