Bill Quickbooks Online Documentation

Quickbooks API Reference



Bill

Fields

  • Payer Ref
    PayerRef: Payer Ref -- Payer information
    Product: QBW

  • Sales Term Ref
    SalesTermRef: Sales Term Ref -- SalesTerm Reference for the bill

  • Due Date
    DueDate: Due Date -- The nominal date by which the bill must be paid, not including any early-payment discount incentives, or late payment penalties.

  • Due Date Specified
    DueDateSpecified: Due Date Specified -- Bill.DueDateSpecified

  • Remit To Addr
    RemitToAddr: Remit To Addr -- Address to which the payment should be sent.
    QuickBooks Notes: Non QB-writable.

  • Ship Addr
    ShipAddr: Ship Addr -- Address to which the vendor shipped or will ship any goods associated with the purchase.

  • Balance
    Balance: Balance -- The unpaid amount of the bill. When paid-in-full, balance will be zero.
    QuickBooks Notes: Non QB-writable. Filterable: QBW Sortable: QBW
    Product: ALL

  • Balance Specified
    BalanceSpecified: Balance Specified -- Bill.BalanceSpecified

  • Bill Ex
    BillEx: Bill Ex -- Internal use only: extension place holder for Bill.

  • Vendor Ref
    VendorRef: Vendor Ref -- Specifies the vendor reference for this transaction Filterable: QBW
    Product: ALL

  • A P Account Ref
    APAccountRef: A P Account Ref -- Specifies which AP account the bill will be credited to. Many/most small businesses have a single AP account, so the account is implied. When specified, the account must be a Liability account, and further, the sub-type must be of type "Payables"
    QuickBooks Notes: The AP Account should always be specified or a default will be used.

  • Total Amt
    TotalAmt: Total Amt -- The total amount due, determined by taking the sum of all lines associated. This includes all charges, allowances, taxes, discounts, etc...
    QuickBooks Notes: Non QB-writable. Output only field in case of QBO Filterable: QBW Sortable: QBW
    Product: ALL

  • Total Amt Specified
    TotalAmtSpecified: Total Amt Specified -- Bill.TotalAmtSpecified

  • Bill Email
    BillEmail: Bill Email -- The email address to which this bill is/was sent.
    Non QB-writable.
    Product: QBW

  • Reply Email
    ReplyEmail: Reply Email -- The email address to which inquiries about the bill may be directed. (Also appropriate for paypal payments).
    Non QB-writable.
    Product: QBW

  • Memo
    Memo: Memo -- QBW only. Memo to be visible to Payee

  • Global Tax Calculation
    GlobalTaxCalculation: Global Tax Calculation -- Indicates the GlobalTax model if the model inclusive of tax, exclusive of taxes or not applicable
    Product: QBO
    GlobalTaxCalculation Enumerated Values:
    • TaxInclusive
    • TaxExcluded
    • NotApplicable

  • Global Tax Calculation Specified
    GlobalTaxCalculationSpecified: Global Tax Calculation Specified -- Bill.GlobalTaxCalculationSpecified

  • Doc Number
    DocNumber: Doc Number -- QBO: Reference number for the transaction. If DocNumber is not provided, and the Custom Transaction Number is set to "Off", QBO assigns a document number using the next-in-sequence algorithm for Sales transactions. Otherwise the value will remaing null. Alternatively, you can also pass in "AUTO_GENERATE" in this field to force QBO to auto-sequence the document number for Invoices, Estimates and Sales Receipt.The maximum length for DocNumber is 21 characters. The default value is an empty String. Filter support not provided for Payment. Description: QBW: The primary document number for this transaction. DocNumber is exposed to end users.If it is not provided, QuickBooks business logic will assign the document number using the "next in sequence" algorithm.Max. length is 11 characters for Payment, Bill, ItemReceipt and VendorCredit. Max. length is 20 characters for other entities. Filterable: QBO InputType: ReadWrite ValidRange: QBW: max=11 ValidRange: QBO: max=21
    Field Length in QB Desktop: 11
    Field Length in QB Online: 21
    Product: ALL

  • Txn Date
    TxnDate: Txn Date -- QBO: The date entered by the user when this transaction occurred. Often, it is the date when the transaction is created in the system. 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. Description: QBW: The nominal, user entered, date of the transaction. Often, but not required to be, the date the transaction was created in the system. For "posting" transactions, this is the posting date that affects financial statements. Filterable: ALL Sortable: ALL InputType: ReadWrite
    Product: ALL

  • Txn Date Specified
    TxnDateSpecified: Txn Date Specified -- Bill.TxnDateSpecified

  • Department Ref
    DepartmentRef: Department Ref -- Location of the transaction, as defined using location tracking in QuickBooks Online.
    Product: QBO

  • Currency Ref
    CurrencyRef: Currency Ref -- Reference to the Currency in which all amounts on the associated transaction are expressed. InputType: ReadWrite
    Product: ALL

  • Exchange Rate
    ExchangeRate: Exchange Rate -- Currency exchange rate. Valid only if the company file is set up to use Multi-Currency feature. In QuickBooks, exchange rates are always recorded as the number of home currency units it takes to equal one foreign currency unit. The foreign unit is always 1 and the amount of home units that equal that 1 foreign unit is what QuickBooks uses as the exchange rate. InputType: ReadWrite
    Product: ALL

  • Exchange Rate Specified
    ExchangeRateSpecified: Exchange Rate Specified -- Bill.ExchangeRateSpecified

  • Private Note
    PrivateNote: Private Note -- User entered, organization-private note about the transaction. This note will not appear on the transaction records by default. InputType: ReadWrite
    Product: ALL

  • Txn Status
    TxnStatus: Txn Status -- QBW: 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 Estimate, the values accepted are defined in EstimateStatusEnum. Description: QBO: 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 Estimate, the values accepted are defined in QboEstimateStatusEnum. Filterable:QBW
    Product: ALL

  • Linked Txn
    LinkedTxn: Linked Txn -- A linked (related) transaction. More than one transaction can be linked.
    Product: ALL

  • Line
    Line: Line -- A line item of a transaction. Product: QBO Description: A line item of a transaction. QuickBooks Online does not support tax lines in the main transaction body, only in the TxnTaxDetail section.
    Product: QBW

  • Txn Tax Detail
    TxnTaxDetail: Txn Tax Detail -- Details of taxes charged on the transaction as a whole. For US versions of QuickBooks, tax rates used in the detail section must not be used in any tax line appearing in the main transaction body. For international versions of QuickBooks, the TxnTaxDetail should provide the details of all taxes (sales or purchase) 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. For US versions of QuickBooks you need only supply the tax code for the customer and the tax code (in the case of multiple rates) or tax rate (for a single rate) to apply for the transaction as a whole.
    See Global Tax Model.
    Product: ALL

  • Txn Source
    TxnSource: Txn Source -- Originating source of the Transaction. Valid values are defined in TxnSourceEnum: QBMobile.
    Product: QBO

  • Sync Token
    SyncToken: Sync Token -- Version number of the entity. The SyncToken is used to lock the entity for use by one application at a time. As soon as an application modifies an entity, its SyncToken is incremented; another application's request to modify the entity with the same SyncToken will fail. Only the latest version of the entity is maintained by Data Services. An attempt to modify an entity specifying an older SyncToken will fail. Required for the update operation. Required: ALL
    Product: ALL
    Required: ALL

  • Meta Data
    MetaData: Meta Data -- Descriptive information about the entity. The MetaData values are set by Data Services and are read only for all applications.
    Product: ALL

  • Custom Field
    CustomField: Custom Field -- Custom field (or data extension). Filterable: QBW
    Product: QBW

  • Attachable Ref
    AttachableRef: Attachable Ref -- Specifies entity name of the attachment from where the attachment was requested

  • domain
    domain: domain -- Domain in which the entity belongs.
    Product: ALL

  • status
    status: status -- System status of the entity. Output only field. Filterable: ALL
    Product: ALL
    status Enumerated Values:
    • Deleted
    • Voided
    • Draft
    • Pending
    • InTransit
    • Synchronized
    • SyncError

  • status Specified
    statusSpecified: status Specified -- Bill.statusSpecified

  • sparse
    sparse: sparse -- True if the entity representation has a partial set of elements. Output only field.
    Product: ALL

  • sparse Specified
    sparseSpecified: sparse Specified -- Bill.sparseSpecified

  • Name And Id
    NameAndId: Name And Id -- Property used for Select clauses. This property is not used for entity operation and Where and orderBy clauses.

  • Overview
    Overview: Overview -- Property used for Select clauses. This property is not used for entity operation and Where and orderBy clauses.

  • Header Lite
    HeaderLite: Header Lite -- Property used for Select clauses. This property is not used for entity operation and Where and orderBy clauses.

  • Header Full
    HeaderFull: Header Full -- Property used for Select clauses. This property is not used for entity operation and Where and orderBy clauses.

Bill Quickbooks Online API/SDK Sample Code:
Bill C# Example