SalesReceiptLineItems
Contains line-level details of sales receipts for immediate sales transactions, including items sold, quantities, discounts, and taxes.
Table Specific Information
SalesReceipts may be inserted, queried, or updated via the SalesReceipts or SalesReceiptLineItems tables. SalesReceipts may be deleted by using the SalesReceipts table.
Select
All filterable columns support the following operators:
- =
- !=
- >=
- <=
- >
- <
- IN
- LIKE
- CONTAINS
Insert
To add a SalesReceipt, specify the Customer, TotalAmt, and at least one Line Item. The following shows an example of inserting multiple SalesReceipts, each with a single line. To insert a SalesReceipt with multiple lines, see the example on the SalesReceipts table.
INSERT INTO SalesReceiptLineItems#TEMP (CustomerRef, Line_Amount, Line_DetailType, Line_SalesItemLineDetail_ItemRef, TotalAmt) VALUES ('4', 0.01, 'SalesItemLineDetail', '2', 0.03)
INSERT INTO SalesReceiptLineItems#TEMP (CustomerRef, Line_Amount, Line_DetailType, Line_SalesItemLineDetail_ItemRef, TotalAmt) VALUES ('4', 0.02, 'SalesItemLineDetail', '3', 0.03)
INSERT INTO SalesReceiptLineItems (CustomerRef, Line_Amount, Line_DetailType, Line_SalesItemLineDetail_ItemRef, TotalAmt) SELECT CustomerRef, Line_Amount, Line_DetailType, Line_SalesItemLineDetail_ItemRef, TotalAmt FROM SalesReceiptLineItems#TEMP
Columns
| Name | Type | ReadOnly | References | Filterable | Sortable | Description |
| LineId [KEY] | String | True | False | False |
The unique identifier (Id) that is assigned by QuickBooks Online to this line item on the sales receipt. It is used to reference, update, or reconcile this specific line. | |
| SalesReceiptId [KEY] | String | False | True | True |
The unique Id of the parent sales-receipt transaction that this line item is linked to; this forms the foreign-key relationship back to the main sales-receipt record. | |
| SyncToken | String | True | False | False |
The version control token for the parent sales 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 sales-receipt record. | |
| MetaData_LastUpdatedTime | Datetime | True | True | True |
The date and time stamp (Coordinated Universal Time) when this sales-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 fields that are associated with this sales-receipt transaction. 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 sales-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 sales-receipt transaction occurred. This date determines the accounting period and can differ from the creation date. | |
| DepartmentRef | String | False |
Departments.Id | False | False |
The unique Id of the department that is linked to this sales-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 sales-receipt transaction when location tracking is enabled in QuickBooks Online. |
| PrivateNote | String | False | False | False |
An internal note recorded on this sales-receipt transaction that is intended for internal use and does not appear on customer-facing forms by default. | |
| LinkedTxnAggregate | String | False | False | False |
An XML aggregate that is serialized into a single string representing all transactions that are linked to this sales receipt line item. Each LinkedTxn element typically includes the Id, Type, and an optional sequence number of the related transaction such as an Invoice or Payment. | |
| Line_Id | String | False | False | False |
The unique Id that is assigned by QuickBooks Online to this individual line within the sales 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 sales receipt; 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 sales receipt total. This amount includes charges and allowances that apply to the line and excludes any tax amount that is 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 or GroupLineDetail) 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 sales receipt. When a line item lacks an item reference, it is treated as documentation and the Line_Amount field is ignored. |
| 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 sales receipt. When a line item lacks an item reference it is treated as documentation and the Line_Amount field is ignored. |
| 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 sales receipt. This price can be overridden per line. | |
| Line_SalesItemLineDetail_Qty | Decimal | False | False | False |
The quantity that, when multiplied by unit price, is used to derive the line amount for this sales item in the sales 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. | |
| Line_GroupLineDetail_GroupItemRef | String | True | False | False |
The unique Id of the group item object that is used for this group line in the sales receipt. | |
| Line_GroupLineDetail_GroupItemRef_Name | String | True | False | False |
The display name of the group item object that is used for this group line in the sales receipt. | |
| Line_GroupLineDetail_Quantity | Integer | True | False | False |
The quantity of the group item that is used for this group line in the sales receipt. | |
| TxnTaxDetail_TxnTaxCodeRef | String | False |
TaxCodes.Id | False | False |
The unique Id of the overall tax code that is applied to the sales-receipt transaction. |
| TxnTaxDetail_TotalTax | String | False | False | False |
The total tax amount that QuickBooks Online calculates for the sales-receipt transaction, excluding any tax lines that are 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 sales-receipt transaction. | |
| CustomerRef | String | False |
Customers.Id | True | False |
The unique Id of the customer that is linked to this sales-receipt transaction. |
| CustomerRef_Name | String | True |
Customers.DisplayName | False | False |
The display name of the customer that is linked to this sales-receipt transaction. |
| CustomerMemo | String | False | False | False |
The message that is entered for the customer and that appears on the sales 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 and 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 and the province name for Canada. | |
| ShipAddr_PostalCode | String | False | False | False |
The postal code that is entered for the shipping address. For example, 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 sales-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 sales-receipt transaction. |
| ShipMethodRef | String | False | False | False |
The unique Id of the shipping method that is associated with this sales-receipt transaction. | |
| ShipMethodRef_Name | String | True | False | False |
The display name of the shipping method that is associated with this sales-receipt transaction. | |
| ShipDate | Date | False | False | False |
The date that is entered for the delivery of goods or services associated with this sales-receipt transaction. | |
| TrackingNum | String | False | False | False |
The tracking number for the shipping provider that is entered for the delivery of goods associated with this sales-receipt transaction. | |
| TotalAmt | Decimal | False | True | False |
The total amount of the sales-receipt transaction. This includes the total of all charges, allowances, and taxes applied within the transaction. By default, this is recalculated based on the sum of the sub-items total and overridden. Calculated by QuickBooks Online business logic. Cannot be written to QuickBooks Online. | |
| PrintStatus | String | False | False | False |
The print status of the sales-receipt transaction (for example, NotSet, NeedToPrint, PrintComplete). The allowed values are NotSet, NeedToPrint, PrintComplete. The default value is NotSet. | |
| EmailStatus | String | False | False | False |
The email status of the sales-receipt transaction (for example, NotSet, NeedToSend, EmailSent). The allowed values are NotSet, NeedToSend, EmailSent. The default value is NotSet. | |
| BillEmail_Address | String | False | False | False |
The email address where the sales receipt is sent. | |
| Balance | Decimal | True | True | True |
The balance that reflects any payments that have been made against this sales-receipt transaction. | |
| PaymentRefNum | String | False | False | False |
The reference number that is provided for the payment on this sales-receipt transaction. | |
| PaymentMethodRef | String | False | False | False |
The unique Id of the payment method entity that is associated with this sales-receipt transaction. | |
| PaymentMethodRef_Name | String | True |
PaymentMethods.Name | False | False |
The display name of the payment method entity that is associated with this sales-receipt transaction. |
| DepositToAccountRef | String | False |
Accounts.Id | False | False |
The unique Id of the asset account entity 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. |
| ApplyTaxAfterDiscount | Boolean | False | False | False |
Indicates whether QuickBooks Online applies discounts before or after calculating tax on this sales-receipt transaction. | |
| CurrencyRef | String | False | False | False |
The unique Id of the currency that is used in the sales-receipt transaction. | |
| CurrencyRef_Name | String | True | False | False |
The display name of the currency that is used in the sales-receipt transaction. | |
| ExchangeRate | Decimal | False | False | False |
The currency exchange rate that QuickBooks Online applies to convert this sales-receipt transaction amount to the home currency. This field is valid only when 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 sales-receipt transaction. This field is valid in the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable. | |
| HomeTotalAmt | Decimal | False | False | False |
The total amount of the sales-receipt transaction in the home currency. This field is valid in the UK, AU, and CA editions. |