Name |
Type |
ReadOnly |
Filterable |
Description |
Id [KEY] |
string |
true |
true |
The Id of the sales receipt. |
SyncToken |
string |
false |
false |
The sync token. This must be specified when executing an update or delete. |
MetaData_CreateTime |
datetime |
true |
true |
The time the record was created. |
MetaData_LastUpdatedTime |
datetime |
true |
true |
The time the record was last updated. |
CustomField |
string |
false |
false |
A json 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 |
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 |
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. |
LinkedTxn |
string |
false |
false |
Zero or more linked transactions. |
Line |
string |
false |
false |
Zero or more lines for the transaction. |
TxnTaxDetail_TxnTaxCodeRef |
string |
false |
false |
The transaction tax code. |
TxnTaxDetail_TxnTaxCodeRef_Name |
string |
true |
false |
The name associated to 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_TaxLine |
string |
false |
false |
A json aggregate of tax line items. |
CustomerRef |
string |
false |
true |
The Id of the customer. |
CustomerRef_Name |
string |
true |
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. |
ShipFromAddr_Id |
string |
false |
false |
The Id of the entity for the address where the goods are shipped from, mainly used for modifying the address. This field is assigned by the data service. |
ShipFromAddr_Line1 |
string |
false |
false |
First line of the address. |
ShipFromAddr_Line2 |
string |
false |
false |
Second line of the address. |
ShipFromAddr_Line3 |
string |
false |
false |
Third line of the address. |
ShipFromAddr_Line4 |
string |
false |
false |
Fourth line of the address. |
ShipFromAddr_Line5 |
string |
false |
false |
Fifth line of the address. |
ShipFromAddr_City |
string |
false |
false |
City name. |
ShipFromAddr_Country |
string |
false |
false |
Country name. |
ShipFromAddr_CountrySubDivisionCode |
string |
false |
false |
Region within a country. For example, the state name for the USA or the province name for Canada. |
ShipFromAddr_PostalCode |
string |
false |
false |
Postal code. For example, the zip code for the USA and Canada. |
ShipFromAddr_Note |
string |
false |
false |
Note for the customer. |
ShipFromAddr_Lat |
string |
false |
false |
The latitude coordinate of the geocoded shipping address. |
ShipFromAddr_Long |
string |
false |
false |
The longitude coordinate of the geocoded shipping address. |
ClassRef |
string |
false |
true |
The Id of the class associated with the transaction. |
ClassRef_Name |
string |
true |
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 |
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. |
EmailStatus |
string |
false |
false |
The email status of the invoice. |
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 |
false |
The Id of the payment method. |
PaymentMethodRef_Name |
string |
true |
false |
The name of the payment method. |
DepositToAccountRef |
string |
false |
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 |
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. |
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. |
HomeBalance |
decimal |
true |
false |
Convenience field containing the amount in Balance expressed in terms of the home currency. Calculated by QuickBooks business logic. Value is valid only when CurrencyRef is specified. |