JDBC Driver for QuickBooks Online

Build 20.0.7587

SalesReceiptLineItems

Create, update, delete, and query QuickBooks Sales Receipt Line Items.

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.

Insert

To add a SalesReceipt, specify the Customer, TotalAmt, and at least one Line Item. All columns denoted with a # are Line Item columns and can be used for inserting multiple Line Items for a new SalesReceipt transaction. For example, the following will insert a new SalesReceipt with two Line Items:

INSERT INTO SalesReceiptLineItems (CustomerRef, Line_Amount#1, Line_DetailType#1, Line_SalesItemLineDetail_ItemRef#1, Line_Amount#2, Line_DetailType#2, Line_SalesItemLineDetail_ItemRef#2, TotalAmt) VALUES ('4', 0.01, 'SalesItemLineDetail', '2', 0.02, 'SalesItemLineDetail', '3', 0.03)

Columns

Name Type ReadOnly References Filterable Sortable Description
LineId [KEY] String True false false

The Id of the line item on the sales receipt.

SalesReceiptId [KEY] String False

SalesReceipts.Id

true true

The Id of the sales receipt.

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 associated with the transaction.

DocNumber String False true true

The reference number for the transaction.

TxnDate Date False true true

The date when this transaction occurred.

DepartmentRef String False

Departments.Id

false false

The Id of the department, which stores the location of the transaction as defined using location tracking in QuickBooks Online.

DepartmentRef_Name String True

Departments.Name

false false

The name of the department, which stores the location of the transaction as defined using location tracking in QuickBooks Online.

PrivateNote String False false false

A private note about the transaction. This note will not appear on the transaction records by default.

TxnStatus String False false false

The status of the transaction. Depending on the transaction type it may have different values. For sales transactions acceptable values are defined in PaymentStatusEnum. For estimates, the values accepted are defined in QboEstimateStatusEnum.

LinkedTxnAggregate String False false false

An XML aggregate of the transactions linked to the line item.

Line_Id# String False false false

The Id of the line item.

Line_LineNum# String False false false

The number of the line item.

Line_Description# String False false false

A description of the line item that appears in the printed record.

Line_Amount# Decimal False false false

Total amount of the charges or discounts for the given line. Includes the charges and allowances, but it excludes the tax amount.

Line_DetailType# String False false false

The line detail type. Different detail types indicate different types of line items.

Line_SalesItemLineDetail_ItemRef# String False

Items.Id

false false

The Id of an item in the line item. When a line item lacks an ItemRef it is treated as documentation and the Line_Amount field is ignored.

Line_SalesItemLineDetail_ItemRef_Name# String True

Items.Name

false false

The name of the item. When a line lacks an ItemRef it is treated as documentation and the Line_Amount field is ignored.

Line_SalesItemLineDetail_ClassRef# String False

Class.Id

false false

The Id of the entity for the class for the line item.

Line_SalesItemLineDetail_ClassRef_Name# String True

Class.FullyQualifiedName

false false

The name of the class for the line item.

Line_SalesItemLineDetail_UnitPrice# Decimal False false false

The unit price of the item referenced by ItemRef.

Line_SalesItemLineDetail_Qty# Decimal False false false

The number of items for the line.

Line_SalesItemLineDetail_TaxCodeRef# String False

TaxCodes.Id

false false

The tax code for this item.

Line_SalesItemLineDetail_ServiceDate# Date False false false

The date when the service is performed.

Line_GroupLineDetail_GroupItemRef String True false false

The Id of the group item object.

Line_GroupLineDetail_GroupItemRef_Name String True false false

The name of the group item object.

Line_GroupLineDetail_Quantity Integer True false false

The amount of the group item.

TxnTaxDetail_TxnTaxCodeRef String False

TaxCodes.Id

false false

The transaction tax code.

TxnTaxDetail_TotalTax String False false false

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 false

The Id of the customer.

CustomerRef_Name String True

Customers.DisplayName

false false

The name of the customer.

CustomerMemo String False false false

The message to the customer.

BillAddr_Id String False false false

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

BillAddr_Line1 String False false false

First line of the address.

BillAddr_Line2 String False false false

Second line of the address.

BillAddr_Line3 String False false false

Third line of the address.

BillAddr_Line4 String False false false

Fourth line of the address.

BillAddr_Line5 String False false false

Fifth line of the address.

BillAddr_City String False false false

City name.

BillAddr_Country String False false false

Country name.

BillAddr_CountrySubDivisionCode String False false false

Region within a country. For example, the state name for the USA and the province name for Canada.

BillAddr_PostalCode String False false false

Postal code. For example, the zip code for the USA and Canada.

BillAddr_Note String False false false

Note for the customer.

BillAddr_Lat String False false false

Latitude coordinate of the geocoded address.

BillAddr_Long String False false false

Longitude coordinate of the geocoded address.

ShipAddr_Id String False false false

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

ShipAddr_Line1 String False false false

First line of the address.

ShipAddr_Line2 String False false false

Second line of the address.

ShipAddr_Line3 String False false false

Third line of the address.

ShipAddr_Line4 String False false false

Fourth line of the address.

ShipAddr_Line5 String False false false

Fifth line of the address.

ShipAddr_City String False false false

City name.

ShipAddr_Country String False false false

Country name.

ShipAddr_CountrySubDivisionCode String False false false

Region within a country. For example, the state name for the USA and the province name for Canada.

ShipAddr_PostalCode String False false false

Postal code. For example, the zip code for the USA and Canada.

ShipAddr_Note String False false false

Note for the customer.

ShipAddr_Lat String False false false

Latitude coordinate of the geocoded address.

ShipAddr_Long String False false false

Longitude coordinate of the geocoded 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.

ShipMethodRef String False false false

The Id of the shipping method associated with the transaction.

ShipMethodRef_Name String True false false

The name of the shipping method associated with the transaction.

ShipDate Date False false false

The date for delivery of goods or services.

TrackingNum String False false false

The tracking number for the shipping provider for the delivery of the goods associated with the transaction.

TotalAmt Decimal False true false

The total amount of the transaction. This includes the total of all the charges, allowances, and taxes. By default, this is recalculated based on sub items total and overridden. Calculated by QuickBooks business logic; cannot be written to QuickBooks.

PrintStatus String False false false

The print status of the invoice.

使用できる値は次のとおりです。NotSet, NeedToPrint, PrintComplete

デフォルト値はNotSetです。

EmailStatus String False false false

The email status of the invoice.

使用できる値は次のとおりです。NotSet, NeedToSend, EmailSent

デフォルト値はNotSetです。

BillEmail_Address String False false false

The email address where the sales receipt is sent.

Balance Decimal True true true

The balance reflecting any payments made against the transaction.

PaymentRefNum String False false false

The reference number for the payment.

PaymentMethodRef String False

PaymentMethods.Id

false false

The Id of the payment method entity.

PaymentMethodRef_Name String True

PaymentMethods.Name

false false

The name of the payment method entity.

DepositToAccountRef String False

Accounts.Id

false false

The Id of the entity for 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

A name that identifies 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

This field sets whether discounts are applied before the tax is 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

Method in which tax is applied. This field is valid in the UK, AU, IN, and CA editions.

使用できる値は次のとおりです。TaxExcluded, TaxInclusive, NotApplicable

HomeTotalAmt Decimal False false false

Total amount of the transaction in the home currency. This field is valid in the UK, AU, IN, and CA editions.

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 20.0.7587