TIBCO Scribe® Online Connector For QuickBooks Online

Use the TIBCO Scribe® Online Connector For QuickBooks Online to accessQuickBooks Online Online data, including customers, invoices and payments. Use it to automate order processing and synchronize customer data with your sales, service, e-commerce, and support systems.

Connector Specifications

  Supported
Agent Types
On Premise X
Cloud X
Replication Services
Source  
Target  
Integration Services
Source X
Target X
Migration Services
Source X
Target X
Maps
Integration X
Request-Reply X
Message  

This Connector is available from the TIBCO Scribe® Online Marketplace. See Marketplace TIBCO Scribe® Certified Connectors for more information.

Supported Entities

The QuickBooks Online Connector supports the following entities. Click a linked entity name for additional information when using that entity in TIBCO Scribe® Online. For a list of additional operations by entity see Special Operations.

Standard Operations

Entity Query Create Update Delete Upsert

Account

X

 

 

 

 

Bill

X

 

 

X

 

BillPayment

X

 

 

X

 

Bundle

X

 

 

 

 

Category

X

 

 

 

 

Customer

X

 

 

 

 

Employee

X

 

 

 

 

Estimate

X

 

 

X

 

Invoice

X

 

 

X

 

Item

X

 

 

 

 

JournalEntry

X

 

 

X

 

Line

X

 

 

 

 

LinkedTxn

X

 

 

 

 

Payment

X

 

 

X

 

Purchase

X

 

 

X

 

TaxAgency

X

 

 

 

 

TaxClassification

X

 

 

 

 

TaxCode

X

 

 

 

 

TaxRate

X

 

 

 

 

Vendor

X

 

 

 

 

Special Operations

Entity Operations

Account

-CreateWith

-UpdateWith

Bill

-CreateWith

-UpdateWith

BillPayment

-Add

-CreateWith

-UpdateWith

Category

-Add

-CreateWith

-UpdateWith

Customer

-Add

-CreateWith

-UpdateWith

Employee

-Add

-CreateWith

-UpdateWith

Estimate

-Add

-CreateWith

-UpdateWith

-Send

Invoice

-Add

-CreateWith

-UpdateWith

-Send

-Void

Item

-Add

-CreateWith

-UpdateWith

JournalEntry

-Add

-CreateWith

-UpdateWith

Payment

-Add

-CreateWith

-UpdateWith

-Void

Purchase

-Add

-CreateWith

-UpdateWith

Vendor

-Add

-CreateWith

-UpdateWith

Setup Considerations

If you have multiple QuickBooks Online Connections to a QuickBooks Online Company, note the following:

API Usage Limits

The Production QuickBooks Online API limits API calls as follows, but may be changed by Inutit without notice: 

Note: Refreshing metadata for the Connector consumes API calls.

Selecting An Agent Type For QuickBooks Online

Refer to TIBCO Scribe® Online Agents for information on available Agent types and how to select the best Agent for your Solution.

Connecting To QuickBooks Online

Note: Best practice is to create Connections with credentials that limit permissions in the target system, following the principle of least privilege. Using Administrator level credentials in a Connection provides Administrator level access to the target system for TIBCO Scribe® Online users. Depending on the entities supported, a TIBCO Scribe® Online user could alter user accounts in the target system.

  1. Select More > Connections from the menu.
  2. From the Connections page select Add to open the Add a New Connection dialog.
  3. Select the Connector from the drop-down list in the Connection Type field, and then enter the following information for this Connection:
    • Name — This can be any meaningful name, up to 25 characters.
    • Alias — An alias for this Connection name. The alias is generated from the Connection name, and can be up to 25 characters. The Connection alias can include letters, numbers, and underscores. Spaces and special characters are not accepted. You can change the alias. For more information, see Connection Alias.
    • Company ID/Realm ID — A unique number used to identify the company you want to access within QuickBooks Online. In QuickBooks Online navigate to Settings > Your Account > Billing & Subscription to locate your ID. Enter the ID without spaces.
    • Is Sandbox Environment — Enable this check box if you are connecting to a company in a developer Sandbox account.
  4. Select Authenticate to open the QuickBooks Online authorization page:
    • If you are not already logged into QuickBooks Online, the QuickBooks Online login page displays. Enter your email address and password, and select Sign in.
    • If this is the first time you are creating a QuickBooks Online Connection, the QuickBooks Online Authorization page displays. Select Connect to allow QuickBooks Online to use the data specified.

      A page with the following message displays:

  5. Select Test to ensure that the Agent can connect to your database. Be sure to test the Connection against all Agents that use this Connection. See Testing Connections.
  6. Select OK to save the Connection.

Metadata Notes

Consider the following for QuickBooks Online data fields and entity types.

Naming

Connection metadata must have unique entity, relationship, and field names. If your Connection metadata has duplicate names, review the source system to determine if the duplicates can be renamed.

Relationships

Retry Logic

When a timeout occurs, the QuickBooks Online Connector retries three times with the following delays in between:

When a throttle limit exceeded error is received, the QuickBooks Online Connector retries three times with a 60 second delay between each retry.

QuickBooks Online Connector As IS/MS Source

Consider the following when using the QuickBooks Online Connector as an Integration or Migration Solution source.

Lookup Blocks

Filtering

Net Change

When a datetime is configured on the Query Block on the Block Properties Net Change Tab to query for new and updated records, that configuration is treated as an additional filter. The Net Change datetime filter is applied as an AND after any other filters specified on the Block Properties Filter Tab. TIBCO Scribe® Online builds a query combining both the Net Change filter and the filters on the Filter tab. See Net Change And Filters for an example.

Some Connectors for TIBCO Scribe® Online only support one filter. For those Connectors you can use either Net Change or one filter on the Filter tab, not both.

Note: The Net Change date is ignored when previewing data on the Preview tab. Filters on the Block Properties Filters tab are used to filter the data on the Preview tab.

When using Net Change to filter for new and updated records, do not use the DueDate or TxnDate fields as the filter date. These dates do not contain a timestamp and could cause new and updated records to be missed during a subsequent query.

QuickBooks Online Connector As IS/MS Target

Consider the following when using the QuickBooks Online Connector as an Integration or Migration Solution target.

Matching Criteria

Fields available as filters for an entity are also available in target operations that require Matching Criteria. However, best practice is to use Id and SyncToken fields for the most efficient performance.

The SyncToken field is ignored unless it is used with the Id field in Matching Criteria with the Id. When both are used, all other Matching Criteria are ignored.

Required Fields

In some cases, required fields on the Block Properties Fields tab may not be marked as required nor is an error generated on the Errors and Warnings tab after validation. These fields may be required only under certain conditions or the API may not indicate that they are required. When a required field is missing, running the Map generates an error similar to the following:

Operation failed. Label: CreateWith Purchase, Name: PurchaseCreateWith, Message: Status Code: BadRequest Reason Phrase: Bad Request Content as String: {"Fault":{"Error":[{"Message":"Required param missing, need to supply the required value for the API","Detail":"Required Parameter Line.DetailType is missing in the request"

Notes On Standard Entities

Account

Fields

Some AccountSubType field values are available in the QuickBooks Online API, but are not supported. The following values generate an Invalid Enumeration error when used in a TIBCO Scribe® Online field mapping:

The AccountSubType field value UndistributedTips under AccountType Other Current Liability is available in the QuickBooks Online UI but is not supported in the API.An Invalid Enumeration error is generated when this value is used in a TIBCO Scribe® Online field mapping.

In some cases, the names of AccountTypes and AccountSubTypes are not the same in the QuickBooks Online UI and API. When viewing AccountType and AccountSubType values in the Query Block Preview Tab, the UI names are displayed. However, when mapping a value in the Fields tab of a target operation Block, you must use the name recognized by the API.

UI Value

API Value

Notes

AccountType

AccountSubType

AccountType

AccountSubType

 

Expenses

Tax Expense

Expense

GlobalTaxExpense

The UI value, Tax Expense, is visible when the API value, GlobalTaxExpense has been added using a TIBCO Scribe® Online field mapping. However, Tax Expense cannot be selected using the QuickBooks Online UI.

Other Expense

  Mortgage Interest Home Office

  Rent and Lease Home Office

Other Expense

  MortgageInterest

  RentAndLease

 

Expense

Utilities Home Office

Other Expense

Utilities

 

Other Current Liability

  Sales Tax Payable

  SalesTax Suspense

  Direct Deposit Payable

Other Current Liability

  GlobalTaxPayable

  GlobalTaxSuspense

  DirectDeposit Payable

The UI values, Sales Tax Suspense and Direct Deposit Payable are visible when GlobalTaxSuspense or DirectDepositPayable have been added using a TIBCO Scribe® Online field mapping. However, those values cannot be selected using the QuickBooks Online UI.

When entering a value for the AccountSubType field, do not use any spaces or special characters.See the Account Entity Field Values And Dependencies table for a list of valid field values.

Descriptions for some Account entity enum fields displayed on the Block Properties Fields tab do not contain the entire list of possible values because that list is too long. In addition there are dependencies between these fields. For example, if the Classification field value is ASSET, then the AccountType field value is limited to Bank, OtherCurrentAsset, FixedAsset, OtherAsset, or AccountsReceivable. The field value in AccountType in turn limits the value of AccountSubType. Review the Account Entity Field Values And Dependencies table for the complete list of values and dependencies.

Account Entity Field Values And Dependencies

 

Classification Field

ASSET

AccountType Fields

AccountSubType Fields

Bank

  CashAndCashEquivalents

  CashOnHand

  Checking

  MoneyMarket

  OtherEarMarkedBankAccounts

  RentsHeldInTrust

  Savings

  TrustAccounts

Other Current Asset

  AllowanceForBadDebts

  AssetsAvailableForSale

  BalWithGovtAuthorities

  CalledUpShareCapitalNotPaid

  DevelopmentCosts

  EmployeeCashAdvances

  ExpenditureAuthorisationsAndLettersOfCredit

  GlobalTaxDeferred

  GlobalTaxRefund

  InternalTransfers

  Inventory

  Investment_MortgageRealEstateLoans

  Investment_Other

  Investment_TaxExemptSecurities

  Investment_USGovernmentObligations

  LoansToOfficers

  LoansToOthers

  LoansToStockholders

  OtherConsumables

  OtherCurrentAssets

  PrepaidExpenses

  ProvisionsCurrentAssets

  Retainage

  ShortTermInvestmentsInRelatedParties

  ShortTermLoansAndAdvancesToRelatedParties

  TradeAndOtherReceivables

  UndepositedFunds

FixedAsset

  AccumulatedAmortization

  AccumulatedDepletion

  AccumulatedDepreciation

  AssetsInCourseOfConstruction

  Buildings

  CapitalWip

  CumulativeDepreciationOnIntangibleAssets

  DepletableAssets

  FixedAssetComputers

  FixedAssetCopiers

  FixedAssetFurniture

  FixedAssetPhone

  FixedAssetPhotoVideo

  FixedAssetSoftware

  FixedAssetOtherToolsEquipment

  FurnitureAndFixtures (default)

  IntangibleAssets

  IntangibleAssetsUnderDevelopment

  Land

  LandAsset

  LeaseholdImprovements

  MachineryAndEquipment

  NonCurrentAssets

  OtherFixedAssets

  ParticipatingInterests

  ProvisionsFixedAssets

  Vehicles

OtherAsset

  AccumulatedAmortizationOfOtherAssets

  AssetsHeldForSale

  AvailableForSaleFinancialAssets

  DeferredTax

  Goodwill

  Investments

  LeaseBuyout

  Licenses

  LongTermInvestments

  LongTermLoansAndAdvancesToRelatedParties

  OrganizationalCosts

  OtherIntangibleAssets

  OtherLongTermAssets

  OtherLongTermInvestments

  OtherLongTermLoansAndAdvances

  PrepaymentsAndAccruedIncome

  ProvisionsNonCurrentAssets

  SecurityDeposits

Accounts Receivable

  AccountsReceivable

 

EQUITY

AccountType Fields

AccountSubType Fields

Equity

  AccumulatedAdjustment

  AccumulatedOtherComprehensiveIncome

  CalledUpShareCapital

  CapitalReserves

  CommonStock

  DividendDisbursed

  EquityInEarningsOfSubsiduaries

  EstimatedTaxes

  Funds

  Healthcare

  InvestmentGrants

  MoneyReceivedAgainstShareWarrants

  OpeningBalanceEquity

  OtherFreeReserves

  OwnersEquity

  PaidInCapitalOrSurplus

  ​PartnerContributions

  PartnerDistributions

  PartnersEquity

  PreferredStock

  PersonalExpense

  PersonalIncome

  RetainedEarnings

  ShareApplicationMoneyPendingAllotment

  ShareCapital

  TreasuryStock

EXPENSE

AccountType Fields

AccountSubType Fields

Expense

  AdvertisingPromotional

  AmortizationExpense

  AppropriationsToDepreciation

  Auto

  BadDebts

  BankCharges

  BorrowingCost

  CharitableContributions

  CommissionsAndFees

  CostOfLabor

  DistributionCosts

  DuesSubscriptions

  Entertainment

  EntertainmentMeals

  EquipmentRental

  ExternalServices

  ExtraordinaryCharges

  FinanceCosts

  GlobalTaxExpense

  IncomeTaxExpense

  Insurance

  InterestPaid

  LegalProfessionalFees

  LossOnDiscontinuedOperationsNetOfTax

  ManagementCompensation

  OtherCurrentOperatingCharges

  OfficeExpenses

  OfficeGeneralAdministrativeExpenses

  OtherBusinessExpenses

  OtherExternalServices

  OtherMiscellaneousServiceCost

  OtherRentalCosts

  OtherSellingExpenses

  PayrollExpenses

  ProjectStudiesSurveysAssessments

  PromotionalMeals

  PurchasesRebates

  RentOrLeaseOfBuildings

  RepairMaintenance

  ShippingAndDeliveryExpense

  ShippingFreightDelivery

  StaffCosts

  Sundry

  SuppliesMaterials

  TaxesPaid

  Travel

  TravelExpensesGeneralAndAdminExpenses

  TravelExpensesSellingExpense

  TravelMeals

  UnappliedCashBillPaymentExpense

  Utilities

Other Expense

  Amortization

  DeferredTaxExpense

  Depletion

  Depreciation

  ExceptionalItems

  ExchangeGainOrLoss

  ExtraordinaryItems

  GasAndFuel

  HomeOffice

  HomeOwnerRentalInsurance

  IncomeTaxOtherExpense

  MatCredit

  MortgageInterest

  OtherHomeOfficeExpenses

  OtherMiscellaneousExpense

  OtherVehicleExpenses

  ParkingAndTolls

  PenaltiesSettlements

  PriorPeriodItems

  RentAndLease

  RepairsAndMaintenance

  TaxRoundoffGainOrLoss

  Utilities

  Vehicle

  VehicleInsurance

  VehicleLease

  VehicleLoanInterest

  VehicleLoan

  VehicleRegistration

  VehicleRepairs

  WashAndRoadServices

Cost of Goods Sold

  CostOfLaborCos

  CostOfSales

  EquipmentRentalCos

  FreightAndDeliveryCost

  OtherCostsOfServiceCos

  ShippingFreightDeliveryCos

  SuppliesMaterialsCogs

LIABILITY

AccountType Fields

AccountSubType Fields

Accounts Payable

  Accounts Payable

  OutstandingDuesMicroSmallEnterprise

  OutstandingDuesOtherThanMicroSmallEnterprise

Credit Card

  Credit Card

 

Long Term Liability

  AccrualsAndDeferredIncome

  AccruedLongLermLiabilities

  AccruedVacationPayable

  BankLoans

  DebtsRelatedToParticipatingInterests

  DeferredTaxLiabilities

  GovernmentAndOtherPublicAuthorities

  GroupAndAssociates

  LiabilitiesRelatedToAssetsHeldForSale

  LongTermBorrowings

  LongTermDebit

  LongTermEmployeeBenefitObligationsNotesPayable

  ObligationsUnderFinanceLeases

  OtherLongTermLiabilities

  OtherLongTermProvisions

  ProvisionForLiabilities

  ProvisionsNonCurrentLiabilities

  ShareholderNotesPayable

  StaffAndRelatedLongTermLiabilityAccounts

Other Current Liability

  AccruedLiabilities

  CurrentLiabilities

  CurrentPortionEmployeeBenefitsObligations

  CurrentPortionOfObligationsUnderFinanceLeases

  CurrentTaxLiability

  DirectDepositPayable

  DividendsPayable

  DutiesAndTaxes

  FederalIncomeTaxPayable

  InsurancePayable

  InterestPayables

  LineOfCredit

  LoanPayable

  GlobalTaxPayable

  GlobalTaxSuspense

  OtherCurrentLiabilities

  PayrollClearing

  PayrollTaxPayable

  PrepaidExpensesPayable

  ProvisionForWarrantyObligations

  ProvisionsCurrentLiabilities

  RentsInTrustLiability

  SalesTaxPayable

  ShortTermBorrowings

  SocialSecurityAgencies

  StaffAndRelatedLiabilityAccounts

  StateLocalIncomeTaxPayable

  SundryDebtorsAndCreditors

  TradeAndOtherPayables

  TrustAccountsLiabilities

REVENUE

AccountType Fields

AccountSubType Fields

Income

  CashReceiptIncome

  DiscountsRefundsGiven

  NonProfitIncome

  OperatingGrants

  OtherCurrentOperatingIncome

  OtherPrimaryIncome

  OwnWorkCapitalized

  RevenueGeneral

  SalesOfProductIncome

  SalesRetail

  SalesWholesale

  SavingsByTaxScheme

  ServiceFeeIncome

  UnappliedCashPaymentIncome

Other Income

  DividendIncome

  GainLossOnSaleOfFixedAssets

  GainLossOnSaleOfInvestments

  InterestEarned

  LossOnDisposalOfAssets

  OtherInvestmentIncome

  OtherMiscellaneousIncome

  OtherOperatingIncome

  TaxExemptInterest

  UnrealisedLossOnSecuritiesNetOfTax

 

Bundle

Category

Estimate

Invoice

Item

Line

LinkedTxn

Payment

TaxClassification

TaxCode

TaxRate

TIBCO Scribe® Online API Considerations

Note: Connectors using OAuth for authentication are not fully supported by the TIBCO Scribe® Online API at this time.

License Agreement

The TIBCO Scribe® Online End User License Agreement for the QuickBooks Online Connector describes TIBCO and your legal obligations and requirements. TIBCO suggests that you read the End User License Agreement.

More Information

For additional information on this Connector, refer to the Knowledge Base and Discussions in the TIBCO Community.