SalesReceipts

Columns

Name

Type

ReadOnly

References

Filterable

Sortable

Description

Id [KEY]

String

True

true

The Id of the sales receipt.

SyncToken

String

True

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

The time the record was created.

MetaData_LastUpdatedTime

Datetime

True

true

The time the record was last updated.

CustomFieldAggregate

String

False

false

An XML aggregate of custom fields associated with the transaction.

DocNumber

String

False

true

Reference number for the transaction.

TxnDate

Date

False

true

The date when this transaction occurred.

DepartmentRef

String

False

Departments.Id

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

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

PrivateNote

String

False

false

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

TxnStatus

String

False

false

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

LinkedTxnAggregate

String

False

false

Zero or more linked transactions.

LineAggregate

String

False

false

Zero or more lines for the transaction.

TxnTaxDetail_TxnTaxCodeRef

String

False

TaxCodes.Id

false

The transaction tax code.

TxnTaxDetail_TotalTax

String

False

false

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

TxnTaxDetail_TaxLineAggregate

String

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

The name of the customer.

CustomerMemo

String

False

false

The message to the customer.

BillAddr_Id

String

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

First line of the address.

BillAddr_Line2

String

False

false

Second line of the address.

BillAddr_Line3

String

False

false

Third line of the address.

BillAddr_Line4

String

False

false

Fourth line of the address.

BillAddr_Line5

String

False

false

Fifth line of the address.

BillAddr_City

String

False

false

City name.

BillAddr_Country

String

False

false

Country name.

BillAddr_CountrySubDivisionCode

String

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

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

BillAddr_Note

String

False

false

The note for the customer.

BillAddr_Lat

String

False

false

Latitude coordinate of the geocoded address.

BillAddr_Long

String

False

false

Longitude coordinate of the geocoded address.

ShipAddr_Id

String

False

false

The 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

First line of the address.

ShipAddr_Line2

String

False

false

Second line of the address.

ShipAddr_Line3

String

False

false

Third line of the address.

ShipAddr_Line4

String

False

false

Fourth line of the address.

ShipAddr_Line5

String

False

false

Fifth line of the address.

ShipAddr_City

String

False

false

City name.

ShipAddr_Country

String

False

false

Country name.

ShipAddr_CountrySubDivisionCode

String

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

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

ShipAddr_Note

String

False

false

Note for the customer.

ShipAddr_Lat

String

False

false

Latitude coordinate of the geocoded address.

ShipAddr_Long

String

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

The name of the class associated with the transaction.

ShipMethodRef

String

False

false

The Id of the shipping method associated with the transaction.

ShipMethodRef_Name

String

True

false

The name of the shipping method associated with the transaction.

ShipDate

Date

False

false

Date for delivery of goods or services.

TrackingNum

String

False

false

The tracking number of 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 and overriden based on total of the subitems. This field is calculated by QuickBooks business logic and cannot be written to QuickBooks.

PrintStatus

String

False

false

The print status of the invoice.

The allowed values are NotSet, NeedToPrint, PrintComplete.

The default value is NotSet.

EmailStatus

String

False

false

The email status of the invoice.

The allowed values are NotSet, NeedToSend, EmailSent.

The default value is NotSet.

BillEmail_Address

String

False

false

The email address where the sales receipt is sent.

Balance

Decimal

True

true

The balance reflecting any payments made against the transaction.

PaymentRefNum

String

False

false

The reference number for the payment.

PaymentMethodRef

String

False

PaymentMethods.Id

false

The Id of the payment method.

PaymentMethodRef_Name

String

True

PaymentMethods.Name

false

The name of the payment method.

DepositToAccountRef

String

False

Accounts.Id

false

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

DepositToAccountRef_Name

String

True

Accounts.Name

false

A name that identifies the asset account where the payment money is deposited. If you do not specify this account, QBO uses the Undeposited Funds account.

ApplyTaxAfterDiscount

Boolean

False

false

This field sets whether discounts are applied before the tax is calculated.

CurrencyRef

String

False

false

The Id of the currency used in the transaction.

CurrencyRef_Name

String

True

false

The name of the currency used in the transaction.

ExchangeRate

Decimal

False

false

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

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

The allowed values are TaxExcluded, TaxInclusive, NotApplicable.

HomeTotalAmt

Decimal

False

false

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

PreviousSalesReceiptLineItems NextTaxAgency

Last updated 2 years ago