CData Python Connector for QuickBooks Online

Build 25.0.9454

Bills

Represents vendor bills in QuickBooks Online, enabling you to create, modify, delete, and retrieve obligations that are owed to suppliers for goods or services received.

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 identifier (Id) of the bill. This Id uniquely identifies the bill record within QuickBooks Online.

SyncToken String True False False

The version number that is assigned to the bill object. The sync token locks the object for one application at a time, and QuickBooks Online increments it after each modification. An update or delete operation that uses an older sync token fails, ensuring that only the latest version of the object is maintained.

MetaData_CreateTime Datetime True True True

The date and time when the bill record was originally created in QuickBooks Online. The CreateTime value provides a reference point for auditing and synchronization.

MetaData_LastUpdatedTime Datetime True True True

The date and time when the bill record was last updated in QuickBooks Online. The LastUpdatedTime value helps track changes and identify the most recent version of the record.

DocNumber String False True True

The document reference number that is associated with the transaction. This document number allows users to match QuickBooks transactions to external documents such as vendor invoices.

TxnDate Date False True True

The date that is entered by the user for when this transaction occurred. This date is used as the posting date in financial statements.

PrivateNote String False False False

A private, internal note about the transaction. The private note does not appear on printed or shared transaction records by default.

LinkedTxnAggregate String False False False

An XML aggregate that contains the transactions that are linked to the bill. This column enables applications to retrieve related transactions in a structured format.

LineAggregate String False False False

An XML aggregate that contains the line items that are associated with the bill. This column enables applications to retrieve related lines in a structured format.

VendorRef String False

Vendors.Id

True True

The Id of the vendor that is associated with this bill. This Id links the bill to the supplier providing the goods or services.

VendorRef_Name String True

Vendors.DisplayName

False False

The name of the vendor that is associated with this bill. This name is the human-readable counterpart to the VendorRef Id.

APAccountRef String False

Accounts.Id

True True

The Id of the accounts-payable account that is used for this bill. This Id connects the bill to the correct liability account in the chart of accounts.

APAccountRef_Name String True

Accounts.Name

False False

The name of the accounts-payable account that is used for this bill. This name is the human-readable counterpart to the APAccountRef Id.

TotalAmt Decimal False True True

The total monetary amount due on the bill. This total is determined by summing all line items associated with the bill.

SalesTermRef String False

Terms.Id

True True

The Id of the sales-terms entity that is applied to this bill. This Id identifies the payment terms such as Net 30 or Due on Receipt.

SalesTermRef_Name String True

Terms.Name

False False

The name of the sales-terms entity that is applied to this bill. This name is the human-readable counterpart to the SalesTermRef Id.

DueDate Date False True True

The date by which the bill must be paid according to its payment terms. This date excludes early-payment discount incentives and late-payment penalties.

Balance Decimal True True False

The unpaid balance of the bill at the time of retrieval. This balance shows the remaining amount due and becomes zero when fully paid.

DepartmentRef String False

Departments.Id

False False

The Id of the department that is associated with this transaction. The department stores the location or division of the transaction as defined by using location tracking in QuickBooks Online.

DepartmentRef_Name String True

Departments.Name

False False

The name of the department that is associated with this transaction. This name is the human-readable counterpart to the DepartmentRef Id.

TxnTaxDetail_TxnTaxCodeRef String False

TaxCodes.Id

False False

The tax code that is applied to this transaction at the transaction level. The tax code determines how QuickBooks Online calculates tax for the bill.

TxnTaxDetail_TotalTax String False False False

The total amount of tax that is calculated for the transaction, excluding any tax lines that are manually inserted into the transaction line list. This total shows the full tax impact of the transaction.

TxnTaxDetail_TaxLineAggregate String False False False

An XML aggregate that contains the details of each tax line item that is included in this transaction. This column enables applications to retrieve related tax lines in a structured format.

CurrencyRef String False False False

The Id of the currency that is used in this transaction. This currency reference is relevant when the multicurrency feature is enabled in the company file.

CurrencyRef_Name String True False False

The name of the currency that is used in this transaction. This name is the human-readable counterpart to the CurrencyRef Id.

ExchangeRate Decimal False False False

The exchange rate that is applied to convert one unit of the bill's currency into the home currency. The exchange rate is valid only when the multicurrency feature is enabled. In QuickBooks Online, exchange rates are recorded as the number of home currency units that are required to equal one foreign currency unit. This field is available only in the UK, AU, and CA editions.

GlobalTaxCalculation String False False False

The method that is used to apply taxes to this transaction (for example, TaxInclusive or TaxExcluded). This column is valid only in the UK, AU, and CA editions.

The allowed values are TaxExcluded, TaxInclusive, NotApplicable.

TransactionLocationType String False False False

The account location type that is used in this transaction. This column is valid only in the FR editions.

The allowed values are WithinFrance, FranceOverseas, OutsideFranceWithEU, OutsideEU.

IncludeInAnnualTPAR Boolean False False False

Indicates whether the supplier is included in the annual Taxable Payments Annual Report (TPAR). The TPAR is mandated by the Australian Taxation Office (ATO) to report payments that businesses make to contractors for providing services. Some government entities also need to report grants they have paid in a TPAR.

RecurDataRef String True False False

The Id for the referenced object as found in the Id field of the object payload. The context is set by the type of reference and is specific to the QuickBooks company file.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9454