QuickBooks: Read a bill — response body — Bill
Read a bill: response body, field Bill. Complete fields and constraints for contract 2026-10-20.
API reference · Contract 2026-10-20
SDK schema: Read a bill — response body — Bill
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
APAccountRef | Model | Optional | Expand Read an item — response body — Item Class Ref Specifies to which AP account the bill is credited. Query the Account name list resource to determine the appropriate Account object for this reference. Use Account.Id and Account.Name from that object for APAccountRef.value and APAccountRef.name , respectively. The specified account must have Account.Classification set to Liability and Account.AccountSubType set to AccountsPayable . If the company has a single AP account, the account is implied. However, it is recommended that the AP Account be explicitly specified in all cases to prevent unexpected errors when relating transactions to each other. |
Balance | JSON | Optional | The balance reflecting any payments made against the transaction. Initially set to the value of TotalAmt . A Balance of 0 indicates the bill is fully paid. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true |
Balance (anyOf 1) | JSON | Alternative | |
Balance (anyOf 1) (anyOf 1) | number | Alternative | |
Balance (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Balance (anyOf 2) | string | Alternative | |
CurrencyRef | Model | Optional | Expand Read a bill — response body — Bill Currency Ref Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multicurrency is enabled for the company. Multicurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true . Read more about multicurrency support here . Required if multicurrency is enabled for the company. Conditionally required |
DepartmentRef | Model | Optional | Expand Read an item — response body — Item Class Ref A reference to a Department object specifying the location of the transaction, as defined using location tracking in QuickBooks Online. Query the Department name list resource to determine the appropriate department object for this reference. Use Department.Id and Department.Name from that object for DepartmentRef.value and DepartmentRef.name , respectively. |
DocNumber | string | Optional | Reference number for the transaction. If not explicitly provided at create time, a custom value can be provided. If no value is supplied, the resulting DocNumber is null. Throws an error when duplicate DocNumber is sent in the request. Recommended best practice: check the setting of Preferences:OtherPrefs before setting DocNumber. If a duplicate DocNumber needs to be supplied, add the query parameter name/value pair, include=allowduplicatedocnum to the URI. Sort order is ASC by default. |
DueDate | string | Optional | Date when the payment of the transaction is due. If date is not provided, the number of days specified in SalesTermRef added the transaction date will be used. |
ExchangeRate | JSON | Optional | 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. Decimal string |
ExchangeRate (anyOf 1) | JSON | Alternative | |
ExchangeRate (anyOf 1) (anyOf 1) | number | Alternative | |
ExchangeRate (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
ExchangeRate (anyOf 2) | string | Alternative | |
GlobalTaxCalculation | string | Optional | Method in which tax is applied. Allowed values are: TaxExcluded , TaxInclusive , and NotApplicable . Not applicable to US companies; required for non-US companies. Conditionally required |
HomeBalance | JSON | Optional | Convenience field containing the amount in Balance expressed in terms of the home currency. Calculated by QuickBooks business logic. Value is valid only when CurrencyRef is specified. Applicable if multicurrency is enabled for the company. Decimal string Read only: true |
HomeBalance (anyOf 1) | JSON | Alternative | |
HomeBalance (anyOf 1) (anyOf 1) | number | Alternative | |
HomeBalance (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
HomeBalance (anyOf 2) | string | Alternative | |
Id | string | Optional | Unique identifier for this object. Read only: true |
IncludeInAnnualTPAR | JSON | Optional | Include the supplier in the annual TPAR. TPAR stands for Taxable Payments Annual Report. The TPAR is mandated by ATO to get the details payments that businesses make to contractors for providing services. Some government entities also need to report the grants they have paid in a TPAR. |
IncludeInAnnualTPAR (anyOf 1) | boolean | Alternative | |
IncludeInAnnualTPAR (anyOf 2) | string | Alternative | Known values: true, false |
Line | array | Optional | Individual line items of a transaction. Valid Line types include: ItemBasedExpenseLine and AccountBasedExpenseLine |
Line[] | JSON | Each item | |
Line[] (anyOf 1) | Model | Alternative | Expand Read a bill — response body — Bill Line item Amount, Custom Extensions, Description, Detail Type, Id, Item Based Expense Line Detail, Line Num, Linked Txn |
Line[] (anyOf 2) | Model | Alternative | Expand Read a bill — response body — Bill Line item Account Based Expense Line Detail, Amount, Custom Extensions, Description, Detail Type, Id, Line Num, Linked Txn |
LinkedTxn | array | Optional | Zero or more transactions linked to this Bill object. The LinkedTxn.TxnType can be set to PurchaseOrder , BillPaymentCheck , or ReimburseCharge . Use LinkedTxn.TxnId as the ID of the transaction. |
LinkedTxn[] | Model | Each item | Expand Read a bill — response body — Bill Linked Txn item |
MetaData | Model | Optional | Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications. |
PrivateNote | string | Optional | User entered, organization-private note about the transaction. This note does not appear on the invoice to the customer. This field maps to the Memo field on the Invoice form. |
RecurDataRef | Model | Optional | Expand Read an item — response body — Item Class Ref A reference to the Recurring Transaction. It captures what recurring transaction template the Bill was created from. Read only: true |
SalesTermRef | Model | Optional | Expand Read an item — response body — Item Class Ref Reference to the Term associated with the transaction. Query the Term name list resource to determine the appropriate Term object for this reference. Use Term.Id and Term.Name from that object for SalesTermRef.value and SalesTermRef.name , respectively. |
SyncToken | string | Optional | 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. Read only: true |
TotalAmt | JSON | Optional | Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. Calculated by QuickBooks business logic; any value you supply is over-written by QuickBooks. Decimal string Read only: true |
TotalAmt (anyOf 1) | JSON | Alternative | |
TotalAmt (anyOf 1) (anyOf 1) | number | Alternative | |
TotalAmt (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
TotalAmt (anyOf 2) | string | Alternative | |
TxnDate | string | Optional | The date entered by the user when this transaction occurred. For posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Sort order is ASC by default. |
TxnTaxDetail | Model | Optional | Expand Read a bill — response body — Bill Txn Tax Detail This data type provides information for taxes charged on the transaction as a whole. It captures the details of all taxes calculated for the transaction based on the tax codes referenced by the transaction. This can be calculated by QuickBooks business logic or you may supply it when adding a transaction. If sales tax is disabled ( Preferences.TaxPrefs.UsingSalesTax is set to false ) then TxnTaxDetail is ignored and not stored. |
VendorRef | Model | Optional | Expand Read an item — response body — Item Class Ref Reference to the vendor for this transaction. Query the Vendor name list resource to determine the appropriate Vendor object for this reference. Use Vendor.Id and Vendor.Name from that object for VendorRef.value and VendorRef.name , respectively. |
Referenced models: Read a bill — response body — Bill Line item Account Based Expense Line Detail, Amount, Custom Extensions, Description, Detail Type, Id, Line Num, Linked Txn, Read a bill — response body — Bill Currency Ref, Read a bill — response body — Bill Line item Amount, Custom Extensions, Description, Detail Type, Id, Item Based Expense Line Detail, Line Num, Linked Txn, Read a bill — response body — Bill Linked Txn item, Read a bill — response body — Bill Meta Data, Read an item — response body — Item Class Ref, Read a bill — response body — Bill Txn Tax Detail