Getting Started

This page provides a guide to Establishing a Connection to QuickBooks Online in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to QuickBooks Online

Establishing a Connection shows how to authenticate to QuickBooks Online and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from QuickBooks Online through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Establishing a Connection

Connect to QuickBooks Online by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

Authenticating to QuickBooks Online

QuickBooks Online provides embedded OAuth credentials that simplify connection from a Desktop application or a Headless machine. To connect from a Web application, you must create a custom OAuth application, as described in Creating a Custom OAuth Application.

To connect via OAuth from all authentication flows, you must set AuthScheme to OAuth.

The following subsections describe how to authenticate to QuickBooks Online from:

Desktop: a connection to a server on the user's local machine, frequently used for testing and prototyping. Authenticated via either embedded OAuth or custom OAuth.
Web: access to data via a shared website. Authenticated via custom OAuth only.
Headless Server: a dedicated computer that provides services to other computers and their users, which is configured to operate without a monitor and keyboard. Authenticated via embedded OAuth or custom OAuth.

For information about how to create a custom OAuth application, and why you might want to create one even for auth flows that already have embedded OAuth credentials, see Creating a Custom OAuth Application.

For a complete list of connection string properties available in QuickBooks Online, see Connection.

When the access token expires, the Cloud refreshes it automatically.

Automatic refresh of the OAuth access token:

To have the Cloud automatically refresh the OAuth access token, do the following:

The first time you connect to data, set these connection parameters:
- InitiateOAuth: REFRESH.
- OAuthClientId: The client Id in your custom OAuth application settings.
- OAuthClientSecret: The client secret in your custom OAuth application settings.
- OAuthAccessToken: The access token returned by GetOAuthAccessToken.
- OAuthSettingsLocation: The path where you want the Cloud to save the OAuth values, which persist across connections.
On subsequent data connections, set:
- InitiateOAuth
- OAuthSettingsLocation

Manual refresh of the OAuth access token:

The only value needed to manually refresh the OAUth access token is the OAuth refresh token.

To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
Set these connection properties:
- OAuthClientId: The Client Id in your custom OAuth application settings.
- OAuthClientSecret: The Client Secret in your custom OAuth application settings.
Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
After the new tokens have been retrieved, set the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken. This opens a new connection.

Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

SSL Configuration

Customizing the SSL Configuration

By default, the Cloud attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

Other Proxies

Set the following properties:

To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
To tunnel the connection, set FirewallType to TUNNEL.
To authenticate, specify FirewallUser and FirewallPassword.
To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Data Model

The CData Cloud models entities in the QuickBooks Online API as tables, views, and stored procedures. These are defined in schema files, which are simple, text-based configuration files.

API limitations and requirements are documented in the following sections; you can use the SupportEnhancedSQL feature, set by default, to circumvent most of these limitations.

Tables

Tables describes the available tables.

Views

Views are tables that cannot be modified. Typically, read-only data are shown as views.

Stored Procedures

Stored Procedures are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.

Tables

The Cloud models the data in QuickBooks Online as a list of tables in a relational database that can be queried using standard SQL statements.

CData Cloud - QuickBooks Online Tables


Name	Description
Accounts	Create, update, delete, and query QuickBooks Accounts.
AttachableRefs	Attachables
Attachables	Attachables
BillLineItems	Create, update, delete, and query QuickBooks Bill Line Items.
BillLinkedTransactions	Create, update, delete, and query QuickBooks Invoice Line Items.
BillPaymentLineItems	Create, update, delete, and query QuickBooks Bill Payment Line Items.
BillPayments	Create, update, delete, and query QuickBooks Bill Payments.
Bills	Create, update, delete, and query QuickBooks Bills.
BudgetDetails	Query QuickBooks BudgetDetails.
Budgets	Query QuickBooks Budgets.
Class	Create, update, delete, and query QuickBooks Classes.
CompanyCurrency	Create, update, delete, and query QuickBooks CompanyCurrency. Applicable only for those companies that enable multicurrency, a companycurrency object defines a currency that is active in the QuickBooks Online company. One or more companycurrency objects are active based on the company's multicurrency business requirements and correspond to the list displayed by the Currency Center in the QuickBooks Online UI.
CompanyInfo	Retrieve information about the QuickBooks company.
CreditMemoLineItems	Create, update, delete, and query QuickBooks Credit Memo Line Items.
CreditMemos	Create, update, delete, and query QuickBooks Credit Memos.
Customers	Create, update, delete, and query QuickBooks Customers.
Departments	Create, update, delete, and query QuickBooks Departments.
DepositLineItems	Create, update, delete, and query QuickBooks Deposit Line Items.
Deposits	Create, update, delete, and query QuickBooks Deposits.
Employees	Create, update, delete, and query QuickBooks Employees.
EstimateLineItems	Create, update, delete, and query QuickBooks Estimate Line Items.
EstimateLinkedTransactions	Create, update, delete, and query QuickBooks Estimate Line Items.
Estimates	Create, update, delete, and query QuickBooks Estimates.
ExchangeRates	Retrieves QuickBooks exchange rates.
InvoiceLineItems	Create, update, delete, and query QuickBooks Invoice Line Items.
InvoiceLinkedTransactions	Create, update, delete, and query QuickBooks Invoice Line Items.
Invoices	Create, update, delete, and query QuickBooks Invoices.
Items	Create, update, delete, and query QuickBooks Items.
JournalCode	Create, update, delete, and query QuickBooks Journal Codes.
JournalEntries	Create, update, delete, and query QuickBooks Journal Entries.
JournalEntryLineItems	Create, update, delete, and query QuickBooks Journal Entry Line Items.
PaymentLineItems	Create, update, delete, and query QuickBooks Payment Line Items.
PaymentMethods	Create, update, delete, and query QuickBooks Payment Methods.
Payments	Create, update, delete, and query QuickBooks Payments.
Preferences	Query QuickBooks Preferences. The Preferences table contains settings for company-wide preferences, which affect all users.
PurchaseLineItems	Create, update, delete, and query QuickBooks Purchase Line Items.
PurchaseOrderLineItems	Create, update, delete, and query QuickBooks Purchase Order Line Items.
PurchaseOrderLinkedTransactions	Create, update, delete, and query QuickBooks Invoice Line Items.
PurchaseOrders	Create, update, delete, and query QuickBooks Purchase Orders.
Purchases	Create, update, delete, and query QuickBooks Purchases.
RecurringCreditMemoTransactions	Create and query QuickBooks Recurring Transactions for Credit Memos.
RecurringCreditMemoTransactionsLineItems	Create and query QuickBooks Recurring Transactions for Credit Memo Line Items.
RecurringDepositTransactions	Create and query QuickBooks Deposits.
RecurringDepositTransactionsLineItems	Create and query QuickBooks Recurring Transactions for Deposit Line Items.
RecurringEstimateTransactions	Create and query QuickBooks Recurring Transaction for Estimates.
RecurringEstimateTransactionsLineItems	Create and query QuickBooks Recurring Transaction Line Items for Estimate.
RecurringInvoiceTransactions	Create and query QuickBooks Recurring Transaction for Invoice.
RecurringInvoiceTransactionsLineItems	Create and query QuickBooks Recurring Transaction Line Items for Invoice.
RecurringJournalEntryTransactions	Create and query QuickBooks Recurring Transaction for Journal Entry.
RecurringJournalEntryTransactionsLineItems	Create and query the QuickBooks RecurringTransactions Journal Entry Line Items.
RecurringPurchaseTransactions	Create and query QuickBooks Recurring Transaction for Purchases.
RecurringPurchaseTransactionsLineItems	Create and query QuickBooks Recurring Transaction for Purchase Line Items.
RecurringRefundReceiptTransactions	Create and query QuickBooks Recurring Transaction for RefundReceipts.
RecurringRefundReceiptTransactionsLineItems	Create and query QuickBooks Recurring Transactions for RefundReceiptLineItems.
RecurringSalesReceiptTransactions	Create and query QuickBooks Recurring Transaction for Sales Receipt.
RecurringSalesReceiptTransactionsLineItems	Create and query QuickBooks Recurring Transaction for Sales Receipt Line Items.
RecurringTransferTransactions	Create and query QuickBooks Recurring Transactions for Transfers
RecurringVendorCreditTransactions	Create and query QuickBooks Recurring Transactions for Vendor Credits.
RecurringVendorCreditTransactionsLineItems	Create and query QuickBooks Recurring Transactions for Vendor Credit Line Items.
RefundReceiptLineItems	Create, update, delete, and query QuickBooks RefundReceiptLineItems.
RefundReceipts	Create, update, delete, and query QuickBooks RefundReceipts.
SalesReceiptLineItems	Create, update, delete, and query QuickBooks Sales Receipt Line Items.
SalesReceipts	Create, update, delete, and query QuickBooks Sales Receipts.
TaxAgency	Create and Query QuickBooks Tax Agency.
TaxCodes	Create and query QuickBooks Sales Tax Codes.
TaxRates	Create and query QuickBooks Tax Rates.
Terms	Create, update, delete, and query QuickBooks Terms.
TimeActivities	Create, update, delete, and query QuickBooks Time Activities.
Transfers	Create, update, delete, and query QuickBooks Transfers
VendorCreditLineItems	Create, update, delete, and query QuickBooks Vendor Credit Line Items.
VendorCredits	Create, update, delete, and query QuickBooks Vendor Credits.
Vendors	Create, update, delete, and query QuickBooks Vendors.

Accounts

Create, update, delete, and query QuickBooks Accounts.

Table Specific Information

Select

All filterable columns support the following operators:

=
!=
>=
<=
>
<
IN
LIKE
CONTAINS

The driver processes other filters client-side within the driver.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Id [KEY]	String	True		True	True	The Id of the account.
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.
Name	String	False		True	True	The name of the account. To create an account, you must provide a unique account name. Default accounts are created for new companies.
SubAccount	Boolean	False		True	True	This value is true if the account is a subaccount, and false or null if it is a top-level account.
ParentRef	String	False	Accounts.Id	True	True	The Id of the parent account.
ParentRef_Name	String	True	Accounts.Name	False	False	The name of the parent account.
FullyQualifiedName	String	True		False	False	The fully qualified name of the account. The fully qualified name consists the topmost parent element followed by each subelement and separated by colons. For example: Parent:Account1:SubAccount1:SubAccount2.
Description	String	False		True	True	The description for the account. This may contain notes on the types of journal entries that should be posted to this account.
Active	Boolean	False		True	False	This field sets whether or not the account is active. Inactive accounts cannot be posted to and are excluded from search results, although references to them are preserved.
Classification	String	False		True	False	The account classification. The allowed values are Asset, Equity, Expense, Liability, Revenue.
AccountType	String	False		True	False	The account type or subclassification that determines how the account is used. This field is indexed by the account classification. The allowed values are Bank, Other Current Asset, Fixed Asset, Other Asset, Accounts Receivable, Equity, Expense, Other Expense, Cost of Goods Sold, Accounts Payable, Credit Card, Long Term Liability, Other Current Liability, Income, Other Income.
AccountSubType	String	False		False	False	The account subtype. This field is indexed by the AccountType field. The allowed values are CashOnHand, Checking, MoneyMarket, RentsHeldInTrust, Savings, TrustAccounts, AllowanceForBadDebts, DevelopmentCosts, EmployeeCashAdvances, OtherCurrentAssets, Inventory, Investment_MortgageRealEstateLoans, Investment_Other, Investment_TaxExemptSecurities, Investment_USGovernmentObligations, LoansToOfficers, LoansToOthers, LoansToStockholders, PrepaidExpenses, Retainage, UndepositedFunds, AccumulatedDepletion, AccumulatedDepreciation, DepletableAssets, FixedAssetComputers, FixedAssetCopiers, FixedAssetFurniture, FixedAssetPhone, FixedAssetPhotoVideo, FixedAssetSoftware, FixedAssetOtherToolsEquipment, FurnitureAndFixtures, Land, LeaseholdImprovements, OtherFixedAssets, AccumulatedAmortization, Buildings, IntangibleAssets, MachineryAndEquipment, Vehicles, LeaseBuyout, OtherLongTermAssets, SecurityDeposits, AccumulatedAmortizationOfOtherAssets, Goodwill, Licenses, OrganizationalCosts, AccountsReceivable, OpeningBalanceEquity, PartnersEquity, RetainedEarnings, AccumulatedAdjustment, OwnersEquity, PaidInCapitalOrSurplus, PartnerContributions, PartnerDistributions, PreferredStock, CommonStock, TreasuryStock, EstimatedTaxes, Healthcare, PersonalIncome, PersonalExpense, AdvertisingPromotional, BadDebts, BankCharges, CharitableContributions, CommissionsAndFees, Entertainment, EntertainmentMeals, EquipmentRental, FinanceCosts, GlobalTaxExpense, Insurance, InterestPaid, LegalProfessionalFees, OfficeExpenses, OfficeGeneralAdministrativeExpenses, OtherBusinessExpenses, OtherMiscellaneousServiceCost, PromotionalMeals, RentOrLeaseOfBuildings, RepairMaintenance, ShippingFreightDelivery, SuppliesMaterials, Travel, TravelMeals, Utilities, Auto, CostOfLabor, DuesSubscriptions, PayrollExpenses, TaxesPaid, UnappliedCashBillPaymentExpense, Depreciation, ExchangeGainOrLoss, OtherMiscellaneousExpense, PenaltiesSettlements, Amortization, GasAndFuel, HomeOffice, HomeOwnerRentalInsurance, OtherHomeOfficeExpenses, MortgageInterest, RentAndLease, RepairsAndMaintenance, ParkingAndTolls, Vehicle, VehicleInsurance, VehicleLease, VehicleLoanInterest, VehicleLoan, VehicleRegistration, VehicleRepairs, OtherVehicleExpenses, Utilities, WashAndRoadServices, EquipmentRentalCos, OtherCostsOfServiceCos, ShippingFreightDeliveryCos, SuppliesMaterialsCogs, CostOfLaborCos, Accounts Payable, Credit Card, NotesPayable, OtherLongTermLiabilities, ShareholderNotesPayable, DirectDepositPayable, LineOfCredit, LoanPayable, GlobalTaxPayable, GlobalTaxSuspense, OtherCurrentLiabilities, PayrollClearing, PayrollTaxPayable, PrepaidExpensesPayable, RentsInTrustLiability, TrustAccountsLiabilities, FederalIncomeTaxPayable, InsurancePayable, SalesTaxPayable, StateLocalIncomeTaxPayable, NonProfitIncome, OtherPrimaryIncome, SalesOfProductIncome, ServiceFeeIncome, DiscountsRefundsGiven, UnappliedCashPaymentIncome, DividendIncome, InterestEarned, OtherInvestmentIncome, OtherMiscellaneousIncome, TaxExemptInterest, PayrollWageExpenses, PayrollTaxExpenses, CashAndCashEquivalents, OtherEarMarkedBankAccounts, AssetsAvailableForSale, BalWithGovtAuthorities, CalledUpShareCapitalNotPaid, ExpenditureAuthorisationsAndLettersOfCredit, GlobalTaxDeferred, GlobalTaxRefund, InternalTransfers, OtherConsumables, ProvisionsCurrentAssets, ShortTermInvestmentsInRelatedParties, ShortTermLoansAndAdvancesToRelatedParties, TradeAndOtherReceivables, AssetsInCourseOfConstruction, CapitalWip, CumulativeDepreciationOnIntangibleAssets, IntangibleAssetsUnderDevelopment, LandAsset, NonCurrentAssets, ParticipatingInterests, ProvisionsFixedAssets, AssetsHeldForSale, AvailableForSaleFinancialAssets, DeferredTax, Investments, LongTermInvestments, LongTermLoansAndAdvancesToRelatedParties, OtherIntangibleAssets, OtherLongTermInvestments, OtherLongTermLoansAndAdvances, PrepaymentsAndAccruedIncome, ProvisionsNonCurrentAssets, AccumulatedOtherComprehensiveIncome, CalledUpShareCapital, CapitalReserves, DividendDisbursed, EquityInEarningsOfSubsiduaries, InvestmentGrants, MoneyReceivedAgainstShareWarrants, OtherFreeReserves, ShareApplicationMoneyPendingAllotment, ShareCapital, Funds, AmortizationExpense, AppropriationsToDepreciation, BorrowingCost, CommissionsAndFees, DistributionCosts, ExternalServices, ExtraordinaryCharges, IncomeTaxExpense, LossOnDiscontinuedOperationsNetOfTax, ManagementCompensation, OtherCurrentOperatingCharges, OtherExternalServices, OtherRentalCosts, OtherSellingExpenses, ProjectStudiesSurveysAssessments, PurchasesRebates, ShippingAndDeliveryExpense, StaffCosts, Sundry, TravelExpensesGeneralAndAdminExpenses, TravelExpensesSellingExpense, DeferredTaxExpense, Depletion, ExceptionalItems, ExtraordinaryItems, IncomeTaxOtherExpense, MatCredit, PriorPeriodItems, TaxRoundoffGainOrLoss, CostOfSales, FreightAndDeliveryCost, OutstandingDuesMicroSmallEnterprise, OutstandingDuesOtherThanMicroSmallEnterprise, AccrualsAndDeferredIncome, AccruedLongLermLiabilities, AccruedVacationPayable, BankLoans, DebtsRelatedToParticipatingInterests, DeferredTaxLiabilities, GovernmentAndOtherPublicAuthorities, GroupAndAssociates, LiabilitiesRelatedToAssetsHeldForSale, LongTermBorrowings, LongTermDebit, LongTermEmployeeBenefitObligations, ObligationsUnderFinanceLeases, OtherLongTermProvisions, ProvisionForLiabilities, ProvisionsNonCurrentLiabilities, StaffAndRelatedLongTermLiabilityAccounts, AccruedLiabilities, CurrentLiabilities, CurrentPortionEmployeeBenefitsObligations, CurrentPortionOfObligationsUnderFinanceLeases, CurrentTaxLiability, DividendsPayable, DutiesAndTaxes, InterestPayables, ProvisionForWarrantyObligations, ProvisionsCurrentLiabilities, ShortTermBorrowings, SocialSecurityAgencies, StaffAndRelatedLiabilityAccounts, SundryDebtorsAndCreditors, TradeAndOtherPayables, CashReceiptIncome, OperatingGrants, OtherCurrentOperatingIncome, OwnWorkCapitalized, RevenueGeneral, SalesRetail, SalesWholesale, SavingsByTaxScheme, GainLossOnSaleOfFixedAssets, GainLossOnSaleOfInvestments, LossOnDisposalOfAssets, OtherOperatingIncome, UnrealisedLossOnSecuritiesNetOfTax.
AcctNum	String	False		False	False	A user-defined account number that identifies the account within the chart of accounts and notes the information that should be posted to the account.
CurrentBalance	Decimal	True		True	True	The current balance. This field is available for only balance sheet accounts.
CurrentBalanceWithSubAccounts	Decimal	True		False	False	The cumulative current balance amount for the account and all its subaccounts.
CurrencyRef	String	False		False	False	The Id of the currency used by the account.
CurrencyRef_Name	String	True		False	False	A name that identifies the currency used by the account.
TaxCodeRef	String	False	TaxCodes.Id	False	False	The ID of the associated Tax Code. This ID can be used with the TaxCodes view to find more information about the associated tax. Only available in International versions of QuickBooks Online.

AttachableRefs

Attachables

Table Specific Information

Select

All filterable columns support the following operators:

=
!=
>=
<=
>
<
IN
LIKE
CONTAINS

The driver processes other filters client-side within the driver.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
EntityRefId [KEY]	String	True		True	True	The ID of the Entity Ref of the attachable.
AttachableId [KEY]	String	True	Attachables.ID	True	True	The Id of the attachable.
SyncToken	String	True		False	False	The version number of the entity. This must be specified when executing an update or delete.
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.
FileName	String	False		True	True	FileName of the attachment.
Size	Integer	False		True	True	Size of the attachment.
ContentType	String	False		True	True	ContentType of the attachment.
Category	String	False		True	True	Category of the attachment.
Latitude	Double	False		True	True	Latitude from where the attachment was requested.
Longitude	Double	False		True	True	Longitude from where the attachment was requested.
Note	String	False		True	True	Note either related to the attachment or as a standalone note.
PlaceName	String	False		True	True	PlaceName from where the attachment was requested.
Tag	String	False		True	True	Tag name for the requested attachment.
AttachableRef_EntityRef	String	False		True	False	Value
AttachableRef_EntityRef_type	String	False		True	False	Type
AttachableRef_EntityRef_name	String	False		False	False	Type name
AttachableRef_IncludeOnSend	Boolean	False		True	False	On sending email to customer (most likely for txns), this field indicates whether or not the attachment is to be sent together with the email.
AttachableRef_LineInfo	String	False		True	True	If the entity is a transaction, user can also specify a transaction detail line to reference.
FileAccessUri	String	False		True	True	FullPath FileAccess URI of the attachment.
TempDownloadUri	String	False		True	True	TempDownload URI which can be directly downloaded by clients.

Attachables

Table Specific Information

Select

All filterable columns support the following operators:

=
!=
>=
<=
>
<
IN
LIKE
CONTAINS

The driver processes other filters client-side within the driver.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Id [KEY]	String	True		True	True	The Id of the attachable.
SyncToken	String	True		False	False	The version number of the entity. This must be specified when executing an update or delete.
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.
FileName	String	False		True	True	FileName of the attachment.
Size	Integer	False		True	True	Size of the attachment.
ContentType	String	False		True	True	ContentType of the attachment.
Category	String	False		True	True	Category of the attachment.
Latitude	Double	False		True	True	Latitude from where the attachment was requested.
Longitude	Double	False		True	True	Longitude from where the attachment was requested.
Note	String	False		True	True	Note either related to the attachment or as a standalone note.
PlaceName	String	False		True	True	PlaceName from where the attachment was requested.
Tag	String	False		True	True	Tag name for the requested attachment.
AttachableRefAggregate	String	False		False	False	Aggregate that specifies the transaction object to which this attachable file is to be linked
FileAccessUri	String	False		True	True	FullPath FileAccess URI of the attachment.
TempDownloadUri	String	False		True	True	TempDownload URI which can be directly downloaded by clients.

BillLineItems

Create, update, delete, and query QuickBooks Bill Line Items.

Table Specific Information

Bills may be inserted, updated, or queried via the Bills or BillLineItems tables. Bills may be deleted by using the Bills 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 Bill, specify the Line_Amount, Line_DetailType, Line_AccountBasedExpenseLineDetail_AccountRef, VendorRef.For example, the following will insert a new Bill with two Line Items:

INSERT INTO BillLineItems (Line_Amount, Line_DetailType, Line_AccountBasedExpenseLineDetail_AccountRef, VendorRef) VALUES ('4.04', 'AccountBasedExpenseLineDetail', '7', '36')

INSERT INTO BillLineItems#TEMP (Line_Amount, Line_DetailType, Line_AccountBasedExpenseLineDetail_AccountRef, VendorRef) VALUES ('4.04', 'AccountBasedExpenseLineDetail', '7', '36')
      INSERT INTO Bills ( VendorRef, Id, DocNumber, TxnDate, PrivateNote, LineAggregate) VALUES ('36', '6704', '66', '1/1/2040', 'AccountBasedExpenseLineDetail', BillLineItems#TEMP)

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
LineId [KEY]	String	True		False	False	The Id of the line item of the bill.
BillId [KEY]	String	False	Bills.ID	True	True	The Id of the bill.
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.
DocNumber	String	False		True	True	The reference number for the transaction.
TxnDate	Date	False		True	True	The date of the transaction. This field is often the date when the transaction was entered into the system, but it is not required to be. If the date is not supplied, the current date on the server is used. For posting transactions, this is the posting date that affects financial statements.
PrivateNote	String	False		False	False	A private note about the transaction. By default, this note will not appear on the transaction records.
LinkedTxnAggregate	String	False		False	False	An XML aggregate of transactions linked to the estimate.
Line_Id	String	False		False	False	The Id of the line item.
Line_Amount	Decimal	False		False	False	The total amount of the charges and discounts for the line item. This includes charges and allowances but excludes the tax amount.
Line_Description	String	False		False	False	The line description.
Line_DetailType	String	False		False	False	The detail type of the line item.
Line_AccountBasedExpenseLineDetail_ClassRef	String	False	Class.Id	False	False	The Id of the class entity of the expense.
Line_AccountBasedExpenseLineDetail_ClassRef_Name	String	True	Class.FullyQualifiedName	False	False	The name of the class entity of the expense.
Line_AccountBasedExpenseLineDetail_CustomerRef	String	False	Customers.Id	False	False	The customer Id for the expense.
Line_AccountBasedExpenseLineDetail_CustomerRef_Name	String	True	Customers.DisplayName	False	False	The customer name for the expense.
Line_AccountBasedExpenseLineDetail_AccountRef	String	False	Accounts.Id	False	False	The Id of the expense account of the expense.
Line_AccountBasedExpenseLineDetail_AccountRef_Name	String	True	Accounts.Name	False	False	The name of the expense account of the expense.
Line_AccountBasedExpenseLineDetail_TaxCodeRef	String	False	TaxCodes.Id	False	False	The sales tax code for the expense.
Line_AccountBasedExpenseLineDetail_TaxAmount	Decimal	False		False	False	Sales tax paid as part of the expense.
Line_AccountBasedExpenseLineDetail_TaxInclusiveAmt	Decimal	False		False	False	The total amount of the line item including tax.
Line_AccountBasedExpenseLineDetail_BillableStatus	String	False		False	False	The billable status of the expense. The allowed values are Billable, NotBillable, HasBeenBilled.
Line_AccountBasedExpenseLineDetail_MarkupInfo_Value	Decimal	True		False	False	Markup value.
Line_AccountBasedExpenseLineDetail_MarkupInfo_Percent	Double	False		False	False	Markup amount expressed as a percent of charges already entered in the current transaction. To enter a rate of 10% use 10.0, not 0.01.
Line_AccountBasedExpenseLineDetail_MarkupInfo_PriceLevelRef	String	False		False	False	The Id of the entity for the price level for the markup.
Line_ItemBasedExpenseLineDetail_ItemRef	String	False	Items.Id	False	False	The Id of the item associated with the expense.
Line_ItemBasedExpenseLineDetail_ItemRef_Name	String	True	Items.Name	False	False	The name of the item associated with the expense.
Line_ItemBasedExpenseLineDetail_ClassRef	String	False	Class.Id	False	False	The Id of the class for the line item.
Line_ItemBasedExpenseLineDetail_ClassRef_Name	String	True	Class.FullyQualifiedName	False	False	The name of the class for the line item.
Line_ItemBasedExpenseLineDetail_UnitPrice	Decimal	False		False	False	The unit price of the subject item as referenced.
Line_ItemBasedExpenseLineDetail_Qty	Double	False		False	False	Number of items for the line.
Line_ItemBasedExpenseLineDetail_CustomerRef	String	False	Customers.Id	False	False	The customer Id for the expense.
Line_ItemBasedExpenseLineDetail_CustomerRef_Name	String	True	Customers.DisplayName	False	False	The customer name for the expense.
Line_ItemBasedExpenseLineDetail_TaxCodeRef	String	False	TaxCodes.Id	False	False	The sales tax code for the expense.
Line_ItemBasedExpenseLineDetail_BillableStatus	String	False		False	False	The billable status of the expense. The allowed values are Billable, NotBillable, HasBeenBill.
Line_ItemBasedExpenseLineDetail_MarkupInfo_Value	Double	True		False	False	Markup value.
Line_ItemBasedExpenseLineDetail_MarkupInfo_Percent	Double	False		False	False	Markup amount expressed as a percent of charges already entered in the current transaction. To enter a rate of 10% use 10.0, not 0.01.
Line_ItemBasedExpenseLineDetail_MarkupInfo_PriceLevelRef	String	False		False	False	The Id of the entity for the price level for the markup.
Line_ItemBasedExpenseLineDetail_MarkupInfo_PriceLevelRef_Name	String	True		False	False	A name that identifies the price level for the markup.
VendorRef	String	False	Vendors.Id	True	True	The Id of the vendor.
VendorRef_Name	String	True	Vendors.DisplayName	False	False	The name of the vendor.
APAccountRef	String	False	Accounts.Id	True	True	The Id of the accounts-payable account.
APAccountRef_Name	String	True	Accounts.Name	False	False	The name of the accounts-payable account.
TotalAmt	Decimal	False		True	True	The total amount of the bill, determined by taking the sum of all the line items of the bill.
SalesTermRef	String	False	Terms.Id	True	True	The Id of the sales term.
SalesTermRef_Name	String	True	Terms.Name	False	False	A name that identifies the sales term.
DueDate	Date	False		True	True	The due date of the bill. This date excludes early payment discount incentives and late payment penalties.
Balance	Decimal	True		True	False	The unpaid amount of the bill. When paid in full this value is 0.
DepartmentRef	String	False	Departments.Id	False	False	The Id of the department, which stores the location of the transaction.
DepartmentRef_Name	String	True	Departments.Name	False	False	A name that identifies the department.
TxnTaxDetail_TxnTaxCodeRef	String	False	TaxCodes.Id	False	False	The tax code of the transaction.
TxnTaxDetail_TotalTax	String	False		False	False	The tax calculated for the transaction. This value excludes any tax line items that have been manually inserted into the transaction.
TxnTaxDetail_TaxLineAggregate	String	False		False	False	An XML aggregate of the tax line items.
CurrencyRef	String	False		False	False	The Id of the currency used in the transaction.
CurrencyRef_Name	String	True		False	False	A name that identifies the currency of the transaction.
ExchangeRate	Decimal	False		False	False	The number of home currency units required to equal one foreign currency unit. This column is available only if the company file is using the multicurrency feature and is available in only the UK, AU, and CA editions.
GlobalTaxCalculation	String	False		False	False	The method used to apply taxes. This column is available in only the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable.

BillLinkedTransactions

Create, update, delete, and query QuickBooks Invoice Line Items.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
LinkedTxnId [KEY]	String	True		False	False	The Id of the line item of the bill.
BillId [KEY]	String	False	Bills.Id	True	True	The Id of the bill.
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.
DocNumber	String	False		True	True	The reference number for the transaction.
TxnDate	Date	False		True	True	The date entered by the user when this transaction occurred.
PrivateNote	String	False		False	False	A private note for the transaction, which does not appear on the transaction records.
LinkedTxn_TxnId	String	False		False	False	The Id of the line item.
LinkedTxn_TxnType	String	False		False	False	The line number of the line item.
LinkedTxn_TxnLineId	String	False		False	False	The description of the line item.
LineAggregate	String	False		False	False	An XML aggregate of line items associated with the transaction.
VendorRef	String	False	Vendors.Id	True	True	The Id of the vendor.
VendorRef_Name	String	True	Vendors.DisplayName	False	False	The name of the vendor associated with the transaction.
APAccountRef	String	False	Accounts.Id	True	True	The Id of the accounts-payable account.
APAccountRef_Name	String	True	Accounts.Name	False	False	The name of the accounts-payable account.
SalesTermRef	String	False	Terms.Id	True	True	The Id of the sales terms entity of the bill.
SalesTermRef_Name	String	True	Terms.Name	False	False	A name that identifies the sales terms entity of the bill.
TxnTaxDetail_TxnTaxCodeRef	String	False	TaxCodes.Id	False	False	The tax code for the transaction.
TxnTaxDetail_TotalTax	String	False		False	False	The 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.
DueDate	Date	False		True	False	The date when the invoice is to be paid, not including any early payment discount incentives or late payment penalties. If the date is not supplied, the current date on the server is used.
TotalAmt	Decimal	True		True	True	The total amount of the transaction. This includes the total of all the charges, allowances, and taxes.
Balance	Decimal	False		False	False	This field indicates whether the transaction is a finance charge.
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.
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. Valid only if the company file is set up to use 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 only the UK, AU, and CA editions.
GlobalTaxCalculation	String	False		False	False	The method in which tax is applied. This field is valid in the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable.

BillPaymentLineItems

Create, update, delete, and query QuickBooks Bill Payment Line Items.

Table Specific Information

BillPayments may be inserted or queried via the BillPayments or BillPaymentLineItems tables. BillPayments may be deleted by using the BillPayments 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 BillPayment, specify the Vendor, PayType, TxnDate (transaction date), and TotalAmt columns and at least one Line Item, as well as either CreditCardPayment or CheckPayment. You must enter an amount for each Line Item up to but not exceeding the total amount remaining to be paid for each Bill. The following shows an example of inserting multiple Bills, each with a single line. To insert a BillPayment with multiple lines, see the example on the BillPayments table.

INSERT INTO BillPaymentLineItems#TEMP (VendorRef, PayType, TxnDate, CheckPayment_BankAccountRef, CheckPayment_PrintStatus, Line_Amount, Line_LinkedTxn_TxnId, Line_LinkedTxn_TxnType, TotalAmt) VALUES ('21', 'Check', '1/1/2011', '41', 'NotSet', 0.01, '313', 'Bill', 0.03)
INSERT INTO BillPaymentLineItems#TEMP (VendorRef, PayType, TxnDate, CheckPayment_BankAccountRef, CheckPayment_PrintStatus, Line_Amount, Line_LinkedTxn_TxnId, Line_LinkedTxn_TxnType, TotalAmt) VALUES ('21', 'Check', '1/1/2011', '41', 'NotSet', 0.02, '312', 'Bill', 0.03)
 INSERT INTO BillPaymentLineItems (VendorRef, PayType, TxnDate, CheckPayment_BankAccountRef, CheckPayment_PrintStatus, Line_Amount, Line_LinkedTxn_TxnId, Line_LinkedTxn_TxnType, TotalAmt) SELECT VendorRef, PayType, TxnDate, CheckPayment_BankAccountRef, CheckPayment_PrintStatus, Line_Amount, Line_LinkedTxn_TxnId, Line_LinkedTxn_TxnType, TotalAmt FROM BillPaymentLineItems#TEMP

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
LineId [KEY]	String	True		False	False	The Id of the line item of the bill payment.
BillPaymentId [KEY]	String	False	BillPayments.Id	True	True	The Id of the bill payment.
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.
DocNumber	String	False		True	True	The document number for this transaction. When creating a line item, if this field is not provided QuickBooks business logic will assign the document number using the next-in-sequence algorithm.
TxnDate	Date	False		True	True	The date of the transaction. This field is often the date when the transaction was entered into the system, but it is not required to be. For posting transactions, this is the posting date that affects financial statements
PrivateNote	String	False		False	False	A private note about the transaction. By default, this field does not appear on the transaction records.
DepartmentRef	String	False	Departments.Id	False	False	The Id of the department, which stores the location of the transaction.
DepartmentRef_Name	String	True	Departments.Name	False	False	The name of the department.
Line_LinkedTxn_TxnId	String	False	Bills.Id	False	False	The Id of the transaction linked to the line item.
Line_Amount	Decimal	False		False	False	The amount of the line item.
Line_LinkedTxn_TxnType	String	False		False	False	The type of the transaction linked to the line item.
VendorRef	String	False	Vendors.Id	True	True	The Id of the vendor for this transaction.
VendorRef_Name	String	True	Vendors.DisplayName	False	False	The name of the vendor for this transaction.
APAccountRef	String	False	Accounts.Id	True	True	The Id of the accounts-payable account that the vendor credit is credited to. If the company has a single accounts-payable account, this account is implied. This must be a Liability account and the subtype must be of type Payables.
APAccountRef_Name	String	True	Accounts.Name	False	False	The name of the accounts-payable account the vendor credit is credited to. If the company has a single accounts-payable account, this account is implied. This must be a Liability-type account and the subtype must be of type Payables.
PayType	String	False		False	False	The payment type. The allowed values are Check, CreditCard.
CheckPayment_BankAccountRef	String	False	Accounts.Id	True	True	The Id of the bank account, which issued the check.
CheckPayment_BankAccountRef_Name	String	True	Accounts.Name	False	False	A name that identifies the bank account.
CheckPayment_PrintStatus	String	False		False	False	The print status of the check payment. This field is only applicable for checks and ignored for credit card charges and refunds. The allowed values are NotSet, NeedToPrint, PrintComplete. The default value is NeedToPrint.
CreditCardPayment_CCAccountRef	String	False	Accounts.Id	True	True	The Id of the credit card account.
CreditCardPayment_CCAccountRef_Name	String	True	Accounts.Name	False	False	The name of the credit card account.
TotalAmt	Decimal	False		True	True	The total amount of the bill, determined by the sum of all line items in the bill payment.
ProcessBillPayment	Boolean	False		False	False	This field indicates that the payment should be processed by the merchant account service. This field is available for companies with credit card processing enabled in QuickBooks Online.
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 exchange rate for the currency. This field is available only if the company file uses 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 in only the UK, AU, and CA editions.

BillPayments

Create, update, delete, and query QuickBooks Bill Payments.

Table Specific Information

BillPayments may be inserted or queried via the BillPayments or BillPaymentLineItems tables. They may be deleted by using the BillPayments 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 BillPayment, specify the Vendor, PayType, TxnDate, and TotalAmt columns, as well as at least one Line Item and either CreditCardPayment or CheckPayment. You must enter an amount for each Line Item up to but not exceeding the total amount remaining to be paid for each Bill. The LineAggregate column may be used to specify an XML aggregate of Line Item data. Each _ denotes hierarchy. Use <Line> at the base level. The contents of LineAggregate will be sent to the API as is. All values for each field in the aggregate should adhere to the API's specifications (e.g. for dates in format yyyy-MM-dd, for date times in format yyyy-MM-dd'T'HH:mm:sszzz).The columns that may be used in the aggregates begin with the prefix 'Line_' to indicate they are part of the line item. Use the Line_ column along with the DocNumber to indicate which lines go with which BillPayments. For example:

INSERT INTO BillPayments (VendorRef, PayType, TxnDate, CheckPayment_BankAccountRef, CheckPayment_PrintStatus, TotalAmt, LineAggregate) 
VALUES ('21', 'Check', '1/1/2011', '41', 'NotSet', 0.03 '
<Line><Amount>Repairs</Amount><LinkedTxn><TxnId>312</TxnId><TxnType>Bill</TxnType></LinkedTxn></Line>
<Line><Amount>Removal</Amount><LinkedTxn><TxnId>313</TxnId><TxnType>Bill</TxnType></LinkedTxn></LinkedTxn></Line>
')

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Id [KEY]	String	True		True	True	The Id of the bill payment.
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.
DocNumber	String	False		True	True	The document number for the transaction. If it is not provided in a create operation, QuickBooks business logic will assign the document number using the next-in-sequence algorithm.
TxnDate	Date	False		True	True	The date of the transaction. This field is often the date when the transaction was entered into the system, but it is not required to be. This field is used in the financial statements for posting transactions.
PrivateNote	String	False		False	False	A private note about the transaction. This note will not appear on the transaction records by default.
DepartmentRef	String	False	Departments.Id	False	False	The Id of the department entity, which stores the location of the transaction.
DepartmentRef_Name	String	True	Departments.Name	False	False	The name of the department.
LineAggregate	String	False		False	False	An XML aggregate containing the line items associated with the bill payment.
VendorRef	String	False	Vendors.Id	True	True	The Id of the vendor.
VendorRef_Name	String	True	Vendors.DisplayName	False	False	The name of the vendor.
APAccountRef	String	False	Accounts.Id	True	True	The Id of the accounts-payable account the vendor credit is credited to. If a single accounts-payable account is used, this account is implied. This account must be a Liability account and the subtype must be of type Payables.
APAccountRef_Name	String	True	Accounts.Name	False	False	The name of the accounts-payable account the vendor credit is credited to. If the company uses a single accounts-payable account, this account is implied. This account must be a Liability account and the subtype must be of type Payables.
PayType	String	False		False	False	The payment type. The allowed values are Check, CreditCard.
CheckPayment_BankAccountRef	String	False	Accounts.Id	False	False	The Id of the bank account.
CheckPayment_BankAccountRef_Name	String	True	Accounts.Name	False	False	The name of the bank account.
CheckPayment_PrintStatus	String	False		False	False	The print status of the check payment. This field is only applicable for checks. It is ignored for credit card charges or refunds. The allowed values are NotSet, NeedToPrint, PrintComplete. The default value is NeedToPrint.
CreditCardPayment_CCAccountRef	String	False	Accounts.Id	True	True	The Id of the credit card account.
CreditCardPayment_CCAccountRef_Name	String	True	Accounts.Name	False	False	A name that identifies the credit card account.
TotalAmt	Decimal	False		True	True	This field sets the total amount of the bill. This includes the total of all the payments from the line items of the bill payment.
ProcessBillPayment	Boolean	False		False	False	This field sets whether the payment is processed by the merchant account service. This field is valid for QuickBooks Online companies with credit card processing.
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 only valid if the company file uses 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 in only the UK, AU, and CA editions.
TransactionLocationType	String	False		False	False	The account location. This field is valid in only the FR editions. The allowed values are WithinFrance, FranceOverseas, OutsideFranceWithEU, OutsideEU.

Bills

Create, update, delete, and query QuickBooks Bills.

Table Specific Information

Bills may be inserted, deleted, updated, or queried via the Bills or BillLineItems tables. Bills may be deleted by using the Bills 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 Bill, specify the Vendor, APAccountRef, and TxnDate columns and at least one Line Item. The LineAggregate column may be used to specify an XML aggregate of Line Item data. Each _ denotes hierarchy. Use <Line> at the base level. The contents of LineAggregate will be sent to the API as is. All values for each field in the aggregate should adhere to the API's specifications (e.g. for dates in format yyyy-MM-dd, for date times in format yyyy-MM-dd'T'HH:mm:sszzz). The columns that may be used in the aggregates begin with the prefix 'Line_' to indicate they are part of the line item. Use the Line_ column along with the DocNumber to indicate which lines go with which Bills. For example:

INSERT INTO Bills (VendorRef, APAccountRef, TxnDate, LineAggregate) 
VALUES ('21', '66', '1/1/2011', '
<Line><Amount>4.04</Amount><DetailType>AccountBasedExpenseLineDetail</DetailType><AccountBasedExpenseLineDetail><AccountRef>7</AccountRef></AccountBasedExpenseLineDetail></Line>
<Line><Amount>6.06</Amount><DetailType>AccountBasedExpenseLineDetail</DetailType><AccountBasedExpenseLineDetail><AccountRef>8</AccountRef></AccountBasedExpenseLineDetail></Line>
')

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Id [KEY]	String	True		True	True	The Id of the bill.
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.
DocNumber	String	False		True	True	The reference number for the transaction.
TxnDate	Date	False		True	True	The date of the transaction. This field is often the date when the transaction was entered into the system, but it is not required to be. For posting transactions, this is the posting date that affects financial statements.
PrivateNote	String	False		False	False	A private note about the transaction. This note will not appear on the transaction records by default.
LinkedTxnAggregate	String	False		False	False	An XML aggregate of transactions linked to the estimate.
LineAggregate	String	False		False	False	An XML aggregate of the line items of the bill.
VendorRef	String	False	Vendors.Id	True	True	The Id of the vendor.
VendorRef_Name	String	True	Vendors.DisplayName	False	False	The name of the vendor associated with the transaction.
APAccountRef	String	False	Accounts.Id	True	True	The Id of the accounts-payable account.
APAccountRef_Name	String	True	Accounts.Name	False	False	The name of the accounts-payable account.
TotalAmt	Decimal	False		True	True	The total amount due, determined by taking the sum of the line items.
SalesTermRef	String	False	Terms.Id	True	True	The Id of the sales terms entity of the bill.
SalesTermRef_Name	String	True	Terms.Name	False	False	A name that identifies the sales terms entity of the bill.
DueDate	Date	False		True	True	The due date for the bill, excluding early payment discount incentives and late payment penalties.
Balance	Decimal	True		True	False	The unpaid amount of the bill. When paid in full this value is 0.
DepartmentRef	String	False	Departments.Id	False	False	The Id of the department, which stores the location of the transaction.
DepartmentRef_Name	String	True	Departments.Name	False	False	The name of the department.
TxnTaxDetail_TxnTaxCodeRef	String	False	TaxCodes.Id	False	False	The tax code of the transaction.
TxnTaxDetail_TotalTax	String	False		False	False	The 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.
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 available only if the multicurrency feature has been set for the company file. 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 only the UK, AU, and CA editions.
GlobalTaxCalculation	String	False		False	False	The method used to apply the tax. This field is valid in only the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable.
TransactionLocationType	String	False		False	False	The account location. This field is valid in only the FR editions. The allowed values are WithinFrance, FranceOverseas, OutsideFranceWithEU, OutsideEU.

BudgetDetails

Query QuickBooks BudgetDetails.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
BudgetId [KEY]	String	True		True	True	The Id of the customer.
DetailId [KEY]	String	True		True	True	The Id of the customer.
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.
Name	String	True		True	True	A user recogniyable name for the Account.
StartDate	Datetime	True		False	False	The begin date for the Budget.
EndDate	Datetime	True		False	False	The end date for the Budget.
BudgetType	String	True		True	True	The type of budget. The allowed values are ProfitAndLoss, Balance Sheet.
BudgetEntryType	String	True		False	False	Period that the budget covers. The allowed values are Monthly, Quarterly, Annually.
Active	Boolean	True		True	False	A boolean indicating if the budget is active.
BudgetDetail_BudgetDate	Datetime	True		False	False	Date of the individual BudgetDetail.
BudgetDetail_Amount	Decimal	True		False	False	Amount assigned to a BudgetDetail.
BudgetDetail_AccountRef	String	True	Accounts.Id	False	False	The id of the account associated with the BudgetDetail.
BudgetDetail_AccountRef_Name	String	True	Accounts.Name	False	False	The name of the account associated with the BudgetDetail.
BudgetDetail_CustomerRef	String	True	Customers.Id	False	False	The id of the customer associated with the BudgetDetail.
BudgetDetail_CustomerRef_Name	String	True	Customers.DisplayName	False	False	The name of the customer associated with the BudgetDetail.
BudgetDetail_ClassRef	String	True	Class.Id	False	False	The id of the class associated with the BudgetDetail.
BudgetDetail_ClassRef_Name	String	True	Class.FullyQualifiedName	False	False	The name of the class associated with the BudgetDetail.
BudgetDetail_DepartmentRef	String	True	Departments.Id	False	False	The id of the department associated with the BudgetDetail.
BudgetDetail_DepartmentRef_Name	String	True	Departments.Name	False	False	The name of the department associated with the BudgetDetail.

Budgets

Query QuickBooks Budgets.

Table Specific Information

Select

All filterable columns support the following operators:

=
!=
>=
<=
>
<
IN
LIKE
CONTAINS

The driver processes other filters client-side within the driver.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Id [KEY]	String	True		True	True	The Id of the customer.
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.
Name	String	True		True	True	A user recogniyable name for the Account.
StartDate	Datetime	True		False	False	The begin date for the Budget.
EndDate	Datetime	True		False	False	The end date for the Budget.
BudgetType	String	True		True	True	The type of budget. The allowed values are ProfitAndLoss, Balance Sheet.
BudgetEntryType	String	True		False	False	Period that the budget covers. The allowed values are Monthly, Quarterly, Annually.
Active	Boolean	True		True	False	A boolean indicating if the budget is active.

Class

Create, update, delete, and query QuickBooks Classes.

Table Specific Information

Select

All filterable columns support the following operators:

=
!=
>=
<=
>
<
IN
LIKE
CONTAINS

The driver processes other filters client-side within the driver.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Id [KEY]	String	True		True	True	The Id of the class.
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.
Name	String	False		True	True	The name of the class.
SubClass	Boolean	True		True	True	This field indicates whether the class is a subclass or not.
ParentRef	String	False	Class.Id	False	False	The Id of the parent record.
ParentRef_Name	String	True	Class.Name	False	False	The Id of the parent record.
Active	Boolean	False		True	True	This field sets whether or not the class is active. Inactive classes may be hidden from display and excluded from financial transactions.
FullyQualifiedName	String	True		True	True	The fully qualified name of the class. The fully qualified name consists the topmost parent element followed by each subelement and separated by colons. For example: Parent:Account1:SubAccount1:SubAccount.

CompanyCurrency

Create, update, delete, and query QuickBooks CompanyCurrency. Applicable only for those companies that enable multicurrency, a companycurrency object defines a currency that is active in the QuickBooks Online company. One or more companycurrency objects are active based on the company's multicurrency business requirements and correspond to the list displayed by the Currency Center in the QuickBooks Online UI.

Table Specific Information

Select

All filterable columns support the following operators:

=
!=
>=
<=
>
<
IN
LIKE
CONTAINS

The driver processes other filters client-side within the driver.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Id [KEY]	String	True		True	True	The Id of the currency object.
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.
Code	String	False		True	True	A three letter string representing the ISO 4217 code for the currency.
Name	String	False		False	True	The fullName of the Currrency object.
Active	Boolean	False		True	False	This field sets whether or not the currency is active. Inactive accounts cannot be posted to and are excluded from search results, although references to them are preserved.

CompanyInfo

Retrieve information about the QuickBooks company.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Id [KEY]	String	True		False	False	The Id of the company.
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		False	False	The time the record was created.
MetaData_LastUpdatedTime	Datetime	True		False	False	The time the record was last updated.
CompanyName	String	True		False	False	The name of the company.
LegalName	String	True		False	False	The legal name of the company.
CompanyAddr_Id	String	False		False	False	The Id of the Intuit entity for the company address, mainly used for modifying the address. This field is assigned by the data service.
CompanyAddr_Line1	String	False		False	False	The first line of the address.
CompanyAddr_Line2	String	False		False	False	The second line of the address.
CompanyAddr_Line3	String	False		False	False	The third line of the address.
CompanyAddr_Line4	String	False		False	False	The fourth line of the address.
CompanyAddr_Line5	String	False		False	False	The fifth line of the address.
CompanyAddr_City	String	False		False	False	The city name.
CompanyAddr_Country	String	False		False	False	The country name.
CompanyAddr_CountrySubDivisionCode	String	False		False	False	The country region. The state name for the USA or the province name for Canada.
CompanyAddr_PostalCode	String	False		False	False	The postal code. The zip code for the USA and Canada.
CompanyAddr_Note	String	False		False	False	A note for the customer.
CompanyAddr_Lat	String	False		False	False	The latitude coordinate of the geocoded address.
CompanyAddr_Long	String	False		False	False	The longitude coordinate of the geocoded address.
CustomerCommunicationAddr_Id	String	False		False	False	The Id of the customer communication address. This field is assigned by the data service. The customer will use this address to contact the company. This field is also used to modify the address.
CustomerCommunicationAddr_Line1	String	False		False	False	The first line of the address.
CustomerCommunicationAddr_Line2	String	False		False	False	The second line of the address.
CustomerCommunicationAddr_Line3	String	False		False	False	The third line of the address.
CustomerCommunicationAddr_Line4	String	False		False	False	The fourth line of the address.
CustomerCommunicationAddr_Line5	String	False		False	False	The fifth line of the address.
CustomerCommunicationAddr_City	String	False		False	False	The city name.
CustomerCommunicationAddr_Country	String	False		False	False	The country name.
CustomerCommunicationAddr_CountrySubDivisionCode	String	False		False	False	The country region. The state name for the USA or the province name for Canada.
CustomerCommunicationAddr_PostalCode	String	False		False	False	The postal code. The zip code for the USA and Canada.
CustomerCommunicationAddr_Note	String	False		False	False	The note for the customer.
CustomerCommunicationAddr_Lat	String	False		False	False	The latitude coordinate of the geocoded address.
CustomerCommunicationAddr_Long	String	False		False	False	The longitude coordinate of the geocoded address.
LegalAddr_Id	String	False		False	False	The Id of the company address used in government communications. This field is assigned by the data service and mainly used for modifying the address.
LegalAddr_Line1	String	False		False	False	The first line of the address.
LegalAddr_Line2	String	False		False	False	The second line of the address.
LegalAddr_Line3	String	False		False	False	The third line of the address.
LegalAddr_Line4	String	False		False	False	The fourth line of the address.
LegalAddr_Line5	String	False		False	False	The fifth line of the address.
LegalAddr_City	String	False		False	False	The city name.
LegalAddr_Country	String	False		False	False	The country name.
LegalAddr_CountrySubDivisionCode	String	False		False	False	The region within a country. For example, the state name for the USA or the province name for Canada.
LegalAddr_PostalCode	String	False		False	False	The postal code. The zip code for the USA and Canada.
LegalAddr_Note	String	False		False	False	The note for the customer.
LegalAddr_Lat	String	False		False	False	The latitude coordinate of the geocoded address.
LegalAddr_Long	String	False		False	False	The longitude coordinate of the geocoded address.
Email_Address	String	True		False	False	The default email address.
PrimaryPhone_FreeFormNumber	String	True		False	False	The primary phone number.
EmployerId	String	True		False	False	The employer identifier (EIN).
Country	String	True		False	False	The country that the company belongs to. This field is used for financial calculations.
SupportedLanguages	String	True		False	False	A comma-separated list of languages supported by the company.
WebAddr_URI	String	True		False	False	The default company website.
CompanyStartDate	Date	True		False	False	The date when the company file was created. This field and Metadata_CreateTime contain the same value.
FiscalYearStartMonth	String	True		False	False	The start month of fiscal year.
NameValue	String	False		False	False	The name/value pairs of the element.

CreditMemoLineItems

Create, update, delete, and query QuickBooks Credit Memo Line Items.

Table Specific Information

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

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

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
LineId [KEY]	String	True		False	False	The Id of the line item of the credit memo.
CreditMemoId [KEY]	String	False	CreditMemos.Id	True	True	The Id of the credit memo.
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.
DocNumber	String	False		True	True	The reference number for the transaction.
TxnDate	Date	False		True	True	The date when the transaction occurred.
PrivateNote	String	False		False	False	A private note about the transaction. By default, this field will not appear on transaction records.
LinkedTxnAggregate	String	False		False	False	An XML aggregate of linked transactions on the credit memo.
Line_Id	String	False		False	False	The Id of the line item.
Line_Description	String	False		False	False	The description of the line item that appears in the printed record.
Line_Amount	Decimal	False		False	False	The total amount of the charges or discounts for the given line. This includes the charges and allowances but excludes the tax amount.
Line_DetailType	String	False		False	False	The detail type of the line item. Different detail types indicate different types of line items.
Line_SalesItemLineDetail_ItemRef	String	False	Items.Id	False	False	The Id of the item. When a line item lacks an ItemRef it is treated as documentation and the Line_Amount attribute is ignored.
Line_SalesItemLineDetail_ItemRef_Name	String	True	Items.Name	False	False	The name of the item. When a line item lacks an ItemRef it is treated as documentation and the Line_Amount attribute is ignored.
Line_SalesItemLineDetail_ClassRef	String	False	Class.Id	False	False	The Id of the class entity of the line item.
Line_SalesItemLineDetail_ClassRef_Name	String	True	Class.FullyQualifiedName	False	False	The name of the class entity of the line item.
Line_SalesItemLineDetail_UnitPrice	Decimal	False		False	False	The unit price of the item.
Line_SalesItemLineDetail_Qty	Double	False		False	False	The number of items in the line item.
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 was 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 tax code for the transaction.
TxnTaxDetail_TotalTax	String	False		False	False	The 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	True	The Id of the customer.
CustomerRef_Name	String	True	Customers.DisplayName	False	False	A name that identifies the customer.
CustomerMemo	String	False		False	False	A message to the customer, visible on the transaction.
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	The first line of the address.
BillAddr_Line2	String	False		False	False	The second line of the address.
BillAddr_Line3	String	False		False	False	The third line of the address.
BillAddr_Line4	String	False		False	False	The fourth line of the address.
BillAddr_Line5	String	False		False	False	The fifth line of the address.
BillAddr_City	String	False		False	False	The city name.
BillAddr_Country	String	False		False	False	The country name.
BillAddr_CountrySubDivisionCode	String	False		False	False	The country region. The state name for the USA or the province name for Canada.
BillAddr_PostalCode	String	False		False	False	The postal code. The zip code for the USA and Canada.
BillAddr_Note	String	False		False	False	The note for the customer.
BillAddr_Lat	String	False		False	False	The latitude coordinate of the geocoded address.
BillAddr_Long	String	False		False	False	The longitude coordinate of the geocoded address.
ShipAddr_Line1	String	False		False	False	The first line of the shipping address.
ShipAddr_Line2	String	False		False	False	The second line of the shipping address.
ShipAddr_Line3	String	False		False	False	The third line of the shipping address.
ShipAddr_Line4	String	False		False	False	The fourth line of the shipping address.
ShipAddr_Line5	String	False		False	False	The fifth line of the shipping address.
ShipAddr_City	String	False		False	False	The city name
ShipAddr_Country	String	False		False	False	The country name
ShipAddr_CountrySubDivisionCode	String	False		False	False	The region within a country.
ShipAddr_PostalCode	String	False		False	False	The postal code.
ShipAddr_Lat	String	False		False	False	The latitude coordinate of the geocoded shipping address.
ShipAddr_Long	String	False		False	False	The longitude coordinate of the geocoded shipping address.
ClassRef	String	False	Class.Id	True	False	The Id of the class.
ClassRef_Name	String	True	Class.FullyQualifiedName	False	False	The name of the class.
SalesTermRef	String	False	Terms.Id	True	False	The Id of the sales term associated with the transaction.
SalesTermRef_Name	String	True	Terms.Name	False	False	A name that identifies the sales term associated with the transaction.
TotalAmt	Decimal	False		True	True	The total amount of the transaction. This includes the total of all the charges, allowances, and taxes.
PrintStatus	String	False		False	False	The print status of the credit memo. The allowed values are NotSet, NeedToPrint, PrintComplete. The default value is NotSet.
EmailStatus	String	False		False	False	The email status of the invoice. The allowed values are NotSent, NeedToSend, EmailSent. The default value is NotSet.
DepositToAccountRef	String	False	Accounts.Id	False	False	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 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.
RemainingCredit	Decimal	False		False	False	The total credit amount still available to apply towards the payment.
DepartmentRef	String	False	Departments.Id	False	False	The Id of the department, which stores the location of the transaction.
DepartmentRef_Name	String	True	Departments.Name	False	False	The name of the department, which stores location of the transaction.
BillEmail_Address	String	False		False	False	The email address where the invoice is sent. If the value of EmailStatus is NeedToSend, this field is a required input.
ApplyTaxAfterDiscount	Boolean	False		False	False	This field sets whether the discount is applied before or after taxes are calculated.
CurrencyRef	String	False		False	False	The Id of the currency used for all amounts of the transaction. This field is available in only the UK, AU, and CA editions.
CurrencyRef_Name	String	True		False	False	The name of the currency used for all amounts of the transaction. This field is available in only the UK, AU, and CA editions.
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 only the UK, AU, and CA editions.
GlobalTaxCalculation	String	False		False	False	The method in which tax is applied. This field is valid in only the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable.
HomeTotalAmt	Decimal	True		False	False	The total amount of the transaction in the home currency. This field includes the total of all the charges, allowances, and taxes. This field is valid in only the UK, AU, and CA editions.

CreditMemos

Create, update, delete, and query QuickBooks Credit Memos.

Table Specific Information

CreditMemos may be inserted, queried, or updated via the CreditMemos or CreditMemoLineItems tables. CreditMemos may be deleted by using the CreditMemos 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 CreditMemo, specify a Customer and at least one Line Item. The LineAggregate column may be used to specify an XML aggregate of Line Item data. Each _ denotes hierarchy. Use <Line> at the base level. The contents of LineAggregate will be sent to the API as is. All values for each field in the aggregate should adhere to the API's specifications (e.g. for dates in format yyyy-MM-dd, for date times in format yyyy-MM-dd'T'HH:mm:sszzz). The columns that may be used in the aggregates begin with the prefix 'Line_' to indicate they are part of the line item. Use the Line_ column along with the DocNumber to indicate which lines go with which CreditMemos. For example:

INSERT INTO CreditMemos (CustomerRef, LineAggregate) 
VALUES ('4', '
<Line><Amount>0.01</Amount><DetailType>SalesItemLineDetail</DetailType><SalesItemLineDetail><ItemRef>2</ItemRef></SalesItemLineDetail></Line>
<Line><Amount>0.02</Amount><DetailType>SalesItemLineDetail</DetailType><SalesItemLineDetail><ItemRef>3</ItemRef></SalesItemLineDetail></Line>
')

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Id [KEY]	String	True		False	False	The Id of the credit memo.
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.
DocNumber	String	False		True	True	The reference number for the transaction.
TxnDate	Date	False		True	True	The date when this transaction occurred.
PrivateNote	String	False		False	False	The private note about the transaction.
LineAggregate	String	False		False	False	An XML aggregate of line items on the credit memo.
TxnTaxDetail_TxnTaxCodeRef	String	False	TaxCodes.Id	False	False	The tax code for the transaction.
TxnTaxDetail_TotalTax	String	False		False	False	The 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	True	The Id of the customer.
CustomerRef_Name	String	True	Customers.DisplayName	False	False	The name of the customer or job.
CustomerMemo	String	False		False	False	The message to the customer, visible on the transaction.
BillAddr_Id	String	False		False	False	The Id of the entity for the address, mainly used for modifying the address. This value is assigned by the data service.
BillAddr_Line1	String	False		False	False	The first line of the address.
BillAddr_Line2	String	False		False	False	The second line of the address.
BillAddr_Line3	String	False		False	False	The third line of the address.
BillAddr_Line4	String	False		False	False	The fourth line of the address.
BillAddr_Line5	String	False		False	False	The fifth line of the address.
BillAddr_City	String	False		False	False	The city name.
BillAddr_Country	String	False		False	False	The country name.
BillAddr_CountrySubDivisionCode	String	False		False	False	The country region. The state name for the USA or the province name for Canada.
BillAddr_PostalCode	String	False		False	False	The postal code. The zip code for the USA and Canada.
BillAddr_Note	String	False		False	False	The note for the customer.
BillAddr_Lat	String	False		False	False	The latitude coordinate of the geocoded billing address.
BillAddr_Long	String	False		False	False	The longitude coordinate of the geocoded billing address.
ShipAddr_Id	String	False		False	False	The Id of the entity for hte address.
ShipAddr_Line1	String	False		False	False	The first line of the shipping address.
ShipAddr_Line2	String	False		False	False	The second line of the shipping address.
ShipAddr_Line3	String	False		False	False	The third line of the shipping address.
ShipAddr_Line4	String	False		False	False	The fourth line of the shipping address.
ShipAddr_Line5	String	False		False	False	The fifth line of the shipping address.
ShipAddr_City	String	False		False	False	The city name
ShipAddr_Country	String	False		False	False	The country name
ShipAddr_CountrySubDivisionCode	String	False		False	False	The region within a country.
ShipAddr_PostalCode	String	False		False	False	The postal code.
ShipAddr_Lat	String	False		False	False	The latitude coordinate of the geocoded shipping address.
ShipAddr_Long	String	False		False	False	The longitude coordinate of the geocoded shipping 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.
SalesTermRef	String	False	Terms.Id	True	False	The Id of the sales term associated with the transaction.
SalesTermRef_Name	String	True	Terms.Name	False	False	The name of the sales term associated with the transaction.
TotalAmt	Decimal	False		True	True	The total amount of the transaction. This includes the total of all the charges, allowances, and taxes.
PrintStatus	String	False		False	False	The print status of the credit memo. The allowed values are NotSet, NeedToPrint, PrintComplete. The default value is NotSet.
EmailStatus	String	False		False	False	The email status of the invoice. The allowed values are NotSent, NeedToSend, EmailSent. The default value is NotSet.
DepositToAccountRef	String	False	Accounts.Id	False	False	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	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.
RemainingCredit	Decimal	False		False	False	The total credit amount still available to be applied towards the payment.
DepartmentRef	String	False	Departments.Id	False	False	The Id of the location of the transaction.
DepartmentRef_Name	String	True	Departments.Name	False	False	The name of the location of the transaction.
BillEmail_Address	String	False		False	False	The email address where the invoice is sent. If the value of EmailStatus is NeedToSend, BillEmail is a required input.
ApplyTaxAfterDiscount	Boolean	False		False	False	This field sets whether discounts are applied before taxes are 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, and CA editions.
GlobalTaxCalculation	String	False		False	False	The method used to apply the tax. This field is valid in only the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable.
HomeTotalAmt	Decimal	True		False	False	The total amount of the transaction, expressed in the home currency. This includes the total of all the charges, allowances, and taxes. This field is valid in the UK, AU, and CA editions.

Customers

Create, update, delete, and query QuickBooks Customers.

Table Specific Information

Select

All filterable columns support the following operators:

=
!=
>=
<=
>
<
IN
LIKE
CONTAINS

The driver processes other filters client-side within the driver.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Id [KEY]	String	True		True	True	The Id of the customer.
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.
Title	String	False		False	False	The title of the person. This field supports all i18n locales. At least one of the following name elements is required: Title, GivenName, MiddleName, or FamilyName.
GivenName	String	False		True	True	The given name or first name of the customer. At least one of the following elements is required: Title, GivenName, MiddleName, or FamilyName.
MiddleName	String	False		True	True	The middle name of the customer. The customer can have zero or more middle names. At least one of the elements is required: Title, GivenName, MiddleName, or FamilyName.
FamilyName	String	False		True	True	The family name or the last name of the customer. At least one of the following name elements is required: Title, GivenName, MiddleName, or FamilyName.
Suffix	String	False		True	True	The suffix of the name.
FullyQualifiedName	String	True		True	True	The fully qualified name of the customer. The fully qualified name consists the topmost parent element followed by each subelement and separated by colons. For example: Parent:Account1:SubAccount1:SubAccount2.
CompanyName	String	False		True	True	The name of the company associated with the customer.
DisplayName	String	False		True	True	The name of the customer to be displayed. This value must be unique.
PrintOnCheckName	String	False		True	True	The name of the customer as printed on a check. If this is not provided, it is populated from DisplayName.
Active	Boolean	False		True	True	This field indicates whether the customer is currently enabled for use by QuickBooks.
IsProject	Boolean	True		True	True	If true, indicates this is a Project.
PrimaryPhone_FreeFormNumber	String	False		False	False	The primary phone number.
AlternatePhone_FreeFormNumber	String	False		False	False	The alternate phone number.
Mobile_FreeFormNumber	String	False		False	False	The mobile phone number.
Fax_FreeFormNumber	String	False		False	False	The fax number.
PrimaryEmailAddr_Address	String	False		False	False	The first line of the address.
WebAddr_URI	String	False		False	False	The website address.
DefaultTaxCodeRef	String	False	TaxCodes.Id	False	False	The tax code for the customer.
Taxable	Boolean	False		False	False	This field indicates whether this customer is taxable.
CustomerTypeRef	String	False	CustomerTypes.Id	False	False	The Id of the type of this customer.
BillAddr_Id	String	True		False	False	The Id of the entity for the billing address, mainly used for modifying the address. This value is assigned by the data service.
BillAddr_Line1	String	False		False	False	The first line of the address.
BillAddr_Line2	String	False		False	False	The second line of the address.
BillAddr_Line3	String	False		False	False	The third line of the address.
BillAddr_Line4	String	False		False	False	The fourth line of the address.
BillAddr_Line5	String	False		False	False	The fifth line of the address.
BillAddr_City	String	False		False	False	The city name.
BillAddr_Country	String	False		False	False	The country name.
BillAddr_CountrySubDivisionCode	String	False		False	False	The country region. The state name for the USA or the province name for Canada.
BillAddr_PostalCode	String	False		False	False	The postal code. The zip code for the USA and Canada.
BillAddr_Lat	String	True		False	False	The latitude coordinate of the geocoded billing address.
BillAddr_Long	String	True		False	False	The longitude coordinate of the geocoded billing address.
ShipAddr_Id	String	True		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	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, state name for the USA or 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	True		False	False	The latitude coordinate of the geocoded shipping address.
ShipAddr_Long	String	True		False	False	The longitude coordinate of the geocoded shipping address.
Notes	String	False		False	False	Notes on the customer.
Job	Boolean	False		True	False	This field indicates whether the customer is a job or subcustomer. If false or null, this is a top-level customer.
BillWithParent	Boolean	False		False	False	This field sets whether the customer is to be billed together with its parent entity. This field is valid only if this entity is a job or subcustomer.
ParentRef	String	False	Customers.Id	False	False	The immediate parent of the subcustomer or job in the hierarchical 'Customer:Job' list. This field is required for the create operation if the customer is a subcustomer or a job.
ParentRef_Name	String	True	Customers.DisplayName	False	False	The name of the immediate parent of the subcustomer or job in the hierarchical 'Customer:Job' list.
Level	Integer	True		False	False	This field shows the level of the hierarchy the customer record is located in. A value of 0 specifies the top level of the hierarchy. The hierarchy is implicit when the parent is specified in an insert command.
SalesTermRef	String	False	Terms.Id	False	False	The Id of the sales term associated with the customer.
SalesTermRef_Name	String	True	Terms.Name	False	False	The name of the sales term associated with the customer.
PaymentMethodRef	String	False	PaymentMethods.Id	False	False	The Id of the payment method associated with the customer.
PaymentMethodRef_Name	String	True	PaymentMethods.Name	False	False	The name of the payment method associated with the customer.
Balance	Decimal	False		True	True	The open balance amount or the amount unpaid by the customer. For the create operation, this represents the opening balance for the customer. When returned in response to the query request it represents the current open balance for that customer.
OpenBalanceDate	Date	False		False	False	The date of the open balance. This field is used in the create operation.
BalanceWithJobs	Decimal	True		False	False	The cumulative open balance amount for the customer and all its subcustomers.
PreferredDeliveryMethod	String	False		False	False	The preferred delivery method. The allowed values are Print, Email, None.
ResaleNum	String	False		False	False	The resale number or additional info about the customer.
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.
TaxExemptionReasonId	Integer	False		True	False	The tax exemption reason associated with this customer object.

Departments

Create, update, delete, and query QuickBooks Departments.

Table Specific Information

Select

All filterable columns support the following operators:

=
!=
>=
<=
>
<
IN
LIKE
CONTAINS

The driver processes other filters client-side within the driver.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Id [KEY]	String	True		True	True	The Id of the department.
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.
Name	String	False		True	True	The name of the department.
SubDepartment	Boolean	True		False	False	This field specifies whether the department is a subdepartment.
ParentRef	String	False	Departments.Id	False	False	The Id of the parent class entity.
ParentRef_Name	String	True	Departments.Name	False	False	The name of the parent class entity.
FullyQualifiedName	String	True		False	False	The fully qualified name of the department. The fully qualified name consists the topmost parent element followed by each subelement and separated by colons. For example: Parent:Account1:SubAccount1:SubAccount2.
Active	Boolean	False		False	False	This field indicates whether or not the department is active. Inactive records are hidden from most display purposes and financial transactions.

DepositLineItems

Create, update, delete, and query QuickBooks Deposit Line Items.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
LineId [KEY]	String	True		False	False	The Id of the line item of the invoice.
DepositId [KEY]	String	False	Deposits.Id	True	True	The Id of the invoice.
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.
TxnDate	Date	False		True	True	The date entered by the user when this transaction occurred.
PrivateNote	String	False		False	False	A private note that does not appear on the transaction records.
Line_Id	String	False		False	False	The Id of the line item.
Line_Description	String	False		False	False	The description of the line item.
Line_Amount	Decimal	False		False	False	The amount of the line item.
Line_DetailType	String	False		False	False	The detailType of the line item.
Line_DepositLineDetail_PaymentMethodRef	String	False	PaymentMethods.Id	False	False	The payment method id of the line item.
Line_DepositLineDetail_PaymentMethodRef_Name	String	False	PaymentMethods.Name	False	False	The payment method id of the line item.
Line_DepositLineDetail_AccountRef	String	False	Accounts.Id	False	False	Account where the funds are deposited to.
Line_DepositLineDetail_AccountRef_Name	String	False	Accounts.Name	False	False	Account where the funds are deposited to.
Line_DepositLineDetail_Entity	String	False	Customers.Id	False	False	Reference to a customer from which the deposit was recieved
Line_DepositLineDetail_Entity_Name	String	False	Customers.DisplayName	False	False	Reference to a customer from which the deposit was recieved
Line_DepositLineDetail_ClassRef	String	False	Class.Id	False	False	Reference to the Class associated with the transaction
Line_DepositLineDetail_ClassRef_Name	String	False	Class.FullyQualifiedName	False	False	Reference to the Class associated with the transaction
Line_DepositLineDetail_CheckNum	String	False		False	False	The check number for the deposit
Line_DepositLineDetail_TxnType	String	False		False	False	The type of the payment transaction. Different types indicate different types of line items.
Line_DepositLineDetail_TaxCodeRef	String	False	TaxCodes.Id	False	False	The Sales/Purchase tax code associated with the Line. This field is valid in the UK, AU, and CA editions.
Line_DepositLineDetail_TaxApplicableOn	String	False		False	False	Indicates whether the tax applicable on the line is sales or purchase. This field is valid in the UK, AU, and CA editions.
Line_LinkedTxn_TxnId	String	True		False	False	The id of the linked transaction
Line_LinkedTxn_TxnType	String	True		False	False	The type of the linked transaction. Different types indicate different types of line items.
Line_LinkedTxn_TxnLineId	String	True		False	False	The lineitem id of the linked transaction line item.
TxnTaxDetail_TxnTaxCodeRef	String	False	TaxCodes.Id	False	False	The tax code for the transaction. This field is valid in the UK, AU, and CA editions.
TxnTaxDetail_TotalTax	String	False		False	False	The total tax calculated for the transaction, excluding any tax lines manually inserted into the transaction line list. This field is valid in the UK, AU, and CA editions.
TxnTaxDetail_TaxLineAggregate	String	False		False	False	An XML aggregate of tax line items. This field is valid in the UK, AU, and CA editions.
DepositToAccountRef	String	False	Accounts.Id	False	False	The Id of the asset account to be used for this deposit.
DepositToAccountRef_Name	String	False	Accounts.Name	False	False	The name of the asset account to be used for this deposit.
ClassRef	String	False	Class.Id	False	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.
TotalAmt	Decimal	True		True	True	This field indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes.
CashBack_AccountRef	String	True		True	False	The asset account (bank account) Id to be used for this cash back transaction
CashBack_AccountRef_Name	String	False		False	False	The asset account (bank account) Name to be used for this cash back transaction
CashBack_Amount	Decimal	False		False	False	The amount of the cash back transaction.
CashBack_Memo	String	True		True	False	The memo associated with this cash back transaction.
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 store the location of the transaction as defined using location tracking in QuickBooks Online.
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.
GlobalTaxCalculation	String	False		False	False	The method in which tax is applied. This field is valid in the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable.

Deposits

Create, update, delete, and query QuickBooks Deposits.

Table Specific Information

Select

All filterable columns support the following operators:

=
!=
>=
<=
>
<
IN
LIKE
CONTAINS

The driver processes other filters client-side within the driver.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Id [KEY]	String	True		True	True	The Id of the invoice.
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.
TxnDate	Date	False		True	True	The date entered by the user when this transaction occurred.
PrivateNote	String	False		False	False	A private note that does not appear on the transaction records.
LineAggregate	String	False		False	False	An XML aggregate of line items associated with the transaction.
TxnTaxDetail_TxnTaxCodeRef	String	False	TaxCodes.Id	False	False	The tax code for the transaction. This field is valid in the UK, AU, and CA editions.
TxnTaxDetail_TotalTax	String	False		False	False	The total tax calculated for the transaction, excluding any tax lines manually inserted into the transaction line list. This field is valid in the UK, AU, and CA editions.
TxnTaxDetail_TaxLineAggregate	String	False		False	False	An XML aggregate of tax line items. This field is valid in the UK, AU, and CA editions.
DepositToAccountRef	String	False	Accounts.Id	False	False	The Id of the asset account to be used for this deposit.
DepositToAccountRef_Name	String	False	Accounts.Name	False	False	The name of the asset account to be used for this deposit.
ClassRef	String	False	Class.Id	False	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.
TotalAmt	Decimal	True		True	True	This field indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes.
CashBack_AccountRef	String	True	Accounts.Id	True	False	The asset account (bank account) Id to be used for this cash back transaction
CashBack_AccountRef_Name	String	False	Accounts.Name	False	False	The asset account (bank account) Name to be used for this cash back transaction
CashBack_Amount	Decimal	False		False	False	The amount of the cash back transaction.
CashBack_Memo	String	True		True	False	The memo associated with this cash back transaction.
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 store the location of the transaction as defined using location tracking in QuickBooks Online.
ApplyTaxAfterDiscount	Boolean	False		False	False	This field sets whether discounts are applied before the tax is calculated.
ExchangeRate	Decimal	False		False	False	The number of home currency units it takes to equal one unit of currency specified by CurrencyRef. Applicable if multicurrency is enabled for the company.
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.
GlobalTaxCalculation	String	False		False	False	The method in which tax is applied. This field is valid in the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable.
TransactionLocationType	String	False		False	False	The account location. This field is valid in only the FR editions. The allowed values are WithinFrance, FranceOverseas, OutsideFranceWithEU, OutsideEU.

Employees

Create, update, delete, and query QuickBooks Employees.

Table Specific Information

Select

All filterable columns support the following operators:

=
!=
>=
<=
>
<
IN
LIKE
CONTAINS

The driver processes other filters client-side within the driver.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Id [KEY]	String	True		True	True	The Id of the employee.
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.
Organization	Boolean	False		False	False	This field indicates whether the entity represents an organization or a person.
Title	String	False		False	False	The title of the employee. The employee can have zero or more titles. This field supports all i18n locales.
EmployeeNumber	String	False		True	True	The employee number in the directory of the employer.
GivenName	String	False		True	True	The given name or first name of the employee.
MiddleName	String	False		True	True	The middle name of the employee. The person can have zero or more middle names.
FamilyName	String	False		True	True	The family name or last name of the employee.
Suffix	String	False		False	False	The suffix of the name of the employee.
DisplayName	String	False		True	False	The name of the person or organization as displayed. This field is required.
PrintOnCheckName	String	False		False	False	The name of the employee as it should appear on a check.
Active	Boolean	False		True	False	This field sets whether this entity is currently enabled for use.
Mobile_FreeFormNumber	String	False		False	False	The mobile phone number.
PrimaryEmailAddr_Address	String	False		False	False	The primary email address.
PrimaryAddr_Id	String	False		False	False	The Id of the entity for the address, mainly used for modifying the address. This value is assigned by the data service.
PrimaryAddr_Line1	String	False		False	False	First line of the address.
PrimaryAddr_Line2	String	False		False	False	Second line of the address.
PrimaryAddr_Line3	String	False		False	False	Third line of the address.
PrimaryAddr_Line4	String	False		False	False	Fourth line of the address.
PrimaryAddr_Line5	String	False		False	False	Fifth line of the address.
PrimaryAddr_City	String	False		False	False	City name.
PrimaryAddr_Country	String	False		False	False	Country name.
PrimaryAddr_CountrySubDivisionCode	String	False		False	False	Region within a country. The state name for the USA or the province name for Canada.
PrimaryAddr_PostalCode	String	False		False	False	Postal code. The zip code for the USA and Canada.
PrimaryAddr_Note	String	False		False	False	Note for the customer.
PrimaryAddr_Lat	String	False		False	False	The latitude coordinate of the geocoded address.
PrimaryAddr_Long	String	False		False	False	The longitude coordinate of the geocoded address.
SSN	String	False		False	False	The social security number (SSN) of the employee. If SSN is set, it is masked in the response with XXX-XX-XXXX. If XXX-XX-XXXX is sent in the create or update request, XXX-XX-XXXX is ignored and the old value is preserved.
BillableTime	Boolean	False		False	False	This field indicates whether the employee is eligible for billable time.
BillRate	Double	False		False	False	This field is available only if BillableTime is true. This field is not required, even if BillableTime is true.
HiredDate	Date	False		False	False	The hire date of the employee.
ReleasedDate	Date	False		False	False	The release date of the employee.
BirthDate	Date	False		False	False	The birth date of the employee.
Gender	String	False		False	False	The gender of the employee. To clear the gender value, set this field to Null in a full update request. The allowed values are Male, Female.

EstimateLineItems

Create, update, delete, and query QuickBooks Estimate Line Items.

Table Specific Information

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

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

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
LineId [KEY]	String	True		False	False	The Id of the line item of the estimate.
EstimateId [KEY]	String	False	Estimates.Id	True	True	The Id of the estimate.
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.
DocNumber	String	False		True	True	The reference number for the transaction.
TxnDate	Date	False		True	True	The date entered by the user 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, which will not appear on the transaction records.
TxnStatus	String	False		False	False	The status of the transaction. The allowed values are Accepted, Closed, Pending, Rejected.
LinkedTxnAggregate	String	False		False	False	An XML aggregate of transactions linked to the estimate.
Line_Id	String	False		False	False	The Id of the line item.
Line_LineNum	String	False		False	False	The line number.
Line_Description	String	False		False	False	The line description.
Line_Amount	Decimal	False		False	False	The line 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 the item in the line item.
Line_SalesItemLineDetail_ItemRef_Name	String	True	Items.Name	False	False	The name of the item in the line item.
Line_SalesItemLineDetail_ClassRef	String	False	Class.Id	False	False	The Id of the class in the line item.
Line_SalesItemLineDetail_ClassRef_Name	String	True	Class.FullyQualifiedName	False	False	The name of the class in the line item.
Line_SalesItemLineDetail_UnitPrice	Decimal	False		False	False	The unit price of the item.
Line_SalesItemLineDetail_Qty	Double	False		False	False	The number of items for the line item.
Line_SalesItemLineDetail_TaxCodeRef	String	False	TaxCodes.Id	False	False	The tax code for the item.
Line_SalesItemLineDetail_ServiceDate	Date	False		False	False	The service date for the item.
Line_SalesItemLineDetail_DiscountAmt	Decimal	False		False	False	The discount amount applied to this line.
Line_SalesItemLineDetail_DiscountRate	Decimal	False		False	False	TThe discount rate applied to this line.
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 tax code for the transaction.
TxnTaxDetail_TotalTax	String	False		False	False	The 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, which appears in the invoice and the printed invoice.
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	The first line of the billing address.
BillAddr_Line2	String	False		False	False	The second line of the billing address.
BillAddr_Line3	String	False		False	False	The third line of the billing address.
BillAddr_Line4	String	False		False	False	The fourth line of the billing address.
BillAddr_Line5	String	False		False	False	The 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 or the province name for Canada.
BillAddr_PostalCode	String	False		False	False	Postal code. The zip code for the USA and Canada.
BillAddr_Note	String	False		False	False	Note for the customer.
BillAddr_Lat	String	False		False	False	The latitude coordinate of the geocoded billing address.
BillAddr_Long	String	False		False	False	The longitude coordinate of the geocoded billing address.
ShipAddr_Id	String	False		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	False	First line of the shipping address.
ShipAddr_Line2	String	False		False	False	Second line of the shipping address.
ShipAddr_Line3	String	False		False	False	Third line of the shipping address.
ShipAddr_Line4	String	False		False	False	Fourth line of the shipping address.
ShipAddr_Line5	String	False		False	False	Fifth line of the shipping 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 or 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	The latitude coordinate of the geocoded shipping address.
ShipAddr_Long	String	False		False	False	The longitude coordinate of the geocoded shipping 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.
SalesTermRef	String	False	Terms.Id	False	False	The Id of the sales term associated with the transaction.
SalesTermRef_Name	String	True	Terms.Name	False	False	The name of the sales term associated with the transaction.
DueDate	Date	False		True	False	The due date for the invoice, not including any early payment discount incentives or late payment penalties. If the date is not supplied, the current date on the server is used.
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	True		True	True	This field indicates the total amount of the transaction. This includes the total of all charges, allowances, and taxes.
PrintStatus	String	False		False	False	The print status of the invoice. The allowed values are NotSet, NeedToPrint, PrintComplete. The default value is NotSet.
EmailStatus	String	False		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	False	The email address where the invoice is sent. If the value of EmailStatus is NeedToSend, BillEmail is a required input.
Balance	Decimal	False		True	True	This field indicates whether the transaction is a finance charge.
ExpirationDate	Date	False		False	False	The date when an estimate becomes invalid.
AcceptedBy	String	False		False	False	The name of the customer who accepted the estimate.
AcceptedDate	Date	False		False	False	The date the estimate was accepted.
ApplyTaxAfterDiscount	Boolean	False		False	False	This field sets whether any discounts are applied before taxes are 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, and CA editions.
GlobalTaxCalculation	String	False		False	False	The method used to apply taxes. 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 transaction, expressed in the home currency. This includes the total of all the charges, allowances, and taxes. This field is valid in the UK, AU, and CA editions.

EstimateLinkedTransactions

Create, update, delete, and query QuickBooks Estimate Line Items.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
LinkedTxnId [KEY]	String	True		False	False	The Id of the line item of the estimate.
EstimateId [KEY]	String	False	Estimates.Id	True	True	The Id of the estimate.
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.
DocNumber	String	False		True	True	The reference number for the transaction.
TxnDate	Date	False		True	True	The date entered by the user 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, which will not appear on the transaction records.
TxnStatus	String	False		False	False	The status of the transaction. The allowed values are Accepted, Closed, Pending, Rejected.
LinkedTxn_TxnId	String	False		False	False	The Id of the line item.
LinkedTxn_TxnType	String	False		False	False	The line number of the line item.
LinkedTxn_TxnLineId	String	False		False	False	The description of the line item.
LineAggregate	String	False		False	False	An XML aggregate of line items associated with the transaction.
TxnTaxDetail_TxnTaxCodeRef	String	False	TaxCodes.Id	False	False	The tax code for the transaction.
TxnTaxDetail_TotalTax	String	False		False	False	The 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, which appears in the invoice and the printed invoice.
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	The first line of the billing address.
BillAddr_Line2	String	False		False	False	The second line of the billing address.
BillAddr_Line3	String	False		False	False	The third line of the billing address.
BillAddr_Line4	String	False		False	False	The fourth line of the billing address.
BillAddr_Line5	String	False		False	False	The 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 or the province name for Canada.
BillAddr_PostalCode	String	False		False	False	Postal code. The zip code for the USA and Canada.
BillAddr_Note	String	False		False	False	Note for the customer.
BillAddr_Lat	String	False		False	False	The latitude coordinate of the geocoded billing address.
BillAddr_Long	String	False		False	False	The longitude coordinate of the geocoded billing address.
ShipAddr_Id	String	False		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	False	First line of the shipping address.
ShipAddr_Line2	String	False		False	False	Second line of the shipping address.
ShipAddr_Line3	String	False		False	False	Third line of the shipping address.
ShipAddr_Line4	String	False		False	False	Fourth line of the shipping address.
ShipAddr_Line5	String	False		False	False	Fifth line of the shipping 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 or 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	The latitude coordinate of the geocoded shipping address.
ShipAddr_Long	String	False		False	False	The longitude coordinate of the geocoded shipping 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.
SalesTermRef	String	False	Terms.Id	False	False	The Id of the sales term associated with the transaction.
SalesTermRef_Name	String	True	Terms.Name	False	False	The name of the sales term associated with the transaction.
DueDate	Date	False		True	False	The due date for the invoice, not including any early payment discount incentives or late payment penalties. If the date is not supplied, the current date on the server is used.
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	True		True	True	This field indicates the total amount of the transaction. This includes the total of all charges, allowances, and taxes.
PrintStatus	String	False		False	False	The print status of the invoice. The allowed values are NotSet, NeedToPrint, PrintComplete. The default value is NotSet.
EmailStatus	String	False		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	False	The email address where the invoice is sent. If the value of EmailStatus is NeedToSend, BillEmail is a required input.
Balance	Decimal	False		True	True	This field indicates whether the transaction is a finance charge.
ExpirationDate	Date	False		False	False	The date when an estimate becomes invalid.
AcceptedBy	String	False		False	False	The name of the customer who accepted the estimate.
AcceptedDate	Date	False		False	False	The date the estimate was accepted.
ApplyTaxAfterDiscount	Boolean	False		False	False	This field sets whether any discounts are applied before taxes are 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, and CA editions.
GlobalTaxCalculation	String	False		False	False	The method used to apply taxes. 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 transaction, expressed in the home currency. This includes the total of all the charges, allowances, and taxes. This field is valid in the UK, AU, and CA editions.

Estimates

Create, update, delete, and query QuickBooks Estimates.

Table Specific Information

Estimates may be inserted, queried, or updated via the Estimates or EstimateLineItems tables. Estimates may be deleted by using the Estimates 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 an Estimate, specify a Customer and at least one Line Item. The LineAggregate column may be used to specify an XML aggregate of Line Item data. Each _ denotes hierarchy. Use <Line> at the base level. The contents of LineAggregate will be sent to the API as is. All values for each field in the aggregate should adhere to the API's specifications (e.g. for dates in format yyyy-MM-dd, for date times in format yyyy-MM-dd'T'HH:mm:sszzz). The columns that may be used in the aggregates begin with the prefix 'Line_' to indicate they are part of the line item. Use the Line_ column along with the DocNumber to indicate which lines go with which Estimates. For example:

INSERT INTO Estimates (CustomerRef, LineAggregate) 
VALUES ('4', '
<Line><Amount>0.01</Amount><DetailType>SalesItemLineDetail</DetailType><SalesItemLineDetail><ItemRef>2</ItemRef></SalesItemLineDetail></Line>
<Line><Amount>0.02</Amount><DetailType>SalesItemLineDetail</DetailType><SalesItemLineDetail><ItemRef>3</ItemRef></SalesItemLineDetail></Line>
')

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Id [KEY]	String	True		True	True	The Id of the Estimate.
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.
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, which will not appear on the transaction records.
TxnStatus	String	False		False	False	The status of the transaction. The allowed values are Accepted, Closed, Pending, Rejected.
LinkedTxnAggregate	String	False		False	False	An XML aggregate of transactions linked to the estimate.
LineAggregate	String	False		False	False	An XML aggregate of line items associated with the transaction. other:childtable=
TxnTaxDetail_TxnTaxCodeRef	String	False	TaxCodes.Id	False	False	The tax code for the transaction.
TxnTaxDetail_TotalTax	String	False		False	False	The 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	A message to the customer, which appears in the invoice and in the printed invoice.
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 billing address.
BillAddr_Line2	String	False		False	False	Second line of the billing address.
BillAddr_Line3	String	False		False	False	Third line of the billing address.
BillAddr_Line4	String	False		False	False	Fourth line of the billing address.
BillAddr_Line5	String	False		False	False	Fifth line of the billing address.
BillAddr_City	String	False		False	False	City name.
BillAddr_Country	String	False		False	False	Country name.
BillAddr_CountrySubDivisionCode	String	False		False	False	Country region. For example, the state name for the USA or the province name for Canada.
BillAddr_PostalCode	String	False		False	False	Postal code. The zip code for the USA and Canada.
BillAddr_Note	String	False		False	False	Note for the customer.
BillAddr_Lat	String	False		False	False	The latitude coordinate of the geocoded billing address.
BillAddr_Long	String	False		False	False	The longitude coordinate of the geocoded billing address.
ShipAddr_Id	String	False		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	False	First line of the shipping address.
ShipAddr_Line2	String	False		False	False	Second line of the shipping address.
ShipAddr_Line3	String	False		False	False	Third line of the shipping address.
ShipAddr_Line4	String	False		False	False	Fourth line of the shipping address.
ShipAddr_Line5	String	False		False	False	Fifth line of the shipping address.
ShipAddr_City	String	False		False	False	City name.
ShipAddr_Country	String	False		False	False	Country name.
ShipAddr_CountrySubDivisionCode	String	False		False	False	Country region. For example, the state name for the USA or 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	The latitude coordinate of the geocoded shipping address.
ShipAddr_Long	String	False		False	False	The longitude coordinate of the geocoded shipping 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.
SalesTermRef	String	False	Terms.Id	False	False	The Id of the sales terms associated with the transaction.
SalesTermRef_Name	String	True	Terms.Name	False	False	The name of the sales terms associated with the transaction.
DueDate	Date	False		True	False	The due date for the invoice, not including any early payment discount incentives or late payment penalties. If the date is not supplied, the current date on the server is used.
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	True		True	True	The total amount of the transaction. This includes the total of all the charges, allowances, and taxes.
PrintStatus	String	False		False	False	The print status of the invoice. The allowed values are NotSet, NeedToPrint, PrintComplete. The default value is NotSet.
EmailStatus	String	False		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	False	The email address where the invoice is sent. If the value of EmailStatus is NeedToSend, BillEmail is a required input.
Balance	Decimal	False		True	True	This column sets whether the transaction is a finance charge.
ExpirationDate	Date	False		False	False	The date when the estimate becomes invalid.
AcceptedBy	String	False		False	False	The name of the customer who accepted the estimate.
AcceptedDate	Date	False		False	False	The date the estimate was accepted.
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 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, and CA editions.
GlobalTaxCalculation	String	False		False	False	The method used to apply taxes. 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 transaction in the home currency. Includes the total of all the charges, allowances, and taxes. This field is valid in the UK, AU, and CA editions.

ExchangeRates

Retrieves QuickBooks exchange rates.

View Specific Information

Select

By default this view will only list rates about today's exchange rates. You can change the date by specifying a valid date for the column AsOfDate.

SELECT * FROM ExchangeRates WHERE AsOfDate = '2018/01/01'

SELECT * FROM ExchangeRates WHERE SourceCurrencyCode = 'USD'

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
SourceCurrencyCode	String	False		True	False	The source currency from which the exchange rate is specified. Specify as a three letter string representing the ISO 4217 code for the currency.
TargetCurrencyCode	String	False		False	False	The target currency against which the exchange rate is specified. Specify as a three letter string representing the ISO 4217 code for the currency.
Rate	Double	False		False	False	The exchange rate between SourceCurrencyCode and TargetCurrencyCode on the AsOfDate date.
AsOfDate	Date	False		True	False	Date on which this exchange rate was set.
MetaData_LastUpdatedTime	Datetime	True		True	True	The time the record was last updated.

InvoiceLineItems

Create, update, delete, and query QuickBooks Invoice Line Items.

Table Specific Information

Invoices may be inserted, queried, or updated via the Invoices or InvoiceLineItems tables. Invoices may be deleted by using the Invoices 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 an Invoice, specify a Customer and at least one Line Item. For example, the following will insert a new Invoice with two Line Items:

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

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

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

Update

To update an existing Line Item, you'll need to specify the LineId. You can only update Line Items which have a Detail Type of SalesItemLineDetail.

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

Delete

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

DELETE FROM InvoiceLineItems WHERE LineId = '5656' AND InvoiceId = '1'

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
LineId [KEY]	String	True		False	False	The Id of the line item of the invoice.
InvoiceId [KEY]	String	False	Invoices.Id	True	True	The Id of the invoice.
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.
DocNumber	String	False		True	True	The reference number for the transaction.
TxnDate	Date	False		True	True	The date entered by the user when this transaction occurred.
PrivateNote	String	False		False	False	A private note for the transaction, which does not appear on the transaction records.
TxnStatus	String	False		False	False	The status of the transaction. The allowed values are Accepted, Closed, Pending, Rejected.
LinkedTxnAggregate	String	False		False	False	An XML aggregate of transactions linked to the estimate.
Line_Id	String	False		False	False	The Id of the line item.
Line_LineNum	String	False		False	False	The line number of the line item.
Line_Description	String	False		False	False	The description of the line item.
Line_Amount	Decimal	False		False	False	The amount of the line item.
Line_DetailType	String	False		False	False	The detail type of the line item. Different detail types indicate different types of line items.
Line_SalesItemLineDetail_ItemRef	String	False	Items.Id	False	False	The Id of the item in the line item.
Line_SalesItemLineDetail_ItemRef_Name	String	True	Items.Name	False	False	The name of the item in the line item.
Line_SalesItemLineDetail_ClassRef	String	False	Class.Id	False	False	The Id of the class in the line item.
Line_SalesItemLineDetail_ClassRef_Name	String	True	Class.FullyQualifiedName	False	False	The name of the class in the line item.
Line_SalesItemLineDetail_UnitPrice	Decimal	False		False	False	The unit price of the item.
Line_SalesItemLineDetail_Qty	Double	False		False	False	The number of items for the line item.
Line_SalesItemLineDetail_TaxCodeRef	String	False	TaxCodes.Id	False	False	The tax code for the item.
Line_SalesItemLineDetail_DiscountAmt	Decimal	False		False	False	The discount rate applied to an individual line item. If both DiscountAmt and DiscountRate are supplied, DiscountRate takes precedence and DiscountAmt is recalculated by QuickBooks services based on amount of DiscountRate.
Line_SalesItemLineDetail_ServiceDate	Date	False		False	False	The service date for the item.
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.
Line_DiscountLineDetail_ClassRef	String	False	Class.Id	False	False	The Id of the class in the line item.
Line_DiscountLineDetail_ClassRef_Name	String	True	Class.FullyQualifiedName	False	False	The name of the class in the line item.
Line_DiscountLineDetail_TaxCodeRef	String	False	TaxCodes.Id	False	False	The tax code for the item.
Line_DiscountLineDetail_TaxCodeRef_Name	String	True	TaxCodes.Name	False	False	The name for the tax sales code.
Line_DiscountLineDetail_PercentBased	Boolean	False		False	False	True if the discount is a percentage; null or false if discount based on amount.
Line_DiscountLineDetail_DiscountAccountRef	String	False		False	False	The discount code for the item.
Line_DiscountLineDetail_DiscountAccountRef_Name	String	True		False	False	The name for the discount account.
Line_DiscountLineDetail_DiscountPercent	Decimal	False		False	False	Percentage by which the amount due is reduced, from 0% to 100%. To enter a discount of 8.5% use 8.5, not 0.085.
TxnTaxDetail_TxnTaxCodeRef	String	False	TaxCodes.Id	False	False	The tax code for the transaction.
TxnTaxDetail_TotalTax	String	False		False	False	The 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, which appears in the invoice and the printed invoice.
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 or 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	The latitude coordinate of the geocoded billing address.
BillAddr_Long	String	False		False	False	The longitude coordinate of the geocoded billing address.
ShipAddr_Id	String	False		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	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	The latitude coordinate of the geocoded shipping address.
ShipAddr_Long	String	False		False	False	The longitude coordinate of the geocoded shipping 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.
SalesTermRef	String	False	Terms.Id	False	False	The Id of the sales terms associated with the transaction.
SalesTermRef_Name	String	True	Terms.Name	False	False	The name of the sales terms associated with the transaction.
DueDate	Date	False		True	False	The date when the invoice is to be paid, not including any early payment discount incentives or late payment penalties. If the date is not supplied, the current date on the server is used.
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	True		True	True	The total amount of the transaction. This includes the total of all the charges, allowances, and taxes.
PrintStatus	String	False		False	False	The print status of the invoice. The allowed values are NotSet, NeedToPrint, PrintComplete. The default value is NotSet.
EmailStatus	String	False		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	False	The email address where the invoice is sent. If the value of EmailStatus is NeedToSend, BillEmail is a required input.
Balance	Decimal	True		True	True	This field indicates whether the transaction is a finance charge.
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.
AllowOnlineCreditCardPayment	Boolean	False		False	False	It specifies if online credit card payments are allowed for this invoice and corresponds to the Cards online payment check box on the QuickBooks UI.
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. Valid only if the company file is set up to use 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 only the UK, AU, and CA editions.
GlobalTaxCalculation	String	False		False	False	The method in which tax is applied. 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 transaction in the home currency. Includes the total of all the charges, allowances, and taxes. This field is valid in the UK, AU, and CA editions.

InvoiceLinkedTransactions

Create, update, delete, and query QuickBooks Invoice Line Items.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
LinkedTxnId [KEY]	String	True		False	False	The Id of the line item of the invoice.
InvoiceId [KEY]	String	False	Invoices.Id	True	True	The Id of the invoice.
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.
DocNumber	String	False		True	True	The reference number for the transaction.
TxnDate	Date	False		True	True	The date entered by the user when this transaction occurred.
PrivateNote	String	False		False	False	A private note for the transaction, which does not appear on the transaction records.
TxnStatus	String	False		False	False	The status of the transaction. The allowed values are Accepted, Closed, Pending, Rejected.
LinkedTxn_TxnId	String	False		False	False	The Id of the line item.
LinkedTxn_TxnType	String	False		False	False	The line number of the line item.
LinkedTxn_TxnLineId	String	False		False	False	The description of the line item.
LineAggregate	String	False		False	False	An XML aggregate of line items associated with the transaction.
TxnTaxDetail_TxnTaxCodeRef	String	False	TaxCodes.Id	False	False	The tax code for the transaction.
TxnTaxDetail_TotalTax	String	False		False	False	The 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, which appears in the invoice and the printed invoice.
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 or 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	The latitude coordinate of the geocoded billing address.
BillAddr_Long	String	False		False	False	The longitude coordinate of the geocoded billing address.
ShipAddr_Id	String	False		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	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	The latitude coordinate of the geocoded shipping address.
ShipAddr_Long	String	False		False	False	The longitude coordinate of the geocoded shipping 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.
SalesTermRef	String	False	Terms.Id	False	False	The Id of the sales terms associated with the transaction.
SalesTermRef_Name	String	True	Terms.Name	False	False	The name of the sales terms associated with the transaction.
DueDate	Date	False		True	False	The date when the invoice is to be paid, not including any early payment discount incentives or late payment penalties. If the date is not supplied, the current date on the server is used.
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	True		True	True	The total amount of the transaction. This includes the total of all the charges, allowances, and taxes.
PrintStatus	String	False		False	False	The print status of the invoice. The allowed values are NotSet, NeedToPrint, PrintComplete. The default value is NotSet.
EmailStatus	String	False		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	False	The email address where the invoice is sent. If the value of EmailStatus is NeedToSend, BillEmail is a required input.
Balance	Decimal	False		False	False	This field indicates whether the transaction is a finance charge.
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.
AllowOnlineCreditCardPayment	Boolean	False		False	False	It specifies if online credit card payments are allowed for this invoice and corresponds to the Cards online payment check box on the QuickBooks UI.
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. Valid only if the company file is set up to use 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 only the UK, AU, and CA editions.
GlobalTaxCalculation	String	False		False	False	The method in which tax is applied. 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 transaction in the home currency. Includes the total of all the charges, allowances, and taxes. This field is valid in the UK, AU, and CA editions.

Invoices

Create, update, delete, and query QuickBooks Invoices.

Table Specific Information

Invoices may be inserted, queried, or updated via the Invoices or InvoiceLineItems tables. Invoices may be deleted by using the Invoices 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 an Invoice, specify a Customer and at least one Line Item. The LineAggregate column may be used to specify an XML aggregate of Line Item data. Each _ denotes hierarchy. Use <Line> at the base level. The contents of LineAggregate will be sent to the API as is. All values for each field in the aggregate should adhere to the API's specifications (e.g. for dates in format yyyy-MM-dd, for date times in format yyyy-MM-dd'T'HH:mm:sszzz). The columns that may be used in the aggregates begin with the prefix 'Line_' to indicate they are part of the line item. Use the Line_ column along with the DocNumber to indicate which lines go with which Invoices. For example:

INSERT INTO Invoices (CustomerRef, LineAggregate) 
VALUES ('4', '
<Line><Amount>0.01</Amount><DetailType>SalesItemLineDetail</DetailType><SalesItemLineDetail><ItemRef>2</ItemRef></SalesItemLineDetail></Line>
<Line><Amount>0.02</Amount><DetailType>SalesItemLineDetail</DetailType><SalesItemLineDetail><ItemRef>3</ItemRef></SalesItemLineDetail></Line>
')

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Id [KEY]	String	True		True	True	The Id of the invoice.
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.
DocNumber	String	False		True	True	The reference number for the transaction.
TxnDate	Date	False		True	True	The date entered by the user when this transaction occurred.
PrivateNote	String	False		False	False	A private note that does not appear on the transaction records.
LinkedTxnAggregate	String	False		False	False	An XML aggregate of transactions linked to the estimate.
LineAggregate	String	False		False	False	An XML aggregate of line items associated with the transaction.
TxnTaxDetail_TxnTaxCodeRef	String	False	TaxCodes.Id	False	False	The tax code of the transaction.
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 that appears in the invoice and in the printed invoice.
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 or 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	The latitude coordinate of the geocoded billing address.
BillAddr_Long	String	False		False	False	The longitude coordinate of the geocoded billing address.
ShipAddr_Id	String	False		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	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 or 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	The latitude coordinate of the geocoded shipping address.
ShipAddr_Long	String	False		False	False	The longitude coordinate of the geocoded shipping 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.
SalesTermRef	String	False	Terms.Id	False	False	The Id of the sales term associated with the transaction.
SalesTermRef_Name	String	True	Terms.Name	False	False	The name of the sales term associated with the transaction.
DueDate	Date	False		True	False	The date when the invoice is to be paid, not including any early payment discount incentives or late payment penalties. If the date is not supplied, the current date on the server is used.
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	True		True	True	This field indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes.
PrintStatus	String	False		False	False	The print status of the invoice. The allowed values are NotSet, NeedToPrint, PrintComplete. The default value is NotSet.
EmailStatus	String	False		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	False	The email address where the invoice is sent. If the value of EmailStatus is NeedToSend, BillEmail is a required input.
BillEmailCc_Address	String	False		False	False	The email address where the invoice is sent as CC.
BillEmailBcc_Address	String	False		False	False	The email address where the invoice is sent as BCC.
Balance	Decimal	True		True	True	This field indicates whether the transaction is a finance charge.
PaymentRefNum	String	False		False	False	The reference number for the payment.
PaymentMethodRef	String	False	PaymentMethods.Id	False	False	The Id of the payment method.
PaymentMethodRef_Name	String	True	PaymentMethods.Name	False	False	The name of the payment method.
DepositToAccountRef	String	False	Accounts.Id	False	False	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	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.
DeliveryInfo_DeliveryType	String	False		False	False	Type of the delivery. Used to confirm that email has been sent via the send operation.
DeliveryInfo_DeliveryTime	Datetime	False		False	False	Delivery date and time.
Deposit	Decimal	False		False	False	The deposit made towards this invoice.
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 store the location of the transaction as defined using location tracking in QuickBooks Online.
AllowOnlineCreditCardPayment	Boolean	False		False	False	It specifies if online credit card payments are allowed for this invoice and corresponds to the Cards online payment check box on the QuickBooks UI.
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, and CA editions.
GlobalTaxCalculation	String	False		False	False	The method in which tax is applied. This field is valid in the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable.
HomeTotalAmt	Decimal	True		False	False	Total amount of the transaction in the home currency. Includes the total of all the charges, allowances, and taxes. This field is valid in the UK, AU, and CA editions.
AllowOnlineACHPayment	Boolean	False		False	False	Specifies if this invoice can be paid with online bank transfers and corresponds to the Free bank transfer online payment check box on the QuickBooks UI.
InvoiceLink	String	True		False	False	Sharable link for the invoice sent to external customers.

Items

Create, update, delete, and query QuickBooks Items.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Id [KEY]	String	True		True	True	The Id of the item.
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.
Name	String	False		True	True	The name of the item.
FullyQualifiedName	String	False		False	False	The fully qualified name of the item. The fully qualified name consists the topmost parent element followed by each subelement and separated by colons. For example: Parent:Account1:SubAccount1:SubAccount2.
Description	String	False		False	False	The description for the item that describes the details of the service or product.
Active	Boolean	False		True	False	This column sets whether the item active. Inactive items may be hidden from display and are not used in financial transactions.
ParentRef	String	False	Items.Id	False	True	The Id of the parent entity of the item. If SubItem is true, then ParenRef is required.
ParentRef_Name	String	True	Items.Name	False	False	A name that identifies the parent entity of the item. If SubItem is true, then ParenRef is required.
PrefVendorRef	String	False	Vendors.Id	False	True	The Id of the vendor entity of the item.
PrefVendorRef_Name	String	False	Vendors.Name	False	False	A name that identifies the vendor entity of the item.
SubItem	Boolean	False		False	False	This field indicates whether the item is a subitem. A value of false or null indicates a top-level item.
UnitPrice	Decimal	False		False	True	Monetary value of the service or product, expressed in the home currency.
Type	String	False		True	True	Classification that specifies the use of this item. The allowed values are Inventory, NonInventory, Service, Category, Group.
Taxable	Boolean	False		False	False	This field indicates whether the item is subject to tax.
AssetAccountRef	String	False	Accounts.Id	False	False	The Id of the inventory asset account. If the same inventory asset account is assigned for individual items, the current balance of that account will show the current total value of the inventory. However, individual items may have different account.
AssetAccountRef_Name	String	True	Accounts.Name	False	False	The name of the inventory asset account. If the same inventory asset account is assigned for individual items, the current balance of that account will show the current total value of the inventory. However, individual items may have different accounts.
IncomeAccountRef	String	False	Accounts.Id	False	False	The Id of the account that records the proceeds from the sale of this item.
IncomeAccountRef_Name	String	True	Accounts.Name	False	False	The name of the account that records the proceeds from the sale of this item.
PurchaseDesc	String	False		False	False	The purchase description for the item.
PurchaseCost	Decimal	False		False	False	The amount paid when buying or ordering the item, as expressed in the home currency.
ExpenseAccountRef	String	False	Accounts.Id	False	False	The Id of the expense account associated with the purchase item.
ExpenseAccountRef_Name	String	True	Accounts.Name	False	False	The name of the expense account reference associated with the purchase item.
QtyOnHand	Double	False		False	True	The current quantity of the inventory items available for sale.
ReorderPoint	Double	False		False	False	The minimum quantity of a product to have on hand.
InvStartDate	Date	False		False	False	The date to start tracking inventory. Required if TrackQtyOnHand is set.
SalesTaxCodeRef	String	False	TaxCodes.Id	False	False	The sales tax code for the item.
PurchaseTaxCodeRef	String	False	TaxCodes.Id	False	False	The purchase tax code for the item.
TrackQtyOnHand	Boolean	False		False	False	This field indicates whether there is quantity on hand to be tracked.
Level	Integer	True		False	False	The level of the item. The value 0 indicates the top-level parent. Otherwise, this field specifies the depth from the top parent.
Sku	String	False		True	False	The stock keeping unit (SKU) for this Item. This is a company-defined identifier for an item or product used in tracking inventory.
SalesTaxIncluded	Boolean	False		False	False	This field indicates whether the sales tax is included in the item amount, and therefore not calculated for the transaction.
PurchaseTaxIncluded	Boolean	False		False	False	This field indicates whether the purchase tax is included in the item amount, and therefore not calculated for the transaction.
ItemGroupDetail_ItemGroupLineAggregate	String	True		False	False	One or more Item objects that comprise a bundle.
ClassRef	String	False	Class.Id	False	False	The ID for the referenced object as found in the Id field of the object payload.
ClassRef_Name	String	False	Class.Name	False	False	An identifying name for the object being referenced by value.

JournalCode

Create, update, delete, and query QuickBooks Journal Codes.

Table Specific Information

Applicable only for France-locale companies (FR locale). JournalCodes may be inserted, queried, or updated via the JournalCode table.

Select

You can retrieve all JournalCode items from the table or a specific one specifying ID. Other filters processed server side are Name, MetaData_CreateTime, MetaData_LastUpdatedTime. You can also order the results by the same fields.

SELECT * FROM JournalCode WHERE Id = 4

SELECT * FROM JournalCode WHERE MetaData_LastUpdatedTime = '2018-07-26 08:29:22'

SELECT * FROM JournalCode ORDER BY Name ASC

SELECT * FROM JournalCode ORDER BY Id ASC

SELECT * FROM JournalCode ORDER BY MetaData_CreateTime DESC

Insert

To add a JournalCode, there must be at least Name field specified, which must be unique. All the fields of JournalCode which are not readonly can be inserted as well.

INSERT INTO JournalCode (Name) VALUES ('New inserted')

Update

All the fields of JournalCode which are not readonly can be updated.

UPDATE JournalCode SET Description = 'New Desc' WHERE Id = 4

Delete

Delete is not supported for the table.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Id [KEY]	String	True		True	True	Unique Identifier for a journal code entity.
Name	String	False		True	True	A name representing the journal code.
Type	String	False		False	False	The type of this journal code. The value cannot be changed once the object is created. The allowed values are Expenses, Sales, Bank, Nouveaux, Wages, Cash, Others.
Description	String	False		True	False	A free-form description of the journal code.
Active	Boolean	True		False	False	Wether journal code object is active
Domain	String	True		False	False
Sparse	Boolean	True		False	False
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	Time the entity was created in the source domain.
MetaData_LastUpdatedTime	Datetime	True		True	True	Time the entity was last updated in the source domain.
Time	Datetime	True		False	False

JournalEntries

Create, update, delete, and query QuickBooks Journal Entries.

Table Specific Information

JournalEntries may be inserted, queried, or updated via the JournalEntries or JournalEntryLineItems tables. JournalEntries may be deleted by using the JournalEntries 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 JournalEntry, there must be at least one credit line and at least one debit line where the total of the debit and credit Lines are equal to each other. The LineAggregate column may be used to specify an XML aggregate of Line Item data. Each _ denotes hierarchy. Use <Line> at the base level. The contents of LineAggregate will be sent to the API as is. All values for each field in the aggregate should adhere to the API's specifications (e.g. for dates in format yyyy-MM-dd, for date times in format yyyy-MM-dd'T'HH:mm:sszzz).The columns that may be used in the aggregates begin with the prefix 'Line_' to indicate they are part of the line item. Use the Line_ column along with the DocNumber to indicate which lines go with which JournalEntries. For example:

INSERT INTO JournalEntries (LineAggregate) 
VALUES ('
<Line><Amount>0.02</Amount><DetailType>JournalEntryLineDetail</DetailType><JournalEntryLineDetail><PostingType>Debit</PostingType><Entity><Type>Customer</Type><EntityRef>24</EntityRef></Entity><AccountRef>33</AccountRef></JournalEntryLineDetail></Line>
<Line><Amount>0.02</Amount><DetailType>JournalEntryLineDetail</DetailType><JournalEntryLineDetail><PostingType>Credit</PostingType><AccountRef>14</AccountRef></JournalEntryLineDetail></Line>
')

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Id [KEY]	String	True		True	True	The Id of the journal entry.
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.
DocNumber	String	False		True	True	The reference number for the transaction.
TxnDate	Date	False		True	True	The date entered by the user when this transaction occurred.
PrivateNote	String	False		False	False	A private note about the transaction. This note will not appear on the transaction records by default.
Adjustment	Boolean	False		False	False	The total amount of the transaction. This includes the total of all the charges, allowances, and taxes.
LineAggregate	String	False		False	False	An XML aggregate of the line items of a transaction.
TxnTaxDetail_TxnTaxCodeRef	String	False	TaxCodes.Id	False	False	The transaction tax code.
TxnTaxDetail_TotalTax	String	False		False	False	The 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.
TotalAmt	Decimal	True		False	True	The total amount of the transaction. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks.
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 only valid if the company file uses 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 in only the UK, AU, and CA editions.
TransactionLocationType	String	False		False	False	The account location. This field is valid in only the FR editions. The allowed values are WithinFrance, FranceOverseas, OutsideFranceWithEU, OutsideEU.

JournalEntryLineItems

Create, update, delete, and query QuickBooks Journal Entry Line Items.

Table Specific Information

JournalEntries may be inserted, queried, or updated via the JournalEntries or JournalEntryLineItems tables. JournalEntries may be deleted by using the JournalEntries 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 JournalEntry, there must be at least one credit line and at least one debit line where the total of the debit and credit lines are equal to each other. The following shows an example of inserting multiple JournalEntries, each with a single line. To insert a JournalEntry with multiple lines, see the example on the JournalEntries table.

INSERT INTO JournalEntryLineItems#TEMP (Line_DetailType, Line_JournalEntryLineDetail_PostingType, Line_JournalEntryLineDetail_Entity_Type, Line_JournalEntryLineDetail_Entity_EntityRef, Line_JournalEntryLineDetail_AccountRef, Line_Amount) VALUES ('JournalEntryLineDetail', 'Debit', 'Customer', '24', '33', 0.02)
INSERT INTO JournalEntryLineItems#TEMP (Line_DetailType, Line_JournalEntryLineDetail_PostingType, Line_JournalEntryLineDetail_AccountRef, Line_Amount) VALUES ('JournalEntryLineDetail', 'Credit', '14', 0.02)
INSERT INTO JournalEntryLineItems (Line_DetailType, Line_JournalEntryLineDetail_PostingType, Line_JournalEntryLineDetail_Entity_Type, Line_JournalEntryLineDetail_Entity_EntityRef, Line_JournalEntryLineDetail_AccountRef, Line_Amount, Line_JournalEntryLineDetail_AccountRef) SELECT Line_DetailType, Line_JournalEntryLineDetail_PostingType, Line_JournalEntryLineDetail_Entity_Type, Line_JournalEntryLineDetail_Entity_EntityRef, Line_JournalEntryLineDetail_AccountRef, Line_Amount, Line_JournalEntryLineDetail_AccountRef FROM JournalEntryLineItems#TEMP

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
LineId [KEY]	String	True		False	False	The Id of the line item of the journal entry.
JournalEntryId [KEY]	String	False	JournalEntries.Id	True	True	The Id of the journal entry.
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.
DocNumber	String	False		True	True	Reference number for the transaction.
TxnDate	Date	False		True	True	The date entered by the user when this transaction occurred.
PrivateNote	String	False		False	False	A private note about the transaction. This note will not appear on the transaction records by default.
Adjustment	Boolean	False		False	False	The total amount of the transaction. This includes the total of all the charges, allowances, and taxes.
Line_Id	String	False		False	False	The Id 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	The amount of the line item.
Line_DetailType	String	False		False	False	The detail type of the line item. Different detail types indicate different types of line items.
Line_JournalEntryLineDetail_PostingType	String	False		False	False	This field indicates the posting type of the line item of the journal entry detail. The allowed values are Credit, Debit.
Line_JournalEntryLineDetail_Entity_Type	String	False		False	False	The type of the entity to be referenced.
Line_JournalEntryLineDetail_Entity_EntityRef	String	False		False	False	The Id of the entity to be referenced.
Line_JournalEntryLineDetail_Entity_EntityRef_Name	String	True		False	False	The name of the entity to be referenced.
Line_JournalEntryLineDetail_AccountRef	String	False	Accounts.Id	False	False	The Id of the account associated with the journal entry line item.
Line_JournalEntryLineDetail_AccountRef_Name	String	True	Accounts.Name	False	False	The name of the account associated with the journal entry line item.
Line_JournalEntryLineDetail_ClassRef	String	False	Class.Id	False	False	The Id of the class associated with the journal entry line item.
Line_JournalEntryLineDetail_ClassRef_Name	String	True	Class.FullyQualifiedName	False	False	The name of the class associated with the journal entry line.
Line_JournalEntryLineDetail_DepartmentRef	String	False	Departments.Id	False	False	The Id of the department associated with the journal entry line.
Line_JournalEntryLineDetail_DepartmentRef_Name	String	True	Departments.Name	False	False	The name of the department associated with the journal entry line.
Line_JournalEntryLineDetail_TaxCodeRef	String	False	TaxCodes.Id	False	False	The sales or purchase tax code associated with the journal entry line. This field is used for non-U.S., non-Canadian companies. This field is valid for the UK edition.
Line_JournalEntryLineDetail_TaxApplicableOn	String	False		False	False	This field indicates whether the tax applicable to the line item is sales or purchase tax. This field is valid for the UK edition.
Line_JournalEntryLineDetail_TaxAmount	Decimal	False		False	False	The tax applicable for this line item. This field is valid for the UK, and AU editions.
Line_JournalEntryLineDetail_BillableStatus	String	False		False	False	The billable status of the journal entry line. The line is to be billed to a customer if the account is an expense account and the Entity Reference specifies a Customer or a Job. The allowed values are Billable, NotBillable, HasBeenBilled.
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.
TotalAmt	Decimal	True		True	True	The total amount of the transaction. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks.
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 only valid if the company file uses 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 in only the UK, AU, and CA editions.

PaymentLineItems

Create, update, delete, and query QuickBooks Payment Line Items.

Table Specific Information

Payments may be inserted, queried, or updated via the Payments or PaymentLineItems tables. Payments may be deleted by using the Payments 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 Payment, specify a Customer, TotalAmt, and optionally Line Items. The following shows an example of inserting multiple Payments, each with a single line. To insert a Payment with multiple lines, see the example on the Payments table.

INSERT INTO PaymentLineItems#TEMP (CustomerRef, Line_Amount, Line_LinkedTxn_TxnType, Line_LinkedTxn_TxnId, TotalAmt) VALUES ('4', 0.01, 'Invoice', '116', 0.03)
INSERT INTO PaymentLineItems#TEMP (CustomerRef, Line_Amount, Line_LinkedTxn_TxnType, Line_LinkedTxn_TxnId, TotalAmt) VALUES ('4', 0.02, 'Invoice', '117', 0.03)
INSERT INTO PaymentLineItems (CustomerRef, Line_Amount, Line_LinkedTxn_TxnType, Line_LinkedTxn_TxnId, TotalAmt) SELECT CustomerRef, Line_Amount, Line_LinkedTxn_TxnType, Line_LinkedTxn_TxnId, TotalAmt FROM PaymentLineItems#TEMP

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
LineId [KEY]	String	True		False	False	The Id of the line item on the payment.
PaymentId [KEY]	String	False	Payments.Id	True	True	The Id of the payment.
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.
TxnDate	Date	False		True	False	The date entered by the user when this transaction occurred.
PrivateNote	String	False		False	False	The 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. For Payment entities, this status is always set to PAID.
Line_LinkedTxn_TxnId	String	False		False	False	The Id of a linked transaction in the line item.
Line_Amount	Decimal	False		False	False	Amount of the line item.
Line_LinkedTxn_TxnType	String	False		False	False	The type of the transaction linked to the line item.
Line_LinkedTxn_TxnLineId	String	False		False	False	The description of the line 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.
RemitToRef	String	True		False	False	This field contains the Id of the entity for the party or location that the payment is to be remitted to or sent to.
RemitToRef_Name	String	True		False	False	A name that identifies the party or location that the payment is to be remitted to or sent to.
ARAccountRef	String	False	Accounts.Id	False	False	Reference to the Accounts Receivable (Accounts Receivable account) account associated with the transaction. It is strongly recommended to always supply this field, even though it is ignored by QuickBooks Online, because QuickBooks Online has only one accounts receivable account.
ARAccountRef_Name	String	True	Accounts.Name	False	False	Reference to the ARAccount (Accounts Receivable account) associated with the transaction. It is strongly recommended to always supply an ARAccountRef even though it is ignored by QBO, because QBO has only one accounts receivable account.
DepositToAccountRef	String	False	Accounts.Id	False	False	An optional asset account specification to designate the account the payment money needs to be deposited to.
DepositToAccountRef_Name	String	True	Accounts.Name	False	False	The optional asset account specification to designate the account the payment money needs to be deposited to.
PaymentMethodRef	String	False	PaymentMethods.Id	False	False	The Id of the payment method.
PaymentMethodRef_Name	String	True	PaymentMethods.Name	False	False	The name of the payment method. The allowed values are Cash, Check, CreditCard, Other.
PaymentRefNum	String	False		True	True	The reference number for the payment received.
CreditCardPayment_CreditChargeInfo	String	False		False	False	Holds credit card information to request a credit card payment from a merchant account service, but not any response or authorization information from the merchant account service provider.
CreditCardPayment_Number	String	False		False	False	The credit card account number, as printed on the card. This field must not have white space or formatting characters.
CreditCardPayment_Type	String	False		False	False	The type of credit card.
CreditCardPayment_NameOnAcct	String	False		False	False	The name of the account holder, as printed on the card.
CreditCardPayment_CcExpiryMonth	Integer	False		False	False	The expiration month on the card.
CreditCardPayment_CcExpiryYear	Integer	False		False	False	4-digit expiration year on the card.
CreditCardPayment_BillAddrStreet	String	False		False	False	The billing address.
CreditCardPayment_PostalCode	String	False		False	False	The postal code.
CreditCardPayment_CommercialCardCode	String	False		False	False	The code associated with commercial cards such as purchase, corporate, or business cards. Lower transaction fee rates apply for these cards when this field is defined.
CreditCardPayment_CCTxnMode	String	False		False	False	Credit card transaction mode used in credit card payment transactions. The allowed values are CardNotPresent, CardPresent.
CreditCardPayment_CCTxnType	String	False		False	False	The type of credit card transaction. The allowed values are Authorization, Capture, Charge, Refund, VoiceAuthorization.
CreditCardPayment_PrevCCTransId	String	False		False	False	Id of the previous payment transaction.
TotalAmt	Decimal	False		True	True	This field indicates the total amount of the entity associated. This includes the total of all the payments from the payment details.
UnappliedAmt	Decimal	False		False	False	This field indicates the amount that has not been applied to pay amounts owed for sales transactions.
ProcessPayment	Boolean	False		False	False	This field indicates that the payment should be processed by merchant account service. This field is valid for QuickBooks Online companies with credit card processing.
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	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, and CA editions.

PaymentMethods

Create, update, delete, and query QuickBooks Payment Methods.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Id [KEY]	String	True		True	True	The Id of the payment method.
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.
Name	String	False		True	True	The name of the payment method item.
Active	Boolean	False		False	False	This field sets whether or not the payment method is active. Inactive payment methods may be hidden from display and may not be used on financial transactions.
Type	String	False		False	False	Defines the type, or the way the payment was made.

Payments

Create, update, delete, and query QuickBooks Payments.

Table Specific Information

Payments may be inserted, queried, or updated via the Payments or PaymentLineItems tables. Payments may be deleted by using the Payments 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 Payment, specify a Customer and at least one item Line Item. The LineAggregate column may be used to specify an XML aggregate of Line Item data. Each _ denotes hierarchy. Use <Line> at the base level. The contents of LineAggregate will be sent to the API as is. All values for each field in the aggregate should adhere to the API's specifications (e.g. for dates in format yyyy-MM-dd, for date times in format yyyy-MM-dd'T'HH:mm:sszzz). The columns that may be used in the aggregates begin with the prefix 'Line_' to indicate they are part of the line item. Use the Line_ column along with the DocNumber to indicate which lines go with which Payments. For example

INSERT INTO Payments (CustomerRef, TotalAmt, LineAggregate) 
VALUES ('4', '0.03', '
<Line><Amount>0.01</Amount><LinkedTxn><TxnId>116</TxnId><TxnType>Invoice</TxnType></LinkedTxn></Line>
<Line><Amount>0.02</Amount><LinkedTxn><TxnId>117</TxnId><TxnType>Invoice</TxnType></LinkedTxn></Line>
')

To automatically add payments for invoices up to a specific total amount, set AutoInvoice to true. You must also supply a Customer and a positive TotalAmt. Your unpaid invoices will be paid from the soonest due to the oldest one.

INSERT INTO Payments (CustomerRef, TotalAmt, AutoInvoice) VALUES ('4', 27.5, true)

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Id [KEY]	String	True		True	True	The Id of the payment.
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.
TxnDate	Date	False		True	False	The date entered by the user when this transaction occurred.
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. For payment entities, this status is always set to PAID.
LineAggregate	String	False		False	False	A line item of a transaction.
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.
RemitToRef	String	True		False	False	The Id of the entity for the party or location that the payment is to be remitted to or sent to.
RemitToRef_Name	String	True		False	False	The name of the party or location that the payment is to be remitted to or sent to.
ARAccountRef	String	False	Accounts.Id	False	False	The Id of the Accounts Receivable account (ARAccount) associated with the transaction. It is strongly recommended to always supply this field, even though it is ignored by QuickBooks Online, because QuickBooks Online has only one accounts recievable account.
ARAccountRef_Name	String	True	Accounts.Name	False	False	The name of the Accounts Receivable account (ARAccount) associated with the transaction. It is strongly recommended to always supply this field, even though it is ignored by QuickBooks Online, because QuickBooks Online has only one accounts recievable account.
DepositToAccountRef	String	False	Accounts.Id	False	False	An optional asset account specification. The Id of the asset account that designates the account the payment money needs to be deposited to.
DepositToAccountRef_Name	String	True	Accounts.Name	False	False	An optional asset account specification. The name of the account the payment money needs to be deposited to.
PaymentMethodRef	String	False	PaymentMethods.Id	False	False	The Id of the payment method.
PaymentMethodRef_Name	String	True	PaymentMethods.Name	False	False	The name of the payment method. The allowed values are Cash, Check, CreditCard, Other.
PaymentRefNum	String	False		True	True	The reference number for the payment received.
CreditCardPayment_CreditChargeInfo	String	False		False	False	This field holds credit card information to request a credit card payment from a merchant account service, but not any response or authorization information from the merchant account service provider.
CreditCardPayment_Number	String	False		False	False	The credit card account number, as printed on the card. This field must not have white space or formatting characters.
CreditCardPayment_Type	String	False		False	False	The type of credit card.
CreditCardPayment_NameOnAcct	String	False		False	False	The account holder name as printed on the card.
CreditCardPayment_CcExpiryMonth	Integer	False		False	False	The expiration month on the card.
CreditCardPayment_CcExpiryYear	Integer	False		False	False	The 4-digit expiration year on the card.
CreditCardPayment_BillAddrStreet	String	False		False	False	The street of the billing address.
CreditCardPayment_PostalCode	String	False		False	False	The postal code.
CreditCardPayment_CommercialCardCode	String	False		False	False	The code associated with commercial cards such as purchase, corporate, or business cards. Lower transaction fee rates apply for these cards when this field is defined.
CreditCardPayment_CCTxnMode	String	False		False	False	The credit card transaction mode used in credit card payment transactions. The allowed values are CardNotPresent, CardPresent.
CreditCardPayment_CCTxnType	String	False		False	False	The type of credit card transaction. The allowed values are Authorization, Capture, Charge, Refund, VoiceAuthorization.
CreditCardPayment_PrevCCTransId	String	False		False	False	The Id of the previous payment transaction.
TotalAmt	Decimal	False		True	True	The total amount of the entity associated. This includes the total of all the payments from the payment details.
UnappliedAmt	Decimal	False		False	False	The amount that has not been applied to pay amounts owed for sales transactions.
ProcessPayment	Boolean	False		False	False	This field indicates that the payment should be processed by merchant account service. This field is valid for companies with credit card processing enabled in QuickBooks Online.
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, and CA editions.
TransactionLocationType	String	False		False	False	The account location. This field is valid in only the FR editions. The allowed values are WithinFrance, FranceOverseas, OutsideFranceWithEU, OutsideEU.

Pseudo-Columns

Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
AutoInvoice	Boolean	Set to true to apply payments to invoices automatically (starting from oldest to newest).

Preferences

Query QuickBooks Preferences. The Preferences table contains settings for company-wide preferences, which affect all users.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Id [KEY]	String	True		False	False	The Id of the preference record.
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		False	False	The time the record was created.
MetaData_LastUpdatedTime	Datetime	True		False	False	The time the record was last updated.
AccountingInfoPrefs_TrackDepartments	Boolean	False		False	False	This setting corresponds to the Track locations preference in QuickBooks Online Company Settings under Categories.
AccountingInfoPrefs_DepartmentTerminology	String	False		False	False	Specifies the term used by the company for department. This string is used as a label on transaction forms.
AccountingInfoPrefs_ClassTrackingPerTxnLine	Boolean	False		False	False	These settings correspond to how classes are assigned when Track classes in QuickBooks Online Company Settings under Categories is set to On.
AccountingInfoPrefs_ClassTrackingPerTxn	Boolean	False		False	False	These settings correspond to how classes are assigned when Track classes in QuickBooks Online Company Settings under Categories is set to On.
AccountingInfoPrefs_CustomerTerminology	String	True		False	False	A value used for describing customers in the UI.
AccountingInfoPrefs_BookCloseDate	Date	True		False	False	This setting corresponds to the Closing date preference in the QuickBooks Online Company Settings and specifies the date the books are closed: income and expense accounts are closed and net profit or loss is rolled up into the retained earnings account. Transactions before this date are protected from changes.
AccountingInfoPrefs_UseAccountNumbers	Boolean	True		False	False	This setting corresponds to Enable account numbers in QuickBooks Online Company Settings.
AccountingInfoPrefs_FirstMonthOfFiscalYear	String	True		False	False	This setting corresponds to the First month of fiscal year preference in the QuickBooks Online Company Settings to specify the beginning of the company's fiscal year.
AccountingInfoPrefs_TaxYearMonth	String	True		False	False	This setting corresponds to the First month of income tax year preference in the QuickBooks Online Company Settings to specify the beginning of the company's fiscal year.
TaxPrefs_UsingSalesTax	Boolean	False		False	False	This field sets whether sales tax is enabled.
TaxPrefs_TaxGroupCodeRef	String	False		False	False	The first-used tax code on a sales form after a new sales tax center has been enabled.
CurrencyPrefs_MultiCurrencyEnabled	String	False		False	False	This field sets whether multicurrency is enabled for this company.
CurrencyPrefs_HomeCurrency	String	False		False	False	The currency code of the country where the business is located.
ProductAndServicesPrefs_ForSales	Boolean	False		False	False	This field indicates whether the Product and Services for Sales preference is enabled.
ProductAndServicesPrefs_ForPurchase	Boolean	False		False	False	This field indicates whether the Product and Services for Purchase preference is enabled.
ProductAndServicesPrefs_QuantityWithPriceAndRate	Boolean	False		False	False	This field indicates whether quantity with price and rate is enabled.
ProductAndServicesPrefs_QuantityOnHand	Boolean	True		False	False	This field indicates whether QuantityOnHand is enabled.
SalesFormsPrefs_AllowDiscount	Boolean	False		False	False	This field allows discounts to be specified.
SalesFormsPrefs_AllowDeposit	Boolean	False		False	False	Allows deposits to be specified.
SalesFormsPrefs_AllowShipping	Boolean	False		False	False	Allows the use of Shipping Info fields.
SalesFormsPrefs_AllowServiceDate	Boolean	False		False	False	Allows the use of Service Date fields.
SalesFormsPrefs_AllowEstimates	Boolean	False		False	False	Allows the use of Estimate entities.
SalesFormsPrefs_CustomTxnNumbers	Boolean	False		False	False	Sets whether custom transaction numbers can be specified.
SalesFormsPrefs_DefaultTerms	Integer	False		False	False	Default sales terms.
SalesFormsPrefs_EstimateMessage	String	False		False	False	Message to the customers on estimates.
SalesFormsPrefs_DefaultDiscountAccount	String	False		False	False	Default discount account.
SalesFormsPrefs_DefaultShippingAccount	String	False		False	False	Default shipping account.
SalesFormsPrefs_DefaultCustomerMessage	String	False		False	False	Default customer message.
SalesFormsPrefs_IPNSupportEnabled	Boolean	False		False	False	Enables support for IPN.
SalesFormsPrefs_ETransactionEnabledStatus	String	False		False	False	This field enables ETransaction status.
SalesFormsPrefs_ETransactionAttachPDF	Boolean	False		False	False	This field indicates whether PDFs may be attached to ETransactions.
SalesFormsPrefs_ETransactionPaymentEnabled	Boolean	False		False	False	This field indicates whether payment entities can be used with ETransactions.
SalesFormsPrefs_CustomFieldAggregate	String	False		False	False	An XML aggregate of the custom fields for sales form entities.
VendorAndPurchasesPrefs_TrackingByPreferences	Boolean	False		False	False	Enables tracking by using settings in preferences.
VendorAndPurchasesPrefs_TrackingByCustomer	Boolean	False		False	False	Enables tracking using customer information.
VendorAndPurchasesPrefs_BillableExpenseTracking	Boolean	False		False	False	Enables tracking using billable expense fields.
VendorAndPurchasesPrefs_WorkWeekStartDate	Date	False		False	False	Sets the starting day of the work week.
VendorAndPurchasesPrefs_POCustomFieldAggregate	String	False		False	False	Defines PO custom fields.
TimeTrackingPrefs_UseServices	Boolean	False		False	False	Enables time tracking services.
TimeTrackingPrefs_BillPreferences	Boolean	False		False	False	Enables billing for time tracking entries.
TimeTrackingPrefs_BillCustomers	Boolean	False		False	False	Enables time tracking services for the customer in a bill.
TimeTrackingPrefs_ShowBillRateToAll	Boolean	False		False	False	Billing rate to all employees enabled.
TimeTrackingPrefs_WorkWeekStartDate	String	False		False	False	The starting day of the work week.
TimeTrackingPrefs_MarkTimeEntiresBillable	Boolean	False		False	False	This field sets whether to mark time entries as billable.
EmailMessagesPrefs_InvoiceMessage_Subject	String	False		False	False	The subject portion of the default invoice message.
EmailMessagesPrefs_InvoiceMessage_Message	String	False		False	False	The message portion of the default invoice message.
EmailMessagesPrefs_EstimateMessage_Subject	String	False		False	False	The subject portion of the default estimate message.
EmailMessagesPrefs_EstimateMessage_Message	String	False		False	False	The message portion of the default estimate message.
EmailMessagesPrefs_SalesReceiptMessage_Subject	String	False		False	False	The subject portion of the default sales receipt message.
EmailMessagesPrefs_SalesReceiptMessage_Message	String	False		False	False	The message portion of the default sales receipt message.
EmailMessagesPrefs_StatementMessage_Subject	String	False		False	False	The subject portion of the default statement message.
EmailMessagesPrefs_StatementMessage_Message	String	False		False	False	The message portion of the default statement message.
OtherPrefs_NameValueAggregate	String	False		False	False	This field specifies an extension of the preference entity to allow name-value pairs in the custom fields at the top level.
ReportPrefs_ReportBasis	String	False		False	False	Accounting method for summary. Possible values include Cash and Accrual.
ReportPrefs_CalcAgingReportFromTxnDate	Boolean	False		False	False	Boolean to indicate whether to calculate report aging from transaction date

PurchaseLineItems

Create, update, delete, and query QuickBooks Purchase Line Items.

Table Specific Information

Note: A Purchase object represents an expense, such as a purchase made from a vendor.

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

INSERT INTO PurchaseLineItems#TEMP (AccountRef, PaymentType, Line_Amount, Line_DetailType, Line_AccountBasedExpenseLineDetail_AccountRef) VALUES ('41',  'Cash', 0.01, 'ItemBasedExpenseLineDetail', '8')
INSERT INTO PurchaseLineItems#TEMP (AccountRef, PaymentType, Line_Amount, Line_DetailType, Line_AccountBasedExpenseLineDetail_AccountRef) VALUES ('41',  'Cash', 0.02, 'ItemBasedExpenseLineDetail', '8')
INSERT INTO PurchaseLineItems (AccountRef, PaymentType, Line_Amount, Line_DetailType, Line_AccountBasedExpenseLineDetail_AccountRef) SELECT AccountRef, PaymentType, Line_Amount, Line_DetailType, Line_AccountBasedExpenseLineDetail_AccountRef FROM PurchaseLineItems#TEMP

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
LineId [KEY]	String	True		False	False	The Id of the line item of the purchase.
PurchaseId [KEY]	String	False	Purchases.Id	True	True	The Id of the purchase.
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.
DocNumber	String	False		True	True	The reference number for the transaction.
TxnDate	Date	False		True	True	The date when this transaction occurred.
PrivateNote	String	False		False	False	A private note about the transaction. This note will not appear on the transaction records by default. This field maps to the Memo field on the Check and CreditCard form.
Line_Id	String	False		False	False	The Id 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	The total amount of the charges or discounts for the given line. This field includes the charges and allowances, but it excludes the tax amount.
Line_DetailType	String	False		False	False	The type of line in the transaction.
Line_ItemBasedExpenseLineDetail_ItemRef	String	False	Items.Id	False	False	The Id of the item in the line item. When a line item lacks an ItemRef it is treated as documentation and the Line.Amount attribute is ignored.
Line_ItemBasedExpenseLineDetail_ItemRef_Name	String	True	Items.Name	False	False	The name of the item. When a line item lacks an ItemRef it is treated as documentation and the Line_Amount field is ignored.
Line_ItemBasedExpenseLineDetail_ClassRef	String	False	Class.Id	False	False	The Id of the class for the line item.
Line_ItemBasedExpenseLineDetail_ClassRef_Name	String	True	Class.Name	False	False	The name of the class for the line item.
Line_ItemBasedExpenseLineDetail_UnitPrice	Decimal	False		False	False	The unit price of the subject item as referenced by ItemRef.
Line_ItemBasedExpenseLineDetail_Qty	Double	False		False	False	Number of items for the line.
Line_ItemBasedExpenseLineDetail_RatePercent	Double	False		False	False	The amount is expressed as a percent of charges already entered in the current transaction. To enter a rate of 10% use 10.0, not 0.01.
Line_ItemBasedExpenseLineDetail_MarkupInfo_Value	Double	False		False	False	Markup value.
Line_ItemBasedExpenseLineDetail_MarkupInfo_Percent	Double	False		False	False	Markup amount expressed as a percent of charges already entered in the current transaction. To enter a rate of 10% use 10.0, not 0.01.
Line_ItemBasedExpenseLineDetail_MarkupInfo_PriceLevelRef	String	False		False	False	The Id of the entity for the price level for the markup.
Line_ItemBasedExpenseLineDetail_MarkupInfo_PriceLevelRef_Name	String	True		False	False	A name that identifies the price level for the markup.
Line_ItemBasedExpenseLineDetail_TaxCodeRef	String	False	TaxCodes.Id	False	False	The sales tax code for this item.
Line_ItemBasedExpenseLineDetail_CustomerRef	String	False	Customers.Id	False	False	The Id of the customer associated with the expense.
Line_ItemBasedExpenseLineDetail_CustomerRef_Name	String	True	Customers.DisplayName	False	False	The name of the customer associated with the expense.
Line_ItemBasedExpenseLineDetail_BillableStatus	String	False		False	False	The billable status of the expense. The allowed values are Billable, NotBillable, HasBeenBilled.
Line_AccountBasedExpenseLineDetail_ClassRef	String	False	Class.Id	False	False	The Id of the class entity of the expense.
Line_AccountBasedExpenseLineDetail_ClassRef_Name	String	True	Class.Name	False	False	The name of the class entity of the expense.
Line_AccountBasedExpenseLineDetail_CustomerRef	String	False	Customers.Id	False	False	The customer id for the expense.
Line_AccountBasedExpenseLineDetail_CustomerRef_Name	String	True	Customers.DisplayName	False	False	The customer name for the expense.
Line_AccountBasedExpenseLineDetail_AccountRef	String	False	Accounts.Id	False	False	The Id of the expense account of the expense.
Line_AccountBasedExpenseLineDetail_AccountRef_Name	String	True	Accounts.Name	False	False	The name of the expense account of the expense.
Line_AccountBasedExpenseLineDetail_BillableStatus	String	False		False	False	The billable status of the expense. The allowed values are Billable, NotBillable, HasBeenBilled.
Line_AccountBasedExpenseLineDetail_MarkupInfo_Value	Double	False		False	False	Markup value.
Line_AccountBasedExpenseLineDetail_MarkupInfo_Percent	Double	False		False	False	Markup amount expressed as a percent of charges already entered in the current transaction. To enter a rate of 10% use 10.0, not 0.01.
Line_AccountBasedExpenseLineDetail_MarkupInfo_PriceLevelRef	String	False		False	False	The Id of price level for the markup.
Line_AccountBasedExpenseLineDetail_MarkupInfo_PriceLevelRef_Name	String	True		False	False	The name of the price level for the markup.
Line_AccountBasedExpenseLineDetail_TaxCodeRef	String	False	TaxCodes.Id	False	False	The type of line in the transaction.
AccountRef	String	False	Accounts.Id	False	False	The Id of the account associated with the transaction.
AccountRef_Name	String	True	Accounts.Name	False	False	A name that identifies the account associated with the transaction. Checks should reference a bank account and CreditCard should reference a credit card account.
PaymentType	String	False		True	True	The expense type. The allowed values are Cash, Check, CreditCard.
EntityRef	String	False		False	False	Specifies the party with whom an expense is associated.
EntityRef_Name	String	True		False	False	Specifies the party with whom an expense is associated.
Credit	Boolean	False		False	False	This field is valid only for the CreditCard payment type.
TotalAmt	Decimal	True		True	True	The total amount due, determined the sum of the line items. This includes all charges, allowances, taxes, discounts, etc.
PrintStatus	String	False		False	False	The print status of the payment. This field is applicable only for checks. It is ignored for credit card charges or refunds.
DepartmentRef	String	False	Departments.Id	False	False	The Id of the department, which stores the location of the transaction.
DepartmentRef_Name	String	True	Departments.Name	False	False	The name of the department, which stores the location of the transaction.
Status	String	True		False	False	The status of the purchase.
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.
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	Double	False		False	False	The currency exchange rate. This field is valid only if the company file is set up to use 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, and CA editions.
GlobalTaxCalculation	String	False		False	False	The method in which tax is applied. This field is valid in the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable.

PurchaseOrderLineItems

Create, update, delete, and query QuickBooks Purchase Order Line Items.

Table Specific Information

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

INSERT INTO PurchaseOrderLineItems#TEMP (VendorRef, Line_Amount, Line_DetailType, Line_ItemBasedExpenseLineDetail_ItemRef, TotalAmt) VALUES ('21', 0.01, 'ItemBasedExpenseLineDetail', '2',  0.03)
INSERT INTO PurchaseOrderLineItems#TEMP (VendorRef, Line_Amount, Line_DetailType, Line_ItemBasedExpenseLineDetail_ItemRef, TotalAmt) VALUES ('21', 0.02, 'ItemBasedExpenseLineDetail', '3', 0.03)
INSERT INTO PurchaseOrderLineItems (VendorRef, Line_Amount, Line_DetailType, Line_ItemBasedExpenseLineDetail_ItemRef, TotalAmt) SELECT VendorRef, Line_Amount, Line_DetailType, Line_ItemBasedExpenseLineDetail_ItemRef, TotalAmt FROM PurchaseOrderLineItems#TEMP

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
LineId [KEY]	String	True		False	True	The Id of the line item of the purchase order.
PurchaseOrderId [KEY]	String	False	PurchaseOrders.Id	True	False	The Id of the purchase order.
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.
DocNumber	String	False		True	True	The reference number for the transaction.
TxnDate	Date	False		True	True	The date when this transaction occurred.
PrivateNote	String	False		False	False	A private note about the transaction. This note will not appear on the transaction records by default.
LinkedTxnAggregate	String	False		False	False	An XML aggregate of transactions linked to the estimate.
Line_Id	String	False		False	False	The Id 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	The amount of the line item. It represents the discount amount, charge amount, tax amount, or subtotal amount based on the value of the DetailType field.
Line_DetailType	String	False		False	False	The type of line in the transaction.
Line_ItemBasedExpenseLineDetail_ItemRef	String	False	Items.Id	False	False	The Id of the item of the line item. When a line lacks an ItemRef it is treated as documentation and the Line_Amount field is ignored.
Line_ItemBasedExpenseLineDetail_ItemRef_Name	String	True	Items.Name	False	False	The name of the item of the line item. When a line lacks an ItemRef it is treated as documentation and the Line_Amount field is ignored.
Line_ItemBasedExpenseLineDetail_ClassRef	String	False	Class.Id	False	False	The Id of the class for the line item.
Line_ItemBasedExpenseLineDetail_ClassRef_Name	String	True	Class.FullyQualifiedName	False	False	The name of the class for the line item.
Line_ItemBasedExpenseLineDetail_UnitPrice	Decimal	False		False	False	The price of the referenced item.
Line_ItemBasedExpenseLineDetail_Qty	Double	False		False	False	The number of items for the line.
Line_ItemBasedExpenseLineDetail_TaxCodeRef	String	False	TaxCodes.Id	False	False	The sales tax code for this item.
Line_ItemBasedExpenseLineDetail_CustomerRef	String	False	Customers.Id	False	False	The Id of the customer associated with the expense.
Line_ItemBasedExpenseLineDetail_CustomerRef_Name	String	True	Customers.DisplayName	False	False	The name of the customer associated with the expense.
Line_ItemBasedExpenseLineDetail_BillableStatus	String	False		False	False	The billable status of the expense. The allowed values are Billable, NotBillable, HasBeenBilled.
Line_AccountBasedExpenseLineDetail_ClassRef	String	False	Class.Id	False	False	The Id of the class entity of the expense.
Line_AccountBasedExpenseLineDetail_ClassRef_Name	String	True	Class.FullyQualifiedName	False	False	The name of the class entity of the expense.
Line_AccountBasedExpenseLineDetail_CustomerRef	String	False	Customers.Id	False	False	The customer Id for the expense.
Line_AccountBasedExpenseLineDetail_CustomerRef_Name	String	True	Customers.DisplayName	False	False	The customer name for the expense.
Line_AccountBasedExpenseLineDetail_AccountRef	String	False	Accounts.Id	False	False	The Id of the expense account of the expense.
Line_AccountBasedExpenseLineDetail_AccountRef_Name	String	True	Accounts.Name	False	False	The name of the expense account of the expense.
Line_AccountBasedExpenseLineDetail_TaxCodeRef	String	False	TaxCodes.Id	False	False	The sales tax code for the expense.
Line_AccountBasedExpenseLineDetail_BillableStatus	String	False		False	False	The billable status of the expense. The allowed values are Billable, NotBillable, HasBeenBilled.
Line_AccountBasedExpenseLineDetail_MarkupInfo_Value	Double	False		False	False	Markup value.
Line_AccountBasedExpenseLineDetail_MarkupInfo_Percent	Double	False		False	False	Markup amount expressed as a percent of charges already entered in the current transaction. To enter a rate of 10% use 10.0, not 0.01.
VendorRef	String	False	Vendors.Id	False	False	The Id of the vendor for this transaction.
VendorRef_Name	String	True	Vendors.DisplayName	False	False	The name of the vendor for this transaction.
APAccountRef	String	False	Accounts.Id	True	True	The accounts-payable account the bill is credited to. Many/most small businesses have a single accounts-payable account, so the account can be implied. When specified, the account must be a Liability account, and further, the subtype must be of type Payables.
APAccountRef_Name	String	True	Accounts.Name	False	False	The accounts-payable account to which the bill is credited. Many/most small businesses have a single accounts-payable account, so the account can be implied. When specified, the account must be a Liability account, and further, the subtype must be of type Payables.
TotalAmt	Decimal	True		True	True	The total amount due, determined by the sum of the line item amounts. This includes all charges, allowances, taxes, and discounts.
VendorAddr_Id	String	True		False	False	The Id of the entity for the vendor address, mainly used for modifying the address. This field is assigned by the data service.
VendorAddr_Line1	String	True		False	False	First line of the vendor address.
VendorAddr_Line2	String	True		False	False	Second line of the vendor address.
VendorAddr_Line3	String	True		False	False	Third line of the vendor address.
VendorAddr_Line4	String	True		False	False	Fourth line of the vendor address.
VendorAddr_Line5	String	True		False	False	Fifth line of the vendor address.
VendorAddr_City	String	True		False	False	City name.
VendorAddr_Country	String	True		False	False	Country name.
VendorAddr_CountrySubDivisionCode	String	True		False	False	Region within a country. For example, the state name for the USA and the province name for Canada.
VendorAddr_PostalCode	String	True		False	False	Postal code. For example the zip code for the USA and Canada.
VendorAddr_Note	String	True		False	False	Note for the customer.
VendorAddr_Lat	String	True		False	False	The latitude coordinate of the geocoded vendor address.
VendorAddr_Long	String	True		False	False	The longitude coordinate of the geocoded vendor address.
ShipAddr_Id	String	False		False	False	The Id of the Intuit entity for the 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 shipping address.
ShipAddr_Line2	String	False		False	False	Second line of the shipping address.
ShipAddr_Line3	String	False		False	False	Third line of the shipping address.
ShipAddr_Line4	String	False		False	False	Fourth line of the shipping address.
ShipAddr_Line5	String	False		False	False	Fifth line of the shipping 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, state name for the USA, province name for Canada.
ShipAddr_PostalCode	String	False		False	False	Postal code. For example, zip code for the USA and Canada.
ShipAddr_Note	String	False		False	False	Note for the customer.
ShipAddr_Lat	String	False		False	False	The latitude coordinate of the geocoded shipping address.
ShipAddr_Long	String	False		False	False	The longitude coordinate of the geocoded shipping address.
ShipMethodRef	String	False		False	False	The Id of the entity for the shipping method. This entity is a reference type of all Ids that are taken as input or output.
ShipMethodRef_Name	String	True		False	False	The name of the entity for the shipping method. This entity is a reference type of all Ids that are taken as input or output.
POStatus	String	False		False	False	Enumeration of status for purchase order. The allowed values are Open, Closed.
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.
TaxCodeRef	String	False	TaxCodes.Id	False	False	The tax code for the purchase. This field is valid in only the UK, AU, and CA editions.
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 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, and CA editions.
GlobalTaxCalculation	String	False		False	False	Method in which tax is applied. This field is valid in the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable.

PurchaseOrderLinkedTransactions

Create, update, delete, and query QuickBooks Invoice Line Items.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
LinkedTxnId [KEY]	String	True		False	False	The Id of the line item of the invoice.
PurchaseOrderId [KEY]	String	False	PurchaseOrders.Id	True	True	The Id of the invoice.
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.
DocNumber	String	False		True	True	The reference number for the transaction.
TxnDate	Date	False		True	True	The date entered by the user when this transaction occurred.
PrivateNote	String	False		False	False	A private note for the transaction, which does not appear on the transaction records.
LinkedTxn_TxnId	String	False		False	False	The Id of the line item.
LinkedTxn_TxnType	String	False		False	False	The line number of the line item.
LinkedTxn_TxnLineId	String	False		False	False	The description of the line item.
LineAggregate	String	False		False	False	An XML aggregate of line items associated with the transaction.
TotalAmt	Decimal	True		True	True	The total amount of the transaction. This includes the total of all the charges, allowances, and taxes.
VendorRef	String	False	Vendors.Id	False	False	The Id of the vendor.
VendorRef_Name	String	True	Vendors.DisplayName	False	False	The name of the vendor.
APAccountRef	String	False	Accounts.Id	True	True	The Id of the accounts-payable account to which the bill is credited. This account is implied when a company has a single accounts-payable account. When specified, the account must be a Liability account and the subtype must be of type Payables.
APAccountRef_Name	String	True	Accounts.Name	False	False	The name of the accounts-payable account to which the bill is credited. This account is implied when a company has a single accounts-payable account. When specified, the account must be a Liability account and the subtype must be of type Payables.

PurchaseOrders

Create, update, delete, and query QuickBooks Purchase Orders.

Table Specific Information

PurchaseOrders may be inserted, queried, or updated via the PurchaseOrders or PurchaseOrderLineItems tables. PurchaseOrders may be deleted by using the PurchaseOrders 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 PurchaseOrder, specify the Vendor, TotalAmt, and at least one Line Item. The LineAggregate column may be used to specify an XML aggregate of Line Item data. Each _ denotes hierarchy. Use <Line> at the base level. The contents of LineAggregate will be sent to the API as is. All values for each field in the aggregate should adhere to the API's specifications (e.g. for dates in format yyyy-MM-dd, for date times in format yyyy-MM-dd'T'HH:mm:sszzz). The columns that may be used in the aggregates begin with the prefix 'Line_' to indicate they are part of the line item. Use the Line_ column along with the DocNumber to indicate which lines go with which PurchaseOrders. For example:

INSERT INTO PurchaseOrders (VendorRef, TotalAmt, LineAggregate) 
VALUES ('21', '0.03', '
<Line><Amount>0.01</Amount><DetailType>ItemBasedExpenseLineDetail</DetailType><ItemBasedExpenseLineDetail><ItemRef>2</ItemRef></ItemBasedExpenseLineDetail></Line>
<Line><Amount>0.02</Amount><DetailType>ItemBasedExpenseLineDetail</DetailType><ItemBasedExpenseLineDetail><ItemRef>3</ItemRef></ItemBasedExpenseLineDetail></Line>
')

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Id [KEY]	String	True		True	True	The Id of the purchase order.
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.
DocNumber	String	False		True	True	The reference number for the transaction.
TxnDate	Date	False		True	True	The date entered by the user when this transaction occurred.
PrivateNote	String	False		False	False	A private note about the transaction. This note will not appear on the transaction records by default.
LinkedTxnAggregate	String	False		False	False	An XML aggregate of transactions linked to the estimate.
LineAggregate	String	False		False	False	An XML aggregate of line items in the transaction.
VendorRef	String	False	Vendors.Id	False	False	The Id of the vendor.
VendorRef_Name	String	True	Vendors.DisplayName	False	False	The name of the vendor.
APAccountRef	String	False	Accounts.Id	True	True	The Id of the accounts-payable account to which the bill is credited. This account is implied when a company has a single accounts-payable account. When specified, the account must be a Liability account and the subtype must be of type Payables.
APAccountRef_Name	String	True	Accounts.Name	False	False	The name of the accounts-payable account to which the bill is credited. This account is implied when a company has a single accounts-payable account. When specified, the account must be a Liability account and the subtype must be of type Payables.
TotalAmt	Decimal	True		True	True	The total amount due, determined by the sum of the line item amounts. This includes all charges, allowances, taxes, and discounts.
VendorAddr_Id	String	True		False	False	Id of the Intuit entity for the vendor address, mainly used for modifying the address. This field is assigned by the data service.
VendorAddr_Line1	String	True		False	False	First line of the address.
VendorAddr_Line2	String	True		False	False	Second line of the address.
VendorAddr_Line3	String	True		False	False	Third line of the address.
VendorAddr_Line4	String	True		False	False	Fourth line of the address.
VendorAddr_Line5	String	True		False	False	Fifth line of the address.
VendorAddr_City	String	True		False	False	City name.
VendorAddr_Country	String	True		False	False	Country name.
VendorAddr_CountrySubDivisionCode	String	True		False	False	Region within a country. For example, the state name for the USA and the province name for Canada.
VendorAddr_PostalCode	String	True		False	False	Postal code. For example, the zip code for the USA and Canada.
VendorAddr_Note	String	True		False	False	Note for the customer.
VendorAddr_Lat	String	True		False	False	Latitude coordinate of the geocoded vendor address.
VendorAddr_Long	String	True		False	False	Longitude coordinate of the geocoded vendor address.
ShipAddr_Id	String	False		False	False	Id of the Intuit entity for the shipping address, mainly used for modifying the address. Read-only; 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, state name for USA, province name for Canada.
ShipAddr_PostalCode	String	False		False	False	Postal code. For example, zip code for USA and Canada.
ShipAddr_Note	String	False		False	False	Note for the customer.
ShipAddr_Lat	String	False		False	False	Latitude coordinate of the Geocode (Geospacial Entity Object Code).
ShipAddr_Long	String	False		False	False	Longitude coordinate of the Geocode (Geospacial Entity Object Code).
ShipMethodRef	String	False		False	False	Reference type of all Ids that are taken as input or output.
ShipMethodRef_Name	String	True		False	False	Reference type of all Ids that are taken as input or output.
POStatus	String	False		False	False	Enumeration of the purchase order status. The allowed values are Open, Closed.
POEmail_Address	String	False		False	False	Enumeration of the purchase order status. The allowed values are Open, Closed.
TxnTaxDetail_TxnTaxCodeRef	String	False	TaxCodes.Id	False	False	The tax code of the transaction.
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.
TaxCodeRef	String	False	TaxCodes.Id	False	False	The tax code for the purchase. This field is valid in the UK, AU, and CA editions.
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	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, and CA editions.
GlobalTaxCalculation	String	False		False	False	The method used to apply the tax. This field is valid in the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable.

Purchases

Create, update, delete, and query QuickBooks Purchases.

Table Specific Information

Note: A Purchase object represents an expense, such as a purchase made from a vendor.

Select

All filterable columns support the following operators:

=
!=
>=
<=
>
<
IN
LIKE
CONTAINS

The driver processes other filters client-side within the driver.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Id [KEY]	String	True		True	True	The Id of the purchase.
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.
DocNumber	String	False		True	True	Reference number for the transaction.
TxnDate	Date	False		True	True	The date when this transaction occurred.
PrivateNote	String	False		False	False	A private note about the transaction. This note will not appear on the transaction records by default. This field maps to the Memo field on the Check and CreditCard form.
LineAggregate	String	False		False	False	A line item of a transaction.
AccountRef	String	False	Accounts.Id	False	False	The Id of the account associated with the purchase. Check payments should reference a bank account and credit card purchases should refer to a credit card account.
AccountRef_Name	String	True	Accounts.Name	False	False	A name that identifies the account associated with the purchase. Checks should reference a bank account and credit card purchases should refer to a credit card account.
PaymentType	String	False		True	True	The payment type. The allowed values are Cash, Check, CreditCard.
EntityRef	String	False		False	False	The Id of the entity for the party the expense is associated with.
EntityRef_Name	String	True		False	False	A name that identifies the party the expense is associated with.
Credit	Boolean	False		False	False	This field is valid only for the credit card payment type.
TotalAmt	Decimal	True		True	True	The total amount due, determined by the sum of the line item amounts. This includes all charges, allowances, taxes, discounts, etc.
PrintStatus	String	False		False	False	The print status of the purchase. This field is applicable only for checks and ignored for credit card charges or refunds.
DepartmentRef	String	False	Departments.Id	False	False	The Id of the department, which stores the location of the transaction.
DepartmentRef_Name	String	True	Departments.Name	False	False	The name of the department, which stores the location of the transaction.
Status	String	True		False	False	The status of the purchase.
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.
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, and CA editions.
GlobalTaxCalculation	String	False		False	False	Method in which tax is applied. This field is valid in the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable.
TransactionLocationType	String	False		False	False	The account location. This field is valid in only the FR editions. The allowed values are WithinFrance, FranceOverseas, OutsideFranceWithEU, OutsideEU.

RecurringCreditMemoTransactions

Create and query QuickBooks Recurring Transactions for Credit Memos.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
CreditMemo_Id [KEY]	String	True		False	False	The Id of the credit memo.
CreditMemo_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.
CreditMemo_MetaData_CreateTime	Datetime	True		True	True	The time the record was created.
CreditMemo_MetaData_LastUpdatedTime	Datetime	True		True	True	The time the record was last updated.
CreditMemo_CustomFieldAggregate	String	False		False	False	An XML aggregate of custom fields for the credit memo.
CreditMemo_DocNumber	String	False		True	True	The reference number for the transaction.
CreditMemo_TxnDate	Date	False		True	True	The date when this transaction occurred.
CreditMemo_PrivateNote	String	False		False	False	The private note about the transaction. This note will not appear on the transaction records by default.
CreditMemo_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.
CreditMemo_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.
CreditMemo_TxnStatus	String	False		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.
CreditMemo_LinkedTxnAggregate	String	False		False	False	Zero or more linked transactions.
CreditMemo_RecurDataRef	String	False		False	False	The Recurrence Data reference.
CreditMemo_RecurDataRef_Name	String	True		False	False	An identifying name for the object.
CreditMemo_RecurringInfo_Name	String	False		False	False	The Recurring Info name.
CreditMemo_RecurringInfo_RecurType	String	False		False	False	The Recurring Info recurring type. The allowed values are Automated, Reminded, UnScheduled.
CreditMemo_RecurringInfo_Active	Boolean	False		False	False	The Recurring Info is active or not.
CreditMemo_RecurringInfo_ScheduleInfo_IntervalType	String	False		False	False	The Recurring Info interval type. The allowed values are Yearly, Monthly, Weekly, Daily.
CreditMemo_RecurringInfo_ScheduleInfo_NumInterval	Integer	False		False	False	The Recurring Info num interval.
CreditMemo_RecurringInfo_ScheduleInfo_DayOfWeek	String	False		False	False	The Recurring Info day of week.
CreditMemo_RecurringInfo_ScheduleInfo_WeekOfMonth	String	False		False	False	The Recurring Info week of month.
CreditMemo_RecurringInfo_ScheduleInfo_MaxOccurrences	String	False		False	False	The max number of recurring occurrences.
CreditMemo_RecurringInfo_ScheduleInfo_RemindDays	String	False		False	False	The days before start date for a reminded RecurType.
CreditMemo_RecurringInfo_ScheduleInfo_MonthOfYear	String	False		False	False	The month of the year.
CreditMemo_RecurringInfo_ScheduleInfo_DaysBefore	String	False		False	False	The days before the scheduled date.
CreditMemo_RecurringInfo_ScheduleInfo_DayOfMonth	String	False		False	False	The day of the month.
CreditMemo_RecurringInfo_ScheduleInfo_StartDate	Datetime	False		False	False	The Recurring Info start date.
CreditMemo_RecurringInfo_ScheduleInfo_NextDate	Datetime	False		False	False	The Recurring Info next date.
CreditMemo_RecurringInfo_ScheduleInfo_EndDate	Datetime	False		False	False	The end date for the recurring schedule.
CreditMemo_RecurringInfo_ScheduleInfo_PreviousDate	Datetime	False		False	False	The Recurring Info previous date.
CreditMemo_LineAggregate	String	False		False	False	An XML aggregate of line items on the credit memo.
CreditMemo_TxnTaxDetail_TxnTaxCodeRef	String	False	TaxCodes.Id	False	False	The tax code for the transaction.
CreditMemo_TxnTaxDetail_TotalTax	String	False		False	False	The total tax calculated for the transaction, excluding any tax lines manually inserted into the transaction line list.
CreditMemo_TxnTaxDetail_TaxLineAggregate	String	False		False	False	An XML aggregate of tax line items.
CreditMemo_CustomerRef	String	False	Customers.Id	True	True	The Id of the customer.
CreditMemo_CustomerRef_Name	String	True	Customers.DisplayName	False	False	The name of the customer or job.
CreditMemo_CustomerMemo	String	False		False	False	The message to the customer, visible on the transaction.
CreditMemo_BillAddr_Id	String	False		False	False	The Id of the entity for the address, mainly used for modifying the address. This value is assigned by the data service.
CreditMemo_BillAddr_Line1	String	False		False	False	The first line of the address.
CreditMemo_BillAddr_Line2	String	False		False	False	The second line of the address.
CreditMemo_BillAddr_Line3	String	False		False	False	The third line of the address.
CreditMemo_BillAddr_Line4	String	False		False	False	The fourth line of the address.
CreditMemo_BillAddr_Line5	String	False		False	False	The fifth line of the address.
CreditMemo_BillAddr_City	String	False		False	False	The city name.
CreditMemo_BillAddr_Country	String	False		False	False	The country name.
CreditMemo_BillAddr_CountrySubDivisionCode	String	False		False	False	The country region. The state name for the USA or the province name for Canada.
CreditMemo_BillAddr_PostalCode	String	False		False	False	The postal code. The zip code for the USA and Canada.
CreditMemo_BillAddr_Note	String	False		False	False	The note for the customer.
CreditMemo_BillAddr_Lat	String	False		False	False	The latitude coordinate of the geocoded billing address.
CreditMemo_BillAddr_Long	String	False		False	False	The longitude coordinate of the geocoded billing address.
CreditMemo_ShipAddr_Id	String	False		False	False	The Id of the entity for hte address.
CreditMemo_ShipAddr_Line1	String	False		False	False	The first line of the shipping address.
CreditMemo_ShipAddr_Line2	String	False		False	False	The second line of the shipping address.
CreditMemo_ShipAddr_Line3	String	False		False	False	The third line of the shipping address.
CreditMemo_ShipAddr_Line4	String	False		False	False	The fourth line of the shipping address.
CreditMemo_ShipAddr_Line5	String	False		False	False	The fifth line of the shipping address.
CreditMemo_ShipAddr_City	String	False		False	False	The city name
CreditMemo_ShipAddr_Country	String	False		False	False	The country name
CreditMemo_ShipAddr_CountrySubDivisionCode	String	False		False	False	The region within a country.
CreditMemo_ShipAddr_PostalCode	String	False		False	False	The postal code.
CreditMemo_ShipAddr_Lat	String	False		False	False	The latitude coordinate of the geocoded shipping address.
CreditMemo_ShipAddr_Long	String	False		False	False	The longitude coordinate of the geocoded shipping address.
CreditMemo_ClassRef	String	False	Class.Id	True	False	The Id of the class associated with the transaction.
CreditMemo_ClassRef_Name	String	True	Class.FullyQualifiedName	False	False	The name of the class associated with the transaction.
CreditMemo_SalesTermRef	String	False	Terms.Id	True	False	The Id of the sales term associated with the transaction.
CreditMemo_SalesTermRef_Name	String	True	Terms.Name	False	False	The name of the sales term associated with the transaction.
CreditMemo_TotalAmt	Decimal	False		True	True	The total amount of the transaction. This includes the total of all the charges, allowances, and taxes.
CreditMemo_PrintStatus	String	False		False	False	The print status of the credit memo. The allowed values are NotSet, NeedToPrint, PrintComplete. The default value is NotSet.
CreditMemo_EmailStatus	String	False		False	False	The email status of the invoice. The allowed values are NotSent, NeedToSend, EmailSent. The default value is NotSet.
CreditMemo_DepositToAccountRef	String	False	Accounts.Id	False	False	The asset account where the payment money is deposited. If you do not specify this account, QuickBooks Online uses the Undeposited Funds account.
CreditMemo_DepositToAccountRef_Name	String	True	Accounts.Name	False	False	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.
CreditMemo_RemainingCredit	Decimal	False		False	False	The total credit amount still available to be applied towards the payment.
CreditMemo_DepartmentRef	String	False	Departments.Id	False	False	The Id of the location of the transaction.
CreditMemo_DepartmentRef_Name	String	True	Departments.Name	False	False	The name of the location of the transaction.
CreditMemo_BillEmail_Address	String	False		False	False	The email address where the invoice is sent. If the value of EmailStatus is NeedToSend, BillEmail is a required input.
CreditMemo_ApplyTaxAfterDiscount	Boolean	False		False	False	This field sets whether discounts are applied before taxes are calculated.
CreditMemo_CurrencyRef	String	False		False	False	The Id of the currency used in the transaction.
CreditMemo_CurrencyRef_Name	String	True		False	False	The name of the currency used in the transaction.
CreditMemo_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, and CA editions.
CreditMemo_GlobalTaxCalculation	String	False		False	False	The method used to apply the tax. This field is valid in only the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable.
CreditMemo_HomeTotalAmt	Decimal	True		False	False	The total amount of the transaction, expressed in the home currency. This includes the total of all the charges, allowances, and taxes. This field is valid in the UK, AU, and CA editions.

RecurringCreditMemoTransactionsLineItems

Create and query QuickBooks Recurring Transactions for Credit Memo Line Items.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
CreditMemo_LineId [KEY]	String	True		False	False	The Id of the line item of the credit memo.
CreditMemo_CreditMemoId [KEY]	String	False	CreditMemos.Id	True	True	The Id of the credit memo.
CreditMemo_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.
CreditMemo_MetaData_CreateTime	Datetime	True		True	True	The time the record was created.
CreditMemo_MetaData_LastUpdatedTime	Datetime	True		True	True	The time the record was last updated.
CreditMemo_CustomFieldAggregate	String	False		False	False	An XML aggregate of custom fields for the credit memo.
CreditMemo_DocNumber	String	False		True	True	The reference number for the transaction.
CreditMemo_TxnDate	Date	False		True	True	The date when the transaction occurred.
CreditMemo_PrivateNote	String	False		False	False	A private note about the transaction. By default, this field will not appear on transaction records.
CreditMemo_LinkedTxnAggregate	String	False		False	False	An XML aggregate of linked transactions on the credit memo.
CreditMemo_Line_Id	String	False		False	False	The Id of the line item.
CreditMemo_Line_Description	String	False		False	False	The description of the line item that appears in the printed record.
CreditMemo_Line_Amount	Decimal	False		False	False	The total amount of the charges or discounts for the given line. This includes the charges and allowances but excludes the tax amount.
CreditMemo_Line_DetailType	String	False		False	False	The detail type of the line item. Different detail types indicate different types of line items.
CreditMemo_Line_SalesItemLineDetail_ItemRef	String	False	Items.Id	False	False	The Id of the item. When a line item lacks an ItemRef it is treated as documentation and the Line_Amount attribute is ignored.
CreditMemo_Line_SalesItemLineDetail_ItemRef_Name	String	True	Items.Name	False	False	The name of the item. When a line item lacks an ItemRef it is treated as documentation and the Line_Amount attribute is ignored.
CreditMemo_Line_SalesItemLineDetail_ClassRef	String	False	Class.Id	False	False	The Id of the class entity of the line item.
CreditMemo_Line_SalesItemLineDetail_ClassRef_Name	String	True	Class.FullyQualifiedName	False	False	The name of the class entity of the line item.
CreditMemo_Line_SalesItemLineDetail_UnitPrice	Decimal	False		False	False	The unit price of the item.
CreditMemo_Line_SalesItemLineDetail_Qty	Double	False		False	False	The number of items in the line item.
CreditMemo_Line_SalesItemLineDetail_TaxCodeRef	String	False	TaxCodes.Id	False	False	The tax code for this item.
CreditMemo_Line_SalesItemLineDetail_ServiceDate	Date	False		False	False	The date when the service was performed.
CreditMemo_Line_GroupLineDetail_GroupItemRef	String	True		False	False	The Id of the group item object.
CreditMemo_Line_GroupLineDetail_GroupItemRef_Name	String	True		False	False	The name of the group item object.
CreditMemo_Line_GroupLineDetail_Quantity	Integer	True		False	False	The amount of the group item.
CreditMemo_TxnTaxDetail_TxnTaxCodeRef	String	False	TaxCodes.Id	False	False	The tax code for the transaction.
CreditMemo_TxnTaxDetail_TotalTax	String	False		False	False	The total tax calculated for the transaction, excluding any tax lines manually inserted into the transaction line list.
CreditMemo_TxnTaxDetail_TaxLineAggregate	String	False		False	False	An XML aggregate of tax line items.
CreditMemo_RecurDataRef	String	False		False	False	The Recurrence Data reference.
CreditMemo_RecurDataRef_Name	String	True		False	False	An identifying name for the object.
CreditMemo_RecurringInfo_Name	String	False		False	False	The Recurring Info name.
CreditMemo_RecurringInfo_RecurType	String	False		False	False	The Recurring Info recurring type. The allowed values are Automated, Reminded, UnScheduled.
CreditMemo_RecurringInfo_Active	Boolean	False		False	False	The Recurring Info is active or not.
CreditMemo_RecurringInfo_ScheduleInfo_IntervalType	String	False		False	False	The Recurring Info interval type. The allowed values are Yearly, Monthly, Weekly, Daily.
CreditMemo_RecurringInfo_ScheduleInfo_NumInterval	Integer	False		False	False	The Recurring Info num interval.
CreditMemo_RecurringInfo_ScheduleInfo_DayOfWeek	String	False		False	False	The Recurring Info day of week.
CreditMemo_RecurringInfo_ScheduleInfo_WeekOfMonth	String	False		False	False	The Recurring Info week of month.
CreditMemo_RecurringInfo_ScheduleInfo_MaxOccurrences	String	False		False	False	The max number of recurring occurrences.
CreditMemo_RecurringInfo_ScheduleInfo_RemindDays	String	False		False	False	The days before start date for a reminded RecurType.
CreditMemo_RecurringInfo_ScheduleInfo_MonthOfYear	String	False		False	False	The month of the year.
CreditMemo_RecurringInfo_ScheduleInfo_DaysBefore	String	False		False	False	The days before the scheduled date.
CreditMemo_RecurringInfo_ScheduleInfo_DayOfMonth	String	False		False	False	The day of the month.
CreditMemo_RecurringInfo_ScheduleInfo_StartDate	Datetime	False		False	False	The Recurring Info start date.
CreditMemo_RecurringInfo_ScheduleInfo_NextDate	Datetime	False		False	False	The Recurring Info next date.
CreditMemo_RecurringInfo_ScheduleInfo_EndDate	Datetime	False		False	False	The end date for the recurring schedule.
CreditMemo_RecurringInfo_ScheduleInfo_PreviousDate	Datetime	False		False	False	The Recurring Info previous date.
CreditMemo_CustomerRef	String	False	Customers.Id	True	True	The Id of the customer.
CreditMemo_CustomerRef_Name	String	True	Customers.DisplayName	False	False	A name that identifies the customer.
CreditMemo_CustomerMemo	String	False		False	False	A message to the customer, visible on the transaction.
CreditMemo_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.
CreditMemo_BillAddr_Line1	String	False		False	False	The first line of the address.
CreditMemo_BillAddr_Line2	String	False		False	False	The second line of the address.
CreditMemo_BillAddr_Line3	String	False		False	False	The third line of the address.
CreditMemo_BillAddr_Line4	String	False		False	False	The fourth line of the address.
CreditMemo_BillAddr_Line5	String	False		False	False	The fifth line of the address.
CreditMemo_BillAddr_City	String	False		False	False	The city name.
CreditMemo_BillAddr_Country	String	False		False	False	The country name.
CreditMemo_BillAddr_CountrySubDivisionCode	String	False		False	False	The country region. The state name for the USA or the province name for Canada.
CreditMemo_BillAddr_PostalCode	String	False		False	False	The postal code. The zip code for the USA and Canada.
CreditMemo_BillAddr_Note	String	False		False	False	The note for the customer.
CreditMemo_BillAddr_Lat	String	False		False	False	The latitude coordinate of the geocoded address.
CreditMemo_BillAddr_Long	String	False		False	False	The longitude coordinate of the geocoded address.
CreditMemo_ShipAddr_Line1	String	False		False	False	The first line of the shipping address.
CreditMemo_ShipAddr_Line2	String	False		False	False	The second line of the shipping address.
CreditMemo_ShipAddr_Line3	String	False		False	False	The third line of the shipping address.
CreditMemo_ShipAddr_Line4	String	False		False	False	The fourth line of the shipping address.
CreditMemo_ShipAddr_Line5	String	False		False	False	The fifth line of the shipping address.
CreditMemo_ShipAddr_City	String	False		False	False	The city name
CreditMemo_ShipAddr_Country	String	False		False	False	The country name
CreditMemo_ShipAddr_CountrySubDivisionCode	String	False		False	False	The region within a country.
CreditMemo_ShipAddr_PostalCode	String	False		False	False	The postal code.
CreditMemo_ShipAddr_Lat	String	False		False	False	The latitude coordinate of the geocoded shipping address.
CreditMemo_ShipAddr_Long	String	False		False	False	The longitude coordinate of the geocoded shipping address.
CreditMemo_ClassRef	String	False	Class.Id	True	False	The Id of the class.
CreditMemo_ClassRef_Name	String	True	Class.FullyQualifiedName	False	False	The name of the class.
CreditMemo_SalesTermRef	String	False	Terms.Id	True	False	The Id of the sales term associated with the transaction.
CreditMemo_SalesTermRef_Name	String	True	Terms.Name	False	False	A name that identifies the sales term associated with the transaction.
CreditMemo_TotalAmt	Decimal	False		True	True	The total amount of the transaction. This includes the total of all the charges, allowances, and taxes.
CreditMemo_PrintStatus	String	False		False	False	The print status of the credit memo. The allowed values are NotSet, NeedToPrint, PrintComplete. The default value is NotSet.
CreditMemo_EmailStatus	String	False		False	False	The email status of the invoice. The allowed values are NotSent, NeedToSend, EmailSent. The default value is NotSet.
CreditMemo_DepositToAccountRef	String	False	Accounts.Id	False	False	The asset account where the payment money is deposited. If you do not specify this account, QuickBooks Online uses the Undeposited Funds account.
CreditMemo_DepositToAccountRef_Name	String	True	Accounts.Name	False	False	The 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.
CreditMemo_RemainingCredit	Decimal	False		False	False	The total credit amount still available to apply towards the payment.
CreditMemo_DepartmentRef	String	False	Departments.Id	False	False	The Id of the department, which stores the location of the transaction.
CreditMemo_DepartmentRef_Name	String	True	Departments.Name	False	False	The name of the department, which stores location of the transaction.
CreditMemo_BillEmail_Address	String	False		False	False	The email address where the invoice is sent. If the value of EmailStatus is NeedToSend, this field is a required input.
CreditMemo_ApplyTaxAfterDiscount	Boolean	False		False	False	This field sets whether the discount is applied before or after taxes are calculated.
CreditMemo_CurrencyRef	String	False		False	False	The Id of the currency used for all amounts of the transaction. This field is available in only the UK, AU, and CA editions.
CreditMemo_CurrencyRef_Name	String	True		False	False	The name of the currency used for all amounts of the transaction. This field is available in only the UK, AU, and CA editions.
CreditMemo_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 only the UK, AU, and CA editions.
CreditMemo_GlobalTaxCalculation	String	False		False	False	The method in which tax is applied. This field is valid in only the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable.
CreditMemo_HomeTotalAmt	Decimal	True		False	False	The total amount of the transaction in the home currency. This field includes the total of all the charges, allowances, and taxes. This field is valid in only the UK, AU, and CA editions.

RecurringDepositTransactions

Create and query QuickBooks Deposits.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Deposit_Id [KEY]	String	True		True	True	The Id of the invoice.
Deposit_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.
Deposit_MetaData_CreateTime	Datetime	True		True	True	The time the record was created.
Deposit_MetaData_LastUpdatedTime	Datetime	True		True	True	The time the record was last updated.
Deposit_TxnDate	Date	False		True	True	The date entered by the user when this transaction occurred.
Deposit_PrivateNote	String	False		False	False	A private note that does not appear on the transaction records.
Deposit_RecurDataRef	String	False		False	False	The Recurrence Data reference.
Deposit_RecurDataRef_Name	String	True		False	False	An identifying name for the object.
Deposit_RecurringInfo_Name	String	False		False	False	The Recurring Info name.
Deposit_RecurringInfo_RecurType	String	False		False	False	The Recurring Info recurring type. The allowed values are Automated, Reminded, UnScheduled.
Deposit_RecurringInfo_Active	Boolean	False		False	False	The Recurring Info is active or not.
Deposit_RecurringInfo_ScheduleInfo_IntervalType	String	False		False	False	The Recurring Info interval type. The allowed values are Yearly, Monthly, Weekly, Daily.
Deposit_RecurringInfo_ScheduleInfo_NumInterval	Integer	False		False	False	The Recurring Info num interval.
Deposit_RecurringInfo_ScheduleInfo_DayOfWeek	String	False		False	False	The Recurring Info day of week.
Deposit_RecurringInfo_ScheduleInfo_WeekOfMonth	String	False		False	False	The Recurring Info week of month.
Deposit_RecurringInfo_ScheduleInfo_MaxOccurrences	String	False		False	False	The max number of recurring occurrences.
Deposit_RecurringInfo_ScheduleInfo_RemindDays	String	False		False	False	The days before start date for a reminded RecurType.
Deposit_RecurringInfo_ScheduleInfo_MonthOfYear	String	False		False	False	The month of the year.
Deposit_RecurringInfo_ScheduleInfo_DaysBefore	String	False		False	False	The days before the scheduled date.
Deposit_RecurringInfo_ScheduleInfo_DayOfMonth	String	False		False	False	The day of the month.
Deposit_RecurringInfo_ScheduleInfo_StartDate	Datetime	False		False	False	The Recurring Info start date.
Deposit_RecurringInfo_ScheduleInfo_NextDate	Datetime	False		False	False	The Recurring Info next date.
Deposit_RecurringInfo_ScheduleInfo_EndDate	Datetime	False		False	False	The end date for the recurring schedule.
Deposit_RecurringInfo_ScheduleInfo_PreviousDate	Datetime	False		False	False	The Recurring Info previous date.
Deposit_LineAggregate	String	False		False	False	An XML aggregate of line items associated with the transaction.
Deposit_TxnTaxDetail_TxnTaxCodeRef	String	False	TaxCodes.Id	False	False	The tax code for the transaction. This field is valid in the UK, AU, and CA editions.
Deposit_TxnTaxDetail_TotalTax	String	False		False	False	The total tax calculated for the transaction, excluding any tax lines manually inserted into the transaction line list. This field is valid in the UK, AU, and CA editions.
Deposit_TxnTaxDetail_TaxLineAggregate	String	False		False	False	An XML aggregate of tax line items. This field is valid in the UK, AU, and CA editions.
Deposit_DepositToAccountRef	String	False	Accounts.Id	False	False	The Id of the asset account to be used for this deposit.
Deposit_DepositToAccountRef_Name	String	False	Accounts.Name	False	False	The name of the asset account to be used for this deposit.
Deposit_ClassRef	String	False	Class.Id	False	False	The Id of the class associated with the transaction.
Deposit_ClassRef_Name	String	True	Class.FullyQualifiedName	False	False	The name of the class associated with the transaction.
Deposit_TotalAmt	Decimal	True		True	True	This field indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes.
Deposit_CashBack_AccountRef	String	True	Accounts.Id	True	False	The asset account (bank account) Id to be used for this cash back transaction
Deposit_CashBack_AccountRef_Name	String	False	Accounts.Name	False	False	The asset account (bank account) Name to be used for this cash back transaction
Deposit_CashBack_Amount	Decimal	False		False	False	The amount of the cash back transaction.
Deposit_CashBack_Memo	String	True		True	False	The memo associated with this cash back transaction.
Deposit_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.
Deposit_DepartmentRef_Name	String	True	Departments.Name	False	False	The name of the department, which store the location of the transaction as defined using location tracking in QuickBooks Online.
Deposit_ApplyTaxAfterDiscount	Boolean	False		False	False	This field sets whether discounts are applied before the tax is calculated.
Deposit_ExchangeRate	Decimal	False		False	False	The number of home currency units it takes to equal one unit of currency specified by CurrencyRef. Applicable if multicurrency is enabled for the company.
Deposit_CurrencyRef	String	False		False	False	The Id of the currency used in the transaction.
Deposit_CurrencyRef_Name	String	True		False	False	The name of the currency used in the transaction.
Deposit_GlobalTaxCalculation	String	False		False	False	The method in which tax is applied. This field is valid in the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable.

RecurringDepositTransactionsLineItems

Create and query QuickBooks Recurring Transactions for Deposit Line Items.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Deposit_LineId [KEY]	String	True		False	False	The Id of the line item of the invoice.
Deposit_DepositId [KEY]	String	False	Deposits.Id	True	True	The Id of the invoice.
Deposit_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.
Deposit_MetaData_CreateTime	Datetime	True		True	True	The time the record was created.
Deposit_MetaData_LastUpdatedTime	Datetime	True		True	True	The time the record was last updated.
Deposit_TxnDate	Date	False		True	True	The date entered by the user when this transaction occurred.
Deposit_PrivateNote	String	False		False	False	A private note that does not appear on the transaction records.
Deposit_Line_Id	String	False		False	False	The Id of the line item.
Deposit_Line_Description	String	False		False	False	The description of the line item.
Deposit_Line_Amount	Decimal	False		False	False	The amount of the line item.
Deposit_Line_DetailType	String	False		False	False	The detailType of the line item.
Deposit_Line_DepositLineDetail_PaymentMethodRef	String	False	PaymentMethods.Id	False	False	The payment method id of the line item.
Deposit_Line_DepositLineDetail_PaymentMethodRef_Name	String	False	PaymentMethods.Name	False	False	The payment method id of the line item.
Deposit_Line_DepositLineDetail_AccountRef	String	False	Accounts.Id	False	False	Account where the funds are deposited to.
Deposit_Line_DepositLineDetail_AccountRef_Name	String	False	Accounts.Name	False	False	Account where the funds are deposited to.
Deposit_Line_DepositLineDetail_Entity	String	False	Customers.Id	False	False	Reference to a customer from which the deposit was recieved
Deposit_Line_DepositLineDetail_Entity_Name	String	False	Customers.DisplayName	False	False	Reference to a customer from which the deposit was recieved
Deposit_Line_DepositLineDetail_ClassRef	String	False	Class.Id	False	False	Reference to the Class associated with the transaction
Deposit_Line_DepositLineDetail_ClassRef_Name	String	False	Class.FullyQualifiedName	False	False	Reference to the Class associated with the transaction
Deposit_Line_DepositLineDetail_CheckNum	String	False		False	False	The check number for the deposit
Deposit_Line_DepositLineDetail_TxnType	String	False		False	False	The type of the payment transaction. Different types indicate different types of line items.
Deposit_Line_DepositLineDetail_TaxCodeRef	String	False	TaxCodes.Id	False	False	The Sales/Purchase tax code associated with the Line. This field is valid in the UK, AU, and CA editions.
Deposit_Line_DepositLineDetail_TaxApplicableOn	String	False		False	False	Indicates whether the tax applicable on the line is sales or purchase. This field is valid in the UK, AU, and CA editions.
Deposit_Line_LinkedTxn_TxnId	String	True		False	False	The id of the linked transaction
Deposit_Line_LinkedTxn_TxnType	String	True		False	False	The type of the linked transaction. Different types indicate different types of line items.
Deposit_Line_LinkedTxn_TxnLineId	String	True		False	False	The lineitem id of the linked transaction line item.
Deposit_TxnTaxDetail_TxnTaxCodeRef	String	False	TaxCodes.Id	False	False	The tax code for the transaction. This field is valid in the UK, AU, and CA editions.
Deposit_TxnTaxDetail_TotalTax	String	False		False	False	The total tax calculated for the transaction, excluding any tax lines manually inserted into the transaction line list. This field is valid in the UK, AU, and CA editions.
Deposit_TxnTaxDetail_TaxLineAggregate	String	False		False	False	An XML aggregate of tax line items. This field is valid in the UK, AU, and CA editions.
Deposit_RecurDataRef	String	False		False	False	The Recurrence Data reference.
Deposit_RecurDataRef_Name	String	True		False	False	An identifying name for the object.
Deposit_RecurringInfo_Name	String	False		False	False	The Recurring Info name.
Deposit_RecurringInfo_RecurType	String	False		False	False	The Recurring Info recurring type. The allowed values are Automated, Reminded, UnScheduled.
Deposit_RecurringInfo_Active	Boolean	False		False	False	The Recurring Info is active or not.
Deposit_RecurringInfo_ScheduleInfo_IntervalType	String	False		False	False	The Recurring Info interval type. The allowed values are Yearly, Monthly, Weekly, Daily.
Deposit_RecurringInfo_ScheduleInfo_NumInterval	Integer	False		False	False	The Recurring Info num interval.
Deposit_RecurringInfo_ScheduleInfo_DayOfWeek	String	False		False	False	The Recurring Info day of week.
Deposit_RecurringInfo_ScheduleInfo_WeekOfMonth	String	False		False	False	The Recurring Info week of month.
Deposit_RecurringInfo_ScheduleInfo_MaxOccurrences	String	False		False	False	The max number of recurring occurrences.
Deposit_RecurringInfo_ScheduleInfo_RemindDays	String	False		False	False	The days before start date for a reminded RecurType.
Deposit_RecurringInfo_ScheduleInfo_MonthOfYear	String	False		False	False	The month of the year.
Deposit_RecurringInfo_ScheduleInfo_DaysBefore	String	False		False	False	The days before the scheduled date.
Deposit_RecurringInfo_ScheduleInfo_DayOfMonth	String	False		False	False	The day of the month.
Deposit_RecurringInfo_ScheduleInfo_StartDate	Datetime	False		False	False	The Recurring Info start date.
Deposit_RecurringInfo_ScheduleInfo_NextDate	Datetime	False		False	False	The Recurring Info next date.
Deposit_RecurringInfo_ScheduleInfo_EndDate	Datetime	False		False	False	The end date for the recurring schedule.
Deposit_RecurringInfo_ScheduleInfo_PreviousDate	Datetime	False		False	False	The Recurring Info previous date.
Deposit_DepositToAccountRef	String	False	Accounts.Id	False	False	The Id of the asset account to be used for this deposit.
Deposit_DepositToAccountRef_Name	String	False	Accounts.Name	False	False	The name of the asset account to be used for this deposit.
Deposit_ClassRef	String	False	Class.Id	False	False	The Id of the class associated with the transaction.
Deposit_ClassRef_Name	String	True	Class.FullyQualifiedName	False	False	The name of the class associated with the transaction.
Deposit_TotalAmt	Decimal	True		True	True	This field indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes.
Deposit_CashBack_AccountRef	String	True		True	False	The asset account (bank account) Id to be used for this cash back transaction
Deposit_CashBack_AccountRef_Name	String	False		False	False	The asset account (bank account) Name to be used for this cash back transaction
Deposit_CashBack_Amount	Decimal	False		False	False	The amount of the cash back transaction.
Deposit_CashBack_Memo	String	True		True	False	The memo associated with this cash back transaction.
Deposit_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.
Deposit_DepartmentRef_Name	String	True	Departments.Name	False	False	The name of the department, which store the location of the transaction as defined using location tracking in QuickBooks Online.
Deposit_ApplyTaxAfterDiscount	Boolean	False		False	False	This field sets whether discounts are applied before the tax is calculated.
Deposit_CurrencyRef	String	False		False	False	The Id of the currency used in the transaction.
Deposit_CurrencyRef_Name	String	True		False	False	The name of the currency used in the transaction.
Deposit_GlobalTaxCalculation	String	False		False	False	The method in which tax is applied. This field is valid in the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable.

RecurringEstimateTransactions

Create and query QuickBooks Recurring Transaction for Estimates.

Table Specific Information

We can perform Select and Insert operations on RecurringEstimateTransactions table.

Select

Estimate_Id, Estimate_MetaData_CreateTime, Estimate_MetaData_LastUpdatedTime can be used for server side filter. The driver processes other filters client-side within the driver.

SELECT * FROM RecurringEstimateTransactions WHERE Estimate_Id = 25529
SELECT * FROM RecurringEstimateTransactions WHERE Estimate_Id IN (25528, 25531, 25530)
SELECT * FROM RecurringEstimateTransactions WHERE Estimate_MetaData_CreateTime = '2020-03-19 19:49:51.0'
SELECT * FROM RecurringEstimateTransactions WHERE Estimate_MetaData_LastUpdatedTime = '2021-01-03 14:46:13'

Insert

To add a RecurringEstimateTransactions following fields needs to be added:

A RecurringEstimateTransactions object must have at least one line that describes an item.
A RecurringEstimateTransactions object must have a RecurringInfo.

INSERT INTO RecurringEstimateTransactions (Estimate_Id, Estimate_CustomerRef, Estimate_RecurringInfo_Name, Estimate_RecurringInfo_RecurType, Estimate_RecurringInfo_Active, Estimate_RecurringInfo_ScheduleInfo_IntervalType, Estimate_RecurringInfo_ScheduleInfo_NumInterval, Estimate_RecurringInfo_ScheduleInfo_DayOfWeek, Estimate_RecurringInfo_ScheduleInfo_WeekOfMonth, Estimate_RecurringInfo_ScheduleInfo_StartDate, Estimate_RecurringInfo_ScheduleInfo_NextDate, Estimate_RecurringInfo_ScheduleInfo_PreviousDate, Estimate_LineAggregate) VALUES (49, 2, 'TestingA11', 'Reminded', false,  'Weekly', 2,  'Tuesday', 3, '2021-12-08', '2021-12-15', '2021-09-01', '<Line><Amount>0.01</Amount><DetailType>SalesItemLineDetail</DetailType><SalesItemLineDetail><ItemRef>2</ItemRef></SalesItemLineDetail></Line><Line><Amount>0.02</Amount><DetailType>SalesItemLineDetail</DetailType><SalesItemLineDetail><ItemRef>3</ItemRef></SalesItemLineDetail></Line>')

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Estimate_Id [KEY]	String	True		True	True	The Id of the Estimate.
Estimate_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.
Estimate_MetaData_CreateTime	Datetime	True		True	True	The time the record was created.
Estimate_MetaData_LastUpdatedTime	Datetime	True		True	True	The time the record was last updated.
Estimate_DocNumber	String	False		True	True	The reference number for the transaction.
Estimate_TxnDate	Date	False		True	True	The date when this transaction occurred.
Estimate_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.
Estimate_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.
Estimate_PrivateNote	String	False		False	False	A private note, which will not appear on the transaction records.
Estimate_TxnStatus	String	False		False	False	The status of the transaction. The allowed values are Accepted, Closed, Pending, Rejected.
Estimate_LinkedTxnAggregate	String	False		False	False	An XML aggregate of transactions linked to the estimate.
Estimate_LineAggregate	String	False		False	False	An XML aggregate of the line items of a transaction.
Estimate_TxnTaxDetail_TxnTaxCodeRef	String	False	TaxCodes.Id	False	False	The tax code for the transaction.
Estimate_TxnTaxDetail_TotalTax	String	False		False	False	The total tax calculated for the transaction, excluding any tax lines manually inserted into the transaction line list.
Estimate_TxnTaxDetail_TaxLineAggregate	String	False		False	False	An XML aggregate of tax line items.
Estimate_RecurDataRef	String	False		False	False	The Recurrence Data reference.
Estimate_RecurDataRef_Name	String	True		False	False	An identifying name for the object.
Estimate_RecurringInfo_Name	String	False		False	False	The Recurring Info name.
Estimate_RecurringInfo_RecurType	String	False		False	False	The Recurring Info recurring type. The allowed values are Automated, Reminded, UnScheduled.
Estimate_RecurringInfo_Active	Boolean	False		False	False	The Recurring Info is active or not.
Estimate_RecurringInfo_ScheduleInfo_IntervalType	String	False		False	False	The Recurring Info interval type. The allowed values are Yearly, Monthly, Weekly, Daily.
Estimate_RecurringInfo_ScheduleInfo_NumInterval	Integer	False		False	False	The Recurring Info num interval.
Estimate_RecurringInfo_ScheduleInfo_DayOfWeek	String	False		False	False	The Recurring Info day of week.
Estimate_RecurringInfo_ScheduleInfo_WeekOfMonth	String	False		False	False	The Recurring Info week of month.
Estimate_RecurringInfo_ScheduleInfo_MaxOccurrences	String	False		False	False	The max number of recurring occurrences.
Estimate_RecurringInfo_ScheduleInfo_RemindDays	String	False		False	False	The days before start date for a reminded RecurType.
Estimate_RecurringInfo_ScheduleInfo_MonthOfYear	String	False		False	False	The month of the year.
Estimate_RecurringInfo_ScheduleInfo_DaysBefore	String	False		False	False	The days before the scheduled date.
Estimate_RecurringInfo_ScheduleInfo_DayOfMonth	String	False		False	False	The day of the month.
Estimate_RecurringInfo_ScheduleInfo_StartDate	Datetime	False		False	False	The Recurring Info start date.
Estimate_RecurringInfo_ScheduleInfo_NextDate	Datetime	False		False	False	The Recurring Info next date.
Estimate_RecurringInfo_ScheduleInfo_EndDate	Datetime	False		False	False	The end date for the recurring schedule.
Estimate_RecurringInfo_ScheduleInfo_PreviousDate	Datetime	False		False	False	The Recurring Info previous date.
Estimate_CustomerRef	String	False	Customers.Id	True	False	The Id of the customer.
Estimate_CustomerRef_Name	String	True	Customers.DisplayName	False	False	The name of the customer.
Estimate_CustomerMemo	String	False		False	False	A message to the customer, which appears in the invoice and in the printed invoice.
Estimate_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.
Estimate_BillAddr_Line1	String	False		False	False	First line of the billing address.
Estimate_BillAddr_Line2	String	False		False	False	Second line of the billing address.
Estimate_BillAddr_Line3	String	False		False	False	Third line of the billing address.
Estimate_BillAddr_Line4	String	False		False	False	Fourth line of the billing address.
Estimate_BillAddr_Line5	String	False		False	False	Fifth line of the billing address.
Estimate_BillAddr_City	String	False		False	False	City name.
Estimate_BillAddr_Country	String	False		False	False	Country name.
Estimate_BillAddr_CountrySubDivisionCode	String	False		False	False	Country region. For example, the state name for the USA or the province name for Canada.
Estimate_BillAddr_PostalCode	String	False		False	False	Postal code. The zip code for the USA and Canada.
Estimate_BillAddr_Note	String	False		False	False	Note for the customer.
Estimate_BillAddr_Lat	String	False		False	False	The latitude coordinate of the geocoded billing address.
Estimate_BillAddr_Long	String	False		False	False	The longitude coordinate of the geocoded billing address.
Estimate_ShipAddr_Id	String	False		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.
Estimate_ShipAddr_Line1	String	False		False	False	First line of the shipping address.
Estimate_ShipAddr_Line2	String	False		False	False	Second line of the shipping address.
Estimate_ShipAddr_Line3	String	False		False	False	Third line of the shipping address.
Estimate_ShipAddr_Line4	String	False		False	False	Fourth line of the shipping address.
Estimate_ShipAddr_Line5	String	False		False	False	Fifth line of the shipping address.
Estimate_ShipAddr_City	String	False		False	False	City name.
Estimate_ShipAddr_Country	String	False		False	False	Country name.
Estimate_ShipAddr_CountrySubDivisionCode	String	False		False	False	Country region. For example, the state name for the USA or the province name for Canada.
Estimate_ShipAddr_PostalCode	String	False		False	False	Postal code. For example, the zip code for the USA and Canada.
Estimate_ShipAddr_Note	String	False		False	False	Note for the customer.
Estimate_ShipAddr_Lat	String	False		False	False	The latitude coordinate of the geocoded shipping address.
Estimate_ShipAddr_Long	String	False		False	False	The longitude coordinate of the geocoded shipping address.
Estimate_ClassRef	String	False	Class.Id	True	False	The Id of the class associated with the transaction.
Estimate_ClassRef_Name	String	True	Class.FullyQualifiedName	False	False	The name of the class associated with the transaction.
Estimate_SalesTermRef	String	False	Terms.Id	False	False	The Id of the sales terms associated with the transaction.
Estimate_SalesTermRef_Name	String	True	Terms.Name	False	False	The name of the sales terms associated with the transaction.
Estimate_DueDate	Date	False		True	False	The due date for the invoice, not including any early payment discount incentives or late payment penalties. If the date is not supplied, the current date on the server is used.
Estimate_ShipMethodRef	String	False		False	False	The Id of the shipping method associated with the transaction.
Estimate_ShipMethodRef_Name	String	True		False	False	The name of the shipping method associated with the transaction.
Estimate_ShipDate	Date	False		False	False	The date for delivery of goods or services.
Estimate_TrackingNum	String	False		False	False	The tracking number for the shipping provider for the delivery of the goods associated with the transaction.
Estimate_TotalAmt	Decimal	True		True	True	The total amount of the transaction. This includes the total of all the charges, allowances, and taxes.
Estimate_PrintStatus	String	False		False	False	The print status of the invoice. The allowed values are NotSet, NeedToPrint, PrintComplete. The default value is NotSet.
Estimate_EmailStatus	String	False		False	False	The email status of the invoice. The allowed values are NotSet, NeedToSend, EmailSent. The default value is NotSet.
Estimate_BillEmail_Address	String	False		False	False	The email address where the invoice is sent. If the value of EmailStatus is NeedToSend, BillEmail is a required input.
Estimate_Balance	Decimal	False		True	True	This column sets whether the transaction is a finance charge.
Estimate_ExpirationDate	Date	False		False	False	The date when the estimate becomes invalid.
Estimate_AcceptedBy	String	False		False	False	The name of the customer who accepted the estimate.
Estimate_AcceptedDate	Date	False		False	False	The date the estimate was accepted.
Estimate_ApplyTaxAfterDiscount	Boolean	False		False	False	This field sets whether discounts are applied before the tax is calculated.
Estimate_CurrencyRef	String	False		False	False	The Id of the currency used in the transaction.
Estimate_CurrencyRef_Name	String	True		False	False	The name of the currency used in the transaction.
Estimate_ExchangeRate	Decimal	False		False	False	The currency exchange rate. This field is valid only if the company file is set up to use 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, and CA editions.
Estimate_GlobalTaxCalculation	String	False		False	False	The method used to apply taxes. This field is valid in the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable.
Estimate_HomeTotalAmt	Decimal	True		False	False	The total amount of the transaction in the home currency. Includes the total of all the charges, allowances, and taxes. This field is valid in the UK, AU, and CA editions.

RecurringEstimateTransactionsLineItems

Create and query QuickBooks Recurring Transaction Line Items for Estimate.

Table Specific Information

RecurringEstimateTransactions may be inserted or queried via the RecurringEstimateTransactions or RecurringEstimateTransactionsLineItems tables.

Select

SELECT * FROM RecurringEstimateTransactionsLineItems

Insert

To add a RecurringEstimateTransactionsLineItems following fields needs to be added:

It must have at least one line that describes an item.
It must have a RecurringInfo.

INSERT INTO RecurringEstimateTransactionsLineItems (Estimate_Id, Estimate_CustomerRef, Estimate_RecurringInfo_Name, Estimate_RecurringInfo_RecurType, Estimate_RecurringInfo_Active, Estimate_RecurringInfo_ScheduleInfo_IntervalType, Estimate_RecurringInfo_ScheduleInfo_NumInterval, Estimate_RecurringInfo_ScheduleInfo_DayOfWeek, Estimate_RecurringInfo_ScheduleInfo_WeekOfMonth, Estimate_RecurringInfo_ScheduleInfo_StartDate, Estimate_RecurringInfo_ScheduleInfo_NextDate, Estimate_RecurringInfo_ScheduleInfo_PreviousDate, Estimate_Line_DetailType, Estimate_Line_SalesItemLineDetail_ItemRef, Estimate_Line_Amount, Estimate_Line_SalesItemLineDetail_Qty, Estimate_Line_SalesItemLineDetail_DiscountAmt, Estimate_Line_SalesItemLineDetail_TaxCodeRef) VALUES (49, 2, 'TESTING155BCD11', 'Reminded', false, 'Weekly', 2, 'Tuesday', 3, '2021-12-08', '2021-12-15', '2021-09-01', 'SalesItemLineDetail', '5', 100.01, 8, 22.3, 'TAX')

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Estimate_LineId [KEY]	String	True		False	False	The Id of the line item of the estimate.
Estimate_Id [KEY]	String	False	Estimates.Id	True	True	The Id of the estimate.
Estimate_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.
Estimate_MetaData_CreateTime	Datetime	True		True	True	The time the record was created.
Estimate_MetaData_LastUpdatedTime	Datetime	True		True	True	The time the record was last updated.
Estimate_DocNumber	String	False		True	True	The reference number for the transaction.
Estimate_TxnDate	Date	False		True	True	The date entered by the user when this transaction occurred.
Estimate_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.
Estimate_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.
Estimate_PrivateNote	String	False		False	False	A private note, which will not appear on the transaction records.
Estimate_TxnStatus	String	False		False	False	The status of the transaction. The allowed values are Accepted, Closed, Pending, Rejected.
Estimate_LinkedTxnAggregate	String	False		False	False	An XML aggregate of transactions linked to the estimate.
Estimate_Line_Id	String	False		False	False	The Id of the line item.
Estimate_Line_LineNum	String	False		False	False	The line number.
Estimate_Line_Description	String	False		False	False	The line description.
Estimate_Line_Amount	Decimal	False		False	False	The line amount.
Estimate_Line_DetailType	String	False		False	False	The line detail type. Different detail types indicate different types of line items.
Estimate_Line_SalesItemLineDetail_ItemRef	String	False	Items.Id	False	False	The Id of the item in the line item.
Estimate_Line_SalesItemLineDetail_ItemRef_Name	String	True	Items.Name	False	False	The name of the item in the line item.
Estimate_Line_SalesItemLineDetail_ClassRef	String	False	Class.Id	False	False	The Id of the class in the line item.
Estimate_Line_SalesItemLineDetail_ClassRef_Name	String	True	Class.FullyQualifiedName	False	False	The name of the class in the line item.
Estimate_Line_SalesItemLineDetail_UnitPrice	Decimal	False		False	False	The unit price of the item.
Estimate_Line_SalesItemLineDetail_Qty	Double	False		False	False	The number of items for the line item.
Estimate_Line_SalesItemLineDetail_TaxCodeRef	String	False	TaxCodes.Id	False	False	The tax code for the item.
Estimate_Line_SalesItemLineDetail_ServiceDate	Date	False		False	False	The service date for the item.
Estimate_Line_SalesItemLineDetail_DiscountAmt	Decimal	False		False	False	The discount amount applied to this line.
Estimate_Line_SalesItemLineDetail_DiscountRate	Decimal	False		False	False	TThe discount rate applied to this line.
Estimate_Line_GroupLineDetail_GroupItemRef	String	True		False	False	The Id of the group item object.
Estimate_Line_GroupLineDetail_GroupItemRef_Name	String	True		False	False	The name of the group item object.
Estimate_Line_GroupLineDetail_Quantity	Integer	True		False	False	The amount of the group item.
Estimate_TxnTaxDetail_TxnTaxCodeRef	String	False	TaxCodes.Id	False	False	The tax code for the transaction.
Estimate_TxnTaxDetail_TotalTax	String	False		False	False	The total tax calculated for the transaction, excluding any tax lines manually inserted into the transaction line list.
Estimate_TxnTaxDetail_TaxLineAggregate	String	False		False	False	An XML aggregate of tax line items.
Estimate_RecurDataRef	String	False		False	False	The Recurrence Data reference.
Estimate_RecurDataRef_Name	String	True		False	False	An identifying name for the object.
Estimate_RecurringInfo_Name	String	False		False	False	The Recurring Info name.
Estimate_RecurringInfo_RecurType	String	False		False	False	The Recurring Info recurring type. The allowed values are Automated, Reminded, UnScheduled.
Estimate_RecurringInfo_Active	Boolean	False		False	False	The Recurring Info is active or not.
Estimate_RecurringInfo_ScheduleInfo_IntervalType	String	False		False	False	The Recurring Info interval type. The allowed values are Yearly, Monthly, Weekly, Daily.
Estimate_RecurringInfo_ScheduleInfo_NumInterval	Integer	False		False	False	The Recurring Info num interval.
Estimate_RecurringInfo_ScheduleInfo_DayOfWeek	String	False		False	False	The Recurring Info day of week.
Estimate_RecurringInfo_ScheduleInfo_WeekOfMonth	String	False		False	False	The Recurring Info week of month.
Estimate_RecurringInfo_ScheduleInfo_MaxOccurrences	String	False		False	False	The max number of recurring occurrences.
Estimate_RecurringInfo_ScheduleInfo_RemindDays	String	False		False	False	The days before start date for a reminded RecurType.
Estimate_RecurringInfo_ScheduleInfo_MonthOfYear	String	False		False	False	The month of the year.
Estimate_RecurringInfo_ScheduleInfo_DaysBefore	String	False		False	False	The days before the scheduled date.
Estimate_RecurringInfo_ScheduleInfo_DayOfMonth	String	False		False	False	The day of the month.
Estimate_RecurringInfo_ScheduleInfo_StartDate	Datetime	False		False	False	The Recurring Info start date.
Estimate_RecurringInfo_ScheduleInfo_NextDate	Datetime	False		False	False	The Recurring Info next date.
Estimate_RecurringInfo_ScheduleInfo_EndDate	Datetime	False		False	False	The end date for the recurring schedule.
Estimate_RecurringInfo_ScheduleInfo_PreviousDate	Datetime	False		False	False	The Recurring Info previous date.
Estimate_CustomerRef	String	False	Customers.Id	True	False	The Id of the customer.
Estimate_CustomerRef_Name	String	True	Customers.DisplayName	False	False	The name of the customer.
Estimate_CustomerMemo	String	False		False	False	The message to the customer, which appears in the invoice and the printed invoice.
Estimate_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.
Estimate_BillAddr_Line1	String	False		False	False	The first line of the billing address.
Estimate_BillAddr_Line2	String	False		False	False	The second line of the billing address.
Estimate_BillAddr_Line3	String	False		False	False	The third line of the billing address.
Estimate_BillAddr_Line4	String	False		False	False	The fourth line of the billing address.
Estimate_BillAddr_Line5	String	False		False	False	The fifth line of the address.
Estimate_BillAddr_City	String	False		False	False	City name.
Estimate_BillAddr_Country	String	False		False	False	Country name.
Estimate_BillAddr_CountrySubDivisionCode	String	False		False	False	Region within a country. For example, the state name for the USA or the province name for Canada.
Estimate_BillAddr_PostalCode	String	False		False	False	Postal code. The zip code for the USA and Canada.
Estimate_BillAddr_Note	String	False		False	False	Note for the customer.
Estimate_BillAddr_Lat	String	False		False	False	The latitude coordinate of the geocoded billing address.
Estimate_BillAddr_Long	String	False		False	False	The longitude coordinate of the geocoded billing address.
Estimate_ShipAddr_Id	String	False		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.
Estimate_ShipAddr_Line1	String	False		False	False	First line of the shipping address.
Estimate_ShipAddr_Line2	String	False		False	False	Second line of the shipping address.
Estimate_ShipAddr_Line3	String	False		False	False	Third line of the shipping address.
Estimate_ShipAddr_Line4	String	False		False	False	Fourth line of the shipping address.
Estimate_ShipAddr_Line5	String	False		False	False	Fifth line of the shipping address.
Estimate_ShipAddr_City	String	False		False	False	City name.
Estimate_ShipAddr_Country	String	False		False	False	Country name.
Estimate_ShipAddr_CountrySubDivisionCode	String	False		False	False	Region within a country. For example, the state name for the USA or the province name for Canada.
Estimate_ShipAddr_PostalCode	String	False		False	False	Postal code. For example, the zip code for the USA and Canada.
Estimate_ShipAddr_Note	String	False		False	False	Note for the customer.
Estimate_ShipAddr_Lat	String	False		False	False	The latitude coordinate of the geocoded shipping address.
Estimate_ShipAddr_Long	String	False		False	False	The longitude coordinate of the geocoded shipping address.
Estimate_ClassRef	String	False	Class.Id	True	False	The Id of the class associated with the transaction.
Estimate_ClassRef_Name	String	True	Class.FullyQualifiedName	False	False	The name of the class associated with the transaction.
Estimate_SalesTermRef	String	False	Terms.Id	False	False	The Id of the sales term associated with the transaction.
Estimate_SalesTermRef_Name	String	True	Terms.Name	False	False	The name of the sales term associated with the transaction.
Estimate_DueDate	Date	False		True	False	The due date for the invoice, not including any early payment discount incentives or late payment penalties. If the date is not supplied, the current date on the server is used.
Estimate_ShipMethodRef	String	False		False	False	The Id of the shipping method associated with the transaction.
Estimate_ShipMethodRef_Name	String	True		False	False	The name of the shipping method associated with the transaction.
Estimate_ShipDate	Date	False		False	False	The date for delivery of goods or services.
Estimate_TrackingNum	String	False		False	False	The tracking number for the shipping provider for the delivery of the goods associated with the transaction.
Estimate_TotalAmt	Decimal	True		True	True	This field indicates the total amount of the transaction. This includes the total of all charges, allowances, and taxes.
Estimate_PrintStatus	String	False		False	False	The print status of the invoice. The allowed values are NotSet, NeedToPrint, PrintComplete. The default value is NotSet.
Estimate_EmailStatus	String	False		False	False	The email status of the invoice. The allowed values are NotSet, NeedToSend, EmailSent. The default value is NotSet.
Estimate_BillEmail_Address	String	False		False	False	The email address where the invoice is sent. If the value of EmailStatus is NeedToSend, BillEmail is a required input.
Estimate_Balance	Decimal	False		True	True	This field indicates whether the transaction is a finance charge.
Estimate_ExpirationDate	Date	False		False	False	The date when an estimate becomes invalid.
Estimate_AcceptedBy	String	False		False	False	The name of the customer who accepted the estimate.
Estimate_AcceptedDate	Date	False		False	False	The date the estimate was accepted.
Estimate_ApplyTaxAfterDiscount	Boolean	False		False	False	This field sets whether any discounts are applied before taxes are calculated.
Estimate_CurrencyRef	String	False		False	False	The Id of the currency used in the transaction.
Estimate_CurrencyRef_Name	String	True		False	False	The name of the currency used in the transaction.
Estimate_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, and CA editions.
Estimate_GlobalTaxCalculation	String	False		False	False	The method used to apply taxes. This field is valid in the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable.
Estimate_HomeTotalAmt	Decimal	True		False	False	The total amount of the transaction, expressed in the home currency. This includes the total of all the charges, allowances, and taxes. This field is valid in the UK, AU, and CA editions.

RecurringInvoiceTransactions

Create and query QuickBooks Recurring Transaction for Invoice.

Table Specific Information

We can perform Select and Insert operations on RecurringInvoiceTransactions table.

Select

Invoice_Id, Invoice_MetaData_CreateTime, Invoice_MetaData_LastUpdatedTime can be used for server side filter. The driver processes other filters client-side within the driver.

SELECT * FROM RecurringInvoiceTransactions WHERE Invoice_Id = 25529
SELECT * FROM RecurringInvoiceTransactions WHERE Invoice_Id IN (25528, 25531, 25530)
SELECT * FROM RecurringInvoiceTransactions WHERE Invoice_MetaData_CreateTime = '2020-03-19 19:49:51.0'
SELECT * FROM RecurringInvoiceTransactions WHERE Invoice_MetaData_LastUpdatedTime = '2021-01-03 14:46:13'

Insert

To add a RecurringInvoiceTransactions following fields needs to be added:

A RecurringInvoiceTransactions object must have at least one line that describes an item.
A RecurringInvoiceTransactions object must have a RecurringInfo.

INSERT INTO RecurringInvoiceTransactions (Invoice_Id, Invoice_CustomerRef,  Invoice_RecurringInfo_Name, Invoice_RecurringInfo_RecurType, Invoice_RecurringInfo_Active, Invoice_RecurringInfo_ScheduleInfo_IntervalType, Invoice_RecurringInfo_ScheduleInfo_NumInterval, Invoice_RecurringInfo_ScheduleInfo_DayOfWeek, Invoice_RecurringInfo_ScheduleInfo_WeekOfMonth, Invoice_RecurringInfo_ScheduleInfo_StartDate, Invoice_RecurringInfo_ScheduleInfo_NextDate, Invoice_RecurringInfo_ScheduleInfo_PreviousDate, Invoice_LineAggregate) VALUES (49, 2, 'TestingA11', 'Reminded', false,  'Weekly', 2,  'Tuesday', 3, '2021-12-08', '2021-12-15', '2021-09-01', '<Line><Amount>0.01</Amount><DetailType>SalesItemLineDetail</DetailType><SalesItemLineDetail><ItemRef>2</ItemRef></SalesItemLineDetail></Line><Line><Amount>0.02</Amount><DetailType>SalesItemLineDetail</DetailType><SalesItemLineDetail><ItemRef>3</ItemRef></SalesItemLineDetail></Line>')

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Invoice_Id [KEY]	String	False	RecurringInvoiceTransactions.Invoice_Id	True	True	The Id of the Recurring Transaction.
Invoice_SyncToken	String	True		False	False	The Version number of the object.
Invoice_MetaData_CreateTime	Datetime	True		True	True	The time the record was created.
Invoice_MetaData_LastUpdatedTime	Datetime	True		True	True	The time the record was last updated.
Invoice_DocNumber	String	False		True	True	The reference number for the transaction.
Invoice_TxnDate	Date	False		True	True	The date entered by the user when this transaction occurred.
Invoice_PrivateNote	String	False		False	False	A private note for the transaction, which does not appear on the transaction records.
Invoice_TxnStatus	String	False		False	False	The status of the transaction. The allowed values are Accepted, Closed, Pending, Rejected.
Invoice_LinkedTxnAggregate	String	False		False	False	An XML aggregate of transactions linked to the estimate.
Invoice_LineAggregate	String	False		False	False	An XML aggregate of the line items of a transaction.
Invoice_TxnTaxDetail_TxnTaxCodeRef	String	False	TaxCodes.Id	False	False	The tax code for the transaction.
Invoice_TxnTaxDetail_TotalTax	String	False		False	False	The total tax calculated for the transaction, excluding any tax lines manually inserted into the transaction line list.
Invoice_TxnTaxDetail_TaxLineAggregate	String	False		False	False	An XML aggregate of tax line items.
Invoice_RecurDataRef	String	False		False	False	The Recurrence Data reference.
Invoice_RecurDataRef_Name	String	True		False	False	An identifying name for the object.
Invoice_RecurringInfo_Name	String	False		False	False	The Recurring Info name.
Invoice_RecurringInfo_RecurType	String	False		False	False	The Recurring Info recurring type. The allowed values are Automated, Reminded, UnScheduled.
Invoice_RecurringInfo_Active	Boolean	False		False	False	The Recurring Info is active or not.
Invoice_RecurringInfo_ScheduleInfo_IntervalType	String	False		False	False	The Recurring Info interval type. The allowed values are Yearly, Monthly, Weekly, Daily.
Invoice_RecurringInfo_ScheduleInfo_NumInterval	Integer	False		False	False	The Recurring Info num interval.
Invoice_RecurringInfo_ScheduleInfo_DayOfWeek	String	False		False	False	The Recurring Info day of week.
Invoice_RecurringInfo_ScheduleInfo_WeekOfMonth	String	False		False	False	The Recurring Info week of month.
Invoice_RecurringInfo_ScheduleInfo_MaxOccurrences	String	False		False	False	The max number of recurring occurrences.
Invoice_RecurringInfo_ScheduleInfo_RemindDays	String	False		False	False	The days before start date for a reminded RecurType.
Invoice_RecurringInfo_ScheduleInfo_MonthOfYear	String	False		False	False	The month of the year.
Invoice_RecurringInfo_ScheduleInfo_DaysBefore	String	False		False	False	The days before the scheduled date.
Invoice_RecurringInfo_ScheduleInfo_DayOfMonth	String	False		False	False	The day of the month.
Invoice_RecurringInfo_ScheduleInfo_StartDate	Datetime	False		False	False	The Recurring Info start date.
Invoice_RecurringInfo_ScheduleInfo_NextDate	Datetime	False		False	False	The Recurring Info next date.
Invoice_RecurringInfo_ScheduleInfo_EndDate	Datetime	False		False	False	The end date for the recurring schedule.
Invoice_RecurringInfo_ScheduleInfo_PreviousDate	Datetime	False		False	False	The Recurring Info previous date.
Invoice_CustomerRef	String	False	Customers.Id	True	False	The Id of the customer.
Invoice_CustomerRef_Name	String	True	Customers.DisplayName	False	False	The name of the customer.
Invoice_CustomerMemo	String	False		False	False	The message to the customer, which appears in the invoice and the printed invoice.
Invoice_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.
Invoice_BillAddr_Line1	String	False		False	False	First line of the address.
Invoice_BillAddr_Line2	String	False		False	False	Second line of the address.
Invoice_BillAddr_Line3	String	False		False	False	Third line of the address.
Invoice_BillAddr_Line4	String	False		False	False	Fourth line of the address.
Invoice_BillAddr_Line5	String	False		False	False	Fifth line of the address.
Invoice_BillAddr_City	String	False		False	False	City name.
Invoice_BillAddr_Country	String	False		False	False	Country name.
Invoice_BillAddr_CountrySubDivisionCode	String	False		False	False	Region within a country. For example, the state name for the USA or the province name for Canada.
Invoice_BillAddr_PostalCode	String	False		False	False	Postal code. For example, the zip code for the USA and Canada.
Invoice_BillAddr_Note	String	False		False	False	Note for the customer.
Invoice_BillAddr_Lat	String	False		False	False	The latitude coordinate of the geocoded billing address.
Invoice_BillAddr_Long	String	False		False	False	The longitude coordinate of the geocoded billing address.
Invoice_ShipAddr_Id	String	False		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.
Invoice_ShipAddr_Line1	String	False		False	False	First line of the address.
Invoice_ShipAddr_Line2	String	False		False	False	Second line of the address.
Invoice_ShipAddr_Line3	String	False		False	False	Third line of the address.
Invoice_ShipAddr_Line4	String	False		False	False	Fourth line of the address.
Invoice_ShipAddr_Line5	String	False		False	False	Fifth line of the address.
Invoice_ShipAddr_City	String	False		False	False	City name.
Invoice_ShipAddr_Country	String	False		False	False	Country name.
Invoice_ShipAddr_CountrySubDivisionCode	String	False		False	False	Region within a country. For example, the state name for the USA and the province name for Canada.
Invoice_ShipAddr_PostalCode	String	False		False	False	Postal code. For example, the zip code for the USA and Canada.
Invoice_ShipAddr_Note	String	False		False	False	Note for the customer.
Invoice_ShipAddr_Lat	String	False		False	False	The latitude coordinate of the geocoded shipping address.
Invoice_ShipAddr_Long	String	False		False	False	The longitude coordinate of the geocoded shipping address.
Invoice_ClassRef	String	False	Class.Id	True	False	The Id of the class associated with the transaction.
Invoice_ClassRef_Name	String	True	Class.FullyQualifiedName	False	False	The name of the class associated with the transaction.
Invoice_SalesTermRef	String	False	Terms.Id	False	False	The Id of the sales terms associated with the transaction.
Invoice_SalesTermRef_Name	String	True	Terms.Name	False	False	The name of the sales terms associated with the transaction.
Invoice_DueDate	Date	False		True	False	The date when the invoice is to be paid, not including any early payment discount incentives or late payment penalties. If the date is not supplied, the current date on the server is used.
Invoice_ShipMethodRef	String	False		False	False	The Id of the shipping method associated with the transaction.
Invoice_ShipMethodRef_Name	String	True		False	False	The name of the shipping method associated with the transaction.
Invoice_ShipDate	Date	False		False	False	The date for delivery of goods or services.
Invoice_TrackingNum	String	False		False	False	The tracking number for the shipping provider for the delivery of the goods associated with the transaction.
Invoice_TotalAmt	Decimal	True		True	True	The total amount of the transaction. This includes the total of all the charges, allowances, and taxes.
Invoice_PrintStatus	String	False		False	False	The print status of the invoice. The allowed values are NotSet, NeedToPrint, PrintComplete. The default value is NotSet.
Invoice_EmailStatus	String	False		False	False	The email status of the invoice. The allowed values are NotSet, NeedToSend, EmailSent. The default value is NotSet.
Invoice_BillEmail_Address	String	False		False	False	The email address where the invoice is sent. If the value of EmailStatus is NeedToSend, BillEmail is a required input.
Invoice_Balance	Decimal	True		True	True	This field indicates whether the transaction is a finance charge.
Invoice_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.
Invoice_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.
Invoice_AllowOnlineCreditCardPayment	Boolean	False		False	False	It specifies if online credit card payments are allowed for this invoice and corresponds to the Cards online payment check box on the QuickBooks UI.
Invoice_ApplyTaxAfterDiscount	Boolean	False		False	False	This field sets whether discounts are applied before the tax is calculated.
Invoice_CurrencyRef	String	False		False	False	The Id of the currency used in the transaction.
Invoice_CurrencyRef_Name	String	True		False	False	The name of the currency used in the transaction.
Invoice_ExchangeRate	Decimal	False		False	False	The currency exchange rate. Valid only if the company file is set up to use 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 only the UK, AU, and CA editions.
Invoice_GlobalTaxCalculation	String	False		False	False	The method in which tax is applied. This field is valid in the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable.
Invoice_HomeTotalAmt	Decimal	True		False	False	The total amount of the transaction in the home currency. Includes the total of all the charges, allowances, and taxes. This field is valid in the UK, AU, and CA editions.
Invoice_AllowOnlineCreditCardPayment	Boolean	True		False	False	To allow Online Credit Card Payment or not.
Invoice_AllowOnlineACHPayment	Boolean	True		False	False	To allow Online ACH Payment or not.

RecurringInvoiceTransactionsLineItems

Create and query QuickBooks Recurring Transaction Line Items for Invoice.

Table Specific Information

RecurringInvoiceTransactions may be inserted or queried via the RecurringInvoiceTransactions or RecurringInvoiceTransactionsLineItems tables.

Select

SELECT * FROM RecurringInvoiceTransactionsLineItems

Insert

To add a RecurringInvoiceTransactionsLineItems following fields needs to be added:

It must have at least one line that describes an item.
It must have a RecurringInfo.

INSERT INTO RecurringInvoiceTransactionsLineItems (Invoice_Id, Invoice_CustomerRef, Invoice_RecurringInfo_Name, Invoice_RecurringInfo_RecurType, Invoice_RecurringInfo_Active, Invoice_RecurringInfo_ScheduleInfo_IntervalType, Invoice_RecurringInfo_ScheduleInfo_NumInterval, Invoice_RecurringInfo_ScheduleInfo_DayOfWeek, Invoice_RecurringInfo_ScheduleInfo_WeekOfMonth, Invoice_RecurringInfo_ScheduleInfo_StartDate, Invoice_RecurringInfo_ScheduleInfo_NextDate, Invoice_RecurringInfo_ScheduleInfo_PreviousDate, Invoice_Line_DetailType, Invoice_Line_SalesItemLineDetail_ItemRef, Invoice_Line_Amount, Invoice_Line_SalesItemLineDetail_Qty, Invoice_Line_SalesItemLineDetail_DiscountAmt, Invoice_Line_SalesItemLineDetail_TaxCodeRef) VALUES (49, 2, 'TESTING155BCD11', 'Reminded', false, 'Weekly', 2, 'Tuesday', 3, '2021-12-08', '2021-12-15', '2021-09-01', 'SalesItemLineDetail', '5', 100.01, 8, 22.3, 'TAX')

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Invoice_Line_Id [KEY]	String	False		False	False	The Id of the line item of the invoice.
Invoice_Id [KEY]	String	False	RecurringInvoiceTransactions.Invoice_Id	True	True	The Id of the Recurring Transaction.
Invoice_SyncToken	String	True		False	False	The Version number of the object.
Invoice_MetaData_CreateTime	Datetime	True		True	True	The time the record was created.
Invoice_MetaData_LastUpdatedTime	Datetime	True		True	True	The time the record was last updated.
Invoice_DocNumber	String	False		True	True	The reference number for the transaction.
Invoice_TxnDate	Date	False		True	True	The date entered by the user when this transaction occurred.
Invoice_PrivateNote	String	False		False	False	A private note for the transaction, which does not appear on the transaction records.
Invoice_TxnStatus	String	False		False	False	The status of the transaction. The allowed values are Accepted, Closed, Pending, Rejected.
Invoice_LinkedTxnAggregate	String	False		False	False	An XML aggregate of transactions linked to the estimate.
Invoice_Line_Id	String	False		False	False	The Id of the line item.
Invoice_Line_LineNum	String	False		False	False	The line number of the line item.
Invoice_Line_Description	String	False		False	False	The description of the line item.
Invoice_Line_Amount	Decimal	False		False	False	The amount of the line item.
Invoice_Line_DetailType	String	False		False	False	The detail type of the line item. Different detail types indicate different types of line items.
Invoice_Line_SalesItemLineDetail_ItemRef	String	False	Items.Id	False	False	The Id of the item in the line item.
Invoice_Line_SalesItemLineDetail_ItemRef_Name	String	True	Items.Name	False	False	The name of the item in the line item.
Invoice_Line_SalesItemLineDetail_ClassRef	String	False	Class.Id	False	False	The Id of the class in the line item.
Invoice_Line_SalesItemLineDetail_ClassRef_Name	String	True	Class.FullyQualifiedName	False	False	The name of the class in the line item.
Invoice_Line_SalesItemLineDetail_UnitPrice	Decimal	False		False	False	The unit price of the item.
Invoice_Line_SalesItemLineDetail_Qty	Double	False		False	False	The number of items for the line item.
Invoice_Line_SalesItemLineDetail_TaxCodeRef	String	False	TaxCodes.Id	False	False	The tax code for the item.
Invoice_Line_SalesItemLineDetail_DiscountAmt	Decimal	False		False	False	The discount rate applied to an individual line item. If both DiscountAmt and DiscountRate are supplied, DiscountRate takes precedence and DiscountAmt is recalculated by QuickBooks services based on amount of DiscountRate.
Invoice_Line_SalesItemLineDetail_ServiceDate	Date	False		False	False	The service date for the item.
Invoice_Line_GroupLineDetail_GroupItemRef	String	True		False	False	The Id of the group item object.
Invoice_Line_GroupLineDetail_GroupItemRef_Name	String	True		False	False	The name of the group item object.
Invoice_Line_GroupLineDetail_Quantity	Integer	True		False	False	The amount of the group item.
Invoice_Line_DiscountLineDetail_ClassRef	String	False	Class.Id	False	False	The Id of the class in the line item.
Invoice_Line_DiscountLineDetail_ClassRef_Name	String	True	Class.FullyQualifiedName	False	False	The name of the class in the line item.
Invoice_Line_DiscountLineDetail_TaxCodeRef	String	False	TaxCodes.Id	False	False	The tax code for the item.
Invoice_Line_DiscountLineDetail_TaxCodeRef_Name	String	True	TaxCodes.Name	False	False	The name for the tax sales code.
Invoice_Line_DiscountLineDetail_PercentBased	Boolean	False		False	False	True if the discount is a percentage; null or false if discount based on amount.
Invoice_Line_DiscountLineDetail_DiscountAccountRef	String	False		False	False	The discount code for the item.
Invoice_Line_DiscountLineDetail_DiscountAccountRef_Name	String	True		False	False	The name for the discount account.
Invoice_Line_DiscountLineDetail_DiscountPercent	Decimal	False		False	False	Percentage by which the amount due is reduced, from 0% to 100%. To enter a discount of 8.5% use 8.5, not 0.085.
Invoice_TxnTaxDetail_TxnTaxCodeRef	String	False	TaxCodes.Id	False	False	The tax code for the transaction.
Invoice_TxnTaxDetail_TotalTax	String	False		False	False	The total tax calculated for the transaction, excluding any tax lines manually inserted into the transaction line list.
Invoice_TxnTaxDetail_TaxLineAggregate	String	False		False	False	An XML aggregate of tax line items.
Invoice_RecurDataRef	String	False		False	False	The Recurrence Data reference.
Invoice_RecurDataRef_Name	String	True		False	False	An identifying name for the object.
Invoice_RecurringInfo_Name	String	False		False	False	The Recurring Info name.
Invoice_RecurringInfo_RecurType	String	False		False	False	The Recurring Info recurring type. The allowed values are Automated, Reminded, UnScheduled.
Invoice_RecurringInfo_Active	Boolean	False		False	False	The Recurring Info is active or not.
Invoice_RecurringInfo_ScheduleInfo_IntervalType	String	False		False	False	The Recurring Info interval type. The allowed values are Yearly, Monthly, Weekly, Daily.
Invoice_RecurringInfo_ScheduleInfo_NumInterval	Integer	False		False	False	The Recurring Info num interval.
Invoice_RecurringInfo_ScheduleInfo_DayOfWeek	String	False		False	False	The Recurring Info day of week.
Invoice_RecurringInfo_ScheduleInfo_WeekOfMonth	String	False		False	False	The Recurring Info week of month.
Invoice_RecurringInfo_ScheduleInfo_MaxOccurrences	String	False		False	False	The max number of recurring occurrences.
Invoice_RecurringInfo_ScheduleInfo_RemindDays	String	False		False	False	The days before start date for a reminded RecurType.
Invoice_RecurringInfo_ScheduleInfo_MonthOfYear	String	False		False	False	The month of the year.
Invoice_RecurringInfo_ScheduleInfo_DaysBefore	String	False		False	False	The days before the scheduled date.
Invoice_RecurringInfo_ScheduleInfo_DayOfMonth	String	False		False	False	The day of the month.
Invoice_RecurringInfo_ScheduleInfo_StartDate	Datetime	False		False	False	The Recurring Info start date.
Invoice_RecurringInfo_ScheduleInfo_NextDate	Datetime	False		False	False	The Recurring Info next date.
Invoice_RecurringInfo_ScheduleInfo_EndDate	Datetime	False		False	False	The end date for the recurring schedule.
Invoice_RecurringInfo_ScheduleInfo_PreviousDate	Datetime	False		False	False	The Recurring Info previous date.
Invoice_CustomerRef	String	False	Customers.Id	True	False	The Id of the customer.
Invoice_CustomerRef_Name	String	True	Customers.DisplayName	False	False	The name of the customer.
Invoice_CustomerMemo	String	False		False	False	The message to the customer, which appears in the invoice and the printed invoice.
Invoice_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.
Invoice_BillAddr_Line1	String	False		False	False	First line of the address.
Invoice_BillAddr_Line2	String	False		False	False	Second line of the address.
Invoice_BillAddr_Line3	String	False		False	False	Third line of the address.
Invoice_BillAddr_Line4	String	False		False	False	Fourth line of the address.
Invoice_BillAddr_Line5	String	False		False	False	Fifth line of the address.
Invoice_BillAddr_City	String	False		False	False	City name.
Invoice_BillAddr_Country	String	False		False	False	Country name.
Invoice_BillAddr_CountrySubDivisionCode	String	False		False	False	Region within a country. For example, the state name for the USA or the province name for Canada.
Invoice_BillAddr_PostalCode	String	False		False	False	Postal code. For example, the zip code for the USA and Canada.
Invoice_BillAddr_Note	String	False		False	False	Note for the customer.
Invoice_BillAddr_Lat	String	False		False	False	The latitude coordinate of the geocoded billing address.
Invoice_BillAddr_Long	String	False		False	False	The longitude coordinate of the geocoded billing address.
Invoice_ShipAddr_Id	String	False		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.
Invoice_ShipAddr_Line1	String	False		False	False	First line of the address.
Invoice_ShipAddr_Line2	String	False		False	False	Second line of the address.
Invoice_ShipAddr_Line3	String	False		False	False	Third line of the address.
Invoice_ShipAddr_Line4	String	False		False	False	Fourth line of the address.
Invoice_ShipAddr_Line5	String	False		False	False	Fifth line of the address.
Invoice_ShipAddr_City	String	False		False	False	City name.
Invoice_ShipAddr_Country	String	False		False	False	Country name.
Invoice_ShipAddr_CountrySubDivisionCode	String	False		False	False	Region within a country. For example, the state name for the USA and the province name for Canada.
Invoice_ShipAddr_PostalCode	String	False		False	False	Postal code. For example, the zip code for the USA and Canada.
Invoice_ShipAddr_Note	String	False		False	False	Note for the customer.
Invoice_ShipAddr_Lat	String	False		False	False	The latitude coordinate of the geocoded shipping address.
Invoice_ShipAddr_Long	String	False		False	False	The longitude coordinate of the geocoded shipping address.
Invoice_ClassRef	String	False	Class.Id	True	False	The Id of the class associated with the transaction.
Invoice_ClassRef_Name	String	True	Class.FullyQualifiedName	False	False	The name of the class associated with the transaction.
Invoice_SalesTermRef	String	False	Terms.Id	False	False	The Id of the sales terms associated with the transaction.
Invoice_SalesTermRef_Name	String	True	Terms.Name	False	False	The name of the sales terms associated with the transaction.
Invoice_DueDate	Date	False		True	False	The date when the invoice is to be paid, not including any early payment discount incentives or late payment penalties. If the date is not supplied, the current date on the server is used.
Invoice_ShipMethodRef	String	False		False	False	The Id of the shipping method associated with the transaction.
Invoice_ShipMethodRef_Name	String	True		False	False	The name of the shipping method associated with the transaction.
Invoice_ShipDate	Date	False		False	False	The date for delivery of goods or services.
Invoice_TrackingNum	String	False		False	False	The tracking number for the shipping provider for the delivery of the goods associated with the transaction.
Invoice_TotalAmt	Decimal	True		True	True	The total amount of the transaction. This includes the total of all the charges, allowances, and taxes.
Invoice_PrintStatus	String	False		False	False	The print status of the invoice. The allowed values are NotSet, NeedToPrint, PrintComplete. The default value is NotSet.
Invoice_EmailStatus	String	False		False	False	The email status of the invoice. The allowed values are NotSet, NeedToSend, EmailSent. The default value is NotSet.
Invoice_BillEmail_Address	String	False		False	False	The email address where the invoice is sent. If the value of EmailStatus is NeedToSend, BillEmail is a required input.
Invoice_Balance	Decimal	True		True	True	This field indicates whether the transaction is a finance charge.
Invoice_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.
Invoice_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.
Invoice_AllowOnlineCreditCardPayment	Boolean	False		False	False	It specifies if online credit card payments are allowed for this invoice and corresponds to the Cards online payment check box on the QuickBooks UI.
Invoice_ApplyTaxAfterDiscount	Boolean	False		False	False	This field sets whether discounts are applied before the tax is calculated.
Invoice_CurrencyRef	String	False		False	False	The Id of the currency used in the transaction.
Invoice_CurrencyRef_Name	String	True		False	False	The name of the currency used in the transaction.
Invoice_ExchangeRate	Decimal	False		False	False	The currency exchange rate. Valid only if the company file is set up to use 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 only the UK, AU, and CA editions.
Invoice_GlobalTaxCalculation	String	False		False	False	The method in which tax is applied. This field is valid in the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable.
Invoice_HomeTotalAmt	Decimal	True		False	False	The total amount of the transaction in the home currency. Includes the total of all the charges, allowances, and taxes. This field is valid in the UK, AU, and CA editions.
Invoice_AllowOnlineCreditCardPayment	Boolean	True		False	False	To allow Online Credit Card Payment or not.
Invoice_AllowOnlineACHPayment	Boolean	True		False	False	To allow Online ACH Payment or not.
Invoice_GroupSalesItemLineAggregate	String	True		False	False	An XML aggregate of invoice group sales item line field information.

RecurringJournalEntryTransactions

Create and query QuickBooks Recurring Transaction for Journal Entry.

Table Specific Information

We can perform Select and Insert operations on RecurringJournalEntryTransactions table.

Select

JournalEntry_Id, JournalEntry_MetaData_CreateTime, JournalEntry_MetaData_LastUpdatedTime can be used for server side filter. The driver processes other filters client-side within the driver.

SELECT * FROM RecurringJournalEntryTransactions;
SELECT * FROM RecurringJournalEntryTransactions WHERE JournalEntry_id = 25536;
SELECT * FROM RecurringJournalEntryTransactions WHERE JournalEntry_MetaData_CreateTime = '2020-12-10 09:53:56';
SELECT * FROM RecurringJournalEntryTransactions WHERE JournalEntry_MetaData_LastUpdatedTime = '2020-12-10 09:53:56';
SELECT * FROM RecurringJournalEntryTransactions WHERE JournalEntry_id = 25536 AND JournalEntry_MetaData_CreateTime = '2020-12-10 09:53:56' AND JournalEntry_MetaData_LastUpdatedTime = '2020-12-10 09:53:56';

Insert

To add a RecurringJournalEntryTransactions following fields needs to be added:

There must be at least one credit line and at least one debit line where the total of the debit and credit Lines are equal to each other. Each _ denotes hierarchy. Use <Line> at the base level. All values for each field in the aggregate should adhere to the API's specifications (e.g. for dates in format yyyy-MM-dd, for date times in format yyyy-MM-dd'T'HH:mm:sszzz). The columns that may be used in the aggregates begin with the prefix 'Line_' to indicate they are part of the line item. Use the Line_ column along with the DocNumber to indicate which lines go with which RecurringJournalEntryTransactions. For example:
A RecurringJournalEntryTransactions object must have a RecurringInfo.

INSERT INTO RecurringJournalEntryTransactions (JournalEntry_LineAggregate, JournalEntry_RecurringInfo_Name, JournalEntry_RecurringInfo_RecurType, JournalEntry_RecurringInfo_Active, JournalEntry_RecurringInfo_ScheduleInfo_DayOfWeek, JournalEntry_RecurringInfo_ScheduleInfo_IntervalType, JournalEntry_RecurringInfo_ScheduleInfo_NumInterval, JournalEntry_RecurringInfo_ScheduleInfo_DayOfMonth, JournalEntry_RecurringInfo_ScheduleInfo_MaxOccurrences, JournalEntry_RecurringInfo_ScheduleInfo_StartDate, JournalEntry_RecurringInfo_ScheduleInfo_NextDate, JournalEntry_RecurringInfo_ScheduleInfo_PreviousDate) VALUES ('<Line><Amount>0.02</Amount><DetailType>JournalEntryLineDetail</DetailType><JournalEntryLineDetail><PostingType>Debit</PostingType><Entity><Type>Customer</Type><EntityRef>24</EntityRef></Entity><AccountRef>33</AccountRef></JournalEntryLineDetail></Line> <Line><Amount>0.02</Amount><DetailType>JournalEntryLineDetail</DetailType><JournalEntryLineDetail><PostingType>Credit</PostingType><AccountRef>14</AccountRef></JournalEntryLineDetail></Line>', 'APPTEST1', 'Reminded', false, 'Monday', 'Weekly',  2,  'Tuesday',  '100',  '2021-12-01',  '2021-12-01',  '2021-12-01')

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
JournalEntry_Id [KEY]	String	True		True	True	The Id of the Recurring Transaction.
JournalEntry_SyncToken	String	True		False	False	The Version number of the object.
JournalEntry_MetaData_CreateTime	Datetime	True		True	True	The time the record was created.
JournalEntry_MetaData_LastUpdatedTime	Datetime	True		True	True	The time the record was last updated.
JournalEntry_CurrencyRef	String	True		False	False	The Id of the currency used in the transaction.
JournalEntry_CurrencyRef_Name	String	True		False	False	The name of the currency used in the transaction.
JournalEntry_LineAggregate	String	False		False	False	An XML aggregate of the line items of a transaction.
JournalEntry_RecurDataRef	String	True		False	False	The Recurrence Data reference.
JournalEntry_RecurringInfo_Name	String	False		False	False	The Recurring Info name.
JournalEntry_RecurringInfo_RecurType	String	False		False	False	The Recurring Info recurring type.
JournalEntry_RecurringInfo_Active	Boolean	False		False	False	The Recurring Info is active or not.
JournalEntry_RecurringInfo_ScheduleInfo_DayOfWeek	String	False		False	False	The Recurring Info day of week.
JournalEntry_RecurringInfo_ScheduleInfo_IntervalType	String	False		False	False	The Recurring Info interval type.
JournalEntry_RecurringInfo_ScheduleInfo_WeekOfMonth	String	False		False	False	The Recurring Info week of month.
JournalEntry_RecurringInfo_ScheduleInfo_NumInterval	Integer	False		False	False	The Recurring Info num interval.
JournalEntry_RecurringInfo_ScheduleInfo_DayOfMonth	String	False		False	False	The Recurring Info day of month.
JournalEntry_RecurringInfo_ScheduleInfo_MaxOccurrences	String	False		False	False	The max number of recurring occurrences.
JournalEntry_RecurringInfo_ScheduleInfo_StartDate	Datetime	False		False	False	The Recurring Info start date.
JournalEntry_RecurringInfo_ScheduleInfo_NextDate	Datetime	False		False	False	The Recurring Info next date.
JournalEntry_RecurringInfo_ScheduleInfo_PreviousDate	Datetime	False		False	False	The Recurring Info previous date.
JournalEntry_TxnTaxDetail_TxnTaxCodeRef	String	False	TaxCodes.Id	False	False	The transaction tax code.
JournalEntry_TxnTaxDetail_TotalTax	String	False		False	False	Total tax calculated for the transaction, excluding any tax lines manually inserted into the transaction line list.
JournalEntry_TxnTaxDetail_TaxLineAggregate	String	False		False	False	An XML aggregate of tax line items.
JournalEntry_TotalAmt	Decimal	True		False	False	The total bill amount.
JournalEntry_Adjustment	Boolean	True		False	False	Is adjustment done or not.
JournalEntry_ExchangeRate	Decimal	False		False	False	The currency exchange rate. This field is only valid if the company file uses 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 in only the UK, AU, and CA editions.

RecurringJournalEntryTransactionsLineItems

Create and query the QuickBooks RecurringTransactions Journal Entry Line Items.

Table Specific Information

RecurringJournalEntryTransactions may be inserted or queried via the RecurringJournalEntryTransactions or RecurringJournalEntryTransactionsLineItems tables.

Select

SELECT * FROM RecurringJournalEntryTransactionsLineItems

Insert

To add a RecurringJournalEntryTransactionsLineItems following fields needs to be added:

There must be at least one credit line and at least one debit line where the total of the debit and credit Lines are equal to each other.
It must have a RecurringInfo.

INSERT INTO RecurringJournalEntryTransactionsLineItems (JournalEntry_Line_Id, JournalEntry_Line_Description, JournalEntry_Line_Amount, JournalEntry_Line_DetailType, JournalEntry_Line_JournalEntryLineDetail_PostingType, JournalEntry_Line_JournalEntryLineDetail_AccountRef, JournalEntry_RecurringInfo_Name, JournalEntry_RecurringInfo_RecurType, JournalEntry_RecurringInfo_Active, JournalEntry_RecurringInfo_ScheduleInfo_DayOfWeek, JournalEntry_RecurringInfo_ScheduleInfo_IntervalType, JournalEntry_RecurringInfo_ScheduleInfo_NumInterval, JournalEntry_RecurringInfo_ScheduleInfo_DayOfMonth, JournalEntry_RecurringInfo_ScheduleInfo_MaxOccurrences, JournalEntry_RecurringInfo_ScheduleInfo_StartDate, JournalEntry_RecurringInfo_ScheduleInfo_NextDate, JournalEntry_RecurringInfo_ScheduleInfo_PreviousDate) VALUES ('1', 'HELLOAPP1', 1001, 'JournalEntryLineDetail', 'Credit', '99', 'HELLOAPP3', 'Reminded', false, 'Monday', 'Weekly', 2,  'Tuesday', '100', '2021-01-23', '2021-01-23', '2021-01-23')

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
JournalEntry_Line_Id [KEY]	String	False		False	False	The Id of the recurring transaction line item for the journal entry.
JournalEntry_Id [KEY]	String	False	RecurringJournalEntryTransactions.JournalEntry_Id	True	True	The Id of the Recurring Transaction.
JournalEntry_SyncToken	String	True		False	False	The Version number of the object.
JournalEntry_MetaData_CreateTime	Datetime	True		True	True	The time the record was created.
JournalEntry_MetaData_LastUpdatedTime	Datetime	True		True	True	The time the record was last updated.
JournalEntry_CurrencyRef	String	False		False	False	The Id of the currency used in the transaction.
JournalEntry_CurrencyRef_Name	String	True		False	False	The name of the currency used in the transaction.
JournalEntry_Line_Description	String	False		False	False	A description of the line item that appears in the printed record.
JournalEntry_Line_Amount	Decimal	False		False	False	The amount of the line item.
JournalEntry_Line_DetailType	String	False		False	False	The detail type of the line item. Different detail types indicate different types of line items.
JournalEntry_Line_JournalEntryLineDetail_PostingType	String	False		False	False	This field indicates the posting type of the line item of the journal entry detail. The allowed values are Credit, Debit.
JournalEntry_Line_JournalEntryLineDetail_Entity_Type	String	False		False	False	The type of the entity to be referenced.
JournalEntry_Line_JournalEntryLineDetail_Entity_EntityRef	String	False		False	False	The Id of the entity to be referenced.
JournalEntry_Line_JournalEntryLineDetail_Entity_EntityRef_Name	String	True		False	False	The name of the entity to be referenced.
JournalEntry_Line_JournalEntryLineDetail_AccountRef	String	False	Accounts.Id	False	False	The Id of the account associated with the journal entry line item.
JournalEntry_Line_JournalEntryLineDetail_AccountRef_Name	String	True	Accounts.Name	False	False	The name of the account associated with the journal entry line item.
JournalEntry_Line_JournalEntryLineDetail_ClassRef	String	False	Class.Id	False	False	The Id of the class associated with the journal entry line item.
JournalEntry_Line_JournalEntryLineDetail_ClassRef_Name	String	True	Class.FullyQualifiedName	False	False	The name of the class associated with the journal entry line.
JournalEntry_Line_JournalEntryLineDetail_DepartmentRef	String	False	Departments.Id	False	False	The Id of the department associated with the journal entry line.
JournalEntry_Line_JournalEntryLineDetail_DepartmentRef_Name	String	True	Departments.Name	False	False	The name of the department associated with the journal entry line.
JournalEntry_Line_JournalEntryLineDetail_TaxCodeRef	String	False	TaxCodes.Id	False	False	The sales or purchase tax code associated with the journal entry line. This field is used for non-U.S., non-Canadian companies. This field is valid for the UK edition.
JournalEntry_Line_JournalEntryLineDetail_TaxApplicableOn	String	False		False	False	This field indicates whether the tax applicable to the line item is sales or purchase tax. This field is valid for the UK edition.
JournalEntry_Line_JournalEntryLineDetail_TaxAmount	Decimal	False		False	False	The tax applicable for this line item. This field is valid for the UK and AU editions.
JournalEntry_Line_JournalEntryLineDetail_BillableStatus	String	False		False	False	The billable status of the journal entry line. The line is to be billed to a customer if the account is an expense account and the Entity Reference specifies a Customer or a Job. The allowed values are Billable, NotBillable, HasBeenBilled.
JournalEntry_Line_JournalEntryLineDetail_JournalCodeRef	String	False		False	False	The Id of the journal code to be referenced.
JournalEntry_Line_JournalEntryLineDetail_JournalCodeRef_Name	String	True		False	False	The name of the journal code to be referenced.
JournalEntry_RecurDataRef	String	True		False	False	The Recurrence Data reference.
JournalEntry_RecurringInfo_Name	String	False		False	False	The Recurring Info name.
JournalEntry_RecurringInfo_RecurType	String	False		False	False	The Recurring Info recurring type.
JournalEntry_RecurringInfo_Active	Boolean	False		False	False	The Recurring Info is active or not.
JournalEntry_RecurringInfo_ScheduleInfo_DayOfWeek	String	False		False	False	The Recurring Info day of week.
JournalEntry_RecurringInfo_ScheduleInfo_IntervalType	String	False		False	False	The Recurring Info interval type.
JournalEntry_RecurringInfo_ScheduleInfo_WeekOfMonth	String	False		False	False	The Recurring Info week of month.
JournalEntry_RecurringInfo_ScheduleInfo_NumInterval	Integer	False		False	False	The Recurring Info num interval.
JournalEntry_RecurringInfo_ScheduleInfo_DayOfMonth	String	False		False	False	The Recurring Info day of month.
JournalEntry_RecurringInfo_ScheduleInfo_MaxOccurrences	String	False		False	False	The max number of recurring occurrences.
JournalEntry_RecurringInfo_ScheduleInfo_StartDate	Datetime	False		False	False	The Recurring Info start date.
JournalEntry_RecurringInfo_ScheduleInfo_NextDate	Datetime	False		False	False	The Recurring Info next date.
JournalEntry_RecurringInfo_ScheduleInfo_PreviousDate	Datetime	False		False	False	The Recurring Info previous date.
JournalEntry_TxnTaxDetail_TxnTaxCodeRef	String	False	TaxCodes.Id	False	False	The transaction tax code.
JournalEntry_TxnTaxDetail_TotalTax	String	False		False	False	Total tax calculated for the transaction, excluding any tax lines manually inserted into the transaction line list.
JournalEntry_TxnTaxDetail_TaxLineAggregate	String	False		False	False	An XML aggregate of tax line items.
JournalEntry_TotalAmt	Decimal	True		False	False	The total bill amount.
JournalEntry_Adjustment	Boolean	True		False	False	Is adjustment done or not.
JournalEntry_ExchangeRate	Decimal	False		False	False	The currency exchange rate. This field is only valid if the company file uses 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 in only the UK, AU, and CA editions.

RecurringPurchaseTransactions

Create and query QuickBooks Recurring Transaction for Purchases.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Purchase_Id [KEY]	String	True		True	True	The Id of the purchase.
Purchase_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.
Purchase_MetaData_CreateTime	Datetime	True		True	True	The time the record was created.
Purchase_MetaData_LastUpdatedTime	Datetime	True		True	True	The time the record was last updated.
Purchase_DocNumber	String	False		True	True	Reference number for the transaction.
Purchase_TxnDate	Date	False		True	True	The date when this transaction occurred.
Purchase_PrivateNote	String	False		False	False	A private note about the transaction. This note will not appear on the transaction records by default. This field maps to the Memo field on the Check and CreditCard form.
Purchase_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.
Purchase_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.
Purchase_TxnStatus	String	False		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.
Purchase_LinkedTxnAggregate	String	False		False	False	Zero or more linked transactions.
Purchase_RecurDataRef	String	False		False	False	The Recurrence Data reference.
Purchase_RecurDataRef_Name	String	True		False	False	An identifying name for the object.
Purchase_RecurringInfo_Name	String	False		False	False	The Recurring Info name.
Purchase_RecurringInfo_RecurType	String	False		False	False	The Recurring Info recurring type. The allowed values are Automated, Reminded, UnScheduled.
Purchase_RecurringInfo_Active	Boolean	False		False	False	The Recurring Info is active or not.
Purchase_RecurringInfo_ScheduleInfo_IntervalType	String	False		False	False	The Recurring Info interval type. The allowed values are Yearly, Monthly, Weekly, Daily.
Purchase_RecurringInfo_ScheduleInfo_NumInterval	Integer	False		False	False	The Recurring Info num interval.
Purchase_RecurringInfo_ScheduleInfo_DayOfWeek	String	False		False	False	The Recurring Info day of week.
Purchase_RecurringInfo_ScheduleInfo_WeekOfMonth	String	False		False	False	The Recurring Info week of month.
Purchase_RecurringInfo_ScheduleInfo_MaxOccurrences	String	False		False	False	The max number of recurring occurrences.
Purchase_RecurringInfo_ScheduleInfo_RemindDays	String	False		False	False	The days before start date for a reminded RecurType.
Purchase_RecurringInfo_ScheduleInfo_MonthOfYear	String	False		False	False	The month of the year.
Purchase_RecurringInfo_ScheduleInfo_DaysBefore	String	False		False	False	The days before the scheduled date.
Purchase_RecurringInfo_ScheduleInfo_DayOfMonth	String	False		False	False	The day of the month.
Purchase_RecurringInfo_ScheduleInfo_StartDate	Datetime	False		False	False	The Recurring Info start date.
Purchase_RecurringInfo_ScheduleInfo_NextDate	Datetime	False		False	False	The Recurring Info next date.
Purchase_RecurringInfo_ScheduleInfo_EndDate	Datetime	False		False	False	The end date for the recurring schedule.
Purchase_RecurringInfo_ScheduleInfo_PreviousDate	Datetime	False		False	False	The Recurring Info previous date.
Purchase_LineAggregate	String	False		False	False	A line item of a transaction.
Purchase_AccountRef	String	False	Accounts.Id	False	False	The Id of the account associated with the purchase. Check payments should reference a bank account and credit card purchases should refer to a credit card account.
Purchase_AccountRef_Name	String	True	Accounts.Name	False	False	A name that identifies the account associated with the purchase. Checks should reference a bank account and credit card purchases should refer to a credit card account.
Purchase_PaymentType	String	False		True	True	The payment type. The allowed values are Cash, Check, CreditCard.
Purchase_EntityRef	String	False		False	False	The Id of the entity for the party the expense is associated with.
Purchase_EntityRef_Name	String	True		False	False	A name that identifies the party the expense is associated with.
Purchase_Credit	Boolean	False		False	False	This field is valid only for the credit card payment type.
Purchase_TotalAmt	Decimal	True		True	True	The total amount due, determined by the sum of the line item amounts. This includes all charges, allowances, taxes, discounts, etc.
Purchase_PrintStatus	String	False		False	False	The print status of the purchase. This field is applicable only for checks and ignored for credit card charges or refunds.
Purchase_Status	String	True		False	False	The status of the purchase.
Purchase_TxnTaxDetail_TxnTaxCodeRef	String	False	TaxCodes.Id	False	False	The transaction tax code.
Purchase_TxnTaxDetail_TotalTax	String	False		False	False	Total tax calculated for the transaction, excluding any tax lines manually inserted into the transaction line list.
Purchase_TxnTaxDetail_TaxLineAggregate	String	False		False	False	An XML aggregate of tax line items.
Purchase_CurrencyRef	String	False		False	False	The Id of the currency used in the transaction.
Purchase_CurrencyRef_Name	String	True		False	False	The name of the currency used in the transaction.
Purchase_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, and CA editions.
Purchase_GlobalTaxCalculation	String	False		False	False	Method in which tax is applied. This field is valid in the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable.

RecurringPurchaseTransactionsLineItems

Create and query QuickBooks Recurring Transaction for Purchase Line Items.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Purchase_LineId [KEY]	String	True		True	False	The Id of the line item of the purchase of the read receipt.
Purchase_PurchaseId [KEY]	String	False	Purchases.Id	True	True	The Id of the purchase.
Purchase_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.
Purchase_MetaData_CreateTime	Datetime	True		True	True	The time the record was created.
Purchase_MetaData_LastUpdatedTime	Datetime	True		True	True	The time the record was last updated.
Purchase_DocNumber	String	False		True	True	The reference number for the transaction.
Purchase_TxnDate	Date	False		True	True	The date when this transaction occurred.
Purchase_PrivateNote	String	False		False	False	A private note about the transaction. This note will not appear on the transaction records by default. This field maps to the Memo field on the Check and CreditCard form.
Purchase_Line_Id	String	False		False	False	The Id of the line item.
Purchase_Line_Description	String	False		False	False	A description of the line item that appears in the printed record.
Purchase_Line_Amount	Decimal	False		False	False	The total amount of the charges or discounts for the given line. This field includes the charges and allowances, but it excludes the tax amount.
Purchase_Line_DetailType	String	False		False	False	The type of line in the transaction.
Purchase_Line_ItemBasedExpenseLineDetail_ItemRef	String	False	Items.Id	False	False	The Id of the item in the line item. When a line item lacks an ItemRef it is treated as documentation and the Line.Amount attribute is ignored.
Purchase_Line_ItemBasedExpenseLineDetail_ItemRef_Name	String	True	Items.Name	False	False	The name of the item. When a line item lacks an ItemRef it is treated as documentation and the Line_Amount field is ignored.
Purchase_Line_ItemBasedExpenseLineDetail_ClassRef	String	False	Class.Id	False	False	The Id of the class for the line item.
Purchase_Line_ItemBasedExpenseLineDetail_ClassRef_Name	String	True	Class.Name	False	False	The name of the class for the line item.
Purchase_Line_ItemBasedExpenseLineDetail_UnitPrice	Decimal	False		False	False	The unit price of the subject item as referenced by ItemRef.
Purchase_Line_ItemBasedExpenseLineDetail_Qty	Double	False		False	False	Number of items for the line.
Purchase_Line_ItemBasedExpenseLineDetail_RatePercent	Double	False		False	False	The amount is expressed as a percent of charges already entered in the current transaction. To enter a rate of 10% use 10.0, not 0.01.
Purchase_Line_ItemBasedExpenseLineDetail_MarkupInfo_Value	Double	False		False	False	Markup value.
Purchase_Line_ItemBasedExpenseLineDetail_MarkupInfo_Percent	Double	False		False	False	Markup amount expressed as a percent of charges already entered in the current transaction. To enter a rate of 10% use 10.0, not 0.01.
Purchase_Line_ItemBasedExpenseLineDetail_MarkupInfo_PriceLevelRef	String	False		False	False	The Id of the entity for the price level for the markup.
Purchase_Line_ItemBasedExpenseLineDetail_MarkupInfo_Name_PriceLevelRef_Name	String	True		False	False	A name that identifies the price level for the markup.
Purchase_Line_ItemBasedExpenseLineDetail_TaxCodeRef	String	False	TaxCodes.Id	False	False	The sales tax code for this item.
Purchase_Line_ItemBasedExpenseLineDetail_CustomerRef	String	False	Customers.Id	False	False	The Id of the customer associated with the expense.
Purchase_Line_ItemBasedExpenseLineDetail_CustomerRef_Name	String	True	Customers.DisplayName	False	False	The name of the customer associated with the expense.
Purchase_Line_ItemBasedExpenseLineDetail_BillableStatus	String	False		False	False	The billable status of the expense. The allowed values are Billable, NotBillable, HasBeenBilled.
Purchase_Line_AccountBasedExpenseLineDetail_ClassRef	String	False	Class.Id	False	False	The Id of the class entity of the expense.
Purchase_Line_AccountBasedExpenseLineDetail_ClassRef_Name	String	True	Class.Name	False	False	The name of the class entity of the expense.
Purchase_Line_AccountBasedExpenseLineDetail_CustomerRef	String	False	Customers.Id	False	False	The customer id for the expense.
Purchase_Line_AccountBasedExpenseLineDetail_CustomerRef_Name	String	True	Customers.DisplayName	False	False	The customer name for the expense.
Purchase_Line_AccountBasedExpenseLineDetail_AccountRef	String	False	Accounts.Id	False	False	The Id of the expense account of the expense.
Purchase_Line_AccountBasedExpenseLineDetail_AccountRef_Name	String	True	Accounts.Name	False	False	The name of the expense account of the expense.
Purchase_Line_AccountBasedExpenseLineDetail_BillableStatus	String	False		False	False	The billable status of the expense. The allowed values are Billable, NotBillable, HasBeenBilled.
Purchase_Line_AccountBasedExpenseLineDetail_MarkupInfo_Value	Double	False		False	False	Markup value.
Purchase_Line_AccountBasedExpenseLineDetail_MarkupInfo_Percent	Double	False		False	False	Markup amount expressed as a percent of charges already entered in the current transaction. To enter a rate of 10% use 10.0, not 0.01.
Purchase_Line_AccountBasedExpenseLineDetail_MarkupInfo_PriceLevelRef	String	False		False	False	The Id of price level for the markup.
Purchase_Line_AccountBasedExpenseLineDetail_MarkupInfo__Name_PriceLevelRef_Name	String	True		False	False	The name of the price level for the markup.
Purchase_AccountRef	String	False	Accounts.Id	False	False	The Id of the account associated with the transaction.
Purchase_AccountRef_Name	String	True	Accounts.Name	False	False	A name that identifies the account associated with the transaction. Checks should reference a bank account and CreditCard should reference a credit card account.
Purchase_PaymentType	String	False		True	True	The expense type. The allowed values are Cash, Check, CreditCard.
Purchase_EntityRef	String	False		False	False	Specifies the party with whom an expense is associated.
Purchase_EntityRef_Name	String	True		False	False	Specifies the party with whom an expense is associated.
Purchase_Credit	Boolean	False		False	False	This field is valid only for the CreditCard payment type.
Purchase_TotalAmt	Decimal	True		True	True	The total amount due, determined the sum of the line items. This includes all charges, allowances, taxes, discounts, etc.
Purchase_PrintStatus	String	False		False	False	The print status of the payment. This field is applicable only for checks. It is ignored for credit card charges or refunds.
Purchase_DepartmentRef	String	False	Departments.Id	False	False	The Id of the department, which stores the location of the transaction.
Purchase_DepartmentRef_Name	String	True	Departments.Name	False	False	The name of the department, which stores the location of the transaction.
Purchase_Status	String	True		False	False	The status of the purchase.
Purchase_TxnTaxDetail_TxnTaxCodeRef	String	False	TaxCodes.Id	False	False	The transaction tax code.
Purchase_TxnTaxDetail_TotalTax	String	False		False	False	Total tax calculated for the transaction, excluding any tax lines manually inserted into the transaction line list.
Purchase_TxnTaxDetail_TaxLineAggregate	String	False		False	False	An XML aggregate of tax line items.
Purchase_RecurDataRef	String	False		False	False	The Recurrence Data reference.
Purchase_RecurDataRef_Name	String	True		False	False	An identifying name for the object.
Purchase_RecurringInfo_Name	String	False		False	False	The Recurring Info name.
Purchase_RecurringInfo_RecurType	String	False		False	False	The Recurring Info recurring type. The allowed values are Automated, Reminded, UnScheduled.
Purchase_RecurringInfo_Active	Boolean	False		False	False	The Recurring Info is active or not.
Purchase_RecurringInfo_ScheduleInfo_IntervalType	String	False		False	False	The Recurring Info interval type. The allowed values are Yearly, Monthly, Weekly, Daily.
Purchase_RecurringInfo_ScheduleInfo_NumInterval	Integer	False		False	False	The Recurring Info num interval.
Purchase_RecurringInfo_ScheduleInfo_DayOfWeek	String	False		False	False	The Recurring Info day of week.
Purchase_RecurringInfo_ScheduleInfo_WeekOfMonth	String	False		False	False	The Recurring Info week of month.
Purchase_RecurringInfo_ScheduleInfo_MaxOccurrences	String	False		False	False	The max number of recurring occurrences.
Purchase_RecurringInfo_ScheduleInfo_RemindDays	String	False		False	False	The days before start date for a reminded RecurType.
Purchase_RecurringInfo_ScheduleInfo_MonthOfYear	String	False		False	False	The month of the year.
Purchase_RecurringInfo_ScheduleInfo_DaysBefore	String	False		False	False	The days before the scheduled date.
Purchase_RecurringInfo_ScheduleInfo_DayOfMonth	String	False		False	False	The day of the month.
Purchase_RecurringInfo_ScheduleInfo_StartDate	Datetime	False		False	False	The Recurring Info start date.
Purchase_RecurringInfo_ScheduleInfo_NextDate	Datetime	False		False	False	The Recurring Info next date.
Purchase_RecurringInfo_ScheduleInfo_EndDate	Datetime	False		False	False	The end date for the recurring schedule.
Purchase_RecurringInfo_ScheduleInfo_PreviousDate	Datetime	False		False	False	The Recurring Info previous date.
Purchase_CurrencyRef	String	False		False	False	The Id of the currency used in the transaction.
Purchase_CurrencyRef_Name	String	True		False	False	The name of the currency used in the transaction.
Purchase_ExchangeRate	Double	False		False	False	The currency exchange rate. This field is valid only if the company file is set up to use 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, and CA editions.
Purchase_GlobalTaxCalculation	String	False		False	False	The method in which tax is applied. This field is valid in the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable.

RecurringRefundReceiptTransactions

Create and query QuickBooks Recurring Transaction for RefundReceipts.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
RefundReceipt_Id [KEY]	String	True		True	True	The Id of the invoice.
RefundReceipt_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.
RefundReceipt_MetaData_CreateTime	Datetime	True		True	True	The time the record was created.
RefundReceipt_MetaData_LastUpdatedTime	Datetime	True		True	True	The time the record was last updated.
RefundReceipt_CustomFieldAggregate	String	False		False	False	An XML aggregate of custom field information.
RefundReceipt_DocNumber	String	False		True	True	The reference number for the transaction.
RefundReceipt_TxnDate	Date	False		True	True	The date entered by the user when this transaction occurred.
RefundReceipt_PrivateNote	String	False		False	False	A private note that does not appear on the transaction records.
RefundReceipt_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.
RefundReceipt_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.
RefundReceipt_TxnStatus	String	False		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.
RefundReceipt_LinkedTxnAggregate	String	False		False	False	Zero or more linked transactions.
RefundReceipt_RecurDataRef	String	False		False	False	The Recurrence Data reference.
RefundReceipt_RecurDataRef_Name	String	True		False	False	An identifying name for the object.
RefundReceipt_RecurringInfo_Name	String	False		False	False	The Recurring Info name.
RefundReceipt_RecurringInfo_RecurType	String	False		False	False	The Recurring Info recurring type. The allowed values are Automated, Reminded, UnScheduled.
RefundReceipt_RecurringInfo_Active	Boolean	False		False	False	The Recurring Info is active or not.
RefundReceipt_RecurringInfo_ScheduleInfo_IntervalType	String	False		False	False	The Recurring Info interval type. The allowed values are Yearly, Monthly, Weekly, Daily.
RefundReceipt_RecurringInfo_ScheduleInfo_NumInterval	Integer	False		False	False	The Recurring Info num interval.
RefundReceipt_RecurringInfo_ScheduleInfo_DayOfWeek	String	False		False	False	The Recurring Info day of week.
RefundReceipt_RecurringInfo_ScheduleInfo_WeekOfMonth	String	False		False	False	The Recurring Info week of month.
RefundReceipt_RecurringInfo_ScheduleInfo_MaxOccurrences	String	False		False	False	The max number of recurring occurrences.
RefundReceipt_RecurringInfo_ScheduleInfo_RemindDays	String	False		False	False	The days before start date for a reminded RecurType.
RefundReceipt_RecurringInfo_ScheduleInfo_MonthOfYear	String	False		False	False	The month of the year.
RefundReceipt_RecurringInfo_ScheduleInfo_DaysBefore	String	False		False	False	The days before the scheduled date.
RefundReceipt_RecurringInfo_ScheduleInfo_DayOfMonth	String	False		False	False	The day of the month.
RefundReceipt_RecurringInfo_ScheduleInfo_StartDate	Datetime	False		False	False	The Recurring Info start date.
RefundReceipt_RecurringInfo_ScheduleInfo_NextDate	Datetime	False		False	False	The Recurring Info next date.
RefundReceipt_RecurringInfo_ScheduleInfo_EndDate	Datetime	False		False	False	The end date for the recurring schedule.
RefundReceipt_RecurringInfo_ScheduleInfo_PreviousDate	Datetime	False		False	False	The Recurring Info previous date.
RefundReceipt_LinkedTxnAggregate	String	False		False	False	An XML aggregate of transactions linked to the refund receipt.
RefundReceipt_LineAggregate	String	False		False	False	An XML aggregate of line items associated with the transaction.
RefundReceipt_TxnTaxDetail_TxnTaxCodeRef	String	False	TaxCodes.Id	False	False	The tax code of the transaction.
RefundReceipt_TxnTaxDetail_TotalTax	String	False		False	False	Total tax calculated for the transaction, excluding any tax lines manually inserted into the transaction line list.
RefundReceipt_TxnTaxDetail_TaxLineAggregate	String	False		False	False	An XML aggregate of tax line items.
RefundReceipt_CustomerRef	String	False	Customers.Id	True	False	The Id of the customer.
RefundReceipt_CustomerRef_Name	String	True	Customers.DisplayName	False	False	The name of the customer.
RefundReceipt_CustomerMemo	String	False		False	False	The message to the customer that appears in the invoice and in the printed invoice.
RefundReceipt_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.
RefundReceipt_BillAddr_Line1	String	False		False	False	First line of the address.
RefundReceipt_BillAddr_Line2	String	False		False	False	Second line of the address.
RefundReceipt_BillAddr_Line3	String	False		False	False	Third line of the address.
RefundReceipt_BillAddr_Line4	String	False		False	False	Fourth line of the address.
RefundReceipt_BillAddr_Line5	String	False		False	False	Fifth line of the address.
RefundReceipt_BillAddr_City	String	False		False	False	City name.
RefundReceipt_BillAddr_Country	String	False		False	False	Country name.
RefundReceipt_BillAddr_CountrySubDivisionCode	String	False		False	False	Region within a country. For example, the state name for the USA or the province name for Canada.
RefundReceipt_BillAddr_PostalCode	String	False		False	False	Postal code. For example, the zip code for the USA and Canada.
RefundReceipt_BillAddr_Note	String	False		False	False	Note for the customer.
RefundReceipt_BillAddr_Lat	String	False		False	False	The latitude coordinate of the geocoded billing address.
RefundReceipt_BillAddr_Long	String	False		False	False	The longitude coordinate of the geocoded billing address.
RefundReceipt_ShipAddr_Id	String	False		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.
RefundReceipt_ShipAddr_Line1	String	False		False	False	First line of the address.
RefundReceipt_ShipAddr_Line2	String	False		False	False	Second line of the address.
RefundReceipt_ShipAddr_Line3	String	False		False	False	Third line of the address.
RefundReceipt_ShipAddr_Line4	String	False		False	False	Fourth line of the address.
RefundReceipt_ShipAddr_Line5	String	False		False	False	Fifth line of the address.
RefundReceipt_ShipAddr_City	String	False		False	False	City name.
RefundReceipt_ShipAddr_Country	String	False		False	False	Country name.
RefundReceipt_ShipAddr_CountrySubDivisionCode	String	False		False	False	Region within a country. For example, the state name for the USA or the province name for Canada.
RefundReceipt_ShipAddr_PostalCode	String	False		False	False	Postal code. For example, the zip code for the USA and Canada.
RefundReceipt_ShipAddr_Note	String	False		False	False	Note for the customer.
RefundReceipt_ShipAddr_Lat	String	False		False	False	The latitude coordinate of the geocoded shipping address.
RefundReceipt_ShipAddr_Long	String	False		False	False	The longitude coordinate of the geocoded shipping address.
RefundReceipt_ClassRef	String	False	Class.Id	False	False	The Id of the class associated with the transaction.
RefundReceipt_ClassRef_Name	String	True	Class.FullyQualifiedName	False	False	The name of the class associated with the transaction.
RefundReceipt_CheckPayment_CheckNum	String	True		False	False	The check number printed on the check.
RefundReceipt_CheckPayment_Status	String	False		False	False	Status of the check. Values provided by service/business logic.
RefundReceipt_CheckPayment_NameOnAccount	String	False		False	False	Name of persons or entities holding the account, as printed on the check.
RefundReceipt_CheckPayment_AcctNum	String	False		False	False	Checking account number, as printed on the check.
RefundReceipt_CheckPayment_BankName	String	True		False	False	The name of the bank on which the check was drawn.
RefundReceipt_CreditCardPayment_CreditChargeInfo_Type	String	False		False	False	The type of credit card.
RefundReceipt_CreditCardPayment_CreditChargeInfo_NameOnAcct	String	False		False	False	The name of the account holder, as printed on the card.
RefundReceipt_CreditCardPayment_CreditChargeInfo_CcExpiryMonth	Integer	False		False	False	The expiration month of the card.
RefundReceipt_CreditCardPayment_CreditChargeInfo_CcExpiryYear	Integer	False		False	False	The four-digit expiration year of the card.
RefundReceipt_CreditCardPayment_CreditChargeInfo_BillAddrStreet	String	False		False	False	The street of the billing address of the credit card holder.
RefundReceipt_CreditCardPayment_CreditChargeInfo_PostalCode	String	False		False	False	The postal code.
RefundReceipt_CreditCardPayment_CreditChargeInfo_Amount	Decimal	False		False	False	The amount processed using the credit card
RefundReceipt_CreditCardPayment_CreditChargeInfo_ProcessPayment	Boolean	False		False	False	False or no value-Store credit card information only.True-Store credit card payment transaction information in CreditChargeResponse below.
RefundReceipt_CreditCardPayment_CreditChargeResponse_CCTransId	String	False		False	False	Unique identifier of the payment transaction.
RefundReceipt_CreditCardPayment_CreditChargeResponse_AuthCode	String	False		False	False	Code returned from the credit card processor to indicate that the charge will be paid by the card issuer.
RefundReceipt_CreditCardPayment_CreditChargeResponse_TxnAuthorizationTime	Datetime	False		False	False	Timestamp indicating the time in which the card processor authorized the transaction.
RefundReceipt_CreditCardPayment_CreditChargeResponse_Status	String	False		False	False	Indicates the status of the payment transaction. Possible values include Completed, Unknown.
RefundReceipt_SalesTermRef	String	False	Terms.Id	False	False	The Id of the sales term associated with the transaction.
RefundReceipt_SalesTermRef_Name	String	True	Terms.Name	False	False	The name of the sales term associated with the transaction.
RefundReceipt_DueDate	Date	False		True	False	The date when the invoice is to be paid, not including any early payment discount incentives or late payment penalties. If the date is not supplied, the current date on the server is used.
RefundReceipt_ShipMethodRef	String	False		False	False	The Id of the shipping method associated with the transaction.
RefundReceipt_ShipMethodRef_Name	String	True		False	False	The name of the shipping method associated with the transaction.
RefundReceipt_ShipDate	Date	False		False	False	The date for delivery of goods or services.
RefundReceipt_TotalAmt	Decimal	True		True	True	This field indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes.
RefundReceipt_ApplyTaxAfterDiscount	Boolean	False		False	False	This field sets whether discounts are applied before the tax is calculated.
RefundReceipt_PrintStatus	String	False		False	False	The print status of the invoice. The allowed values are NotSet, NeedToPrint, PrintComplete.
RefundReceipt_BillEmail_Address	String	False		False	False	This field identifies the email address where the invoice is sent. If the value of EmailStatus is NeedToSend, BillEmail is a required input.
RefundReceipt_Balance	Decimal	False		False	False	This field indicates whether the transaction is a finance charge.
RefundReceipt_PaymentMethodRef	String	False	PaymentMethods.Id	False	False	The Id of the payment method associated with the transaction.
RefundReceipt_PaymentMethodRef_Name	String	True	PaymentMethods.Name	False	False	The name of the payment method associated with the transaction.
RefundReceipt_PaymentRefNum	String	False		False	False	The reference number for the payment received.
RefundReceipt_PaymentType	String	False		False	False	The type of payment used for the transaction. The allowed values are Cash, Check, CreditCard, Other.
RefundReceipt_DepositToAccountRef	String	False	Accounts.Id	False	False	The asset account where the payment money is deposited. If you do not specify this account, QuickBooks Online uses the Undeposited Funds account.
RefundReceipt_DepositToAccountRef_Name	String	True	Accounts.Name	False	False	The 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.
RefundReceipt_CurrencyRef	String	False		False	False	The Id of the currency used in the transaction.
RefundReceipt_CurrencyRef_Name	String	True		False	False	The name of the currency used in the transaction.
RefundReceipt_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, and CA editions.
RefundReceipt_GlobalTaxCalculation	String	False		False	False	The method in which tax is applied. This field is valid in the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable.
RefundReceipt_HomeTotalAmt	Decimal	True		False	False	Total amount of the transaction in the home currency. Includes the total of all the charges, allowances, and taxes. This field is valid in the UK, AU, and CA editions.

RecurringRefundReceiptTransactionsLineItems

Create and query QuickBooks Recurring Transactions for RefundReceiptLineItems.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
RefundReceipt_LineId [KEY]	String	True		True	False	The Id of the line item of the invoice of the read receipt.
RefundReceipt_RefundReceiptId [KEY]	String	False	RefundReceipts.Id	True	True	The Id of the read receipt.
RefundReceipt_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.
RefundReceipt_MetaData_CreateTime	Datetime	True		True	True	The time the record was created.
RefundReceipt_MetaData_LastUpdatedTime	Datetime	True		True	True	The time the record was last updated.
RefundReceipt_CustomFieldAggregate	String	False		False	False	An XML aggregate of custom field information.
RefundReceipt_DocNumber	String	False		True	True	The reference number for the transaction.
RefundReceipt_TxnDate	Date	False		True	True	The date entered by the user when this transaction occurred.
RefundReceipt_PrivateNote	String	False		False	False	A private note that does not appear on the transaction records.
RefundReceipt_Line_Id	String	False		False	False	The Id of the line item.
RefundReceipt_Line_LineNum	String	False		False	False	The line number of the line item.
RefundReceipt_Line_Description	String	False		False	False	The description of the line item.
RefundReceipt_Line_Amount	Decimal	False		False	False	The amount of the line item.
RefundReceipt_Line_DetailType	String	False		False	False	The detail type of the line item. Different detail types indicate different types of line items.
RefundReceipt_Line_SalesItemLineDetail_ItemRef	String	False	Items.Id	False	False	The Id of the item in the line item.
RefundReceipt_Line_SalesItemLineDetail_ItemRef_Name	String	True	Items.Name	False	False	The name of the item in the line item.
RefundReceipt_Line_SalesItemLineDetail_ClassRef	String	False	Class.Id	False	False	The Id of the class in the line item.
RefundReceipt_Line_SalesItemLineDetail_ClassRef_Name	String	True	Class.FullyQualifiedName	False	False	The name of the class in the line item.
RefundReceipt_Line_SalesItemLineDetail_UnitPrice	Decimal	False		False	False	The unit price of the item.
RefundReceipt_Line_SalesItemLineDetail_Qty	Double	False		False	False	The number of items for the line item.
RefundReceipt_Line_SalesItemLineDetail_TaxCodeRef	String	False	TaxCodes.Id	False	False	The tax code for the item.
RefundReceipt_Line_SalesItemLineDetail_ServiceDate	Date	False		False	False	The service date for the item.
RefundReceipt_TxnTaxDetail_TxnTaxCodeRef	String	False	TaxCodes.Id	False	False	The tax code of the transaction.
RefundReceipt_TxnTaxDetail_TotalTax	String	False		False	False	Total tax calculated for the transaction, excluding any tax lines manually inserted into the transaction line list.
RefundReceipt_TxnTaxDetail_TaxLineAggregate	String	False		False	False	An XML aggregate of tax line items.
RefundReceipt_RecurDataRef	String	False		False	False	The Recurrence Data reference.
RefundReceipt_RecurDataRef_Name	String	True		False	False	An identifying name for the object.
RefundReceipt_RecurringInfo_Name	String	False		False	False	The Recurring Info name.
RefundReceipt_RecurringInfo_RecurType	String	False		False	False	The Recurring Info recurring type. The allowed values are Automated, Reminded, UnScheduled.
RefundReceipt_RecurringInfo_Active	Boolean	False		False	False	The Recurring Info is active or not.
RefundReceipt_RecurringInfo_ScheduleInfo_IntervalType	String	False		False	False	The Recurring Info interval type. The allowed values are Yearly, Monthly, Weekly, Daily.
RefundReceipt_RecurringInfo_ScheduleInfo_NumInterval	Integer	False		False	False	The Recurring Info num interval.
RefundReceipt_RecurringInfo_ScheduleInfo_DayOfWeek	String	False		False	False	The Recurring Info day of week.
RefundReceipt_RecurringInfo_ScheduleInfo_WeekOfMonth	String	False		False	False	The Recurring Info week of month.
RefundReceipt_RecurringInfo_ScheduleInfo_MaxOccurrences	String	False		False	False	The max number of recurring occurrences.
RefundReceipt_RecurringInfo_ScheduleInfo_RemindDays	String	False		False	False	The days before start date for a reminded RecurType.
RefundReceipt_RecurringInfo_ScheduleInfo_MonthOfYear	String	False		False	False	The month of the year.
RefundReceipt_RecurringInfo_ScheduleInfo_DaysBefore	String	False		False	False	The days before the scheduled date.
RefundReceipt_RecurringInfo_ScheduleInfo_DayOfMonth	String	False		False	False	The day of the month.
RefundReceipt_RecurringInfo_ScheduleInfo_StartDate	Datetime	False		False	False	The Recurring Info start date.
RefundReceipt_RecurringInfo_ScheduleInfo_NextDate	Datetime	False		False	False	The Recurring Info next date.
RefundReceipt_RecurringInfo_ScheduleInfo_EndDate	Datetime	False		False	False	The end date for the recurring schedule.
RefundReceipt_RecurringInfo_ScheduleInfo_PreviousDate	Datetime	False		False	False	The Recurring Info previous date.
RefundReceipt_CustomerRef	String	False	Customers.Id	True	False	The Id of the customer.
RefundReceipt_CustomerRef_Name	String	True	Customers.DisplayName	False	False	The name of the customer.
RefundReceipt_CustomerMemo	String	False		False	False	The message to the customer that appears in the invoice and in the printed invoice.
RefundReceipt_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.
RefundReceipt_BillAddr_Line1	String	False		False	False	First line of the address.
RefundReceipt_BillAddr_Line2	String	False		False	False	Second line of the address.
RefundReceipt_BillAddr_Line3	String	False		False	False	Third line of the address.
RefundReceipt_BillAddr_Line4	String	False		False	False	Fourth line of the address.
RefundReceipt_BillAddr_Line5	String	False		False	False	Fifth line of the address.
RefundReceipt_BillAddr_City	String	False		False	False	City name.
RefundReceipt_BillAddr_Country	String	False		False	False	Country name.
RefundReceipt_BillAddr_CountrySubDivisionCode	String	False		False	False	Region within a country. For example, the state name for the USA or the province name for Canada.
RefundReceipt_BillAddr_PostalCode	String	False		False	False	Postal code. For example, the zip code for the USA and Canada.
RefundReceipt_BillAddr_Note	String	False		False	False	Note for the customer.
RefundReceipt_BillAddr_Lat	String	False		False	False	The latitude coordinate of the geocoded billing address.
RefundReceipt_BillAddr_Long	String	False		False	False	The longitude coordinate of the geocoded billing address.
RefundReceipt_ShipAddr_Id	String	False		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.
RefundReceipt_ShipAddr_Line1	String	False		False	False	First line of the address.
RefundReceipt_ShipAddr_Line2	String	False		False	False	Second line of the address.
RefundReceipt_ShipAddr_Line3	String	False		False	False	Third line of the address.
RefundReceipt_ShipAddr_Line4	String	False		False	False	Fourth line of the address.
RefundReceipt_ShipAddr_Line5	String	False		False	False	Fifth line of the address.
RefundReceipt_ShipAddr_City	String	False		False	False	City name.
RefundReceipt_ShipAddr_Country	String	False		False	False	Country name.
RefundReceipt_ShipAddr_CountrySubDivisionCode	String	False		False	False	Region within a country. For example, the state name for the USA or the province name for Canada.
RefundReceipt_ShipAddr_PostalCode	String	False		False	False	Postal code. For example, the zip code for the USA and Canada.
RefundReceipt_ShipAddr_Note	String	False		False	False	Note for the customer.
RefundReceipt_ShipAddr_Lat	String	False		False	False	The latitude coordinate of the geocoded shipping address.
RefundReceipt_ShipAddr_Long	String	False		False	False	The longitude coordinate of the geocoded shipping address.
RefundReceipt_ClassRef	String	False	Class.Id	False	False	The Id of the class associated with the transaction.
RefundReceipt_ClassRef_Name	String	True	Class.FullyQualifiedName	False	False	The name of the class associated with the transaction.
RefundReceipt_CheckPayment_CheckNum	String	True		False	False	The check number printed on the check.
RefundReceipt_CheckPayment_Status	String	False		False	False	Status of the check. Values provided by service/business logic.
RefundReceipt_CheckPayment_NameOnAccount	String	False		False	False	Name of persons or entities holding the account, as printed on the check.
RefundReceipt_CheckPayment_AcctNum	String	False		False	False	Checking account number, as printed on the check.
RefundReceipt_CheckPayment_BankName	String	True		False	False	The name of the bank on which the check was drawn.
RefundReceipt_CreditCardPayment_CreditChargeInfo_Type	String	False		False	False	The type of credit card.
RefundReceipt_CreditCardPayment_CreditChargeInfo_NameOnAcct	String	False		False	False	The name of the account holder, as printed on the card.
RefundReceipt_CreditCardPayment_CreditChargeInfo_CcExpiryMonth	Integer	False		False	False	The expiration month of the card.
RefundReceipt_CreditCardPayment_CreditChargeInfo_CcExpiryYear	Integer	False		False	False	The four-digit expiration year of the card.
RefundReceipt_CreditCardPayment_CreditChargeInfo_BillAddrStreet	String	False		False	False	The street of the billing address of the credit card holder.
RefundReceipt_CreditCardPayment_CreditChargeInfo_PostalCode	String	False		False	False	The postal code.
RefundReceipt_CreditCardPayment_CreditChargeInfo_Amount	Decimal	False		False	False	The amount processed using the credit card
RefundReceipt_CreditCardPayment_CreditChargeInfo_ProcessPayment	Boolean	False		False	False	False or no value-Store credit card information only.True-Store credit card payment transaction information in CreditChargeResponse below.
RefundReceipt_CreditCardPayment_CreditChargeResponse_CCTransId	String	False		False	False	Unique identifier of the payment transaction.
RefundReceipt_CreditCardPayment_CreditChargeResponse_AuthCode	String	False		False	False	Code returned from the credit card processor to indicate that the charge will be paid by the card issuer.
RefundReceipt_CreditCardPayment_CreditChargeResponse_TxnAuthorizationTime	Datetime	False		False	False	Timestamp indicating the time in which the card processor authorized the transaction.
RefundReceipt_CreditCardPayment_CreditChargeResponse_Status	String	False		False	False	Indicates the status of the payment transaction. Possible values include Completed, Unknown.
RefundReceipt_SalesTermRef	String	False	Terms.Id	False	False	The Id of the sales term associated with the transaction.
RefundReceipt_SalesTermRef_Name	String	True	Terms.Name	False	False	The name of the sales term associated with the transaction.
RefundReceipt_DueDate	Date	False		True	False	The date when the invoice is to be paid, not including any early payment discount incentives or late payment penalties. If the date is not supplied, the current date on the server is used.
RefundReceipt_ShipMethodRef	String	False		False	False	The Id of the shipping method associated with the transaction.
RefundReceipt_ShipMethodRef_Name	String	True		False	False	The name of the shipping method associated with the transaction.
RefundReceipt_ShipDate	Date	False		False	False	The date for delivery of goods or services.
RefundReceipt_TotalAmt	Decimal	True		True	True	This field indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes.
RefundReceipt_ApplyTaxAfterDiscount	Boolean	False		False	False	This field sets whether discounts are applied before the tax is calculated.
RefundReceipt_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.
RefundReceipt_DepartmentRef_Name	String	True	Departments.Name	False	False	The name of the department, which store the location of the transaction as defined using location tracking in QuickBooks Online.
RefundReceipt_PrintStatus	String	False		False	False	The print status of the invoice. The allowed values are NotSet, NeedToPrint, PrintComplete.
RefundReceipt_BillEmail_Address	String	False		False	False	This field identifies the email address where the invoice is sent. If the value of EmailStatus is NeedToSend, BillEmail is a required input.
RefundReceipt_Balance	Decimal	False		False	False	This field indicates whether the transaction is a finance charge.
RefundReceipt_PaymentMethodRef	String	False	PaymentMethods.Id	False	False	The Id of the payment method associated with the transaction.
RefundReceipt_PaymentMethodRef_Name	String	True	PaymentMethods.Name	False	False	The name of the payment method associated with the transaction.
RefundReceipt_PaymentRefNum	String	False		False	False	The reference number for the payment received.
RefundReceipt_PaymentType	String	False		False	False	The type of payment used for the transaction. The allowed values are Cash, Check, CreditCard, Other.
RefundReceipt_DepositToAccountRef	String	False	Accounts.Id	False	False	The asset account where the payment money is deposited. If you do not specify this account, QuickBooks Online uses the Undeposited Funds account.
RefundReceipt_DepositToAccountRef_Name	String	True	Accounts.Name	False	False	The 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.
RefundReceipt_CurrencyRef	String	False		False	False	The Id of the currency used in the transaction. This field is valid in the UK, AU, and CA editions.
RefundReceipt_CurrencyRef_Name	String	False		False	False	The name of the currency in which all amounts on the associated transaction are expressed. This field is valid in the UK, AU, and CA editions.
RefundReceipt_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, and CA editions.
RefundReceipt_GlobalTaxCalculation	String	False		False	False	The method in which tax is applied. This field is valid in the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable.
RefundReceipt_HomeTotalAmt	Decimal	True		False	False	Total amount of the transaction in the home currency. Includes the total of all the charges, allowances, and taxes. This field is valid in the UK, AU, and CA editions.

RecurringSalesReceiptTransactions

Create and query QuickBooks Recurring Transaction for Sales Receipt.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
SalesReceipt_Id [KEY]	String	True		True	True	The Id of the sales receipt.
SalesReceipt_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.
SalesReceipt_MetaData_CreateTime	Datetime	True		True	True	The time the record was created.
SalesReceipt_MetaData_LastUpdatedTime	Datetime	True		True	True	The time the record was last updated.
SalesReceipt_CustomFieldAggregate	String	False		False	False	An XML aggregate of custom fields associated with the transaction.
SalesReceipt_DocNumber	String	False		True	True	Reference number for the transaction.
SalesReceipt_TxnDate	Date	False		True	True	The date when this transaction occurred.
SalesReceipt_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.
SalesReceipt_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.
SalesReceipt_PrivateNote	String	False		False	False	The private note about the transaction. This note will not appear on the transaction records by default.
SalesReceipt_TxnStatus	String	False		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.
SalesReceipt_LinkedTxnAggregate	String	False		False	False	Zero or more linked transactions.
SalesReceipt_RecurDataRef	String	False		False	False	The Recurrence Data reference.
SalesReceipt_RecurDataRef_Name	String	True		False	False	An identifying name for the object.
SalesReceipt_RecurringInfo_Name	String	False		False	False	The Recurring Info name.
SalesReceipt_RecurringInfo_RecurType	String	False		False	False	The Recurring Info recurring type. The allowed values are Automated, Reminded, UnScheduled.
SalesReceipt_RecurringInfo_Active	Boolean	False		False	False	The Recurring Info is active or not.
SalesReceipt_RecurringInfo_ScheduleInfo_IntervalType	String	False		False	False	The Recurring Info interval type. The allowed values are Yearly, Monthly, Weekly, Daily.
SalesReceipt_RecurringInfo_ScheduleInfo_NumInterval	Integer	False		False	False	The Recurring Info num interval.
SalesReceipt_RecurringInfo_ScheduleInfo_DayOfWeek	String	False		False	False	The Recurring Info day of week.
SalesReceipt_RecurringInfo_ScheduleInfo_WeekOfMonth	String	False		False	False	The Recurring Info week of month.
SalesReceipt_RecurringInfo_ScheduleInfo_MaxOccurrences	String	False		False	False	The max number of recurring occurrences.
SalesReceipt_RecurringInfo_ScheduleInfo_RemindDays	String	False		False	False	The days before start date for a reminded RecurType.
SalesReceipt_RecurringInfo_ScheduleInfo_MonthOfYear	String	False		False	False	The month of the year.
SalesReceipt_RecurringInfo_ScheduleInfo_DaysBefore	String	False		False	False	The days before the scheduled date.
SalesReceipt_RecurringInfo_ScheduleInfo_DayOfMonth	String	False		False	False	The day of the month.
SalesReceipt_RecurringInfo_ScheduleInfo_StartDate	Datetime	False		False	False	The Recurring Info start date.
SalesReceipt_RecurringInfo_ScheduleInfo_NextDate	Datetime	False		False	False	The Recurring Info next date.
SalesReceipt_RecurringInfo_ScheduleInfo_EndDate	Datetime	False		False	False	The end date for the recurring schedule.
SalesReceipt_RecurringInfo_ScheduleInfo_PreviousDate	Datetime	False		False	False	The Recurring Info previous date.
SalesReceipt_LineAggregate	String	False		False	False	Zero or more lines for the transaction.
SalesReceipt_TxnTaxDetail_TxnTaxCodeRef	String	False	TaxCodes.Id	False	False	The transaction tax code.
SalesReceipt_TxnTaxDetail_TotalTax	String	False		False	False	Total tax calculated for the transaction, excluding any tax lines manually inserted into the transaction line list.
SalesReceipt_TxnTaxDetail_TaxLineAggregate	String	False		False	False	An XML aggregate of tax line items.
SalesReceipt_CustomerRef	String	False	Customers.Id	True	False	The Id of the customer.
SalesReceipt_CustomerRef_Name	String	True	Customers.DisplayName	False	False	The name of the customer.
SalesReceipt_CustomerMemo	String	False		False	False	The message to the customer.
SalesReceipt_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.
SalesReceipt_BillAddr_Line1	String	False		False	False	First line of the address.
SalesReceipt_BillAddr_Line2	String	False		False	False	Second line of the address.
SalesReceipt_BillAddr_Line3	String	False		False	False	Third line of the address.
SalesReceipt_BillAddr_Line4	String	False		False	False	Fourth line of the address.
SalesReceipt_BillAddr_Line5	String	False		False	False	Fifth line of the address.
SalesReceipt_BillAddr_City	String	False		False	False	City name.
SalesReceipt_BillAddr_Country	String	False		False	False	Country name.
SalesReceipt_BillAddr_CountrySubDivisionCode	String	False		False	False	Region within a country. For example, the state name for the USA and the province name for Canada.
SalesReceipt_BillAddr_PostalCode	String	False		False	False	Postal code. For example, the zip code for the USA and Canada.
SalesReceipt_BillAddr_Note	String	False		False	False	The note for the customer.
SalesReceipt_BillAddr_Lat	String	False		False	False	Latitude coordinate of the geocoded address.
SalesReceipt_BillAddr_Long	String	False		False	False	Longitude coordinate of the geocoded address.
SalesReceipt_ShipAddr_Id	String	False		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.
SalesReceipt_ShipAddr_Line1	String	False		False	False	First line of the address.
SalesReceipt_ShipAddr_Line2	String	False		False	False	Second line of the address.
SalesReceipt_ShipAddr_Line3	String	False		False	False	Third line of the address.
SalesReceipt_ShipAddr_Line4	String	False		False	False	Fourth line of the address.
SalesReceipt_ShipAddr_Line5	String	False		False	False	Fifth line of the address.
SalesReceipt_ShipAddr_City	String	False		False	False	City name.
SalesReceipt_ShipAddr_Country	String	False		False	False	Country name.
SalesReceipt_ShipAddr_CountrySubDivisionCode	String	False		False	False	Region within a country. For example, the state name for the USA and the province name for Canada.
SalesReceipt_ShipAddr_PostalCode	String	False		False	False	Postal code. For example, the zip code for the USA and Canada.
SalesReceipt_ShipAddr_Note	String	False		False	False	Note for the customer.
SalesReceipt_ShipAddr_Lat	String	False		False	False	Latitude coordinate of the geocoded address.
SalesReceipt_ShipAddr_Long	String	False		False	False	Longitude coordinate of the geocoded address.
SalesReceipt_ClassRef	String	False	Class.Id	True	False	The Id of the class associated with the transaction.
SalesReceipt_ClassRef_Name	String	True	Class.FullyQualifiedName	False	False	The name of the class associated with the transaction.
SalesReceipt_ShipMethodRef	String	False		False	False	The Id of the shipping method associated with the transaction.
SalesReceipt_ShipMethodRef_Name	String	True		False	False	The name of the shipping method associated with the transaction.
SalesReceipt_ShipDate	Date	False		False	False	Date for delivery of goods or services.
SalesReceipt_TrackingNum	String	False		False	False	The tracking number of the shipping provider for the delivery of the goods associated with the transaction.
SalesReceipt_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.
SalesReceipt_PrintStatus	String	False		False	False	The print status of the invoice. The allowed values are NotSet, NeedToPrint, PrintComplete. The default value is NotSet.
SalesReceipt_EmailStatus	String	False		False	False	The email status of the invoice. The allowed values are NotSet, NeedToSend, EmailSent. The default value is NotSet.
SalesReceipt_BillEmail_Address	String	False		False	False	The email address where the sales receipt is sent.
SalesReceipt_Balance	Decimal	True		True	True	The balance reflecting any payments made against the transaction.
SalesReceipt_PaymentRefNum	String	False		False	False	The reference number for the payment.
SalesReceipt_PaymentMethodRef	String	False	PaymentMethods.Id	False	False	The Id of the payment method.
SalesReceipt_PaymentMethodRef_Name	String	True	PaymentMethods.Name	False	False	The name of the payment method.
SalesReceipt_DepositToAccountRef	String	False	Accounts.Id	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.
SalesReceipt_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, QBO uses the Undeposited Funds account.
SalesReceipt_ApplyTaxAfterDiscount	Boolean	False		False	False	This field sets whether discounts are applied before the tax is calculated.
SalesReceipt_CurrencyRef	String	False		False	False	The Id of the currency used in the transaction.
SalesReceipt_CurrencyRef_Name	String	True		False	False	The name of the currency used in the transaction.
SalesReceipt_ExchangeRate	Decimal	False		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, and CA editions.
SalesReceipt_GlobalTaxCalculation	String	False		False	False	Method in which tax is applied. This field is valid in the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable.
SalesReceipt_HomeTotalAmt	Decimal	False		False	False	Total amount of the transaction in the home currency. This field is valid in the UK, AU, and CA editions.

RecurringSalesReceiptTransactionsLineItems

Create and query QuickBooks Recurring Transaction for Sales Receipt Line Items.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
SalesReceipt_LineId [KEY]	String	True		False	False	The Id of the line item on the sales receipt.
SalesReceipt_SalesReceiptId [KEY]	String	False	SalesReceipts.Id	True	True	The Id of the sales receipt.
SalesReceipt_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.
SalesReceipt_MetaData_CreateTime	Datetime	True		True	True	The time the record was created.
SalesReceipt_MetaData_LastUpdatedTime	Datetime	True		True	True	The time the record was last updated.
SalesReceipt_CustomFieldAggregate	String	False		False	False	An XML aggregate of custom fields associated with the transaction.
SalesReceipt_DocNumber	String	False		True	True	The reference number for the transaction.
SalesReceipt_TxnDate	Date	False		True	True	The date when this transaction occurred.
SalesReceipt_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.
SalesReceipt_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.
SalesReceipt_PrivateNote	String	False		False	False	A private note about the transaction. This note will not appear on the transaction records by default.
SalesReceipt_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.
SalesReceipt_LinkedTxnAggregate	String	False		False	False	An XML aggregate of the transactions linked to the line item.
SalesReceipt_Line_Id	String	False		False	False	The Id of the line item.
SalesReceipt_Line_LineNum	String	False		False	False	The number of the line item.
SalesReceipt_Line_Description	String	False		False	False	A description of the line item that appears in the printed record.
SalesReceipt_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.
SalesReceipt_Line_DetailType	String	False		False	False	The line detail type. Different detail types indicate different types of line items.
SalesReceipt_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.
SalesReceipt_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.
SalesReceipt_Line_SalesItemLineDetail_ClassRef	String	False	Class.Id	False	False	The Id of the entity for the class for the line item.
SalesReceipt_Line_SalesItemLineDetail_ClassRef_Name	String	True	Class.FullyQualifiedName	False	False	The name of the class for the line item.
SalesReceipt_Line_SalesItemLineDetail_UnitPrice	Decimal	False		False	False	The unit price of the item referenced by ItemRef.
SalesReceipt_Line_SalesItemLineDetail_Qty	Decimal	False		False	False	The number of items for the line.
SalesReceipt_Line_SalesItemLineDetail_TaxCodeRef	String	False	TaxCodes.Id	False	False	The tax code for this item.
SalesReceipt_Line_SalesItemLineDetail_ServiceDate	Date	False		False	False	The date when the service is performed.
SalesReceipt_Line_GroupLineDetail_GroupItemRef	String	True		False	False	The Id of the group item object.
SalesReceipt_Line_GroupLineDetail_GroupItemRef_Name	String	True		False	False	The name of the group item object.
SalesReceipt_Line_GroupLineDetail_Quantity	Integer	True		False	False	The amount of the group item.
SalesReceipt_TxnTaxDetail_TxnTaxCodeRef	String	False	TaxCodes.Id	False	False	The transaction tax code.
SalesReceipt_TxnTaxDetail_TotalTax	String	False		False	False	Total tax calculated for the transaction, excluding any tax lines manually inserted into the transaction line list.
SalesReceipt_TxnTaxDetail_TaxLineAggregate	String	False		False	False	An XML aggregate of tax line items.
SalesReceipt_RecurDataRef	String	False		False	False	The Recurrence Data reference.
SalesReceipt_RecurDataRef_Name	String	True		False	False	An identifying name for the object.
SalesReceipt_RecurringInfo_Name	String	False		False	False	The Recurring Info name.
SalesReceipt_RecurringInfo_RecurType	String	False		False	False	The Recurring Info recurring type. The allowed values are Automated, Reminded, UnScheduled.
SalesReceipt_RecurringInfo_Active	Boolean	False		False	False	The Recurring Info is active or not.
SalesReceipt_RecurringInfo_ScheduleInfo_IntervalType	String	False		False	False	The Recurring Info interval type. The allowed values are Yearly, Monthly, Weekly, Daily.
SalesReceipt_RecurringInfo_ScheduleInfo_NumInterval	Integer	False		False	False	The Recurring Info num interval.
SalesReceipt_RecurringInfo_ScheduleInfo_DayOfWeek	String	False		False	False	The Recurring Info day of week.
SalesReceipt_RecurringInfo_ScheduleInfo_WeekOfMonth	String	False		False	False	The Recurring Info week of month.
SalesReceipt_RecurringInfo_ScheduleInfo_MaxOccurrences	String	False		False	False	The max number of recurring occurrences.
SalesReceipt_RecurringInfo_ScheduleInfo_RemindDays	String	False		False	False	The days before start date for a reminded RecurType.
SalesReceipt_RecurringInfo_ScheduleInfo_MonthOfYear	String	False		False	False	The month of the year.
SalesReceipt_RecurringInfo_ScheduleInfo_DaysBefore	String	False		False	False	The days before the scheduled date.
SalesReceipt_RecurringInfo_ScheduleInfo_DayOfMonth	String	False		False	False	The day of the month.
SalesReceipt_RecurringInfo_ScheduleInfo_StartDate	Datetime	False		False	False	The Recurring Info start date.
SalesReceipt_RecurringInfo_ScheduleInfo_NextDate	Datetime	False		False	False	The Recurring Info next date.
SalesReceipt_RecurringInfo_ScheduleInfo_EndDate	Datetime	False		False	False	The end date for the recurring schedule.
SalesReceipt_RecurringInfo_ScheduleInfo_PreviousDate	Datetime	False		False	False	The Recurring Info previous date.
SalesReceipt_CustomerRef	String	False	Customers.Id	True	False	The Id of the customer.
SalesReceipt_CustomerRef_Name	String	True	Customers.DisplayName	False	False	The name of the customer.
SalesReceipt_CustomerMemo	String	False		False	False	The message to the customer.
SalesReceipt_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.
SalesReceipt_BillAddr_Line1	String	False		False	False	First line of the address.
SalesReceipt_BillAddr_Line2	String	False		False	False	Second line of the address.
SalesReceipt_BillAddr_Line3	String	False		False	False	Third line of the address.
SalesReceipt_BillAddr_Line4	String	False		False	False	Fourth line of the address.
SalesReceipt_BillAddr_Line5	String	False		False	False	Fifth line of the address.
SalesReceipt_BillAddr_City	String	False		False	False	City name.
SalesReceipt_BillAddr_Country	String	False		False	False	Country name.
SalesReceipt_BillAddr_CountrySubDivisionCode	String	False		False	False	Region within a country. For example, the state name for the USA and the province name for Canada.
SalesReceipt_BillAddr_PostalCode	String	False		False	False	Postal code. For example, the zip code for the USA and Canada.
SalesReceipt_BillAddr_Note	String	False		False	False	Note for the customer.
SalesReceipt_BillAddr_Lat	String	False		False	False	Latitude coordinate of the geocoded address.
SalesReceipt_BillAddr_Long	String	False		False	False	Longitude coordinate of the geocoded address.
SalesReceipt_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.
SalesReceipt_ShipAddr_Line1	String	False		False	False	First line of the address.
SalesReceipt_ShipAddr_Line2	String	False		False	False	Second line of the address.
SalesReceipt_ShipAddr_Line3	String	False		False	False	Third line of the address.
SalesReceipt_ShipAddr_Line4	String	False		False	False	Fourth line of the address.
SalesReceipt_ShipAddr_Line5	String	False		False	False	Fifth line of the address.
SalesReceipt_ShipAddr_City	String	False		False	False	City name.
SalesReceipt_ShipAddr_Country	String	False		False	False	Country name.
SalesReceipt_ShipAddr_CountrySubDivisionCode	String	False		False	False	Region within a country. For example, the state name for the USA and the province name for Canada.
SalesReceipt_ShipAddr_PostalCode	String	False		False	False	Postal code. For example, the zip code for the USA and Canada.
SalesReceipt_ShipAddr_Note	String	False		False	False	Note for the customer.
SalesReceipt_ShipAddr_Lat	String	False		False	False	Latitude coordinate of the geocoded address.
SalesReceipt_ShipAddr_Long	String	False		False	False	Longitude coordinate of the geocoded address.
SalesReceipt_ClassRef	String	False	Class.Id	True	False	The Id of the class associated with the transaction.
SalesReceipt_ClassRef_Name	String	True	Class.FullyQualifiedName	False	False	The name of the class associated with the transaction.
SalesReceipt_ShipMethodRef	String	False		False	False	The Id of the shipping method associated with the transaction.
SalesReceipt_ShipMethodRef_Name	String	True		False	False	The name of the shipping method associated with the transaction.
SalesReceipt_ShipDate	Date	False		False	False	The date for delivery of goods or services.
SalesReceipt_TrackingNum	String	False		False	False	The tracking number for the shipping provider for the delivery of the goods associated with the transaction.
SalesReceipt_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.
SalesReceipt_PrintStatus	String	False		False	False	The print status of the invoice. The allowed values are NotSet, NeedToPrint, PrintComplete. The default value is NotSet.
SalesReceipt_EmailStatus	String	False		False	False	The email status of the invoice. The allowed values are NotSet, NeedToSend, EmailSent. The default value is NotSet.
SalesReceipt_BillEmail_Address	String	False		False	False	The email address where the sales receipt is sent.
SalesReceipt_Balance	Decimal	True		True	True	The balance reflecting any payments made against the transaction.
SalesReceipt_PaymentRefNum	String	False		False	False	The reference number for the payment.
SalesReceipt_PaymentMethodRef	String	False	PaymentMethods.Id	False	False	The Id of the payment method entity.
SalesReceipt_PaymentMethodRef_Name	String	True	PaymentMethods.Name	False	False	The name of the payment method entity.
SalesReceipt_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.
SalesReceipt_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.
SalesReceipt_ApplyTaxAfterDiscount	Boolean	False		False	False	This field sets whether discounts are applied before the tax is calculated.
SalesReceipt_CurrencyRef	String	False		False	False	The Id of the currency used in the transaction.
SalesReceipt_CurrencyRef_Name	String	True		False	False	The name of the currency used in the transaction.
SalesReceipt_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, and CA editions.
SalesReceipt_GlobalTaxCalculation	String	False		False	False	Method in which tax is applied. This field is valid in the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable.
SalesReceipt_HomeTotalAmt	Decimal	False		False	False	Total amount of the transaction in the home currency. This field is valid in the UK, AU, and CA editions.

RecurringTransferTransactions

Create and query QuickBooks Recurring Transactions for Transfers

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Transfer_Id [KEY]	String	True		True	True	The Id of the payment.
Transfer_TxnDate	Date	False		True	True	The date entered by the user when this transaction occurred.
Transfer_PrivateNote	String	False		False	False	User entered, organization-private note about the transaction.
Transfer_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.
Transfer_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.
Transfer_TxnStatus	String	False		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.
Transfer_LinkedTxnAggregate	String	False		False	False	Zero or more linked transactions.
Transfer_RecurDataRef	String	False		False	False	The Recurrence Data reference.
Transfer_RecurDataRef_Name	String	True		False	False	An identifying name for the object.
Transfer_RecurringInfo_Name	String	False		False	False	The Recurring Info name.
Transfer_RecurringInfo_RecurType	String	False		False	False	The Recurring Info recurring type. The allowed values are Automated, Reminded, UnScheduled.
Transfer_RecurringInfo_Active	Boolean	False		False	False	The Recurring Info is active or not.
Transfer_RecurringInfo_ScheduleInfo_IntervalType	String	False		False	False	The Recurring Info interval type. The allowed values are Yearly, Monthly, Weekly, Daily.
Transfer_RecurringInfo_ScheduleInfo_NumInterval	Integer	False		False	False	The Recurring Info num interval.
Transfer_RecurringInfo_ScheduleInfo_DayOfWeek	String	False		False	False	The Recurring Info day of week.
Transfer_RecurringInfo_ScheduleInfo_WeekOfMonth	String	False		False	False	The Recurring Info week of month.
Transfer_RecurringInfo_ScheduleInfo_MaxOccurrences	String	False		False	False	The max number of recurring occurrences.
Transfer_RecurringInfo_ScheduleInfo_RemindDays	String	False		False	False	The days before start date for a reminded RecurType.
Transfer_RecurringInfo_ScheduleInfo_MonthOfYear	String	False		False	False	The month of the year.
Transfer_RecurringInfo_ScheduleInfo_DaysBefore	String	False		False	False	The days before the scheduled date.
Transfer_RecurringInfo_ScheduleInfo_DayOfMonth	String	False		False	False	The day of the month.
Transfer_RecurringInfo_ScheduleInfo_StartDate	Datetime	False		False	False	The Recurring Info start date.
Transfer_RecurringInfo_ScheduleInfo_NextDate	Datetime	False		False	False	The Recurring Info next date.
Transfer_RecurringInfo_ScheduleInfo_EndDate	Datetime	False		False	False	The end date for the recurring schedule.
Transfer_RecurringInfo_ScheduleInfo_PreviousDate	Datetime	False		False	False	The Recurring Info previous date.
Transfer_FromAccountRef	String	False	Accounts.Id	False	False	The account Id from which the funds were transfered.
Transfer_FromAccountRef_Name	String	False	Accounts.Name	False	False	The account Name from which the funds were transfered.
Transfer_ToAccountRef	String	False	Accounts.Id	False	False	The account Id to which the funds were transfered.
Transfer_ToAccountRef_Name	String	False	Accounts.Name	False	False	The account Name to which the funds were transfered.
Transfer_Amount	Decimal	False		False	False	The total amount of the transaction
Transfer_CurrencyRef	String	False		False	False	The Id of the currency used in the transaction.
Transfer_CurrencyRef_Name	String	True		False	False	The name of the currency used in the transaction.
Transfer_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.
Transfer_MetaData_CreateTime	Datetime	True		True	True	The time the record was created.
Transfer_MetaData_LastUpdatedTime	Datetime	True		True	True	The time the record was last updated.

RecurringVendorCreditTransactions

Create and query QuickBooks Recurring Transactions for Vendor Credits.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
VendorCredit_Id [KEY]	String	True		True	True	The Id of the vendor credit.
VendorCredit_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.
VendorCredit_MetaData_CreateTime	Datetime	True		True	True	The time the record was created.
VendorCredit_MetaData_LastUpdatedTime	Datetime	True		True	True	The time the record was last updated.
VendorCredit_DocNumber	String	False		True	True	The primary document number for this transaction. If it is not provided, QuickBooks business logic will assign the document number using the next-in-sequence algorithm.
VendorCredit_TxnDate	Date	False		True	True	The date of the transaction. Often, but not required to be, this value is the date the transaction was created in the system. For posting transactions, this is the posting date that affects financial statements.
VendorCredit_PrivateNote	String	False		False	False	A private note about the transaction. This note will not appear on the transaction records by default.
VendorCredit_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.
VendorCredit_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.
VendorCredit_TxnStatus	String	False		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.
VendorCredit_LinkedTxnAggregate	String	False		False	False	Zero or more linked transactions.
VendorCredit_RecurDataRef	String	False		False	False	The Recurrence Data reference.
VendorCredit_RecurDataRef_Name	String	True		False	False	An identifying name for the object.
VendorCredit_RecurringInfo_Name	String	False		False	False	The Recurring Info name.
VendorCredit_RecurringInfo_RecurType	String	False		False	False	The Recurring Info recurring type. The allowed values are Automated, Reminded, UnScheduled.
VendorCredit_RecurringInfo_Active	Boolean	False		False	False	The Recurring Info is active or not.
VendorCredit_RecurringInfo_ScheduleInfo_IntervalType	String	False		False	False	The Recurring Info interval type. The allowed values are Yearly, Monthly, Weekly, Daily.
VendorCredit_RecurringInfo_ScheduleInfo_NumInterval	Integer	False		False	False	The Recurring Info num interval.
VendorCredit_RecurringInfo_ScheduleInfo_DayOfWeek	String	False		False	False	The Recurring Info day of week.
VendorCredit_RecurringInfo_ScheduleInfo_WeekOfMonth	String	False		False	False	The Recurring Info week of month.
VendorCredit_RecurringInfo_ScheduleInfo_MaxOccurrences	String	False		False	False	The max number of recurring occurrences.
VendorCredit_RecurringInfo_ScheduleInfo_RemindDays	String	False		False	False	The days before start date for a reminded RecurType.
VendorCredit_RecurringInfo_ScheduleInfo_MonthOfYear	String	False		False	False	The month of the year.
VendorCredit_RecurringInfo_ScheduleInfo_DaysBefore	String	False		False	False	The days before the scheduled date.
VendorCredit_RecurringInfo_ScheduleInfo_DayOfMonth	String	False		False	False	The day of the month.
VendorCredit_RecurringInfo_ScheduleInfo_StartDate	Datetime	False		False	False	The Recurring Info start date.
VendorCredit_RecurringInfo_ScheduleInfo_NextDate	Datetime	False		False	False	The Recurring Info next date.
VendorCredit_RecurringInfo_ScheduleInfo_EndDate	Datetime	False		False	False	The end date for the recurring schedule.
VendorCredit_RecurringInfo_ScheduleInfo_PreviousDate	Datetime	False		False	False	The Recurring Info previous date.
VendorCredit_LineAggregate	String	False		False	False	An XML aggregate of the individual line item entries contained in the vendor credit.
VendorCredit_VendorRef	String	False	Vendors.Id	True	False	The Id of the vendor.
VendorCredit_VendorRef_Name	String	True	Vendors.DisplayName	False	False	The name of the vendor.
VendorCredit_APAccountRef	String	False	Accounts.Id	True	True	The accounts-payable account the bill is credited to. If the company has a single accounts-payable account, this account is implied. When specified, the account must be a Liability account and the subtype must be of type Payables.
VendorCredit_APAccountRef_Name	String	True	Accounts.Name	False	False	The accounts-payable account to which the bill is credited. If the company has a single accounts-payable account, this account is implied. When specified, the account must be a Liability account and the subtype must be of type Payables.
VendorCredit_TotalAmt	Decimal	False		True	True	The total amount due, determined by the sum of the line item amounts. This includes all charges, allowances, taxes, and discounts.
VendorCredit_CurrencyRef	String	False		False	False	The Id of the currency used in the transaction.
VendorCredit_CurrencyRef_Name	String	True		False	False	The name of the currency used in the transaction.
VendorCredit_ExchangeRate	Decimal	False		False	False	Currency exchange rate. Valid only if the company file is set up to use 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, and CA editions.
VendorCredit_GlobalTaxCalculation	String	False		False	False	Method in which tax is applied. This field is valid in the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable.

RecurringVendorCreditTransactionsLineItems

Create and query QuickBooks Recurring Transactions for Vendor Credit Line Items.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
VendorCredit_LineId [KEY]	String	True		False	True	The Id of the line item on the vendor credit.
VendorCredit_VendorCreditId [KEY]	String	False	VendorCredits.Id	True	False	The Id of the vendor credit.
VendorCredit_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.
VendorCredit_MetaData_CreateTime	Datetime	True		True	True	The time the record was created.
VendorCredit_MetaData_LastUpdatedTime	Datetime	True		True	True	The time the record was last updated.
VendorCredit_DocNumber	String	False		True	True	The primary document number for this transaction. If it is not provided, QuickBooks business logic will assign the document number using the next-in-sequence algorithm.
VendorCredit_TxnDate	Date	False		True	True	The date of the transaction. Often, but not required to be, this value is the date the transaction was created in the system. For posting transactions, this is the posting date that affects financial statements
VendorCredit_PrivateNote	String	False		False	False	A private note about the transaction. This note will not appear on the transaction records by default.
VendorCredit_DepartmentRef	String	False	Departments.Id	False	False	The reference number for the transaction.
VendorCredit_DepartmentRef_Name	String	True	Departments.Name	False	False	The reference number for the transaction.
VendorCredit_Line_Id	String	False		False	False	The Id of the line item.
VendorCredit_Line_Description	String	False		False	False	The description of the line item that appears in the printed record.
VendorCredit_Line_Amount	Decimal	False		False	False	Total amount of the charges or discounts for the given line item. Includes the charges and allowances, but it excludes the tax amount.
VendorCredit_Line_DetailType	String	False		False	False	The detail type of the line item.
VendorCredit_Line_AccountBasedExpenseLineDetail_CustomerRef	String	False	Customers.Id	False	False	The Id of the customer in the expense.
VendorCredit_Line_AccountBasedExpenseLineDetail_CustomerRef_Name	String	True	Customers.DisplayName	False	False	The name of the customer in the expense.
VendorCredit_Line_AccountBasedExpenseLineDetail_ClassRef	String	False	Class.Id	False	False	The Id of the class for the expense.
VendorCredit_Line_AccountBasedExpenseLineDetail_ClassRef_Name	String	True	Class.FullyQualifiedName	False	False	The name of the class for the expense.
VendorCredit_Line_AccountBasedExpenseLineDetail_AccountRef	String	False	Accounts.Id	False	False	The Id of the account associated with the expense.
VendorCredit_Line_AccountBasedExpenseLineDetail_AccountRef_Name	String	True	Accounts.Name	False	False	The name of the account associated with the expense.
VendorCredit_Line_AccountBasedExpenseLineDetail_BillableStatus	String	False		False	False	The billable status of this type of line item.
VendorCredit_Line_AccountBasedExpenseLineDetail_TaxCodeRef	String	False	TaxCodes.Id	False	False	The reference to the tax code used for this line.
VendorCredit_Line_ItemBasedExpenseLineDetail_ItemRef	String	False	Items.Id	False	False	The Id of the item associated with the expense.
VendorCredit_Line_ItemBasedExpenseLineDetail_ItemRef_Name	String	True	Items.Name	False	False	The name of the item associated with the expense.
VendorCredit_Line_ItemBasedExpenseLineDetail_ClassRef	String	False	Class.Id	False	False	The Id of the class for the expense.
VendorCredit_Line_ItemBasedExpenseLineDetail_ClassRef_Name	String	True	Class.FullyQualifiedName	False	False	The name of the class for the expense.
VendorCredit_Line_ItemBasedExpenseLineDetail_UnitPrice	Decimal	False		False	False	The unit price of the item for the expense.
VendorCredit_Line_ItemBasedExpenseLineDetail_Qty	Double	False		False	False	The number of items for the line.
VendorCredit_Line_ItemBasedExpenseLineDetail_TaxCodeRef	String	False	TaxCodes.Id	False	False	The reference to the tax code used for this line.
VendorCredit_Line_ItemBasedExpenseLineDetail_CustomerRef	String	False	Customers.Id	False	False	The Id of the customer in the expense.
VendorCredit_Line_ItemBasedExpenseLineDetail_CustomerRef_Name	String	True	Customers.DisplayName	False	False	The name of the customer in the expense.
VendorCredit_Line_ItemBasedExpenseLineDetail_BillableStatus	String	False		False	False	The billable status of this type of line item.
VendorCredit_VendorRef	String	False	Vendors.Id	True	False	The Id of the vendor for this transaction.
VendorCredit_VendorRef_Name	String	True	Vendors.DisplayName	False	False	The name of the vendor for this transaction.
VendorCredit_APAccountRef	String	False	Accounts.Id	True	True	The accounts-payable account to which the bill is credited. If the company uses a single accounts-payable account, this account is implied. When specified, the account must be a Liability account and the subtype must be of type Payables.
VendorCredit_APAccountRef_Name	String	True	Accounts.Name	False	False	The accounts-payable account to which the bill is credited. This account is implied if the company uses a single accounts-payable account. When specified, the account must be a Liability account and the subtype must be of type Payables.
VendorCredit_TotalAmt	Decimal	False		True	True	The total amount due, determined by the sum of the line item amounts. This includes all charges, allowances, taxes, and discounts.
VendorCredit_CurrencyRef	String	False		False	False	The Id of the currency used in the transaction.
VendorCredit_CurrencyRef_Name	String	True		False	False	The name of the currency used in the transaction.
VendorCredit_ExchangeRate	Decimal	False		False	False	Currency exchange rate. 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, and CA editions.
VendorCredit_GlobalTaxCalculation	String	False		False	False	Method in which tax is applied. This field is valid in the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable.
VendorCredit_RecurDataRef	String	False		False	False	The Recurrence Data reference.
VendorCredit_RecurDataRef_Name	String	True		False	False	An identifying name for the object.
VendorCredit_RecurringInfo_Name	String	False		False	False	The Recurring Info name.
VendorCredit_RecurringInfo_RecurType	String	False		False	False	The Recurring Info recurring type. The allowed values are Automated, Reminded, UnScheduled.
VendorCredit_RecurringInfo_Active	Boolean	False		False	False	The Recurring Info is active or not.
VendorCredit_RecurringInfo_ScheduleInfo_IntervalType	String	False		False	False	The Recurring Info interval type. The allowed values are Yearly, Monthly, Weekly, Daily.
VendorCredit_RecurringInfo_ScheduleInfo_NumInterval	Integer	False		False	False	The Recurring Info num interval.
VendorCredit_RecurringInfo_ScheduleInfo_DayOfWeek	String	False		False	False	The Recurring Info day of week.
VendorCredit_RecurringInfo_ScheduleInfo_WeekOfMonth	String	False		False	False	The Recurring Info week of month.
VendorCredit_RecurringInfo_ScheduleInfo_MaxOccurrences	String	False		False	False	The max number of recurring occurrences.
VendorCredit_RecurringInfo_ScheduleInfo_RemindDays	String	False		False	False	The days before start date for a reminded RecurType.
VendorCredit_RecurringInfo_ScheduleInfo_MonthOfYear	String	False		False	False	The month of the year.
VendorCredit_RecurringInfo_ScheduleInfo_DaysBefore	String	False		False	False	The days before the scheduled date.
VendorCredit_RecurringInfo_ScheduleInfo_DayOfMonth	String	False		False	False	The day of the month.
VendorCredit_RecurringInfo_ScheduleInfo_StartDate	Datetime	False		False	False	The Recurring Info start date.
VendorCredit_RecurringInfo_ScheduleInfo_NextDate	Datetime	False		False	False	The Recurring Info next date.
VendorCredit_RecurringInfo_ScheduleInfo_EndDate	Datetime	False		False	False	The end date for the recurring schedule.
VendorCredit_RecurringInfo_ScheduleInfo_PreviousDate	Datetime	False		False	False	The Recurring Info previous date.

RefundReceiptLineItems

Create, update, delete, and query QuickBooks RefundReceiptLineItems.

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 Id of the line item of the invoice of the read receipt.
RefundReceiptId [KEY]	String	False	RefundReceipts.Id	True	True	The Id of the read 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.
DocNumber	String	False		True	True	The reference number for the transaction.
TxnDate	Date	False		True	True	The date entered by the user when this transaction occurred.
PrivateNote	String	False		False	False	A private note that does not appear on the transaction records.
Line_Id	String	False		False	False	The Id of the line item.
Line_LineNum	String	False		False	False	The line number of the line item.
Line_Description	String	False		False	False	The description of the line item.
Line_Amount	Decimal	False		False	False	The amount of the line item.
Line_DetailType	String	False		False	False	The detail type of the line item. Different detail types indicate different types of line items.
Line_SalesItemLineDetail_ItemRef	String	False	Items.Id	False	False	The Id of the item in the line item.
Line_SalesItemLineDetail_ItemRef_Name	String	True	Items.Name	False	False	The name of the item in the line item.
Line_SalesItemLineDetail_ClassRef	String	False	Class.Id	False	False	The Id of the class in the line item.
Line_SalesItemLineDetail_ClassRef_Name	String	True	Class.FullyQualifiedName	False	False	The name of the class in the line item.
Line_SalesItemLineDetail_UnitPrice	Decimal	False		False	False	The unit price of the item.
Line_SalesItemLineDetail_Qty	Double	False		False	False	The number of items for the line item.
Line_SalesItemLineDetail_TaxCodeRef	String	False	TaxCodes.Id	False	False	The tax code for the item.
Line_SalesItemLineDetail_ServiceDate	Date	False		False	False	The service date for the item.
TxnTaxDetail_TxnTaxCodeRef	String	False	TaxCodes.Id	False	False	The tax code of the transaction.
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 that appears in the invoice and in the printed invoice.
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 or 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	The latitude coordinate of the geocoded billing address.
BillAddr_Long	String	False		False	False	The longitude coordinate of the geocoded billing address.
ShipAddr_Id	String	False		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	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 or 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	The latitude coordinate of the geocoded shipping address.
ShipAddr_Long	String	False		False	False	The longitude coordinate of the geocoded shipping address.
ClassRef	String	False	Class.Id	False	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.
CheckPayment_CheckNum	String	True		False	False	The check number printed on the check.
CheckPayment_Status	String	False		False	False	Status of the check. Values provided by service/business logic.
CheckPayment_NameOnAccount	String	False		False	False	Name of persons or entities holding the account, as printed on the check.
CheckPayment_AcctNum	String	False		False	False	Checking account number, as printed on the check.
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.
CreditCardPayment_CreditChargeInfo_NameOnAcct	String	False		False	False	The name of the account holder, as printed on the card.
CreditCardPayment_CreditChargeInfo_CcExpiryMonth	Integer	False		False	False	The expiration month of the card.
CreditCardPayment_CreditChargeInfo_CcExpiryYear	Integer	False		False	False	The four-digit expiration year of the card.
CreditCardPayment_CreditChargeInfo_BillAddrStreet	String	False		False	False	The street of the billing address of the credit card holder.
CreditCardPayment_CreditChargeInfo_PostalCode	String	False		False	False	The postal code.
CreditCardPayment_CreditChargeInfo_Amount	Decimal	False		False	False	The amount processed using the credit card
CreditCardPayment_CreditChargeInfo_ProcessPayment	Boolean	False		False	False	False or no value-Store credit card information only.True-Store credit card payment transaction information in CreditChargeResponse below.
CreditCardPayment_CreditChargeResponse_CCTransId	String	False		False	False	Unique identifier of the payment transaction.
CreditCardPayment_CreditChargeResponse_AuthCode	String	False		False	False	Code returned from the credit card processor to indicate that the charge will be paid by the card issuer.
CreditCardPayment_CreditChargeResponse_TxnAuthorizationTime	Datetime	False		False	False	Timestamp indicating the time in which the card processor authorized the transaction.
CreditCardPayment_CreditChargeResponse_Status	String	False		False	False	Indicates the status of the payment transaction. Possible values include Completed, Unknown.
SalesTermRef	String	False	Terms.Id	False	False	The Id of the sales term associated with the transaction.
SalesTermRef_Name	String	True	Terms.Name	False	False	The name of the sales term associated with the transaction.
DueDate	Date	False		True	False	The date when the invoice is to be paid, not including any early payment discount incentives or late payment penalties. If the date is not supplied, the current date on the server is used.
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.
TotalAmt	Decimal	True		True	True	This field indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes.
ApplyTaxAfterDiscount	Boolean	False		False	False	This field sets whether discounts are applied before the tax is calculated.
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 store the location of the transaction as defined using location tracking in QuickBooks Online.
PrintStatus	String	False		False	False	The print status of the invoice. The allowed values are NotSet, NeedToPrint, PrintComplete.
BillEmail_Address	String	False		False	False	This field identifies the email address where the invoice is sent. If the value of EmailStatus is NeedToSend, BillEmail is a required input.
Balance	Decimal	False		False	False	This field indicates whether the transaction is a finance charge.
PaymentMethodRef	String	False	PaymentMethods.Id	False	False	The Id of the payment method associated with the transaction.
PaymentMethodRef_Name	String	True	PaymentMethods.Name	False	False	The name of the payment method associated with the transaction.
PaymentRefNum	String	False		False	False	The reference number for the payment received.
PaymentType	String	False		False	False	The type of payment used for the transaction. The allowed values are Cash, Check, CreditCard, Other.
DepositToAccountRef	String	False	Accounts.Id	False	False	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 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 Id of the currency used in the transaction. This field is valid in the UK, AU, and CA editions.
CurrencyRef_Name	String	False		False	False	The name of the currency in which all amounts on the associated transaction are expressed. This field is valid in the UK, AU, and CA editions.
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, and CA editions.
GlobalTaxCalculation	String	False		False	False	The method in which tax is applied. This field is valid in the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable.
HomeTotalAmt	Decimal	True		False	False	Total amount of the transaction in the home currency. Includes the total of all the charges, allowances, and taxes. This field is valid in the UK, AU, and CA editions.

RefundReceipts

Create, update, delete, and query QuickBooks RefundReceipts.

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

Insert

To add a RefundReceipt, specify a Customer, DepositToAccount and at least one Line Item. The LineAggregate column may be used to specify an XML aggregate of Line Item data. Each _ denotes hierarchy. Use <Line> at the base level. The contents of LineAggregate will be sent to the API as is. All values for each field in the aggregate should adhere to the API's specifications (e.g. for dates in format yyyy-MM-dd, for date times in format yyyy-MM-dd'T'HH:mm:sszzz). The columns that may be used in the aggregates begin with the prefix 'Line_' to indicate they are part of the line item. Use the Line_ column along with the DocNumber to indicate which lines go with which RefundReceipt. For example:

INSERT INTO RefundReceipts (CustomerRef, DepositToAccountRef, LineAggregate) 
VALUES ('15', '35',
<Line><Amount>0.02</Amount><DetailType>SalesItemLineDetail</DetailType><SalesItemLineDetail><ItemRef>2</ItemRef></SalesItemLineDetail></Line>
<Line><Amount>0.02</Amount><DetailType>SalesItemLineDetail</DetailType><SalesItemLineDetail><ItemRef>3</ItemRef></SalesItemLineDetail></Line>
')

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Id [KEY]	String	True		True	True	The Id of the invoice.
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.
DocNumber	String	False		True	True	The reference number for the transaction.
TxnDate	Date	False		True	True	The date entered by the user when this transaction occurred.
PrivateNote	String	False		False	False	A private note that does not appear on the transaction records.
LinkedTxnAggregate	String	False		False	False	An XML aggregate of transactions linked to the refund receipt.
LineAggregate	String	False		False	False	An XML aggregate of line items associated with the transaction.
TxnTaxDetail_TxnTaxCodeRef	String	False	TaxCodes.Id	False	False	The tax code of the transaction.
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 that appears in the invoice and in the printed invoice.
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 or 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	The latitude coordinate of the geocoded billing address.
BillAddr_Long	String	False		False	False	The longitude coordinate of the geocoded billing address.
ShipAddr_Id	String	False		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	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 or 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	The latitude coordinate of the geocoded shipping address.
ShipAddr_Long	String	False		False	False	The longitude coordinate of the geocoded shipping address.
ClassRef	String	False	Class.Id	False	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.
CheckPayment_CheckNum	String	True		False	False	The check number printed on the check.
CheckPayment_Status	String	False		False	False	Status of the check. Values provided by service/business logic.
CheckPayment_NameOnAccount	String	False		False	False	Name of persons or entities holding the account, as printed on the check.
CheckPayment_AcctNum	String	False		False	False	Checking account number, as printed on the check.
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.
CreditCardPayment_CreditChargeInfo_NameOnAcct	String	False		False	False	The name of the account holder, as printed on the card.
CreditCardPayment_CreditChargeInfo_CcExpiryMonth	Integer	False		False	False	The expiration month of the card.
CreditCardPayment_CreditChargeInfo_CcExpiryYear	Integer	False		False	False	The four-digit expiration year of the card.
CreditCardPayment_CreditChargeInfo_BillAddrStreet	String	False		False	False	The street of the billing address of the credit card holder.
CreditCardPayment_CreditChargeInfo_PostalCode	String	False		False	False	The postal code.
CreditCardPayment_CreditChargeInfo_Amount	Decimal	False		False	False	The amount processed using the credit card
CreditCardPayment_CreditChargeInfo_ProcessPayment	Boolean	False		False	False	False or no value-Store credit card information only.True-Store credit card payment transaction information in CreditChargeResponse below.
CreditCardPayment_CreditChargeResponse_CCTransId	String	False		False	False	Unique identifier of the payment transaction.
CreditCardPayment_CreditChargeResponse_AuthCode	String	False		False	False	Code returned from the credit card processor to indicate that the charge will be paid by the card issuer.
CreditCardPayment_CreditChargeResponse_TxnAuthorizationTime	Datetime	False		False	False	Timestamp indicating the time in which the card processor authorized the transaction.
CreditCardPayment_CreditChargeResponse_Status	String	False		False	False	Indicates the status of the payment transaction. Possible values include Completed, Unknown.
SalesTermRef	String	False	Terms.Id	False	False	The Id of the sales term associated with the transaction.
SalesTermRef_Name	String	True	Terms.Name	False	False	The name of the sales term associated with the transaction.
DueDate	Date	False		True	False	The date when the invoice is to be paid, not including any early payment discount incentives or late payment penalties. If the date is not supplied, the current date on the server is used.
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.
TotalAmt	Decimal	True		True	True	This field indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes.
ApplyTaxAfterDiscount	Boolean	False		False	False	This field sets whether discounts are applied before the tax is calculated.
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 store the location of the transaction as defined using location tracking in QuickBooks Online.
PrintStatus	String	False		False	False	The print status of the invoice. The allowed values are NotSet, NeedToPrint, PrintComplete.
BillEmail_Address	String	False		False	False	This field identifies the email address where the invoice is sent. If the value of EmailStatus is NeedToSend, BillEmail is a required input.
Balance	Decimal	False		False	False	This field indicates whether the transaction is a finance charge.
PaymentMethodRef	String	False	PaymentMethods.Id	False	False	The Id of the payment method associated with the transaction.
PaymentMethodRef_Name	String	True	PaymentMethods.Name	False	False	The name of the payment method associated with the transaction.
PaymentRefNum	String	False		False	False	The reference number for the payment received.
PaymentType	String	False		False	False	The type of payment used for the transaction. The allowed values are Cash, Check, CreditCard, Other.
DepositToAccountRef	String	False	Accounts.Id	False	False	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 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 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, and CA editions.
GlobalTaxCalculation	String	False		False	False	The method in which tax is applied. This field is valid in the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable.
HomeTotalAmt	Decimal	True		False	False	Total amount of the transaction in the home currency. Includes the total of all the charges, allowances, and taxes. This field is valid in the UK, AU, and CA editions.

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.

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 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.
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. The allowed values are NotSet, NeedToPrint, PrintComplete. The default value is NotSet.
EmailStatus	String	False		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	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, and CA editions.
GlobalTaxCalculation	String	False		False	False	Method in which tax is applied. This field is valid in the UK, AU, and CA editions. The allowed values are 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, and CA editions.

SalesReceipts

Create, update, delete, and query QuickBooks Sales Receipts.

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

The driver processes other filters client-side within the driver.

Insert

To add a SalesReceipt, specify the Customer, TotalAmt, and at least one Line Item. The LineAggregate column may be used to specify an XML aggregate of Line Item data. Each _ denotes hierarchy. Use <Line> at the base level. The contents of LineAggregate will be sent to the API as is. All values for each field in the aggregate should adhere to the API's specifications (e.g. for dates in format yyyy-MM-dd, for date times in format yyyy-MM-dd'T'HH:mm:sszzz). The columns that may be used in the aggregates begin with the prefix 'Line_' to indicate they are part of the line item. Use the Line_ column along with the DocNumber to indicate which lines go with which SalesReceipts. For example:

INSERT INTO SalesReceipts (CustomerRef, TotalAmt, LineAggregate) 
VALUES ('21', '0.03', '
<Line><Amount>0.01</Amount><DetailType>SalesItemLineDetail</DetailType><SalesItemLineDetail><ItemRef>2</ItemRef></SalesItemLineDetail></Line>
<Line><Amount>0.02</Amount><DetailType>SalesItemLineDetail</DetailType><SalesItemLineDetail><ItemRef>3</ItemRef></SalesItemLineDetail></Line>
')

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Id [KEY]	String	True		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.
DocNumber	String	False		True	True	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	The 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, the acceptable values are defined in PaymentStatusEnum. For estimates, the values accepted are defined in QboEstimateStatusEnum.
LinkedTxnAggregate	String	False		False	False	Zero or more linked transactions.
LineAggregate	String	False		False	False	Zero or more lines for the transaction.
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	The 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	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	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	Date for delivery of goods or services.
TrackingNum	String	False		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	False	The print status of the invoice. The allowed values are NotSet, NeedToPrint, PrintComplete. The default value is NotSet.
EmailStatus	String	False		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	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.
PaymentMethodRef_Name	String	True	PaymentMethods.Name	False	False	The name of the payment method.
DepositToAccountRef	String	False	Accounts.Id	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	Accounts.Name	False	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	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	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, and CA editions.
GlobalTaxCalculation	String	False		False	False	Method in which tax is applied. This field is valid in the UK, AU, and CA editions. The allowed values are 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, and CA editions.

TaxAgency

Create and Query QuickBooks Tax Agency.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Id [KEY]	String	True		True	True	The Id of the sales tax code.
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.
DisplayName	String	False		True	True	The name for the tax agency.
TaxRegistrationNumber	String	True		True	True	The Registration number for the agency
TaxTrackedOnPurchases	Boolean	True		True	False	This field denotes whether this tax agency is used to track tax on purchases.
TaxTrackedOnSales	Boolean	True		True	False	This field denotes whether this tax agency is used to track tax on sales.
LastFileDate	Date	True		False	False	The last tax filing date for this tax agency. This field is automatically populated by QuickBooks business logic at tax filing time.

TaxCodes

Create and query QuickBooks Sales Tax Codes.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Id [KEY]	String	True		True	True	The Id of the sales tax code.
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		False	True	The time the record was created.
MetaData_LastUpdatedTime	Datetime	True		False	True	The time the record was last updated.
Name	String	False		False	True	The name for the tax sales code.
Description	String	False		False	True	A description for the sales tax code. This field must not contain white space or formatting characters.
Active	Boolean	False		False	False	This field sets whether the sales tax code entity is active. Inactive sales tax codes may be hidden from display and are not used on financial transactions.
Taxable	Boolean	False		False	False	This field indicates that the sales tax code signifies a non-taxable entity if false or null (default) or a taxable entity if true.
TaxGroup	Boolean	False		False	False	This field indicates whether the sales tax code is for a tax group.
SalesTaxRateList_TaxRateDetailAggregate	String	False		False	False	An XML aggregate of sales tax rates.
PurchaseTaxRateList_TaxRateDetailAggregate	String	False		False	False	An XML aggregate of purchase tax rates. This field available in only the UK, AU, and CA editions.

Pseudo-Columns

Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
TaxRateDetails	String	Aggregate of TaxRateDetails. Used only for insert.
TaxApplicableOn	String	Specifies where this tax rate can be applied. Possible values are 'Sales' or 'Purchase'.Used only for insert.
TaxRateName	String	Name of a new tax rate.Used only for insert.
TaxAgencyId	String	The Id of the agency to whom tax is paid.Used only for insert.
RateValue	String	The tax rate value.Used only for insert.

TaxRates

Create and query QuickBooks Tax Rates.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Id [KEY]	String	True		True	True	The Id of the tax rate.
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.
Name	String	False		True	False	The name for the tax rate.
Description	String	False		True	True	A description for the sales tax rate. This field must not contain white space or formatting characters.
Active	Boolean	False		True	False	This field sets whether the tax rate is active. This value is false if inactive. Inactive sales tax codes may be hidden from display and are not used on financial transactions.
RateValue	String	False		True	True	The value of the tax rate.
AgencyRef	String	False	TaxAgency.Id	True	True	The Id of the tax agency.
AgencyRef_Name	String	True	TaxAgency.DisplayName	False	False	The name of the tax agency.
TaxReturnLineRef	String	False		True	True	The Id of the tax return line.
TaxReturnLineRef_Name	String	True		False	False	The name of the tax return line.
SpecialTaxType	String	False		False	False	The special tax type to handle zero-rate taxes. VAT-registered businesses who receive goods, services, or acquisitions from other EU countries will need to calculate the VAT due, but not paid, on these acquisitions. The rate of VAT that is payable is the same that would have been paid if the goods had been supplied by a UK supplier.
DisplayType	String	False		False	False	The display type of the tax rate. This field is used to configure display settings.
EffectiveTaxRate	Double	False		False	False	The effective tax rate. This field is used to know which tax rate is applicable on any date.

Pseudo-Columns

Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
TaxRateDetails	String	The Tax Rate Details.Used only for insert.
TaxCode	String	The name for the tax code.Used only for insert.
TaxApplicableOn	String	The Tax rate applicability. Values can be 'Sales or 'Purchase'. Used only for Insert.

Terms

Create, update, delete, and query QuickBooks Terms.

Table Specific Information

Select

All filterable columns support the following operators:

=
!=
>=
<=
>
<
IN
LIKE
CONTAINS

The driver processes other filters client-side within the driver.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Id [KEY]	String	True		True	True	The Id of the term.
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.
Name	String	False		True	False	The name for the term.
Active	Boolean	False		True	False	This field sets whether this entity is currently enabled for use by QuickBooks.
Type	String	False		False	False	The type of the sales term.
DiscountPercent	Double	False		False	False	The discount percentage available against an amount if paid within the days specified by DiscountDays.
DueDays	Integer	False		False	False	Number of days from delivery of goods or services until the payment is due.
DiscountDays	Integer	False		False	False	The discount applies if paid within this number of days.
DayOfMonthDue	Integer	False		False	False	The payment must be received by this day of the month.
DueNextMonthDays	Integer	False		False	False	The payment is due next month if it was issued the specified number of days before the value of DayOfMonthDue.
DiscountDayOfMonth	Integer	False		False	False	The discount applies if paid before this day of month.

TimeActivities

Create, update, delete, and query QuickBooks Time Activities.

Note: The CostRate column will not return data unless MinorVersion is set to 65 or above.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Id [KEY]	String	True		True	False	The Id of the time activity.
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.
TxnDate	Date	False		True	True	The date of the time activity.
NameOf	String	False		False	False	The type of the person who performs the task. The allowed values are Employee, Vendor.
EmployeeRef	String	False	Employees.Id	False	False	The Id of the employee. Either the EmployeeId or EmployeeName is required for the create operation. EmployeeId is preferred.
EmployeeRef_Name	String	True	Employees.DisplayName	False	False	The fully qualified name for an employee. A fully qualified name starts with the employee name followed by a colon and the employee subentry name. Up to 5 additional subemployees can be declared by appending a colon and subentry name. For example: Store54:Shane Hamby.
VendorRef	String	False	Vendors.Id	False	False	The Id vendor associated with the transaction. A reference either the VendorId or VendorName is required for the create operation, although VendorId is preferred.
VendorRef_Name	String	True	Vendors.DisplayName	False	False	The fully qualified name for a vendor. A fully qualified name starts with the name followed by a colon and the subentry name. Up to five levels of subentries can be defined by appending a colon and name for the subentry. For example: Rock Construction:Building Materials.
CustomerRef	String	False	Customers.Id	False	False	The Id of the customer receiving the goods or services. For example, if the transaction is associated with a job or project, such as John Doe:Kitchen, this Id must reference John Doe.
CustomerRef_Name	String	True	Customers.DisplayName	False	False	The fully qualified name for a customer or organization. A fully qualified name starts with the customer name followed by a colon and the subcustomer name. Up to five additional subcustomers can be defined by appending a colon and the name of the subcustomer. For example: Rock Construction:Sammuels.
DepartmentRef	String	False	Departments.Id	False	False	The Id of the department.
DepartmentRef_Name	String	True	Departments.Name	False	False	The name of the department.
ItemRef	String	False	Items.Id	False	False	The Id of the item. This field is required in create commands.
ItemRef_Name	String	True	Items.Name	False	False	The name of item. This field is required in create commands.
ClassRef	String	False	Class.Id	False	False	Reference type of all Ids that are taken as input or output.
ClassRef_Name	String	True	Class.FullyQualifiedName	False	False	Reference type of all Ids that are taken as input or output.
PayrollItemRef	String	False		False	False	Specifies how much the employee should be paid for doing the work specified by the Compensation Id.
BillableStatus	String	False		False	False	Billable status of the time activity. The allowed values are Billable, NotBillable, HasBeenBilled.
Taxable	Boolean	False		False	False	This value is true if the time activity recorded is both billable and taxable.
HourlyRate	Decimal	False		False	False	Hourly bill rate of the employee or vendor for this time activity.
Hours	Integer	False		False	False	Hours worked.
Minutes	Integer	False		False	False	Minutes worked. Valid values are 0 - 59.
StartTime	Datetime	False		False	False	Time work started.
EndTime	Datetime	False		False	False	Time work ended.
Description	String	False		False	False	Description of work completed during the time activity.
TransactionLocationType	String	False		False	False	The account location. This field is valid in only the FR editions. The allowed values are WithinFrance, FranceOverseas, OutsideFranceWithEU, OutsideEU.
CostRate	Decimal	False		False	False	Pay rate of the employee or vendor for this time activity.

Transfers

Create, update, delete, and query QuickBooks Transfers

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Id [KEY]	String	True		True	True	The Id of the payment.
TxnDate	Date	False		True	True	The date entered by the user when this transaction occurred.
PrivateNote	String	False		False	False	User entered, organization-private note about the transaction.
FromAccountRef	String	False	Accounts.Id	False	False	The account Id from which the funds were transfered.
FromAccountRef_Name	String	False	Accounts.Name	False	False	The account Name from which the funds were transfered.
ToAccountRef	String	False	Accounts.Id	False	False	The account Id to which the funds were transfered.
ToAccountRef_Name	String	False	Accounts.Name	False	False	The account Name to which the funds were transfered.
Amount	Decimal	False		False	False	The total amount of the transaction
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.
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.
TransactionLocationType	String	False		False	False	The account location. This field is valid in only the FR editions. The allowed values are WithinFrance, FranceOverseas, OutsideFranceWithEU, OutsideEU.

VendorCreditLineItems

Create, update, delete, and query QuickBooks Vendor Credit Line Items.

Table Specific Information

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

INSERT INTO VendorCreditLineItems#TEMP (VendorRef, Line_Amount, Line_DetailType, Line_AccountBasedExpenseLineDetail_CustomerRef, Line_AccountBasedExpenseLineDetail_AccountRef, TotalAmt) VALUES ('21', 0.01, 'AccountBasedExpenseLineDetail', '4', '41', 0.03)
INSERT INTO VendorCreditLineItems#TEMP (VendorRef, Line_Amount, Line_DetailType, Line_AccountBasedExpenseLineDetail_CustomerRef, Line_AccountBasedExpenseLineDetail_AccountRef, TotalAmt) VALUES ('21', 0.02, 'AccountBasedExpenseLineDetail', '4', '41', 0.03)
INSERT INTO VendorCreditLineItems (VendorRef, Line_Amount, Line_DetailType, Line_AccountBasedExpenseLineDetail_CustomerRef, Line_AccountBasedExpenseLineDetail_AccountRef, TotalAmt) SELECT VendorRef, Line_Amount, Line_DetailType, Line_AccountBasedExpenseLineDetail_CustomerRef, Line_AccountBasedExpenseLineDetail_AccountRef, TotalAmt FROM VendorCreditLineItems#TEMP

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
LineId [KEY]	String	True		False	True	The Id of the line item on the vendor credit.
VendorCreditId [KEY]	String	False	VendorCredits.Id	True	False	The Id of the vendor credit.
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.
DocNumber	String	False		True	True	The primary document number for this transaction. If it is not provided, QuickBooks business logic will assign the document number using the next-in-sequence algorithm.
TxnDate	Date	False		True	True	The date of the transaction. Often, but not required to be, this value is the date the transaction was created in the system. For posting transactions, this is the posting date that affects financial statements
PrivateNote	String	False		False	False	A private note about the transaction. This note will not appear on the transaction records by default.
DepartmentRef	String	False	Departments.Id	False	False	The reference number for the transaction.
DepartmentRef_Name	String	True	Departments.Name	False	False	The reference number for the transaction.
Line_Id	String	False		False	False	The Id of the line item.
Line_Description	String	False		False	False	The 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 item. Includes the charges and allowances, but it excludes the tax amount.
Line_DetailType	String	False		False	False	The detail type of the line item.
Line_AccountBasedExpenseLineDetail_CustomerRef	String	False	Customers.Id	False	False	The Id of the customer in the expense.
Line_AccountBasedExpenseLineDetail_CustomerRef_Name	String	True	Customers.DisplayName	False	False	The name of the customer in the expense.
Line_AccountBasedExpenseLineDetail_ClassRef	String	False	Class.Id	False	False	The Id of the class for the expense.
Line_AccountBasedExpenseLineDetail_ClassRef_Name	String	True	Class.FullyQualifiedName	False	False	The name of the class for the expense.
Line_AccountBasedExpenseLineDetail_AccountRef	String	False	Accounts.Id	False	False	The Id of the account associated with the expense.
Line_AccountBasedExpenseLineDetail_AccountRef_Name	String	True	Accounts.Name	False	False	The name of the account associated with the expense.
Line_AccountBasedExpenseLineDetail_BillableStatus	String	False		False	False	The billable status of this type of line item.
Line_AccountBasedExpenseLineDetail_TaxCodeRef	String	False	TaxCodes.Id	False	False	The reference to the tax code used for this line.
Line_ItemBasedExpenseLineDetail_ItemRef	String	False	Items.Id	False	False	The Id of the item associated with the expense.
Line_ItemBasedExpenseLineDetail_ItemRef_Name	String	True	Items.Name	False	False	The name of the item associated with the expense.
Line_ItemBasedExpenseLineDetail_ClassRef	String	False	Class.Id	False	False	The Id of the class for the expense.
Line_ItemBasedExpenseLineDetail_ClassRef_Name	String	True	Class.FullyQualifiedName	False	False	The name of the class for the expense.
Line_ItemBasedExpenseLineDetail_UnitPrice	Decimal	False		False	False	The unit price of the item for the expense.
Line_ItemBasedExpenseLineDetail_Qty	Double	False		False	False	The number of items for the line.
Line_ItemBasedExpenseLineDetail_TaxCodeRef	String	False	TaxCodes.Id	False	False	The reference to the tax code used for this line.
Line_ItemBasedExpenseLineDetail_CustomerRef	String	False	Customers.Id	False	False	The Id of the customer in the expense.
Line_ItemBasedExpenseLineDetail_CustomerRef_Name	String	True	Customers.DisplayName	False	False	The name of the customer in the expense.
Line_ItemBasedExpenseLineDetail_BillableStatus	String	False		False	False	The billable status of this type of line item.
VendorRef	String	False	Vendors.Id	True	False	The Id of the vendor for this transaction.
VendorRef_Name	String	True	Vendors.DisplayName	False	False	The name of the vendor for this transaction.
APAccountRef	String	False	Accounts.Id	True	True	The accounts-payable account to which the bill is credited. If the company uses a single accounts-payable account, this account is implied. When specified, the account must be a Liability account and the subtype must be of type Payables.
APAccountRef_Name	String	True	Accounts.Name	False	False	The accounts-payable account to which the bill is credited. This account is implied if the company uses a single accounts-payable account. When specified, the account must be a Liability account and the subtype must be of type Payables.
TotalAmt	Decimal	False		True	True	The total amount due, determined by the sum of the line item amounts. This includes all charges, allowances, taxes, and discounts.
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	Currency exchange rate. 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, and CA editions.
GlobalTaxCalculation	String	False		False	False	Method in which tax is applied. This field is valid in the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable.

VendorCredits

Create, update, delete, and query QuickBooks Vendor Credits.

Table Specific Information

VendorCredits may be inserted, queried, or updated via the VendorCredits or VendorCreditLineItems tables. VendorCredits may be deleted by using the VendorCredits 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 VendorCredit, specify a Vendor, TotalAmt, and at least one Line Item. The LineAggregate column may be used to specify an XML aggregate of Line Item data. Each _ denotes hierarchy. Use <Line> at the base level. The contents of LineAggregate will be sent to the API as is. All values for each field in the aggregate should adhere to the API's specifications (e.g. for dates in format yyyy-MM-dd, for date times in format yyyy-MM-dd'T'HH:mm:sszzz). The columns that may be used in the aggregates begin with the prefix 'Line_' to indicate they are part of the line item. Use the Line_ column along with the DocNumber to indicate which lines go with which VendorCredits. For example:

INSERT INTO VendorCredits (VendorRef, TotalAmt, LineAggregate) 
VALUES ('21', '0.03', '
<Line><Amount>0.01</Amount><DetailType>AccountBasedExpenseLineDetail</DetailType><AccountBasedExpenseLineDetail><CustomerRef>4</CustomerRef><AccountRef>41</AccountRef></AccountBasedExpenseLineDetail></Line>
<Line><Amount>0.02</Amount><DetailType>AccountBasedExpenseLineDetail</DetailType><AccountBasedExpenseLineDetail><CustomerRef>4</CustomerRef><AccountRef>41</AccountRef></AccountBasedExpenseLineDetail></Line>
')

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Id [KEY]	String	True		True	True	The Id of the vendor credit.
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.
DocNumber	String	False		True	True	The primary document number for this transaction. If it is not provided, QuickBooks business logic will assign the document number using the next-in-sequence algorithm.
TxnDate	Date	False		True	True	The date of the transaction. Often, but not required to be, this value is the date the transaction was created in the system. For posting transactions, this is the posting date that affects financial statements.
PrivateNote	String	False		False	False	A private note about the transaction. This note will not appear on the transaction records by default.
DepartmentRef	String	False	Departments.Id	False	False	The Id of the department, which stores the location of the transaction.
DepartmentRef_Name	String	True	Departments.Name	False	False	The name of the department, which stores the location of the transaction.
LineAggregate	String	False		False	False	An XML aggregate of the individual line item entries contained in the vendor credit.
VendorRef	String	False	Vendors.Id	True	False	The Id of the vendor.
VendorRef_Name	String	True	Vendors.DisplayName	False	False	The name of the vendor.
APAccountRef	String	False	Accounts.Id	True	True	The accounts-payable account the bill is credited to. If the company has a single accounts-payable account, this account is implied. When specified, the account must be a Liability account and the subtype must be of type Payables.
APAccountRef_Name	String	True	Accounts.Name	False	False	The accounts-payable account to which the bill is credited. If the company has a single accounts-payable account, this account is implied. When specified, the account must be a Liability account and the subtype must be of type Payables.
TotalAmt	Decimal	False		True	True	The total amount due, determined by the sum of the line item amounts. This includes all charges, allowances, taxes, and discounts.
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	Currency exchange rate. Valid only if the company file is set up to use 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, and CA editions.
GlobalTaxCalculation	String	False		False	False	Method in which tax is applied. This field is valid in the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable.
TransactionLocationType	String	False		False	False	The account location. This field is valid in only the FR editions. The allowed values are WithinFrance, FranceOverseas, OutsideFranceWithEU, OutsideEU.

Vendors

Create, update, delete, and query QuickBooks Vendors.

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Id [KEY]	String	True		True	True	The Id of the vendor.
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	False		True	True	The time the record was created.
MetaData_LastUpdatedTime	Datetime	False		True	True	The time the record was last updated.
Title	String	False		False	False	Title of a person.
GivenName	String	False		True	True	Given name or first name of a person.
MiddleName	String	False		True	True	Middle name of the person.
FamilyName	String	False		True	True	Family name or last name of the person.
Suffix	String	False		False	True	Suffix of the name.
DisplayName	String	False		True	True	The name of the vendor, as displayed.
CompanyName	String	False		True	True	The name of the company associated with the vendor.
PrintOnCheckName	String	False		True	True	Name of the person or organization as printed on a check
Active	Boolean	False		True	False	This field sets whether the vendor is currently enabled for use by QuickBooks.
PrimaryPhone_FreeFormNumber	String	False		False	False	Primary phone number.
AlternatePhone_FreeFormNumber	String	False		False	False	Alternate phone number.
Mobile_FreeFormNumber	String	False		False	False	The mobile phone number.
Fax_FreeFormNumber	String	False		False	False	Fax number.
PrimaryEmailAddr_Address	String	False		False	False	Email address of the vendor.
WebAddr_URI	String	False		False	False	Website address.
BillAddr_Id	String	False		False	False	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_Lat	String	False		False	False	Latitude coordinate of the geocoded address.
BillAddr_Long	String	False		False	False	Longitude coordinate of the geocoded address.
OtherContactInfo_Type	String	False		False	False	The type of contact information.
OtherContactInfo_Telephone_FreeFormNumber	String	False		False	False	Telephone number information.
TaxIdentifier	String	False		False	False	Tax Id of the vendor.
TermRef	String	False	Terms.Id	False	False	The Id of a term associated with the vendor.
TermRef_Name	String	True	Terms.Name	False	False	A name that identifies a term associated with the vendor.
Balance	String	False		True	True	The amount the company owes to this vendor. For the create operation, this represents the opening balance or the unpaid amount for the vendor. When returned in response to the query request it represents the current open balance or unpaid amount for that vendor.
AcctNum	String	False		False	False	Name or number of the account associated with this vendor.
Vendor1099	Boolean	False		False	False	This field specifies that the vendor is an independent contractor who is given a 1099-MISC form at the end of the year. The 1099 vendor is paid with regular checks and taxes are not withheld on their behalf.
CurrencyRef	String	False		False	False	The Id of the currency used in all the business transactions created for or received from that vendor.
CurrencyRef_Name	String	True		False	False	The name of the currency used in all the business transactions created for or received from that vendor.

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

CData Cloud - QuickBooks Online Views


Name	Description
BalanceSheetSummaryReport	The QuickBooks report BalanceSheet.
CreditCardPayments	Query QuickBooks Credit Card Payments.
CustomerBalanceDetail	The QuickBooks report CustomerBalanceDetail.
CustomerTypes	Query QuickBooks Customer Types.
Entitlements	Retrieves QuickBooks Entitlements.
GetDeletedAsView	Retrieve deleted records of a given entity like Customer, Invoice, BillPayment etc.
RecurringBillTransactions	Query QuickBooks Recurring Transaction for Bills.
Thresholds	Retrieves QuickBooks Thresholds.

BalanceSheetSummaryReport

The QuickBooks report BalanceSheet.

Columns


Name	Type	References	Description
Account	String		A column for Account containing Account data.
Total	Decimal		A column for Total containing Money data.
RowType	String		A column for Type of the row.
RowGroup	String		A column for Group of the row.

Pseudo-Columns

Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
DateMacro	String		A predefined date range. Use this if you want the report to cover a standard report date range. Otherwise, use the StartDate and EndDate to cover an explicit range. The allowed values are Today, Yesterday, This Week, This Week-to-date, Last Week, Last Week-to-date, Next Week, Next 4 Weeks, This Month, This Month-to-date, Last Month, Last Month-to-date, Next Month, This Fiscal Quarter, This Fiscal Year, This Fiscal Year-to-date, Last Fiscal Year, Last Fiscal Year-to-date, Next Fiscal Year.
StartDate	String		The startdate of the report. StartDate must be less than EndDate.
EndDate	String		The enddate of the report. EndDate must be greater than StartDate.
AccountingMethod	String		The accounting method used in the report. The allowed values are Cash, Accrual.
Customer	String		Filters report contents to include information for specified customers. This is a comma separated list (spaces omitted after/before separating comma) of one or more Customer IDs.
Department	String		Filters report contents to include information for specified departments if so configured in the company file. This is a comma separated list (spaces omitted after/before separating comma) of one or more Department IDs.
Vendor	String		Filters report contents to include information for specified vendors. This is a comma separated list (spaces omitted after/before separating comma) of one or more Vendor IDs.
Class	String		Filters report contents to include information for specified classes if so configured in the company file. This is a comma separated list (spaces omitted after/before separating comma) of one or more Class IDs.
Item	String		Filters report contents to include information for specified items. This is a comma separated list (spaces omitted after/before separating comma) of one or more Item IDs.
Indentation	Boolean		Add spaces at the start of values to visually identify totals and group values.

CreditCardPayments

Query QuickBooks Credit Card Payments.

View Specific Information

Select

This view will retrieve all the credit card payments from the user's account.

SELECT * FROM CreditCardPayments WHERE Id = '1234'

SELECT * FROM CreditCardPayments WHERE TxnDate > '2020-01-01'

Columns


Name	Type	References	Description
Id [KEY]	String		The Id of the credit card payment.
SyncToken	String		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		Time the entity was created in the source domain.
MetaData_LastUpdatedTime	Datetime		Time the entity was last updated in the source domain.
TxnDate	Date		The date entered by the user when this transaction occurred.
CurrencyRef	String		The currency entered by the user when this transaction occurred.
ExchangeRate	Decimal		The exchange rate when this transaction occurred.
CreditCardAccountRef	String		Identifies the credit card account to which funds are transfered.
BankAccountRef	String		Identifies the bank account from which funds are transfered.
Amount	Decimal		Indicates the total amount of the transaction.

CustomerBalanceDetail

The QuickBooks report CustomerBalanceDetail.

Columns


Name	Type	References	Description
Label	String		A column for Label.
ReportDate	String		A column for Date. If used as a filter it will retrieve the records up to the specified date.
TransactionType	String		A column for TransactionType containing String data.
Num	String		A column for Num containing String data.
DueDate	String		A column for Due_Date containing Date data.
Amount	Decimal		A column for Amount containing Money data.
OpenBalance	Decimal		A column for OpenBalance containing Money data.
Balance	Decimal		A column for Balance containing Money data.
RowType	String		A column for Type of the row.
RowGroup	String		A column for Group of the row.

Pseudo-Columns

Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
AgingMethod	String		The date upon which aging is determined. The allowed values are Report_Date, Current.
ARPaid	String		The accounts receivable paid status. The allowed values are All, Paid, Unpaid. The default value is Unpaid.
Customer	String		Filters report contents to include information for specified customers. This is a comma separated list (spaces omitted after/before separating comma) of one or more Customer IDs.
Department	String		Filters report contents to include information for specified departments if so configured in the company file. This is a comma separated list (spaces omitted after/before separating comma) of one or more Department IDs.
ShipVia	String		Filter by the shipping method as specified in Invoice's ShipMethodRef. This is the name of the shipping method.
Term	String		Filters report contents to include information for specified term or terms supplied. This is a comma separated list (spaces omitted after/before separating comma) of one or more Term IDs.

CustomerTypes

Query QuickBooks Customer Types.

Columns


Name	Type	References	Description
Id [KEY]	String		The Id of the customer type.
MetaData_CreateTime	Datetime		The time the record was created.
MetaData_LastUpdatedTime	Datetime		The time the record was last updated.
Name	String		The full name of the customer type.
Active	Boolean		This field indicates whether the customer type is currently enabled for use by QuickBooks.

Entitlements

Retrieves QuickBooks Entitlements.

Columns


Name	Type	References	Description
Id [KEY]	String		The Id of the entitlement.
Name	String		The name of the entitlement.
Term	String		The term associated with the entitlement.

GetDeletedAsView

Retrieve deleted records of a given entity like Customer, Invoice, BillPayment etc.

GetDeletedAsView is capable of retrieving the ID and deletion time of QuickBooks Online entities such as Customer, Invoice, BillPayment, though it is not capable of retrieving this information about their children. LineItems are a common example of children, where BillPaymentLineItem is a child of BillPayment. This is a limitation of the QuickBooks Online API.

EntityName is required to be specified in the WHERE clause of a query for this view. Note that EntityName refers to the QuickBooks Online API name, rather than the table name that CData provides. For example, the Vendors table represents Vendor entities. Please refer to the QuickBooks Online API Reference for all entity names.

The following query retrieves deleted record information for the 'Customer' entity:

SELECT * FROM GetDeletedAsView WHERE EntityName = 'Customer'

Columns


Name	Type	References	Description
Id [KEY]	Long		The Id of the deleted entity.
EntityName	String		The name of deleted entity.
DeletedTime	Datetime		The date and time when the record was deleted.

RecurringBillTransactions

Query QuickBooks Recurring Transaction for Bills.

Table Specific Information

We can perform Select operation on RecurringBillTransactions table.

Select

Bill_Id, Bill_MetaData_CreateTime, Bill_MetaData_LastUpdatedTime can be used for server side filter. The driver processes other filters client-side within the driver.

SELECT * FROM RecurringBillTransactions;
SELECT * FROM RecurringBillTransactions WHERE bill_id = 25544
SELECT * FROM RecurringBillTransactions WHERE bill_MetaData_CreateTime = '2020-12-28 23:07:26'
SELECT * FROM RecurringBillTransactions WHERE bill_MetaData_LastUpdatedTime = '2020-12-30 14:47:54'
SELECT * FROM RecurringBillTransactions WHERE bill_id = 25538 AND bill_MetaData_CreateTime = '2020-12-28 23:07:26' AND bill_MetaData_LastUpdatedTime = '2020-12-30 14:47:54'

Columns


Name	Type	References	Description
Bill_Id [KEY]	String		The Id of the Recurring Transaction.
Bill_SyncToken	String		The Version number of the object.
Bill_MetaData_CreateTime	Datetime		The time the record was created.
Bill_MetaData_LastUpdatedTime	Datetime		The time the record was last updated.
Bill_CurrencyRef	String		The Id of the currency used in the transaction.
Bill_CurrencyRef_Name	String		The currency used in the transaction.
Bill_TotalAmt	Decimal		The total bill amount.
Bill_APAccountRef_Name	String		The account reference name.
Bill_APAccountRef	String		The account reference value.
Bill_Sparse	Boolean		The Recurring transaction is sparse or not.
Bill_VendorRef_Name	String		The vendor reference name.
Bill_VendorRef	String		The vendor reference value.
Bill_SalesTermRef_Name	String		The sales reference name.
Bill_SalesTermRef	String		The sales reference value.
Bill_Balance	Decimal		The transaction balance.
Bill_LineAggregate	String		An XML aggregate of the line items of a transaction.
Bill_RecurringInfo_Name	String		The Recurring Info name.
Bill_RecurDataRef	String		The recurring data reference value.
Bill_RecurringInfo_RecurType	String		The Recurring Info recurring type.
Bill_RecurringInfo_Active	Boolean		The Recurring Info is active or not.
Bill_RecurringInfo_ScheduleInfo_IntervalType	String		The Recurring Info interval type.
Bill_RecurringInfo_ScheduleInfo_NumInterval	Integer		The Recurring Info num interval.
Bill_RecurringInfo_ScheduleInfo_DayOfWeek	String		The Recurring Info day of week.
Bill_RecurringInfo_ScheduleInfo_DayOfMonth	String		The Recurring Info day of month.
Bill_RecurringInfo_ScheduleInfo_WeekOfMonth	String		The Recurring Info week of month.
Bill_RecurringInfo_ScheduleInfo_StartDate	Datetime		The Recurring Info start date.
Bill_RecurringInfo_ScheduleInfo_NextDate	Datetime		The Recurring Info next date.
Bill_RecurringInfo_ScheduleInfo_PreviousDate	Datetime		The Recurring Info previous date.
Bill_RecurringInfo_ScheduleInfo_MaxOccurrences	String		The max number of recurring occurrences.
Bill_RecurringInfo_ScheduleInfo_RemindDays	String		The days before start date for a reminded RecurType.
Bill_RecurringInfo_ScheduleInfo_MonthOfYear	String		The month of the year.
Bill_RecurringInfo_ScheduleInfo_DaysBefore	String		The days before the scheduled date.
Bill_RecurringInfo_ScheduleInfo_EndDate	Datetime		The end date for the recurring schedule.

Thresholds

Retrieves QuickBooks Thresholds.

View Specific Information

Select

This view will retrieve the threshold entries for the all the entitlements of the user's account.

SELECT * FROM Thresholds

Columns


Name	Type	References	Description
Name	String		The name of the threshold.
Limit	String		The upper limit for the threshold.
Enforced	String		Whether the threshold is enforced.
CurrentCount	String		Indicates current value of attribute.
AboveThreshold	String		Indicate whether the current count of the attribute has reached its limit.

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with QuickBooks Online.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from QuickBooks Online, along with an indication of whether the procedure succeeded or failed.

CData Cloud - QuickBooks Online Stored Procedures


Name	Description
CreateAccountListReport	Generates an Account list report schema file.
CreateAPAgingDetailReport	Generates an A/P Aging Detail report schema file.
CreateAPAgingSummaryReport	Generates an A/P Aging Summary report schema file.
CreateARAgingDetailReport	Generates an A/R Aging Detail report schema file.
CreateARAgingSummaryReport	Generates an A/R Aging Summary report schema file.
CreateBalanceSheetSummaryReport	Generates a Balance Sheet Summary report schema file.
CreateCustomerBalanceDetailReport	Generates a Customer Balance detail report schema file.
CreateCustomerBalanceReport	Generates a Customer Balance report schema file.
CreateCustomerIncomeReport	Generates a Customer Income report schema file.
CreateCustomerSalesReport	Generates a Sales by Customer Summary report schema file.
CreateExpensesByVendorReport	Generates an Expenses by Vendor report schema file.
CreateGeneralLedgerDetailReport	Generates a General Ledger Detail report schema file.
CreateInventoryValuationSummaryReport	Generates an Inventory Valuation Summary report schema file.
CreateJournalReport	Generates a Journal report schema file.
CreateProfitAndLossDetailReport	Generates a Profit and Loss Detail report schema file.
CreateProfitAndLossSummaryReport	Generates a Profit and Loss Summary report schema file.
CreateSalesByClassReport	Generates a Sales by Class report schema file.
CreateSalesByDepartmentReport	Generates a Sales by Department report schema file.
CreateSalesByProductReport	Generates a Sales by Product report schema file.
CreateStatementOfCashFlowReport	Generates a Statement of Cash Flow report schema file.
CreateTransactionListReport	Generates a Transaction List report schema file.
CreateTransactionListWithSplitsReport	Generates an Account list report schema file.
CreateTrialBalanceReport	Generates a Trial Balance report schema file.
CreateVendorBalanceDetailReport	Generates a Vendor Balance Detail report schema file.
CreateVendorBalanceReport	Generates a Vendor Balance report schema file.
SendInvoice	Send linked payment Invoices via Email
VoidInvoice	To void an existing invoice object

CreateAccountListReport

Generates an Account list report schema file.

Stored Procedure Specific Information

QuickBooks Online allows only a small subset of columns to be used in the Exec query. All the columns are optional for this Stored Procedure.

For example:

To create the RSD file, it will be generated based on the value of the Location connection property.

EXECUTE CreateAccountListReport

To return BASE64 encoded data in FileData column.

EXECUTE CreateAccountListReport WriteToFile	= 'False'

Input


Name	Type	Description
ReportName	String	The name of the report. The default value is AccountListReport.
ReportDescription	String	A description for the report. If one is not specified, a description based on the ReportType will be selected.
WriteToFile	String	Whether to write to an output file or not. Defaults to true, must be set to false to write to FileStream or FileData.

Result Set Columns


Name	Type	Description
Result	String	Success or Failure.
SchemaFile	String	The generated schema file.
Columns	String	The number of columns found.
FileData	String	The BASE64 downloaded file content. Only returned if WriteToFile set to false and FileStream is not set.

CreateAPAgingDetailReport

Generates an A/P Aging Detail report schema file.

Input


Name	Type	Description
ReportName	String	The name of the report. The default value is APAgingDetailReport.
ReportDescription	String	A description for the report. If one is not specified, a description based on the ReportType will be selected.
AccountingMethod	String	The accounting method used in the report. The allowed values are Cash, Accrual.
AgingPeriod	String	The number of days in the aging period.
Columns	String	Column types to be shown in the report. A comma separated list of one or more of the following: create_by, create_date, doc_num, due_date, last_mod_by, last_mod_date, memo, past_due, term_name, tx_date, txn_type, vend_bill_addr, vend_comp_name, vend_name, vend_pri_cont, vend_pri_email, vend_pri_tel. Additional columns with location tracking enabled: dept_name. In addition to the above, the following values are supported based on the multicurrency setting for the company. Multicurrency disabled: subt_net_open_bal, subt_neg_amount. Multicurrency enabled: currency, exch_rate, neg_foreign_open_bal, subt_neg_home_open_bal, neg_foreign_amount, subt_neg_home_amount. Default=tx_date,txn_type,doc_num,vend_name,dept_name,due_date,past_due,subt_neg_amount,subt_net_open_bal
NumPeriods	String	The number of periods to be shown in the report.
PastDue	String	Filters report contents based on minimum days past due.
ReportDate	String	Start date to use for the report.
ShipVia	String	Filter by the shipping method as specified in Invoice's ShipMethodRef. This is the name of the shipping method.
StartDueDate	String	The startdate of which the recievables are due. StartDueDate must be less than EndDueDate.
EndDueDate	String	The enddate of which the recievables are due. EndDueDate must be greater than StartDueDate.
Term	String	Filters report contents to include information for specified term or terms supplied. This is a comma separated list (spaces omitted after/before separating comma) of one or more Term IDs.
Vendor	String	Filters report contents to include information for specified vendors. This is a comma separated list (spaces omitted after/before separating comma) of one or more Vendor IDs.
Indentation	String	Add spaces at the start of values to visually identify totals and group values.
WriteToFile	String	Whether to write to an output file or not. Defaults to true, must be set to false to write to FileStream or FileData.

Result Set Columns


Name	Type	Description
Result	String	Success or Failure.
SchemaFile	String	The generated schema file.
Columns	String	The number of columns found.
FileData	String	The BASE64 downloaded file content. Only returned if WriteToFile set to false and FileStream is not set.

CreateAPAgingSummaryReport

Generates an A/P Aging Summary report schema file.

Input


Name	Type	Description
ReportName	String	The name of the report. The default value is APAgingSummaryReport.
ReportDescription	String	A description for the report. If one is not specified, a description based on the ReportType will be selected.
AgingMethod	String	The date upon which aging is determined. The allowed values are Report_Date, Current.
Customer	String	Filters report contents to include information for specified customers. This is a comma separated list (spaces omitted after/before separating comma) of one or more Customer IDs
DateMacro	String	A predefined date range. Use this if you want the report to cover a standard report date range. Otherwise, use the StartDate and EndDate to cover an explicit range. The allowed values are Today, Yesterday, This Week, This Week-to-date, Last Week, Last Week-to-date, Next Week, Next 4 Weeks, This Month, This Month-to-date, Last Month, Last Month-to-date, Next Month, This Fiscal Quarter, This Fiscal Year, This Fiscal Year-to-date, Last Fiscal Year, Last Fiscal Year-to-date, Next Fiscal Year.
Department	String	Filters report contents to include information for specified departments if so configured in the company file. This is a comma separated list (spaces omitted after/before separating comma) of one or more Department IDs.
ReportDate	String	Start date to use for the report.
SummarizeColumnsBy	String	The criteria by which to group the report results. The allowed values are Total, Month, Week, Days, Quarter, Year, Customers, Vendors, Classes, Departments, Employees, ProductsAndServices.
Vendor	String	Filters report contents to include information for specified vendors. This is a comma separated list (spaces omitted after/before separating comma) of one or more Vendor IDs.
WriteToFile	String	Whether to write to an output file or not. Defaults to true, must be set to false to write to FileStream or FileData.
NumPeriods	String	The number of periods to be shown in the report.

Result Set Columns


Name	Type	Description
Result	String	Success or Failure.
SchemaFile	String	The generated schema file.
Columns	String	The number of columns found.
FileData	String	The BASE64 downloaded file content. Only returned if WriteToFile set to false and FileStream is not set.

CreateARAgingDetailReport

Generates an A/R Aging Detail report schema file.

Input


Name	Type	Description
ReportName	String	The name of the report. The default value is ARAgingDetailReport.
ReportDescription	String	A description for the report. If one is not specified, a description based on the ReportType will be selected.
AgingMethod	String	The date upon which aging is determined. The allowed values are Report_Date, Current.
AgingPeriod	String	The number of days in the aging period.
Columns	String	Column types to be shown in the report. A comma separated list of one or more of the following: bill_addr, create_date, create_by, cust_bill_email, cust_comp_name, cust_msg, cust_phone_other, cust_tel, cust_name, deliv_addr, doc_num, due_date, last_mod_by, last_mod_date, memo, past_due, sale_sent_state, ship_addr, term_name, tx_date, txn_type. Additional columns with custom fields enabled: sales_cust1, sales_cust2, sales_cust3. Additional columns with location tracking enabled: dept_name. In addition to the above, the following values are supported based on the multicurrency setting for the company. Multicurrency disabled: supt_open_bal, subt_amount. Multicurrency enabled: currency, exch_rate, foreign_open_bal, subt_home_open_bal, foreign_amount, subt_home_amount. Default=tx_date,txn_type,doc_num,cust_name,dept_name,due_date,subt_open_bal,subt_amount
Customer	String	Filters report contents to include information for specified customers. This is a comma separated list (spaces omitted after/before separating comma) of one or more Customer IDs.
NumPeriods	String	The number of periods to be shown in the report.
PastDue	String	Filters report contents based on minimum days past due.
ReportDate	String	Start date to use for the report.
ShipVia	String	Filter by the shipping method as specified in Invoice's ShipMethodRef. This is the name of the shipping method.
StartDueDate	String	The startdate of which receivables are due. StartDueDate must be less than EndDate.
EndDueDate	String	The enddate of which receivables are due. EndDueDate must be greater than StartDate.
Term	String	Filters report contents to include information for specified term or terms supplied. This is a comma separated list (spaces omitted after/before separating comma) of one or more Term IDs.
Indentation	String	Add spaces at the start of values to visually identify totals and group values.
WriteToFile	String	Whether to write to an output file or not. Defaults to true, must be set to false to write to FileStream or FileData.

Result Set Columns


Name	Type	Description
Result	String	Success or Failure.
SchemaFile	String	The generated schema file.
Columns	String	The number of columns found.
FileData	String	The BASE64 downloaded file content. Only returned if WriteToFile set to false and FileStream is not set.

CreateARAgingSummaryReport

Generates an A/R Aging Summary report schema file.

Input


Name	Type	Description
ReportName	String	The name of the report. The default value is ARAgingSummaryReport.
ReportDescription	String	A description for the report. If one is not specified, a description based on the ReportType will be selected.
AgingMethod	String	The date upon which aging is determined. The allowed values are Report_Date, Current.
Customer	String	Filters report contents to include information for specified customers. This is a comma separated list (spaces omitted after/before separating comma) of one or more Customer IDs.
DateMacro	String	A predefined date range. Use this if you want the report to cover a standard report date range. Otherwise, use the StartDate and EndDate to cover an explicit range. The allowed values are Today, Yesterday, This Week, This Week-to-date, Last Week, Last Week-to-date, Next Week, Next 4 Weeks, This Month, This Month-to-date, Last Month, Last Month-to-date, Next Month, This Fiscal Quarter, This Fiscal Year, This Fiscal Year-to-date, Last Fiscal Year, Last Fiscal Year-to-date, Next Fiscal Year.
Department	String	Filters report contents to include information for specified departments if so configured in the company file. This is a comma separated list (spaces omitted after/before separating comma) of one or more Department IDs.
ReportDate	String	Start date to use for the report.
SummarizeColumnsBy	String	The criteria by which to group the report results. The allowed values are Total, Month, Week, Days, Quarter, Year, Customers, Vendors, Classes, Departments, Employees, ProductsAndServices.
Indentation	String	Add spaces at the start of values to visually identify totals and group values.
WriteToFile	String	Whether to write to an output file or not. Defaults to true, must be set to false to write to FileStream or FileData.
NumPeriods	String	The number of periods to be shown in the report.

Result Set Columns


Name	Type	Description
Result	String	Success or Failure.
SchemaFile	String	The generated schema file.
Columns	String	The number of columns found.
FileData	String	The BASE64 downloaded file content. Only returned if WriteToFile set to false and FileStream is not set.

CreateBalanceSheetSummaryReport

Generates a Balance Sheet Summary report schema file.

Input


Name	Type	Description
ReportName	String	The name of the report. The default value is BalanceSheetSummaryReport.
ReportDescription	String	A description for the report. If one is not specified, a description based on the ReportType will be selected.
AccountingMethod	String	The accounting method used in the report. The allowed values are Cash, Accrual.
Class	String	Filters report contents to include information for specified classes if so configured in the company file. This is a comma separated list (spaces omitted after/before separating comma) of one or more Class IDs.
Customer	String	Filters report contents to include information for specified customers. This is a comma separated list (spaces omitted after/before separating comma) of one or more Customer IDs
DateMacro	String	A predefined date range. Use this if you want the report to cover a standard report date range. Otherwise, use the StartDate and EndDate to cover an explicit range. The allowed values are Today, Yesterday, This Week, This Week-to-date, Last Week, Last Week-to-date, Next Week, Next 4 Weeks, This Month, This Month-to-date, Last Month, Last Month-to-date, Next Month, This Fiscal Quarter, This Fiscal Year, This Fiscal Year-to-date, Last Fiscal Year, Last Fiscal Year-to-date, Next Fiscal Year.
Department	String	Filters report contents to include information for specified departments if so configured in the company file. This is a comma separated list (spaces omitted after/before separating comma) of one or more Department IDs.
Item	String	Filters report contents to include information for specified items. This is a comma separated list (spaces omitted after/before separating comma) of one or more Item IDs.
StartDate	String	The startdate of the report. StartDate must be less than EndDate.
EndDate	String	The enddate of the report. EndDate must be greater than StartDate.
SummarizeColumnsBy	String	The criteria by which to group the report results. The allowed values are Total, Month, Week, Days, Quarter, Year, Customers, Vendors, Classes, Departments, Employees, ProductsAndServices.
Vendor	String	Filters report contents to include information for specified vendors. This is a comma separated list (spaces omitted after/before separating comma) of one or more Vendor IDs.
Indentation	String	Add spaces at the start of values to visually identify totals and group values.
WriteToFile	String	Whether to write to an output file or not. Defaults to true, must be set to false to write to FileStream or FileData.

Result Set Columns


Name	Type	Description
Result	String	Success or Failure.
SchemaFile	String	The generated schema file.
Columns	String	The number of columns found.
FileData	String	The BASE64 downloaded file content. Only returned if WriteToFile set to false and FileStream is not set.

CreateCustomerBalanceDetailReport

Generates a Customer Balance detail report schema file.

Input


Name	Type	Description
ReportName	String	The name of the report. The default value is CustomerBalanceDetailReport.
ReportDescription	String	A description for the report. If one is not specified, a description based on the ReportType will be selected.
AgingMethod	String	The date upon which aging is determined. The allowed values are Report_Date, Current.
ARPaid	String	The accounts receivable paid status. The allowed values are All, Paid, Unpaid. The default value is Unpaid.
Columns	String	Column types to be shown in the report. A comma separated list of one or more of the following: bill_addr, create_by, create_date, cust_bill_email, cust_comp_name, cust_msg, cust_phone_other, cust_tel, cust_name, deliv_addr, doc_num, due_date, last_mod_by, last_mod_date, memo, sale_sent_state, ship_addr, ship_date, ship_via, term_name, tracking_num, tx_date, txn_type. Additional columns with custom fields enabled: sales_cust1, sales_cust2, sales_cust3. Additional columns with location tracking enabled: dept_name. In addition to the above, the following values are supported based on the multicurrency setting for the company. MultiCurrency disabled: subt_open_bal, rbal_open_bal, subt_amount. MultiCurrency Enabled: currency, exch_rate, foreign_open_bal, subt_home_open_bal, rbal_home_open_bal, foreign_amount, subt_home_amount. Default= tx_date,txn_type,doc_num,dept_name,due_date,subt_amount,subt_open_bal,rbal_open_bal
Customer	String	Filters report contents to include information for specified customers. This is a comma separated list (spaces omitted after/before separating comma) of one or more Customer IDs.
Department	String	Filters report contents to include information for specified departments if so configured in the company file. This is a comma separated list (spaces omitted after/before separating comma) of one or more Department IDs.
ReportDate	String	Start date to use for the report.
ShipVia	String	Filter by the shipping method as specified in Invoice's ShipMethodRef. This is the name of the shipping method.
SortBy	String	The column type used in sorting report rows. Specify one of the Columns from the Columns input.
SortOrder	String	The sort ordering. The allowed values are ascend, descend. The default value is ascend.
StartDueDate	String	The startdate of the report. StartDate must be less than EndDate.
EndDueDate	String	The enddate of the report. EndDate must be greater than StartDate.
Term	String	Filters report contents to include information for specified term or terms supplied. This is a comma separated list (spaces omitted after/before separating comma) of one or more Term IDs.
Indentation	String	Add spaces at the start of values to visually identify totals and group values.
WriteToFile	String	Whether to write to an output file or not. Defaults to true, must be set to false to write to FileStream or FileData.

Result Set Columns


Name	Type	Description
Result	String	Success or Failure.
SchemaFile	String	The generated schema file.
Columns	String	The number of columns found.
FileData	String	The BASE64 downloaded file content. Only returned if WriteToFile set to false and FileStream is not set.

CreateCustomerBalanceReport

Generates a Customer Balance report schema file.

Input


Name	Type	Description
ReportName	String	The name of the report. The default value is CustomerBalanceReport.
ReportDescription	String	A description for the report. If one is not specified, a description based on the ReportType will be selected.
AccountingMethod	String	The accounting method used in the report. The allowed values are Cash, Accrual.
ARPaid	String	The accounts receivable paid status. The allowed values are All, Paid, Unpaid. The default value is Unpaid.
Customer	String	Filters report contents to include information for specified customers. This is a comma separated list (spaces omitted after/before separating comma) of one or more Customer IDs
DateMacro	String	A predefined date range. Use this if you want the report to cover a standard report date range. Otherwise, use the StartDate and EndDate to cover an explicit range. The allowed values are Today, Yesterday, This Week, This Week-to-date, Last Week, Last Week-to-date, Next Week, Next 4 Weeks, This Month, This Month-to-date, Last Month, Last Month-to-date, Next Month, This Fiscal Quarter, This Fiscal Year, This Fiscal Year-to-date, Last Fiscal Year, Last Fiscal Year-to-date, Next Fiscal Year.
Department	String	Filters report contents to include information for specified departments if so configured in the company file. This is a comma separated list (spaces omitted after/before separating comma) of one or more Department IDs.
ReportDate	String	Start date to use for the report.
SummarizeColumnsBy	String	The criteria by which to group the report results. The allowed values are Total, Month, Week, Days, Quarter, Year, Customers, Vendors, Classes, Departments, Employees, ProductsAndServices.
WriteToFile	String	Whether to write to an output file or not. Defaults to true, must be set to false to write to FileStream or FileData.

Result Set Columns


Name	Type	Description
Result	String	Success or Failure.
SchemaFile	String	The generated schema file.
Columns	String	The number of columns found.
FileData	String	The BASE64 downloaded file content. Only returned if WriteToFile set to false and FileStream is not set.

CreateCustomerIncomeReport

Generates a Customer Income report schema file.

Input


Name	Type	Description
ReportName	String	The name of the report. The default value is CustomerIncomeReport.
ReportDescription	String	A description for the report. If one is not specified, a description based on the ReportType will be selected.
AccountingMethod	String	The accounting method used in the report. The allowed values are Cash, Accrual.
Class	String	Filters report contents to include information for specified classes if so configured in the company file. This is a comma separated list (spaces omitted after/before separating comma) of one or more Class IDs.
Customer	String	Filters report contents to include information for specified customers. This is a comma separated list (spaces omitted after/before separating comma) of one or more Customer IDs
DateMacro	String	A predefined date range. Use this if you want the report to cover a standard report date range. Otherwise, use the StartDate and EndDate to cover an explicit range. The allowed values are Today, Yesterday, This Week, This Week-to-date, Last Week, Last Week-to-date, Next Week, Next 4 Weeks, This Month, This Month-to-date, Last Month, Last Month-to-date, Next Month, This Fiscal Quarter, This Fiscal Year, This Fiscal Year-to-date, Last Fiscal Year, Last Fiscal Year-to-date, Next Fiscal Year.
Department	String	Filters report contents to include information for specified departments if so configured in the company file. This is a comma separated list (spaces omitted after/before separating comma) of one or more Department IDs.
StartDate	String	The startdate of the report. StartDate must be less than EndDate.
EndDate	String	The enddate of the report. EndDate must be greater than StartDate.
SummarizeColumnsBy	String	The criteria by which to group the report results. The allowed values are Total, Month, Week, Days, Quarter, Year, Customers, Vendors, Classes, Departments, Employees, ProductsAndServices.
Term	String	Filters report contents to include information for specified term or terms supplied. This is a comma separated list (spaces omitted after/before separating comma) of one or more Term IDs.
Vendor	String	Filters report contents to include information for specified vendors. This is a comma separated list (spaces omitted after/before separating comma) of one or more Vendor IDs.
Indentation	String	Add spaces at the start of values to visually identify totals and group values.
WriteToFile	String	Whether to write to an output file or not. Defaults to true, must be set to false to write to FileStream or FileData.

Result Set Columns


Name	Type	Description
Result	String	Success or Failure.
SchemaFile	String	The generated schema file.
Columns	String	The number of columns found.
FileData	String	The BASE64 downloaded file content. Only returned if WriteToFile set to false and FileStream is not set.

CreateCustomerSalesReport

Generates a Sales by Customer Summary report schema file.

Input


Name	Type	Description
ReportName	String	The name of the report. The default value is CustomerSalesReport.
ReportDescription	String	A description for the report. If one is not specified, a description based on the ReportType will be selected.
AccountingMethod	String	The accounting method used in the report. The allowed values are Cash, Accrual.
Class	String	Filters report contents to include information for specified classes if so configured in the company file. This is a comma separated list (spaces omitted after/before separating comma) of one or more Class IDs.
Customer	String	Filters report contents to include information for specified customers. This is a comma separated list (spaces omitted after/before separating comma) of one or more Customer IDs
DateMacro	String	A predefined date range. Use this if you want the report to cover a standard report date range. Otherwise, use the StartDate and EndDate to cover an explicit range. The allowed values are Today, Yesterday, This Week, This Week-to-date, Last Week, Last Week-to-date, Next Week, Next 4 Weeks, This Month, This Month-to-date, Last Month, Last Month-to-date, Next Month, This Fiscal Quarter, This Fiscal Year, This Fiscal Year-to-date, Last Fiscal Year, Last Fiscal Year-to-date, Next Fiscal Year.
Department	String	Filters report contents to include information for specified departments if so configured in the company file. This is a comma separated list (spaces omitted after/before separating comma) of one or more Department IDs.
Item	String	Filters report contents to include information for specified items. This is a comma separated list (spaces omitted after/before separating comma) of one or more Item IDs.
StartDate	String	The startdate of the report. StartDate must be less than EndDate.
EndDate	String	The enddate of the report. EndDate must be greater than StartDate.
SummarizeColumnsBy	String	The criteria by which to group the report results. The allowed values are Total, Month, Week, Days, Quarter, Year, Customers, Vendors, Classes, Departments, Employees, ProductsAndServices.
Indentation	String	Add spaces at the start of values to visually identify totals and group values.
WriteToFile	String	Whether to write to an output file or not. Defaults to true, must be set to false to write to FileStream or FileData.

Result Set Columns


Name	Type	Description
Result	String	Success or Failure.
SchemaFile	String	The generated schema file.
Columns	String	The number of columns found.
FileData	String	The BASE64 downloaded file content. Only returned if WriteToFile set to false and FileStream is not set.

CreateExpensesByVendorReport

Generates an Expenses by Vendor report schema file.

Input


Name	Type	Description
ReportName	String	The name of the report. The default value is ExpensesByVendorReport.
ReportDescription	String	A description for the report. If one is not specified, a description based on the ReportType will be selected.
AccountingMethod	String	The accounting method used in the report. The allowed values are Cash, Accrual.
Class	String	Filters report contents to include information for specified classes if so configured in the company file. This is a comma separated list (spaces omitted after/before separating comma) of one or more Class IDs.
Customer	String	Filters report contents to include information for specified customers. This is a comma separated list (spaces omitted after/before separating comma) of one or more Customer IDs
DateMacro	String	A predefined date range. Use this if you want the report to cover a standard report date range. Otherwise, use the StartDate and EndDate to cover an explicit range. The allowed values are Today, Yesterday, This Week, This Week-to-date, Last Week, Last Week-to-date, Next Week, Next 4 Weeks, This Month, This Month-to-date, Last Month, Last Month-to-date, Next Month, This Fiscal Quarter, This Fiscal Year, This Fiscal Year-to-date, Last Fiscal Year, Last Fiscal Year-to-date, Next Fiscal Year.
Department	String	Filters report contents to include information for specified departments if so configured in the company file. This is a comma separated list (spaces omitted after/before separating comma) of one or more Department IDs.
StartDate	String	The startdate of the report. StartDate must be less than EndDate.
EndDate	String	The enddate of the report. EndDate must be greater than StartDate.
SummarizeColumnsBy	String	The criteria by which to group the report results. The allowed values are Total, Month, Week, Days, Quarter, Year, Customers, Vendors, Classes, Departments, Employees, ProductsAndServices.
Vendor	String	Filters report contents to include information for specified vendors. This is a comma separated list (spaces omitted after/before separating comma) of one or more Vendor IDs.
WriteToFile	String	Whether to write to an output file or not. Defaults to true, must be set to false to write to FileStream or FileData.

Result Set Columns


Name	Type	Description
Result	String	Success or Failure.
SchemaFile	String	The generated schema file.
Columns	String	The number of columns found.
FileData	String	The BASE64 downloaded file content. Only returned if WriteToFile set to false and FileStream is not set.

CreateGeneralLedgerDetailReport

Generates a General Ledger Detail report schema file.

Input


Name	Type	Description
ReportName	String	The name of the report. The default value is GeneralLedgerDetailReport.
ReportDescription	String	A description for the report. If one is not specified, a description based on the ReportType will be selected.
Account	String	Filters report contents to include information for specified accounts. This is a comma separated list (spaces omitted after/before separating comma) of one or more Account IDs.
AccountingMethod	String	The accounting method used in the report. The allowed values are Cash, Accrual.
AccountType	String	Account type from which transactions are included in the report. This is a comma separated list (spaces omitted after/before separating comma) and may include: Bank,AccountsReceivable,OtherCurrentAsset,FixedAsset,OtherAsset,AccountsPayable,CreditCard,OtherCurrentLiability,LongTermLiability,Equity,Income,CostOfGoodsSold,Expense,OtherIncome,OtherExpense,NonPosting.
SourceAccountType	String	Account type from which transactions are included in the report. This is a comma separated list (spaces omitted after/before separating comma) and may include: Bank,AccountsReceivable,OtherCurrentAsset,FixedAsset,OtherAsset,AccountsPayable,CreditCard,OtherCurrentLiability,LongTermLiability,Equity,Income,CostOfGoodsSold,Expense,OtherIncome,OtherExpense,NonPosting.
Class	String	Filters report contents to include information for specified classes if so configured in the company file. This is a comma separated list (spaces omitted after/before separating comma) of one or more Class IDs.
Columns	String	Column types to be shown in the report. A comma separated list of one or more of the following: account_name, chk_print_state, create_by, create_date, cust_name, doc_num, emp_name, inv_date, is_adj, is_ap_paid, is_ar_paid, is_cleared, item_name, last_mod_by, last_mod_date, memo, name, quantity, rate, split_acc, tx_date, txn_type, vend_name. Additional columns when class tracking enabled: klass_name. Additional columns when sales tax enabled: net_amount, tax_amount, tax_code. Additional columns when location tracking enabled:dept_name. In addition to the above, the following values are supported based on the multicurrency setting for the company. Multicurrency disabled: debt_amt, credit_amt, nat_open_bal, subt_nat_amount, rbal_nat_amount, tax_amount, net_amount. Multicurrency enabled: debt_home_amt, credit_home_amt, currency, exch_rate, nat_home_open_bal, nat_foreign_open_bal, subt_nat_home_amount, nat_foreign_amount, rbal_nat_home_amount, home_tax_amount, home_net_amount. Default=tx_date,txn_type,doc_num,account_name,memo,split_acc,subt_nat_home_amount,rbal_nat_home_amount. For more information refer to API documentation.
Customer	String	Filters report contents to include information for specified customers. This is a comma separated list (spaces omitted after/before separating comma) of one or more Customer IDs.
Locale	String	Specify the Locale of the QBOnline Company you are running this report for. This is generally needed when calling GeneralLedger and TrailBalance reports for a French company. In that case, specify the locale as FR.
DateMacro	String	A predefined date range. Use this if you want the report to cover a standard report date range. Otherwise, use the StartDate and EndDate to cover an explicit range. The allowed values are Today, Yesterday, This Week, This Week-to-date, Last Week, Last Week-to-date, Next Week, Next 4 Weeks, This Month, This Month-to-date, Last Month, Last Month-to-date, Next Month, This Fiscal Quarter, This Fiscal Year, This Fiscal Year-to-date, Last Fiscal Year, Last Fiscal Year-to-date, Next Fiscal Year.
Department	String	Filters report contents to include information for specified departments if so configured in the company file. This is a comma separated list (spaces omitted after/before separating comma) of one or more Department IDs.
SortBy	String	The column type used in sorting report rows. Specify one of the Columns from the Columns input.
SortOrder	String	The sort ordering. The allowed values are ascend, descend. The default value is ascend.
SourceAccount	String	Filters report contents to include information for specified accounts. This is a comma separated list (spaces omitted after/before separating comma) of one or more Account IDs.
StartDate	String	The startdate of the report. StartDate must be less than EndDate.
EndDate	String	The enddate of the report. EndDate must be greater than StartDate.
Vendor	String	Filters report contents to include information for specified vendors. This is a comma separated list (spaces omitted after/before separating comma) of one or more Vendor IDs.
Indentation	String	Add spaces at the start of values to visually identify totals and group values.
WriteToFile	String	Whether to write to an output file or not. Defaults to true, must be set to false to write to FileStream or FileData.

Result Set Columns


Name	Type	Description
Result	String	Success or Failure.
SchemaFile	String	The generated schema file.
Columns	String	The number of columns found.
FileData	String	The BASE64 downloaded file content. Only returned if WriteToFile set to false and FileStream is not set.

CreateInventoryValuationSummaryReport

Generates an Inventory Valuation Summary report schema file.

Input


Name	Type	Description
ReportName	String	The name of the report. The default value is InventoryValuationSummaryReport.
ReportDescription	String	A description for the report. If one is not specified, a description based on the ReportType will be selected.
DateMacro	String	A predefined date range. Use this if you want the report to cover a standard report date range. Otherwise, use the StartDate and EndDate to cover an explicit range. The allowed values are Today, Yesterday, This Week, This Week-to-date, Last Week, Last Week-to-date, Next Week, Next 4 Weeks, This Month, This Month-to-date, Last Month, Last Month-to-date, Next Month, This Fiscal Quarter, This Fiscal Year, This Fiscal Year-to-date, Last Fiscal Year, Last Fiscal Year-to-date, Next Fiscal Year.
Item	String	Filters report contents to include information for specified items. This is a comma separated list (spaces omitted after/before separating comma) of one or more Item IDs.
ReportDate	String	Start date to use for the report.
SummarizeColumnsBy	String	The criteria by which to group the report results. The allowed values are Total, Month, Week, Days, Quarter, Year, Customers, Vendors, Classes, Departments, Employees, ProductsAndServices.
Indentation	String	Add spaces at the start of values to visually identify totals and group values.
WriteToFile	String	Whether to write to an output file or not. Defaults to true, must be set to false to write to FileStream or FileData.

Result Set Columns


Name	Type	Description
Result	String	Success or Failure.
SchemaFile	String	The generated schema file.
Columns	String	The number of columns found.
FileData	String	The BASE64 downloaded file content. Only returned if WriteToFile set to false and FileStream is not set.

CreateJournalReport

Generates a Journal report schema file.

Input


Name	Type	Description
ReportName	String	The name of the report.
ReportDescription	String	A description for the report. If one is not specified, a description based on the ReportType will be selected.
Columns	String	Column types to be shown in the report. A comma separated list of one or more of the following:acct_num_with_extn,account_name,credit_amt,create_by,create_date,debt_amt,doc_num,due_date,is_ar_paid,is_ap_paid,item_name,journal_code_name,last_mod_by,last_mod_date,memo,name,neg_open_bal,paid_date,pmt_mthd,quantity,rate,tx_date,txn_num,txn_type.
DateMacro	String	A predefined date range. Use this if you want the report to cover a standard report date range. Otherwise, use the StartDate and EndDate to cover an explicit range. The allowed values are Today, Yesterday, This Week, This Week-to-date, Last Week, Last Week-to-date, Next Week, Next 4 Weeks, This Month, This Month-to-date, Last Month, Last Month-to-date, Next Month, This Fiscal Quarter, This Fiscal Year, This Fiscal Year-to-date, Last Fiscal Year, Last Fiscal Year-to-date, Next Fiscal Year.
JournalCode	String	One or more comma separated journal codes. For example AN, BQ1, VT, and so on. Default is to include data for all journal codes.
SortBy	String	The column type used in sorting report rows. Specify one of the Columns from the Columns input.
SortOrder	String	The sort ordering. The allowed values are ascend, descend.
StartDate	String	The startdate of the report. StartDate must be less than EndDate. If not specified value of DateMacro is used.
EndDate	String	The enddate of the report. EndDate must be greater than StartDate.
Locale	String	Specify the Locale of the QBOnline Company you are running this report for. If a French company, specify the locale as FR.
Indentation	String	Add spaces at the start of values to visually identify totals and group values.
WriteToFile	String	Whether to write to an output file or not. Defaults to true, must be set to false to write to FileStream or FileData.

Result Set Columns


Name	Type	Description
Result	String	Success or Failure.
SchemaFile	String	The generated schema file.
Columns	String	The number of columns found.
FileData	String	The BASE64 downloaded file content. Only returned if WriteToFile set to false and FileStream is not set.

CreateProfitAndLossDetailReport

Generates a Profit and Loss Detail report schema file.

Input


Name	Type	Description
ReportName	String	The name of the report. The default value is ProfitAndLossDetailReport.
ReportDescription	String	A description for the report. If one is not specified, a description based on the ReportType will be selected.
AccountType	String	Account type from which transactions are included in the report. This is a comma separated list (spaces omitted after/before separating comma) including: Bank, AccountsReceivable, OtherCurrentAsset, FixedAsset, OtherAsset, AccountsPayable, CreditCard, OtherCurrentLiability, LongTermLiability, Equity, Income, CostOfGoodsSold, Expense, OtherIncome, OtherExpense, NonPosting.
AccountingMethod	String	The accounting method used in the report. The allowed values are Cash, Accrual.
Account	String	Filters report contents to include information for specified accounts. This is a comma separated list (spaces omitted after/before separating comma) of one or more Item IDs.
SourceAccountType	String	Account type from which transactions are included in the report. This is a comma separated list (spaces omitted after/before separating comma) and may include: Bank,AccountsReceivable,OtherCurrentAsset,FixedAsset,OtherAsset,AccountsPayable,CreditCard,OtherCurrentLiability,LongTermLiability,Equity,Income,CostOfGoodsSold,Expense,OtherIncome,OtherExpense,NonPosting.
Class	String	Filters report contents to include information for specified classes if so configured in the company file. This is a comma separated list (spaces omitted after/before separating comma) of one or more Class IDs.
Columns	String	Column types to be shown in the report. A comma separated list of one or more of the following: create_by, create_date, doc_num, last_mod_by, last_mod_date, memo, name, pmt_mthd, split_acc, tx_date, txn_type. Additional columns with tax enabled: tax_code. Additional columns with class tracking enabled: klass_name. Additional columns with location tracking enabled: dept_name. In addition to the above, the following values are supported based on the multicurrency and NonTracking setting for the company - Multicurrency disabled and NonTracking disabled: subt_nat_amount, rbal_nat_amount Multicurrency disabled and NonTracking enabled: subt_nat_amount_nt, rbal_nat_amount_nt Multicurrency enabled and NonTracking disabled: subt_nat_home_amount, rbal_nat_home_amount Multicurrency enabled and NonTracking enabled: subt_nat_home_amount_nt, rbal_nat_home_amount_nt
Customer	String	Filters report contents to include information for specified customers. This is a comma separated list (spaces omitted after/before separating comma) of one or more Customer IDs
DateMacro	String	A predefined date range. Use this if you want the report to cover a standard report date range. Otherwise, use the StartDate and EndDate to cover an explicit range. The allowed values are Today, Yesterday, This Week, This Week-to-date, Last Week, Last Week-to-date, Next Week, Next 4 Weeks, This Month, This Month-to-date, Last Month, Last Month-to-date, Next Month, This Fiscal Quarter, This Fiscal Year, This Fiscal Year-to-date, Last Fiscal Year, Last Fiscal Year-to-date, Next Fiscal Year.
Department	String	Filters report contents to include information for specified departments if so configured in the company file. This is a comma separated list (spaces omitted after/before separating comma) of one or more Department IDs.
Employee	String	Filters report contents to include information for specified employees. This is a comma separated list (spaces omitted after/before separating comma) of one or more Item IDs.
PaymentMethod	String	Filter report contents based on payment method. This is a comma separated list (spaces omitted after/before separating comma) including: Cash, Check, Dinners Club, AmericanExpress, Discover, MasterCard, Visa.
SortBy	String	The column type used in sorting report rows. Specify one of the Columns from the Columns input.
SortOrder	String	The sort ordering. The allowed values are ascend, descend. The default value is ascend.
StartDate	String	The startdate of the report. StartDate must be less than EndDate.
EndDate	String	The enddate of the report. EndDate must be greater than StartDate.
Vendor	String	Filters report contents to include information for specified vendors. This is a comma separated list (spaces omitted after/before separating comma) of one or more Vendor IDs.
Indentation	String	Add spaces at the start of values to visually identify totals and group values.
WriteToFile	String	Whether to write to an output file or not. Defaults to true, must be set to false to write to FileStream or FileData.

Result Set Columns


Name	Type	Description
Result	String	Success or Failure.
SchemaFile	String	The generated schema file.
Columns	String	The number of columns found.
FileData	String	The BASE64 downloaded file content. Only returned if WriteToFile set to false and FileStream is not set.

CreateProfitAndLossSummaryReport

Generates a Profit and Loss Summary report schema file.

Input


Name	Type	Description
ReportName	String	The name of the report. The default value is ProfitAndLossSummaryReport.
ReportDescription	String	A description for the report. If one is not specified, a description based on the ReportType will be selected.
AccountingMethod	String	The accounting method used in the report. The allowed values are Cash, Accrual.
Class	String	Filters report contents to include information for specified classes if so configured in the company file. This is a comma separated list (spaces omitted after/before separating comma) of one or more Class IDs.
Customer	String	Filters report contents to include information for specified customers. This is a comma separated list (spaces omitted after/before separating comma) of one or more Customer IDs
DateMacro	String	A predefined date range. Use this if you want the report to cover a standard report date range. Otherwise, use the StartDate and EndDate to cover an explicit range. The allowed values are Today, Yesterday, This Week, This Week-to-date, Last Week, Last Week-to-date, Next Week, Next 4 Weeks, This Month, This Month-to-date, Last Month, Last Month-to-date, Next Month, This Fiscal Quarter, This Fiscal Year, This Fiscal Year-to-date, Last Fiscal Year, Last Fiscal Year-to-date, Next Fiscal Year.
Department	String	Filters report contents to include information for specified departments if so configured in the company file. This is a comma separated list (spaces omitted after/before separating comma) of one or more Department IDs.
Item	String	Filters report contents to include information for specified items. This is a comma separated list (spaces omitted after/before separating comma) of one or more Item IDs.
StartDate	String	The startdate of the report. StartDate must be less than EndDate.
EndDate	String	The enddate of the report. EndDate must be greater than StartDate.
SummarizeColumnsBy	String	The criteria by which to group the report results. The allowed values are Total, Month, Week, Days, Quarter, Year, Customers, Vendors, Classes, Departments, Employees, ProductsAndServices.
Vendor	String	Filters report contents to include information for specified vendors. This is a comma separated list (spaces omitted after/before separating comma) of one or more Vendor IDs.
Indentation	String	Add spaces at the start of values to visually identify totals and group values.
WriteToFile	String	Whether to write to an output file or not. Defaults to true, must be set to false to write to FileStream or FileData.

Result Set Columns


Name	Type	Description
Result	String	Success or Failure.
SchemaFile	String	The generated schema file.
Columns	String	The number of columns found.
FileData	String	The BASE64 downloaded file content. Only returned if WriteToFile set to false and FileStream is not set.

CreateSalesByClassReport

Generates a Sales by Class report schema file.

Input


Name	Type	Description
ReportName	String	The name of the report. The default value is SalesByClassReport.
ReportDescription	String	A description for the report. If one is not specified, a description based on the ReportType will be selected.
AccountingMethod	String	The accounting method used in the report. The allowed values are Cash, Accrual.
Class	String	Filters report contents to include information for specified classes if so configured in the company file. This is a comma separated list (spaces omitted after/before separating comma) of one or more Class IDs.
Customer	String	Filters report contents to include information for specified customers. This is a comma separated list (spaces omitted after/before separating comma) of one or more Customer IDs
DateMacro	String	A predefined date range. Use this if you want the report to cover a standard report date range. Otherwise, use the StartDate and EndDate to cover an explicit range. The allowed values are Today, Yesterday, This Week, This Week-to-date, Last Week, Last Week-to-date, Next Week, Next 4 Weeks, This Month, This Month-to-date, Last Month, Last Month-to-date, Next Month, This Fiscal Quarter, This Fiscal Year, This Fiscal Year-to-date, Last Fiscal Year, Last Fiscal Year-to-date, Next Fiscal Year.
Department	String	Filters report contents to include information for specified departments if so configured in the company file. This is a comma separated list (spaces omitted after/before separating comma) of one or more Department IDs.
Item	String	Filters report contents to include information for specified items. This is a comma separated list (spaces omitted after/before separating comma) of one or more Item IDs.
StartDate	String	The startdate of the report. StartDate must be less than EndDate.
EndDate	String	The enddate of the report. EndDate must be greater than StartDate.
SummarizeColumnsBy	String	The criteria by which to group the report results. The allowed values are Total, Month, Week, Days, Quarter, Year, Customers, Vendors, Classes, Departments, Employees, ProductsAndServices.
Indentation	String	Add spaces at the start of values to visually identify totals and group values.
WriteToFile	String	Whether to write to an output file or not. Defaults to true, must be set to false to write to FileStream or FileData.

Result Set Columns


Name	Type	Description
Result	String	Success or Failure.
SchemaFile	String	The generated schema file.
Columns	String	The number of columns found.
FileData	String	The BASE64 downloaded file content. Only returned if WriteToFile set to false and FileStream is not set.

CreateSalesByDepartmentReport

Generates a Sales by Department report schema file.

Input


Name	Type	Description
ReportName	String	The name of the report. The default value is SalesByDepartmentReport.
ReportDescription	String	A description for the report. If one is not specified, a description based on the ReportType will be selected.
AccountingMethod	String	The accounting method used in the report. The allowed values are Cash, Accrual.
Class	String	Filters report contents to include information for specified classes if so configured in the company file. This is a comma separated list (spaces omitted after/before separating comma) of one or more Class IDs.
Customer	String	Filters report contents to include information for specified customers. This is a comma separated list (spaces omitted after/before separating comma) of one or more Customer IDs
DateMacro	String	A predefined date range. Use this if you want the report to cover a standard report date range. Otherwise, use the StartDate and EndDate to cover an explicit range. The allowed values are Today, Yesterday, This Week, This Week-to-date, Last Week, Last Week-to-date, Next Week, Next 4 Weeks, This Month, This Month-to-date, Last Month, Last Month-to-date, Next Month, This Fiscal Quarter, This Fiscal Year, This Fiscal Year-to-date, Last Fiscal Year, Last Fiscal Year-to-date, Next Fiscal Year.
Department	String	Filters report contents to include information for specified departments if so configured in the company file. This is a comma separated list (spaces omitted after/before separating comma) of one or more Department IDs.
Item	String	Filters report contents to include information for specified items. This is a comma separated list (spaces omitted after/before separating comma) of one or more Item IDs.
StartDate	String	The startdate of the report. StartDate must be less than EndDate.
EndDate	String	The enddate of the report. EndDate must be greater than StartDate.
SummarizeColumnsBy	String	The criteria by which to group the report results. The allowed values are Total, Month, Week, Days, Quarter, Year, Customers, Vendors, Classes, Departments, Employees, ProductsAndServices.
WriteToFile	String	Whether to write to an output file or not. Defaults to true, must be set to false to write to FileStream or FileData.

Result Set Columns


Name	Type	Description
Result	String	Success or Failure.
SchemaFile	String	The generated schema file.
Columns	String	The number of columns found.
FileData	String	The BASE64 downloaded file content. Only returned if WriteToFile set to false and FileStream is not set.

CreateSalesByProductReport

Generates a Sales by Product report schema file.

Input


Name	Type	Description
ReportName	String	The name of the report. The default value is SalesByProductReport.
ReportDescription	String	A description for the report. If one is not specified, a description based on the ReportType will be selected.
AccountingMethod	String	The accounting method used in the report. The allowed values are Cash, Accrual.
Class	String	Filters report contents to include information for specified classes if so configured in the company file. This is a comma separated list (spaces omitted after/before separating comma) of one or more Class IDs.
Customer	String	Filters report contents to include information for specified customers. This is a comma separated list (spaces omitted after/before separating comma) of one or more Customer IDs
DateMacro	String	A predefined date range. Use this if you want the report to cover a standard report date range. Otherwise, use the StartDate and EndDate to cover an explicit range. The allowed values are Today, Yesterday, This Week, This Week-to-date, Last Week, Last Week-to-date, Next Week, Next 4 Weeks, This Month, This Month-to-date, Last Month, Last Month-to-date, Next Month, This Fiscal Quarter, This Fiscal Year, This Fiscal Year-to-date, Last Fiscal Year, Last Fiscal Year-to-date, Next Fiscal Year.
Department	String	Filters report contents to include information for specified departments if so configured in the company file. This is a comma separated list (spaces omitted after/before separating comma) of one or more Department IDs.
Item	String	Filters report contents to include information for specified items. This is a comma separated list (spaces omitted after/before separating comma) of one or more Item IDs.
StartDate	String	The startdate of the report. StartDate must be less than EndDate.
EndDate	String	The enddate of which receivables are due. EndDueDate must be greater than StartDueDate.
StartDueDate	String	The startdate of which receivables are due. StartDueDate must be less than EndDueDate.
EndDueDate	String	The enddate of the report. EndDate must be greater than StartDate.
SummarizeColumnsBy	String	The criteria by which to group the report results. The allowed values are Total, Month, Week, Days, Quarter, Year, Customers, Vendors, Classes, Departments, Employees, ProductsAndServices.
WriteToFile	String	Whether to write to an output file or not. Defaults to true, must be set to false to write to FileStream or FileData.

Result Set Columns


Name	Type	Description
Result	String	Success or Failure.
SchemaFile	String	The generated schema file.
Columns	String	The number of columns found.
FileData	String	The BASE64 downloaded file content. Only returned if WriteToFile set to false and FileStream is not set.

CreateStatementOfCashFlowReport

Generates a Statement of Cash Flow report schema file.

Input


Name	Type	Description
ReportName	String	The name of the report. The default value is StatementOfCashFlowReport.
ReportDescription	String	A description for the report. If one is not specified, a description based on the ReportType will be selected.
Class	String	Filters report contents to include information for specified classes if so configured in the company file. This is a comma separated list (spaces omitted after/before separating comma) of one or more Class IDs.
Customer	String	Filters report contents to include information for specified customers. This is a comma separated list (spaces omitted after/before separating comma) of one or more Customer IDs
DateMacro	String	A predefined date range. Use this if you want the report to cover a standard report date range. Otherwise, use the StartDate and EndDate to cover an explicit range. The allowed values are Today, Yesterday, This Week, This Week-to-date, Last Week, Last Week-to-date, Next Week, Next 4 Weeks, This Month, This Month-to-date, Last Month, Last Month-to-date, Next Month, This Fiscal Quarter, This Fiscal Year, This Fiscal Year-to-date, Last Fiscal Year, Last Fiscal Year-to-date, Next Fiscal Year.
Department	String	Filters report contents to include information for specified departments if so configured in the company file. This is a comma separated list (spaces omitted after/before separating comma) of one or more Department IDs.
Item	String	Filters report contents to include information for specified items. This is a comma separated list (spaces omitted after/before separating comma) of one or more Item IDs.
StartDate	String	The startdate of the report. StartDate must be less than EndDate.
EndDate	String	The enddate of the report. EndDate must be greater than StartDate.
SummarizeColumnsBy	String	The criteria by which to group the report results. The allowed values are Total, Month, Week, Days, Quarter, Year, Customers, Vendors, Classes, Departments, Employees, ProductsAndServices.
Vendor	String	Filters report contents to include information for specified vendors. This is a comma separated list (spaces omitted after/before separating comma) of one or more Vendor IDs.
Indentation	String	Add spaces at the start of values to visually identify totals and group values.
WriteToFile	String	Whether to write to an output file or not. Defaults to true, must be set to false to write to FileStream or FileData.

Result Set Columns


Name	Type	Description
Result	String	Success or Failure.
SchemaFile	String	The generated schema file.
Columns	String	The number of columns found.
FileData	String	The BASE64 downloaded file content. Only returned if WriteToFile set to false and FileStream is not set.

CreateTransactionListReport

Generates a Transaction List report schema file.

Input


Name	Type	Description
ReportName	String	The name of the report. The default value is TransactionListReport.
ReportDescription	String	A description for the report. If one is not specified, a description based on the ReportType will be selected.
AccountingMethod	String	The accounting method used in the report. The allowed values are Cash, Accrual.
APPaid	String	Status of the balance. The allowed values are Paid, Unpaid, All.
ARPaid	String	The accounts receivable paid status. The allowed values are Paid, Unpaid, All.
BothAmount	String	Filters report contents to include information for specified transaction amount.
Class	String	Filters report contents to include information for specified classes if so configured in the company file. This is a comma separated list (spaces omitted after/before separating comma) of one or more Class IDs.
Cleared	String	Filters report contents to include information for specified check status. The allowed values are Cleared, Uncleared, Reconciled, Deposited.
Columns	String	Column types to be shown in the report. A comma separated list of one or more of the following: account_name, create_by, create_date, cust_msg, dued_date, doc_num, inv_date, is_ap_paid, is_cleared, is_no_post, last_mod_by, memo, name, other_account, pmt_mthd, printed, sales_cust1, sales_cust2, sales_cust3, term_name, tracking_num, tx_date, txn_type. Additional columns when account numbering enabled: account_num. Additional columns when location tracking enabled: dept_name. In addition to the above, the following values are supported based on the multicurrency setting for the company. Multicurrency disabled: debt_amt, credit_amt, nat_open_bal, subt_nat_amount, tax_amount, net_amount. Multicurrency enabled: debt_home_amt, credit_home_amt, currency, exch_rate, nat_home_open_bal, nat_foreign_open_bal, subt_nat_home_amount, nat_foreign_amount, home_tax_amountm foreign_tax_amount, home_net_amount, foreign_net_amount. Default= tx_date, txn_type, doc_num, is_no_post, name, account_name, other_account, subt_nat_amount
CreateDateMacro	String	A predefined account create date range. Use this if you want the report to cover a standard date range when accounts were created. Otherwise, use the StartCreateDate and EndCreateDate to cover an explicit range. The allowed values are Today, Yesterday, This Week, Last Week, This Week-to-date, Last Week-to-date, Next Week, Next 4 Weeks, This Month, Last Month, This Month-to-date, Last Month-to-date, Next Month, This Fiscal Quarter, Last Fiscal Quarter, This Fiscal Quarter-to-date, Last Fiscal Quarter-to-date, Next Fiscal Quarter, This Fiscal Year, Last Fiscal Year, This Fiscal Year-to-date, Last Fiscal Year-to-date, Next Fiscal Year.
Customer	String	Filters report contents to include information for specified customers. This is a comma separated list (spaces omitted after/before separating comma) of one or more Customer IDs.
DateMacro	String	A predefined date range. Use this if you want the report to cover a standard report date range. Otherwise, use the StartDate and EndDate to cover an explicit range. The allowed values are Today, Yesterday, This Week, Last Week, This Week-to-date, Last Week-to-date, Next Week, Next 4 Weeks, This Month, Last Month, This Month-to-date, Last Month-to-date, Next Month, This Fiscal Quarter, Last Fiscal Quarter, This Fiscal Quarter-to-date, Last Fiscal Quarter-to-date, Next Fiscal Quarter, This Fiscal Year, Last Fiscal Year, This Fiscal Year-to-date, Last Fiscal Year-to-date, Next Fiscal Year.
Department	String	Filters report contents to include information for specified departments if so configured in the company file. This is a comma separated list (spaces omitted after/before separating comma) of one or more Department IDs.
DocNum	String	Filters report contents to include information for specified transaction number, as found in the docnum parameter of the transaction object
DueDateMacro	String	A predefined date range of due dates for balances to include in the report. Otherwise, use the StartDueDate and EndDueDate to cover an explicit range. The allowed values are Today, Yesterday, This Week, Last Week, This Week-to-date, Last Week-to-date, Next Week, Next 4 Weeks, This Month, Last Month, This Month-to-date, Last Month-to-date, Next Month, This Fiscal Quarter, Last Fiscal Quarter, This Fiscal Quarter-to-date, Last Fiscal Quarter-to-date, Next Fiscal Quarter, This Fiscal Year, Last Fiscal Year, This Fiscal Year-to-date, Last Fiscal Year-to-date, Next Fiscal Year.
GroupBy	String	The field in the transaction by which to group results. The allowed values are Name, Account, Transaction Type, Customer, Vendor, Employee, Location, Payment Method, Day, Week, Month, Quarter, Year, None.
Item	String	Filters report contents to include information for specified items. This is a comma separated list (spaces omitted after/before separating comma) of one or more Item IDs.
Memo	String	Filters report contents to include information for specified memo. One or more comma separated memo IDs
ModDateMacro	String	A predefined report account modification date range. Use if you want the report to cover a standard report date range when accounts were modified; otherwise, use the StartModDate and EndModDate to cover an explicit report date range. The allowed values are Today, Yesterday, This Week, Last Week, This Week-to-date, Last Week-to-date, Next Week, Next 4 Weeks, This Month, Last Month, This Month-to-date, Last Month-to-date, Next Month, This Fiscal Quarter, Last Fiscal Quarter, This Fiscal Quarter-to-date, Last Fiscal Quarter-to-date, Next Fiscal Quarter, This Fiscal Year, Last Fiscal Year, This Fiscal Year-to-date, Last Fiscal Year-to-date, Next Fiscal Year.
PaymentMethod	String	Filters report contents based on payment method. The allowed values are Cash, Credit, Dinners Club, American Express, Discover, Mastercard, Visa.
Printed	String	Filters report contents based on whether checks are printed or not. The allowed values are All, Printed, To_be_printed.
SortBy	String	The column type used in sorting report rows. Specify one of the Columns from the Columns input.
SortOrder	String	The sort ordering. The allowed values are ascend, descend.
SourceAccountType	String	Account type from which transactions are included in the report. This is a comma separated list (spaces omitted after/before separating comma) and may include: Bank,AccountsReceivable,OtherCurrentAsset,FixedAsset,OtherAsset,AccountsPayable,CreditCard,OtherCurrentLiability,LongTermLiability,Equity,Income,CostOfGoodsSold,Expense,OtherIncome,OtherExpense,NonPosting.
StartCreateDate	String	The startcreatedate of account creation to include in the report. StartCreateDate must be less than EndCreateDate.
EndCreateDate	String	The endcreatedate account creation to include in the report. EndCreateDate must be greater than StartCreateDate.
StartDate	String	The startdate of the report. StartDate must be less than EndDate.
EndDate	String	The enddate of the report. EndDate must be greater than StartDate.
StartDueDate	String	The startdate of which receivables are due. StartDueDate must be less than EndDueDate.
EndDueDate	String	The enddate of which recievables are due. EndDueDate must be greater than StartDueDate.
StartModDate	String	The startdate of which accounts were modified. StartModDate must be less than EndModDate.
EndModDate	String	The enddate of which accounts were modified. EndModDate must be greater than StartModDate.
Term	String	Filters report contents to include information for specified terms. This is a comma separated list (spaces omitted after/before separating comma) of one or more Term IDs.
TransactionType	String	Filters report based on transaction type. The allowed values are CreditCardCharge, Check, Invoice, ReceivePayment, JournalEntry, Bill, CreditCardCredit, VendorCredit, Credit, BillPaymentCheck, BillPaymentCreditCard, Charge, Transfer, Deposit, Statement, BillableCharge, TimeActivity, CashPurchase, SalesReceipt, CreditMemo, CreditRefund, Estimate, InventoryQuantityAdjustment, PurchaseOrder, GlobalTaxPayment, GlobalTaxAdjustment, Service Tax Refund, Service Tax Gross Adjustment, Service Tax Reversal, Service Tax Defer, Service Tax Partial Utilisation.
Vendor	String	Filters report contents to include information for specified vendors. This is a comma separated list (spaces omitted after/before separating comma) of one or more Vendor IDs.
Indentation	String	Add spaces at the start of values to visually identify totals and group values.
WriteToFile	String	Whether to write to an output file or not. Defaults to true, must be set to false to write to FileStream or FileData.

Result Set Columns


Name	Type	Description
Result	String	Success or Failure.
SchemaFile	String	The generated schema file.
Columns	String	The number of columns found.
FileData	String	The BASE64 downloaded file content. Only returned if WriteToFile set to false and FileStream is not set.

CreateTransactionListWithSplitsReport

Generates an Account list report schema file.

Input


Name	Type	Description
ReportName	String	The name of the report. The default value is TransactionListWithSplitsReport.
ReportDescription	String	A description for the report. If one is not specified, a description based on the ReportType will be selected.
StartDate	String	The startdate of the report. StartDate must be less than EndDate.
EndDate	String	The enddate of the report. EndDate must be greater than StartDate.
DateMacro	String	A predefined date range. Use this if you want the report to cover a standard report date range. Otherwise, use the StartDate and EndDate to cover an explicit range.
SourceAccountType	String	Account type from which transactions are included in the report.
SortBy	String	The column type used in sorting report rows. Specify one of the Columns from the Columns input.
SortOrder	String	The sort ordering. The allowed values are ascend, descend.
DocNum	String	Filters report contents to include information for specified transaction number, as found in the docnum parameter of the transaction object.
PaymentMethod	String	Filter report contents based on payment method.
Transactiontype	String	Filters report based on transaction type.
WriteToFile	String	Whether to write to an output file or not. Defaults to true, must be set to false to write to FileStream or FileData.

Result Set Columns


Name	Type	Description
Result	String	Success or Failure.
SchemaFile	String	The generated schema file.
Columns	String	The number of columns found.
FileData	String	The BASE64 downloaded file content. Only returned if WriteToFile set to false and FileStream is not set.

CreateTrialBalanceReport

Generates a Trial Balance report schema file.

Input


Name	Type	Description
ReportName	String	The name of the report. The default value is TrialBalanceReport.
ReportDescription	String	A description for the report. If one is not specified, a description based on the ReportType will be selected.
AccountingMethod	String	The accounting method used in the report. The allowed values are Cash, Accrual.
DateMacro	String	A predefined date range. Use this if you want the report to cover a standard report date range. Otherwise, use the StartDate and EndDate to cover an explicit range. The allowed values are Today, Yesterday, This Week, This Week-to-date, Last Week, Last Week-to-date, Next Week, Next 4 Weeks, This Month, This Month-to-date, Last Month, Last Month-to-date, Next Month, This Fiscal Quarter, This Fiscal Year, This Fiscal Year-to-date, Last Fiscal Year, Last Fiscal Year-to-date, Next Fiscal Year.
StartDate	String	The startdate of the report. StartDate must be less than EndDate.
EndDate	String	The enddate of the report. EndDate must be greater than StartDate.
SummarizeColumnsBy	String	The criteria by which to group the report results. The allowed values are Total, Month, Week, Days, Quarter, Year, Customers, Vendors, Classes, Departments, Employees, ProductsAndServices.
Locale	String	Specify the Locale of the QBOnline Company you are running this report for. This is generally needed when calling GeneralLedger and TrailBalance reports for a French company. In that case, specify the locale as FR.
WriteToFile	String	Whether to write to an output file or not. Defaults to true, must be set to false to write to FileStream or FileData.

Result Set Columns


Name	Type	Description
Result	String	Success or Failure.
SchemaFile	String	The generated schema file.
Columns	String	The number of columns found.
FileData	String	The BASE64 downloaded file content. Only returned if WriteToFile set to false and FileStream is not set.

CreateVendorBalanceDetailReport

Generates a Vendor Balance Detail report schema file.

Input


Name	Type	Description
ReportName	String	The name of the report. The default value is VendorBalanceDetailReport.
ReportDescription	String	A description for the report. If one is not specified, a description based on the ReportType will be selected.
AccountingMethod	String	The accounting method used in the report. The allowed values are Cash, Accrual.
APPaid	String	The status of the balance. The allowed values are Paid, Unpaid, All. The default value is Unpaid.
Columns	String	Column types to be shown in the report. A comma separated list of one or more of the following: create_by, create_date, doc_num, due_date, last_mod_by, last_mod_date, memo, term_name, tx_date, txn_type, vend_bill_addr, vend_comp_name, vend_name, vend_pri_cont, vend_pri_email, vend_pri_tel. Additional columns with location tracking enabled: dept_name. In addition to the above, the following values are supported based on the multicurrency setting for the company: Multicurrency disabled: subt_net_open_bal, rbal_neg_open_bal, subt_neg_amount. Multicurrency enabled: currency, exch_rate, neg_foreign_open_bal, subt_neg_home_open_bal, rbal_neg_home_open_bal. Default=tx_date,txn_type,doc_num,dept_name,subt_neg_amount,subt_net_open_bal, rbal_neg_open_bal
DateMacro	String	A predefined date range. Use this if you want the report to cover a standard report date range. Otherwise, use the StartDate and EndDate to cover an explicit range. The allowed values are Today, Yesterday, This Week, This Week-to-date, Last Week, Last Week-to-date, Next Week, Next 4 Weeks, This Month, This Month-to-date, Last Month, Last Month-to-date, Next Month, This Fiscal Quarter, This Fiscal Year, This Fiscal Year-to-date, Last Fiscal Year, Last Fiscal Year-to-date, Next Fiscal Year.
Department	String	Filters report contents based on term or terms supplied. This is a comma separated list (spaces omitted after/before separating comma) of one or more Department IDs.
DueDateMacro	String	A predefined date range. Use this if you want the report to cover a standard report date range. Otherwise, use the StartDate and EndDate to cover an explicit range. The allowed values are Today, Yesterday, This Week, This Week-to-date, Last Week, Last Week-to-date, Next Week, Next 4 Weeks, This Month, This Month-to-date, Last Month, Last Month-to-date, Next Month, This Fiscal Quarter, This Fiscal Year, This Fiscal Year-to-date, Last Fiscal Year, Last Fiscal Year-to-date, Next Fiscal Year.
ReportDate	String	Start date to use for the report.
StartDueDate	String	The startduedate of which receivables are due. StartDueDate must be less than EndDueDate.
EndDueDate	String	The endduedate of the report. EndDueDate must be greater than StartDueDate.
SortBy	String	The column type used in sorting report rows. Specify one of the Columns from the Columns input.
SortOrder	String	The sort ordering. The allowed values are ascend, descend. The default value is ascend.
Term	String	Filters report contents to include information for specified term or terms supplied. This is a comma separated list (spaces omitted after/before separating comma) of one or more Term IDs.
Vendor	String	Filters report contents to include information for specified vendors. This is a comma separated list (spaces omitted after/before separating comma) of one or more Vendor IDs.
Indentation	String	Add spaces at the start of values to visually identify totals and group values.
WriteToFile	String	Whether to write to an output file or not. Defaults to true, must be set to false to write to FileStream or FileData.

Result Set Columns


Name	Type	Description
Result	String	Success or Failure.
SchemaFile	String	The generated schema file.
Columns	String	The number of columns found.
FileData	String	The BASE64 downloaded file content. Only returned if WriteToFile set to false and FileStream is not set.

CreateVendorBalanceReport

Generates a Vendor Balance report schema file.

Input


Name	Type	Description
ReportName	String	The name of the report. The default value is VendorBalanceReport.
ReportDescription	String	A description for the report. If one is not specified, a description based on the ReportType will be selected.
AccountingMethod	String	The accounting method used in the report. The allowed values are Cash, Accrual.
DateMacro	String	A predefined date range. Use this if you want the report to cover a standard report date range. Otherwise, use the StartDate and EndDate to cover an explicit range. The allowed values are Today, Yesterday, This Week, This Week-to-date, Last Week, Last Week-to-date, Next Week, Next 4 Weeks, This Month, This Month-to-date, Last Month, Last Month-to-date, Next Month, This Fiscal Quarter, This Fiscal Year, This Fiscal Year-to-date, Last Fiscal Year, Last Fiscal Year-to-date, Next Fiscal Year.
Department	String	Filters report contents to include information for specified departments if so configured in the company file. This is a comma separated list (spaces omitted after/before separating comma) of one or more Department IDs.
ReportDate	String	Start date to use for the report.
SummarizeColumnsBy	String	The criteria by which to group the report results. The allowed values are Total, Month, Week, Days, Quarter, Year, Customers, Vendors, Classes, Departments, Employees, ProductsAndServices.
Vendor	String	Filters report contents to include information for specified vendors. This is a comma separated list (spaces omitted after/before separating comma) of one or more Vendor IDs.
WriteToFile	String	Whether to write to an output file or not. Defaults to true, must be set to false to write to FileStream or FileData.

Result Set Columns


Name	Type	Description
Result	String	Success or Failure.
SchemaFile	String	The generated schema file.
Columns	String	The number of columns found.
FileData	String	The BASE64 downloaded file content. Only returned if WriteToFile set to false and FileStream is not set.

SendInvoice

Send linked payment Invoices via Email

Input


Name	Type	Description
InvoiceId	String	Id of the Invoice object to send
EmailAddress	String	Delivery email address for the invoice item

Result Set Columns


Name	Type	Description
Status	String	Stored procedure execution status.

VoidInvoice

To void an existing invoice object

Input


Name	Type	Description
InvoiceId	String	Invoice Id to Void
SyncToken	String	SyncToken for the Invoice Id
BillEmail	String	Identifies the e-mail address where the invoice is sent. If EmailStatus=NeedToSend, BillEmail is required input

Result Set Columns


Name	Type	Description
Status	String	Stored procedure execution status.

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for QuickBooks Online:

sys_catalogs: Lists the available databases.
sys_schemas: Lists the available schemas.
sys_tables: Lists the available tables and views.
sys_tablecolumns: Describes the columns of the available tables and views.
sys_procedures: Describes the available stored procedures.
sys_procedureparameters: Describes stored procedure parameters.
sys_keycolumns: Describes the primary and foreign keys.
sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

sys_connection_props: Returns information on the available connection properties.
sys_sqlinfo: Describes the SELECT queries that the Cloud can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries, including batch operations::

sys_identity: Returns information about batch operations or single updates.

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns


Name	Type	Description
CatalogName	String	The database name.

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas

Columns


Name	Type	Description
CatalogName	String	The database name.
SchemaName	String	The schema name.

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables

Columns


Name	Type	Description
CatalogName	String	The database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view.
TableType	String	The table type (table or view).
Description	String	A description of the table or view.
IsUpdateable	Boolean	Whether the table can be updated.

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Customers table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Customers'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view containing the column.
ColumnName	String	The column name.
DataTypeName	String	The data type name.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The storage size of the column.
DisplaySize	Int32	The designated column's normal maximum width in characters.
NumericPrecision	Int32	The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The column scale or number of digits to the right of the decimal point.
IsNullable	Boolean	Whether the column can contain null.
Description	String	A brief description of the column.
Ordinal	Int32	The sequence number of the column.
IsAutoIncrement	String	Whether the column value is assigned in fixed increments.
IsGeneratedColumn	String	Whether the column is generated.
IsHidden	Boolean	Whether the column is hidden.
IsArray	Boolean	Whether the column is an array.
IsReadOnly	Boolean	Whether the column is read-only.
IsKey	Boolean	Indicates whether a field returned from sys_tablecolumns is the primary key of the table.

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures

Columns


Name	Type	Description
CatalogName	String	The database containing the stored procedure.
SchemaName	String	The schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure.
Description	String	A description of the stored procedure.
ProcedureType	String	The type of the procedure, such as PROCEDURE or FUNCTION.

sys_procedureparameters

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the GetOAuthAccessToken stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='GetOAuthAccessToken' AND Direction=1 OR Direction=2

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the stored procedure.
SchemaName	String	The name of the schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure containing the parameter.
ColumnName	String	The name of the stored procedure parameter.
Direction	Int32	An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataTypeName	String	The name of the data type.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The number of digits to the right of the decimal point in numeric data.
IsNullable	Boolean	Whether the parameter can contain null.
IsRequired	Boolean	Whether the parameter is required for execution of the procedure.
IsArray	Boolean	Whether the parameter is an array.
Description	String	The description of the parameter.
Ordinal	Int32	The index of the parameter.

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the Customers table:

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Customers'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
IsKey	Boolean	Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey	Boolean	Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.
ForeignKeyType	String	Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

sys_primarykeys

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
KeySeq	String	The sequence number of the primary key.
KeyName	String	The name of the primary key.

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

          SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns


Name	Type	Description
CatalogName	String	The name of the database containing the index.
SchemaName	String	The name of the schema containing the index.
TableName	String	The name of the table containing the index.
IndexName	String	The index name.
ColumnName	String	The name of the column associated with the index.
IsUnique	Boolean	True if the index is unique. False otherwise.
IsPrimary	Boolean	True if the index is a primary key. False otherwise.
Type	Int16	An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder	String	The sort order: A for ascending or D for descending.
OrdinalPosition	Int16	The sequence number of the column in the index.

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

When querying this table, the config connection string should be used:

jdbc:cdata:quickbooksonline:config:

This connection string enables you to query this table without a valid connection.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns


Name	Type	Description
Name	String	The name of the connection property.
ShortDescription	String	A brief description.
Type	String	The data type of the connection property.
Default	String	The default value if one is not explicitly set.
Values	String	A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value	String	The value you set or a preconfigured default.
Required	Boolean	Whether the property is required to connect.
Category	String	The category of the connection property.
IsSessionProperty	String	Whether the property is a session property, used to save information about the current connection.
Sensitivity	String	The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName	String	A camel-cased truncated form of the connection property name.
Ordinal	Int32	The index of the parameter.
CatOrdinal	Int32	The index of the parameter category.
Hierarchy	String	Shows dependent properties associated that need to be set alongside this one.
Visible	Boolean	Informs whether the property is visible in the connection UI.
ETC	String	Various miscellaneous information about the property.

sys_sqlinfo

Describes the SELECT query processing that the Cloud can offload to the data source.

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.


Name	Description	Possible Values
AGGREGATE_FUNCTIONS	Supported aggregation functions.	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	Whether COUNT function is supported.	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	The opening character used to escape an identifier.	[
IDENTIFIER_QUOTE_CLOSE_CHAR	The closing character used to escape an identifier.	]
SUPPORTED_OPERATORS	A list of supported SQL operators.	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	Whether GROUP BY is supported, and, if so, the degree of support.	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	The supported varieties of outer joins supported.	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	Whether outer joins are supported.	YES, NO
SUBQUERIES	Whether subqueries are supported, and, if so, the degree of support.	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	Supported string functions.	LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS	Supported numeric functions.	ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS	Supported date/time functions.	NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES	Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS	A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN	String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION	Indicates if the provider supports transactions such as commit and rollback.	YES, NO
DIALECT	Indicates the SQL dialect to use.
KEY_PROPERTIES	Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS	Indicates if multiple schemas may exist for the provider.	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	Indicates if multiple catalogs may exist for the provider.	YES, NO
DATASYNCVERSION	The CData Data Sync version needed to access this driver.	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	The CData Data Sync category of this driver.	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	Whether enhanced SQL functionality beyond what is offered by the API is supported.	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	Whether batch operations are supported.	YES, NO
SQL_CAP	All supported SQL capabilities for this driver.	SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS	A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY	Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.	YES, NO
PSEUDO_COLUMNS	A string array indicating the available pseudo columns.
MERGE_ALWAYS	If the value is true, The Merge Mode is forcibly executed in Data Sync.	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION	Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE	Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY	A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION	Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID	Indicates whether the CheckCache statement should be done against the parent key column.	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns


Name	Type	Description
NAME	String	A component of SQL syntax, or a capability that can be processed on the server.
VALUE	String	Detail on the supported SQL or SQL syntax.

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

         SELECT * FROM sys_identity

Columns


Name	Type	Description
Id	String	The database-generated Id returned from a data modification operation.
Batch	String	An identifier for the batch. 1 for a single operation.
Operation	String	The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message	String	SUCCESS or an error message if the update in the batch failed.

Data Type Mapping

Data Type Mappings

The Cloud maps types from the data source to the corresponding data type available in the schema. The table below documents these mappings.


QuickBooks Online	CData Schema
BigDecimal	double
Boolean	bool
Date	date
Decimal	double
EmailAddress	string
IdType	string
Integer	int
PhysicalAddress	string
String	string
TelephoneNumber	string
WebSiteAddress	string

Custom Fields

The Cloud supports editing and saving custom fields in QuickBooks Online. Custom fields in QuickBooks Online are displayed on all estimates, invoices, sales receipts, refund receipts, and credit memos. Up to three custom fields can be added to any estimate, invoice, sales receipt, refund receipt, or credit memo.

Custom fields are also exposed as individual read-only columns that can be selected just like other columns in a table.

To create a new custom field:

Navigate to Your Account > Company Preferences -> Sales Form Entry.
In the Custom Fields section, go to the Screen Name box and enter the a name for the new custom field.

You can access the custom fields for a record in the CustomFieldAggregate column. This column contains an aggregate of the custom fields, represented as XML entities.

To modify a custom field, you must edit the corresponding XML entity. For example, you can execute an update query similar to:

UPDATE InvoiceLineItems SET CustomFieldAggregate='<CustomField><Name>Custom Field Name</Name><Type>StringType</Type><StringValue>test</StringValue><StringValue></StringValue></CustomField>' WHERE InvoiceId='782' AND Line='1'

You can also supply values for custom fields when inserting. For example:

INSERT INTO InvoiceLineItems (CustomerRef, Line_DetailType, Line_SalesItemLineDetail_ItemRef, Line_Amount, CustomFieldAggregate) VALUES ('4', 'SalesItemLineDetail', '2', 0.01, '<CustomField><DefinitionId>1</DefinitionId><Name>Custom Field Name</Name><Type>StringType</Type><StringValue>test</StringValue></CustomField>')

To clear a custom field, submit the custom field name without a value. For example:

<CustomField><Name>Custom Field Name</Name><Type>StringType</Type><StringValue></StringValue><StringValue></StringValue></CustomField>

You can also access the custom fields as individual read-only columns that can be selected like other columns on the table. These column values automatically get updated by modifying the CustomFieldAggreate value.

Note: Custom fields only support string data types. If you enter IntType or IntegerType data into a custom field, it is handled as a string.

Connection String Options

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

Property	Description
MinorVersion	Set the minor version to be used when sending requests to the QuickBooks Online API.
UseSandbox	A boolean indicating if you are using a Sandbox account.

SSL

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

Logging

Property	Description
Verbosity	The verbosity level that determines the amount of detail included in the log file.

Schema

Property	Description
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Miscellaneous

Property	Description
ArchiveMode	Boolean indicating whether to include deleted records with a standard SELECT query.
CountryCode	The country code for the edition of QuickBooks Online being used.
HideLineTotals	Whether or not to hide line totals on line item tables.
IncludeCustomFields	Set whether to include custom fields. This defaults to true.
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Pagesize	The maximum number of results to return per page from QuickBooks Online.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.

Authentication

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

Property	Description
MinorVersion	Set the minor version to be used when sending requests to the QuickBooks Online API.
UseSandbox	A boolean indicating if you are using a Sandbox account.

MinorVersion

Set the minor version to be used when sending requests to the QuickBooks Online API.

Data Type

string

Default Value

""

Remarks

Set the minor version to be used when sending requests to the QuickBooks Online API.

UseSandbox

A boolean indicating if you are using a Sandbox account.

Data Type

bool

Default Value

false

Remarks

A boolean indicating if you are using a Sandbox account.

SSL

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

SSLServerCert

The certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:


Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Logging

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

Property	Description
Verbosity	The verbosity level that determines the amount of detail included in the log file.

Verbosity

The verbosity level that determines the amount of detail included in the log file.

Data Type

string

Default Value

"1"

Remarks

The verbosity level determines the amount of detail that the Cloud reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.

Schema

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

Property	Description
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

BrowsableSchemas

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Data Type

string

Default Value

""

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

Property	Description
ArchiveMode	Boolean indicating whether to include deleted records with a standard SELECT query.
CountryCode	The country code for the edition of QuickBooks Online being used.
HideLineTotals	Whether or not to hide line totals on line item tables.
IncludeCustomFields	Set whether to include custom fields. This defaults to true.
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Pagesize	The maximum number of results to return per page from QuickBooks Online.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the Cloud throws an exception.

Cloud

QuickBooks Online - CData Cloud

Overview

Key Features

Getting Started

Connecting to QuickBooks Online

Accessing Data from CData Cloud Services

Establishing a Connection

Authenticating to QuickBooks Online

SSL Configuration

Customizing the SSL Configuration

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

Other Proxies

Data Model

Tables

Views

Stored Procedures

Tables

CData Cloud - QuickBooks Online Tables

Accounts

Table Specific Information

Select

Columns

AttachableRefs

Table Specific Information

Select

Columns

Attachables

Table Specific Information

Select

Columns

BillLineItems

Table Specific Information

Select

Insert

Columns

BillLinkedTransactions

Columns

BillPaymentLineItems

Table Specific Information

Select

Insert

Columns

BillPayments

Table Specific Information

Select

Insert

Columns

Bills

Table Specific Information

Select

Insert

Columns

BudgetDetails

Columns

Budgets

Table Specific Information

Select

Columns

Class

Table Specific Information

Select

Columns

CompanyCurrency

Table Specific Information

Select

Columns

CompanyInfo

Columns

CreditMemoLineItems

Table Specific Information

Select

Insert

Columns

CreditMemos

Table Specific Information

Select

Insert