Intuit · Schema
QuickBooks Online Invoice
An Invoice represents a sales form where the customer pays for a product or service later. QuickBooks Online records an accounts receivable transaction for each invoice. This schema describes the full Invoice entity as returned by the QuickBooks Online Accounting API.
AccountingCustom FieldsFinancialFinancial ServicesInvoicingPaymentsPayrollProject ManagementSales TaxSmall BusinessTaxTax PreparationTaxesTime Tracking
Properties
| Name | Type | Description |
|---|---|---|
| Id | string | Unique identifier for the invoice, assigned by QuickBooks Online. |
| SyncToken | string | Version number of the entity used for optimistic concurrency control. Required for update operations. The value changes each time the entity is updated. |
| MetaData | object | |
| DocNumber | string | Reference number for the transaction. If not provided during creation, QuickBooks auto-generates a sequential number. |
| TxnDate | string | The date of the transaction in YYYY-MM-DD format. Defaults to the current date if not specified. |
| DueDate | string | The date when payment is due. Calculated based on the sales terms if not explicitly set. |
| PrivateNote | string | A private note for internal use that is not displayed to the customer. |
| CustomerMemo | object | A note to the customer that appears on the invoice. |
| CustomerRef | object | Reference to the customer associated with this invoice. Required for creation. |
| BillAddr | object | Bill-to address for the invoice. |
| ShipAddr | object | Ship-to address for the invoice. |
| BillEmail | object | Email address to which the invoice is sent. |
| Line | array | Individual line items of the transaction. At least one line item with a valid DetailType is required. |
| TxnTaxDetail | object | Tax details for the entire invoice transaction. |
| TotalAmt | number | Total amount of the transaction including tax. This is a calculated field and is read-only. |
| Balance | number | The balance remaining to be paid on the invoice. A value of 0 indicates the invoice is fully paid. |
| Deposit | number | Deposit amount previously applied to this invoice. |
| DepositToAccountRef | object | Account where the deposit was made. |
| SalesTermRef | object | Reference to the sales term (e.g., Net 30, Due on Receipt). |
| PaymentMethodRef | object | Reference to the payment method for this invoice. |
| CurrencyRef | object | Reference to the currency used for this invoice. Only applicable for companies with multicurrency enabled. |
| ExchangeRate | number | The exchange rate between the invoice currency and the home currency. Only applicable for multicurrency companies. |
| ShipDate | string | Date for delivery of goods or services. |
| ShipMethodRef | object | Reference to the shipping method. |
| TrackingNum | string | Shipping tracking number. |
| ApplyTaxAfterDiscount | boolean | If true, tax is calculated after applying any discount. If false, tax is calculated before the discount. |
| PrintStatus | string | Printing status of the invoice. |
| EmailStatus | string | Email delivery status of the invoice. |
| GlobalTaxCalculation | string | Method in which tax is applied. TaxExcluded means line amounts are exclusive of tax. TaxInclusive means line amounts include tax. |
| AllowOnlinePayment | boolean | Whether online payment is allowed for this invoice. |
| AllowOnlineCreditCardPayment | boolean | Whether online credit card payment is allowed. |
| AllowOnlineACHPayment | boolean | Whether online ACH (bank transfer) payment is allowed. |
| CustomField | array | Custom fields defined for the invoice. A maximum of 3 custom fields are supported. |
| LinkedTxn | array | Transactions linked to this invoice such as payments or credit memos. |
| domain | string | Domain of the entity (e.g., QBO). |
| sparse | boolean | Indicates whether this is a sparse (partial) representation of the entity. |