Back to tools

AI Agent Tool

Quickbooks logo

Quickbooks

Small business accounting software for invoicing, expenses, payroll, and financial reporting.

AccountingVerified

accounts.platform.intuit.com

•

One-click Login

About Quickbooks

QuickBooks Online is Intuit's cloud accounting platform used by millions of small and mid-sized businesses for bookkeeping, invoicing, expense tracking, payroll (add-on), and tax preparation. Intuit raised prices significantly in May 2026 across all tiers. The API (accessible via accounts.platform.intuit.com) enables third-party apps to read and write accounting data.

AI Agent Use Cases

- Income and expense tracking with bank feed reconciliation

- Invoicing with online payment acceptance

- Inventory tracking and project profitability (Plus and above)

- Financial reports: P&L, balance sheet, cash flow

- Payroll integration (paid add-on)

- REST API for third-party integrations via Intuit Developer Platform

Available Actions

These are the specific actions that AI agents can perform with this tool

Inputs

metaData

Specifies whether to return only the count of query objects, count with data, or no count at all.

iterator

Breaks down query results into manageable chunks. Only valid for the current QuickBooks session.

iteratorID

Identifies which iteration to use for continuing the query.

TxnIDList

One or more TxnID values to query specific bills.

RefNumberList

A list of one or more RefNumber values to query specific bills.

EntityFilter

Filter bills associated with a specific entity like Vendor or Customer.

PaidStatus

Filter bills based on their paid status.

IncludeLineItems

Include line items of bills in the response.

IncludeLinkedTxns

Include linked transactions in the response.

OwnerIDList

Specifies the ID of the data extension owner.

Inputs

shipvia

Filter by the shipping method

termIds

Filters report contents based on term or terms supplied

startDueDate

The range of dates over which receivables are due, in the format `YYYY-MM-DD`. `start_duedate` must be less than `end_duedate`. If not specified, all data is returned.

endDueDate

The range of dates over which receivables are due, in the format `YYYY-MM-DD`. `start_duedate` must be less than `end_duedate`. If not specified, all data is returned.

accountingMethod

The accounting method used in the report

reportDate

Start date to use for the report, in the format `YYYY-MM-DD`

numPeriods

The number of periods to be shown in the report

vendorIds

Filters report contents to include information for specified vendors

pastDue

Filters report contents based on minimum days past due

agingPeriod

The number of days in the aging period

columns

Column types to be shown in the report

Inputs

vendorRefValue

Reference to the vendor for this transaction

currencyRefValue

A three letter string representing the ISO 4217 code for the currency. For example, `USD`, `AUD`, `EUR`, and so on. This must be defined if multicurrency is enabled for the company.\nMulticurrency is enabled for the company if `Preferences.MultiCurrencyEnabled` is set to `true`. Read more about multicurrency support [here](https://developer.intuit.com/docs?RedirectID=MultCurrencies). Required if multicurrency is enabled for the company.

lineItemsAsObjects

Enter line items as an array of objects

Inputs

displayName

The name of the person or organization as displayed. Must be unique across all Customer, Vendor, and Employee objects. Cannot be removed with sparse update. If not supplied, the system generates DisplayName by concatenating customer name components supplied in the request from the following list: `Title`, `GivenName`, `MiddleName`, `FamilyName`, and `Suffix`.

title

Title of the person. This tag supports i18n, all locales. The `DisplayName` attribute or at least one of `Title`, `GivenName`, `MiddleName`, `FamilyName`, `Suffix`, or `FullyQualifiedName` attributes are required during create.

givenName

Given name or first name of a person. The `DisplayName` attribute or at least one of `Title`, `GivenName`, `MiddleName`, `FamilyName`, or `Suffix` attributes is required for object create.

middleName

Middle name of the person. The person can have zero or more middle names. The `DisplayName` attribute or at least one of `Title`, `GivenName`, `MiddleName`, `FamilyName`, or `Suffix` attributes is required for object create.

familyName

Family name or the last name of the person. The `DisplayName` attribute or at least one of `Title`, `GivenName`, `MiddleName`, `FamilyName`, or `Suffix` attributes is required for object create.

suffix

Suffix of the name. For example, `Jr`. The `DisplayName` attribute or at least one of `Title`, `GivenName`, `MiddleName`, `FamilyName`, or `Suffix` attributes is required for object create.

Inputs

customerRefValue

Reference to a customer or job

billEmail

Email address where the estimate should be sent

expirationDate

Date when the estimate expires (YYYY-MM-DD)

acceptedBy

Name of the customer who accepted the estimate

acceptedDate

Date when the estimate was accepted (YYYY-MM-DD)

currencyRefValue

A three letter string representing the ISO 4217 code for the currency. For example, `USD`, `AUD`, `EUR`, and so on. This must be defined if multicurrency is enabled for the company.\nMulticurrency is enabled for the company if `Preferences.MultiCurrencyEnabled` is set to `true`. Read more about multicurrency support [here](https://developer.intuit.com/docs?RedirectID=MultCurrencies). Required if multicurrency is enabled for the company.

docNumber

Reference number for the transaction

billingStreetAddress

The street address of the billing address

billingCity

The city of the billing address

billingState

The state of the billing address

billingZip

The zip code of the billing address

billingLatitude

The latitude of the billing address

billingLongitude

The longitude of the billing address

shippingStreetAddress

The street address of the shipping address

shippingCity

The city of the shipping address

shippingState

The state of the shipping address

shippingZip

The zip code of the shipping address

shippingLatitude

The latitude of the shipping address

shippingLongitude

The longitude of the shipping address

privateNote

Private note for internal use

customerMemo

Memo visible to customer

taxCodeId

The identifier of a tax code

lineItemsAsObjects

Enter line items as an array of objects

Inputs

customerRefValue

Reference to a customer or job

billEmail

Email address where the invoice should be sent

dueDate

Date when the payment of the transaction is due (YYYY-MM-DD)

allowOnlineCreditCardPayment

Allow online credit card payment

allowOnlineACHPayment

Allow online bank transfer payment

currencyRefValue

A three letter string representing the ISO 4217 code for the currency. For example, `USD`, `AUD`, `EUR`, and so on. This must be defined if multicurrency is enabled for the company.\nMulticurrency is enabled for the company if `Preferences.MultiCurrencyEnabled` is set to `true`. Read more about multicurrency support [here](https://developer.intuit.com/docs?RedirectID=MultCurrencies). Required if multicurrency is enabled for the company.

docNumber

Reference number for the transaction

billAddr

Billing address details

shipAddr

Shipping address details

trackingNum

Shipping tracking number

privateNote

Private note for internal use

customerMemo

Memo visible to customer

taxCodeId

The identifier of a tax code

lineItemsAsObjects

Enter line items as an array of objects

Inputs

totalAmount

Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. E.g. 25.0

customerRefValue

Reference to a customer or job

currencyRefValue

A three letter string representing the ISO 4217 code for the currency. For example, `USD`, `AUD`, `EUR`, and so on. This must be defined if multicurrency is enabled for the company.\nMulticurrency is enabled for the company if `Preferences.MultiCurrencyEnabled` is set to `true`. Read more about multicurrency support [here](https://developer.intuit.com/docs?RedirectID=MultCurrencies). Required if multicurrency is enabled for the company.

Inputs

customerIds

Filters report contents to include information for specified customers

accountIds

Filters report contents to include information for specified accounts

accountingMethod

The accounting method used in the report

dateMacro

Predefined date range. Use if you want the report to cover a standard report date range; otherwise, use the `start_date` and `end_date` to cover an explicit report date range

startDate

The start date of the report, in the format `YYYY-MM-DD`. `start_date` must be less than `end_date`

endDate

The end date of the report, in the format `YYYY-MM-DD`. `start_date` must be less than `end_date`

adjustedGainLoss

Specifies whether unrealized gain and losses are included in the report

classIds

Filters report contents to include information for specified classes if so configured in the company file

paymentMethod

Filters report contents based on payment method

employeeIds

Filters report contents to include information for specified employees

departmentIds

Filters report contents to include information for specified departments if so configured in the company file

vendorIds

Filters report contents to include information for specified vendors

accountType

Account type from which transactions are included in the report

sortBy

The column type used in sorting report rows

columns

Column types to be shown in the report

Inputs

accountRefValue

Specifies the ID of the account reference. Check must specify bank account, CreditCard must specify credit card account. Validation Rules:Valid and Active Account Reference of an appropriate type.

paymentType

Payment Type can be: `Cash`, `Check`, or `CreditCard`.

currencyRefValue

A three letter string representing the ISO 4217 code for the currency. For example, `USD`, `AUD`, `EUR`, and so on. This must be defined if multicurrency is enabled for the company.\nMulticurrency is enabled for the company if `Preferences.MultiCurrencyEnabled` is set to `true`. Read more about multicurrency support [here](https://developer.intuit.com/docs?RedirectID=MultCurrencies). Required if multicurrency is enabled for the company.

lineItemsAsObjects

Enter line items as an array of objects

Inputs

accountId

The ID of the account to use for the purchase order

vendorRefValue

Reference to a vendor

dueDate

Date when the purchase order is due (YYYY-MM-DD)

currencyRefValue

A three letter string representing the ISO 4217 code for the currency. For example, `USD`, `AUD`, `EUR`, and so on. This must be defined if multicurrency is enabled for the company.\nMulticurrency is enabled for the company if `Preferences.MultiCurrencyEnabled` is set to `true`. Read more about multicurrency support [here](https://developer.intuit.com/docs?RedirectID=MultCurrencies). Required if multicurrency is enabled for the company.

docNumber

Reference number for the transaction

shippingStreetAddress

The street address of the shipping address

shippingCity

The city of the shipping address

shippingState

The state of the shipping address

shippingZip

The zip code of the shipping address

shippingLatitude

The latitude of the shipping address

shippingLongitude

The longitude of the shipping address

memo

Memo or note for the purchase order

lineItemsAsObjects

Enter line items as an array of objects

Inputs

lineItemsAsObjects

Enter line items as an array of objects

currencyRefValue

A three letter string representing the ISO 4217 code for the currency. For example, `USD`, `AUD`, `EUR`, and so on. This must be defined if multicurrency is enabled for the company.\nMulticurrency is enabled for the company if `Preferences.MultiCurrencyEnabled` is set to `true`. Read more about multicurrency support [here](https://developer.intuit.com/docs?RedirectID=MultCurrencies). Required if multicurrency is enabled for the company.

Inputs

purchaseId

ID of the purchase.

Inputs

realmId

The unique identifier for the QuickBooks Online company.

accessToken

Access token obtained from the OAuth 2.0 authentication process.

Inputs

billId

The identifier of a bill

Inputs

customerId

Reference to a customer or job

Inputs

invoiceId

ID of the invoice to get details of

Inputs

paymentId

The identifier of a payment

Inputs

purchaseId

ID of the purchase.

Inputs

purchaseOrderId

The identifier of a purchase order

Inputs

salesReceiptId

The identifier of a sales receipt

Inputs

timeActivityId

The identifier of a time activity

Inputs

amount

The amount to be charged in the transaction

currency

The currency in which the payment is made

card_number

The credit card number for processing the payment

expiry_date

The expiration date of the credit card

cvv

The CVV security code of the credit card

access_token

OAuth 2.0 access token for authenticating API requests

Inputs

maxResults

The number of entity elements in the response.

orderClause

The `orderClause` is for sorting the result. Include the property to sort by. The default sort order is ascending; to indicate descending sort order, include DESC, for example: `Name DESC`

startPosition

The starting count of the response for pagination.

whereClause

Filters to use in the where clause of the data query. Note: Multiple clauses (filters) are AND

Inputs

maxResults

The number of entity elements in the response.

orderClause

The `orderClause` is for sorting the result. Include the property to sort by. The default sort order is ascending; to indicate descending sort order, include DESC, for example: `Name DESC`

startPosition

The starting count of the response for pagination.

whereClause

Filters to use in the where clause of the data query. Note: Multiple clauses (filters) are AND

Inputs

maxResults

The number of entity elements in the response.

orderClause

The `orderClause` is for sorting the result. Include the property to sort by. The default sort order is ascending; to indicate descending sort order, include DESC, for example: `Name DESC`

startPosition

The starting count of the response for pagination.

whereClause

Filters to use in the where clause of the data query. Note: Multiple clauses (filters) are AND

Inputs

maxResults

The number of entity elements in the response.

orderClause

The `orderClause` is for sorting the result. Include the property to sort by. The default sort order is ascending; to indicate descending sort order, include DESC, for example: `Name DESC`

startPosition

The starting count of the response for pagination.

whereClause

Filters to use in the where clause of the data query. Note: Multiple clauses (filters) are AND

Inputs

maxResults

The number of entity elements in the response.

orderClause

The `orderClause` is for sorting the result. Include the property to sort by. The default sort order is ascending; to indicate descending sort order, include DESC, for example: `Name DESC`

startPosition

The starting count of the response for pagination.

whereClause

Filters to use in the where clause of the data query. Note: Multiple clauses (filters) are AND

Inputs

maxResults

The number of entity elements in the response.

orderClause

The `orderClause` is for sorting the result. Include the property to sort by. The default sort order is ascending; to indicate descending sort order, include DESC, for example: `Name DESC`

startPosition

The starting count of the response for pagination.

whereClause

Filters to use in the where clause of the data query. Note: Multiple clauses (filters) are AND

Inputs

searchQuery

A search query against a Quickbooks entity. See query language syntax, limitations, and other specifications on [Data queries](https://developer.intuit.com/app/developer/qbo/docs/develop/explore-the-quickbooks-online-api/data-queries)

Inputs

whereClause

Filters to use in the where clause of the data query. Note: Multiple clauses (filters) are AND

orderClause

The `orderClause` is for sorting the result. Include the property to sort by. The default sort order is ascending; to indicate descending sort order, include DESC, for example: `Name DESC`

startPosition

The starting count of the response for pagination.

maxResults

The number of entity elements in the response.

Inputs

maxResults

The number of entity elements in the response.

orderClause

The `orderClause` is for sorting the result. Include the property to sort by. The default sort order is ascending; to indicate descending sort order, include DESC, for example: `Name DESC`

startPosition

The starting count of the response for pagination.

whereClause

Filters to use in the where clause of the data query. Note: Multiple clauses (filters) are AND

Inputs

maxResults

The number of entity elements in the response.

orderClause

The `orderClause` is for sorting the result. Include the property to sort by. The default sort order is ascending; to indicate descending sort order, include DESC, for example: `Name DESC`

startPosition

The starting count of the response for pagination.

whereClause

Filters to use in the where clause of the data query. Note: Multiple clauses (filters) are AND

Inputs

estimateId

ID of the estimate to get details of

email

Email address to send the estimate to (optional - if not provided, uses the customer

Inputs

invoiceId

ID of the invoice to get details of

email

Email address to send the invoice to

Inputs

invoiceId

ID of the invoice to get details of

customer

Reference to a customer or job

currency

A three letter string representing the ISO 4217 code for the currency. For example, `USD`, `AUD`, `EUR`, and so on. This must be defined if multicurrency is enabled for the company.\nMulticurrency is enabled for the company if `Preferences.MultiCurrencyEnabled` is set to `true`. Read more about multicurrency support [here](https://developer.intuit.com/docs?RedirectID=MultCurrencies). Required if multicurrency is enabled for the company.

lineItemsAsObjects

Enter line items as an array of objects

Inputs

customerId

Reference to a customer or job

displayName

The name of the person or organization as displayed. Must be unique across all Customer, Vendor, and Employee objects. Cannot be removed with sparse update. If not supplied, the system generates DisplayName by concatenating customer name components supplied in the request from the following list: `Title`, `GivenName`, `MiddleName`, `FamilyName`, and `Suffix`.

title

Title of the person. This tag supports i18n, all locales. The `DisplayName` attribute or at least one of `Title`, `GivenName`, `MiddleName`, `FamilyName`, `Suffix`, or `FullyQualifiedName` attributes are required during create.

givenName

Given name or first name of a person. The `DisplayName` attribute or at least one of `Title`, `GivenName`, `MiddleName`, `FamilyName`, or `Suffix` attributes is required for object create.

middleName

Middle name of the person. The person can have zero or more middle names. The `DisplayName` attribute or at least one of `Title`, `GivenName`, `MiddleName`, `FamilyName`, or `Suffix` attributes is required for object create.

familyName

Family name or the last name of the person. The `DisplayName` attribute or at least one of `Title`, `GivenName`, `MiddleName`, `FamilyName`, or `Suffix` attributes is required for object create.

suffix

Suffix of the name. For example, `Jr`. The `DisplayName` attribute or at least one of `Title`, `GivenName`, `MiddleName`, `FamilyName`, or `Suffix` attributes is required for object create.

currencyRefValue

A three letter string representing the ISO 4217 code for the currency. For example, `USD`, `AUD`, `EUR`, and so on. This must be defined if multicurrency is enabled for the company.\nMulticurrency is enabled for the company if `Preferences.MultiCurrencyEnabled` is set to `true`. Read more about multicurrency support [here](https://developer.intuit.com/docs?RedirectID=MultCurrencies). Required if multicurrency is enabled for the company.

active

If true, this entity is currently enabled for use by QuickBooks. If there is an amount in `Customer.Balance` when setting this Customer object to inactive through the QuickBooks UI, a CreditMemo balancing transaction is created for the amount.

alternatePhoneFreeFormNumber

Specifies the alternate phone number in free form.

arAccountRefValue

ID of the accounts receivable account to be used for this customer. Each customer must have his own AR account. Applicable for France companies, only. Available when endpoint is evoked with the minorversion=3 query parameter. Query the Account name list resource to determine the appropriate Account object for this reference, where Account.AccountType=Accounts Receivable. Use `Account.Id` from that object for `ARAccountRef.value`.

billAddrCity

City name for the billing address.

billAddrCountry

Country name. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country.

billAddrCountrySubDivisionCode

Region within a country for the billing address. For example, state name for USA, province name for Canada.

billAddrLate

Latitude coordinate of Geocode (Geospacial Entity Object Code). `INVALID` is returned for invalid addresses.

billAddrLine1

First line of the billing address.

billAddrLine2

Second line of the billing address.

billAddrLine3

Third line of the billing address.

billAddrLine4

Fourth line of the billing address.

billAddrLine5

Fifth line of the billing address.

billAddrLong

Longitude coordinate of Geocode (Geospacial Entity Object Code). `INVALID` is returned for invalid addresses.

billAddrPostalCode

Postal code for the billing address. For example, zip code for USA and Canada.

billWithParent

If true, this Customer object is billed with its parent. If false, or null the customer is not to be billed with its parent. This attribute is valid only if this entity is a Job or sub Customer.

businessNumber

Also called, PAN (in India) is a code that acts as an identification for individuals, families and corporates, especially for those who pay taxes on their income.

companyName

The name of the company associated with the person or organization.

customerTypeRefValue

ID referencing the customer type assigned to a customer

defaultTaxCodeValue

ID of the default tax code associated with this Customer object. Reference is valid if `Customer.Taxable` is set to true; otherwise, it is ignored. If automated sales tax is enabled (`Preferences.TaxPrefs.PartnerTaxEnabled` is set to true) the default tax code is set by the system and can not be overridden. Query the `TaxCode` name list resource to determine the appropriate `TaxCode` object for this reference. Use `TaxCode.Id` from that object for `DefaultTaxCodeRef.value`.

faxFreeFormNumber

Specifies the fax number in free form.

GSTIN

GSTIN is an identification number assigned to every GST registered business.

gstRegistrationType

For the filing of GSTR, transactions need to be classified depending on the type of customer to whom the sale is done. To facilitate this, we have introduced a new field as

job

If true, this is a Job or sub-customer. If false or null, this is a top level customer, not a Job or sub-customer.

mobileFreeFormNumber

Specifies the mobile phone number in free form.

notes

Free form text describing the Customer.

paymentMethodRefValue

ID referencing a PaymentMethod object associated with this Customer object

preferredDeliveryMethod

Preferred delivery method. Values are `Print`, `Email`, or `None`.

primaryEmailAddr

Primary email address.

primaryPhoneFreeFormNumber

Specifies the primary phone number in free form.

primaryTaxIdentifier

Also called Tax Reg. No in ( UK ) , ( CA ) , ( IN ) , ( AU ) represents the tax ID of the Person or Organization. This value is masked in responses, exposing only last five characters. For example, the ID of `123-45-6789` is returned as `XXXXXX56789`.

printOnCheckName

Name of the person or organization as printed on a check. If not provided, this is populated from DisplayName. Constraints: Cannot be removed with sparse update.

resaleNum

Resale number or some additional info about the customer.

saleTermRefValue

ID of a SalesTerm object associated with this Customer object. Query the Term name list resource to determine the appropriate Term object for this reference. Use `Term.Id` from that object for `SalesTermRef.value`.

secondaryTaxIdentifier

Also called UTR No. in ( UK ) , CST Reg No. ( IN ) also represents the tax registration number of the Person or Organization. This value is masked in responses, exposing only last five characters. For example, the ID of `123-45-6789` is returned as `XXXXXX56789`

shipAddrCity

City name for the shipping address.

shipAddrCountry

Country name. For international addresses - countries should be passed as 3 ISO alpha-3 characters or the full name of the country.

shipAddrCountrySubDivisionCode

Region within a country for the shipping address. For example, state name for USA, province name for Canada.

shipAddrId

Unique identifier of the QuickBooks object for the shipping address, used for modifying the address. \nThe ShippingAddr object represents the default shipping address. If a physical address is updated from within the transaction object, the QuickBooks Online API flows individual address components differently into the Line elements of the transaction response then when the transaction was first created:\n* `Line1` and `Line2` elements are populated with the customer name and company name.\n* Original `Line1` through `Line5` contents, `City`, `SubDivisionCode`, and `PostalCode` flow into `Line3` through `Line5` as a free format strings.

shipAddrLate

Latitude coordinate of Geocode (Geospacial Entity Object Code). `INVALID` is returned for invalid addresses.

shipAddrLine1

First line of the shipping address.

shipAddrLine2

Second line of the shipping address.

shipAddrLine3

Third line of the shipping address.

shipAddrLine4

Fourth line of the shipping address.

shipAddrLine5

Fifth line of the shipping address.

shipAddrLong

Longitude coordinate of Geocode (Geospacial Entity Object Code). `INVALID` is returned for invalid addresses.

shipAddrPostalCode

Postal code for the shipping address. For example, zip code for USA and Canada.

taxable

If true, transactions for this customer are taxable. Default behavior with minor version 10 and above: true, if `DefaultTaxCodeRef` is defined or false if `TaxExemptionReasonId` is set.

taxExemptionReasonId

The tax exemption reason associated with this customer object. Applicable if automated sales tax is enabled (`Preferences.TaxPrefs.PartnerTaxEnabled` is set to `true`) for the company. Set `TaxExemptionReasonId`: to one of the following:\n**Id\tReason**\n* 1\tFederal government\n* 2\tState government\n* 3\tLocal government\n* 4\tTribal government\n* 5\tCharitable organization\n* 6\tReligious organization\n* 7\tEducational organization\n* 8\tHospital\n* 9\tResale\n* 10\tDirect pay permit\n* 11\tMultiple points of use\n* 12\tDirect mail\n* 13\tAgricultural production\n* 14\tIndustrial production / manufacturing\n* 15\tForeign diplomat

webAddr

Website address.

Inputs

estimateId

ID of the estimate to get details of

customerRefValue

Reference to a customer or job

billEmail

Email address where the estimate should be sent

expirationDate

Date when the estimate expires (YYYY-MM-DD)

acceptedBy

Name of the customer who accepted the estimate

acceptedDate

Date when the estimate was accepted (YYYY-MM-DD)

currencyRefValue

A three letter string representing the ISO 4217 code for the currency. For example, `USD`, `AUD`, `EUR`, and so on. This must be defined if multicurrency is enabled for the company.\nMulticurrency is enabled for the company if `Preferences.MultiCurrencyEnabled` is set to `true`. Read more about multicurrency support [here](https://developer.intuit.com/docs?RedirectID=MultCurrencies). Required if multicurrency is enabled for the company.

docNumber

Reference number for the transaction

billingStreetAddress

The street address of the billing address

billingCity

The city of the billing address

billingState

The state of the billing address

billingZip

The zip code of the billing address

billingLatitude

The latitude of the billing address

billingLongitude

The longitude of the billing address

shippingStreetAddress

The street address of the shipping address

shippingCity

The city of the shipping address

shippingState

The state of the shipping address

shippingZip

The zip code of the shipping address

shippingLatitude

The latitude of the shipping address

shippingLongitude

The longitude of the shipping address

privateNote

Private note for internal use

customerMemo

Memo visible to customer

taxCodeId

The identifier of a tax code

lineItemsAsObjects

Enter line items as an array of objects

Inputs

invoiceId

ID of the invoice to get details of

customerRefValue

Reference to a customer or job

billEmail

Email address where the invoice should be sent

dueDate

Date when the payment of the transaction is due (YYYY-MM-DD)

allowOnlineCreditCardPayment

Allow online credit card payment

allowOnlineACHPayment

Allow online bank transfer payment

currencyRefValue

A three letter string representing the ISO 4217 code for the currency. For example, `USD`, `AUD`, `EUR`, and so on. This must be defined if multicurrency is enabled for the company.\nMulticurrency is enabled for the company if `Preferences.MultiCurrencyEnabled` is set to `true`. Read more about multicurrency support [here](https://developer.intuit.com/docs?RedirectID=MultCurrencies). Required if multicurrency is enabled for the company.

docNumber

Reference number for the transaction

billingStreetAddress

The street address of the billing address

billingCity

The city of the billing address

billingState

The state of the billing address

billingZip

The zip code of the billing address

billingLatitude

The latitude of the billing address

billingLongitude

The longitude of the billing address

shippingStreetAddress

The street address of the shipping address

shippingCity

The city of the shipping address

shippingState

The state of the shipping address

shippingZip

The zip code of the shipping address

shippingLatitude

The latitude of the shipping address

shippingLongitude

The longitude of the shipping address

trackingNum

Shipping tracking number

privateNote

Private note for internal use

customerMemo

Memo visible to customer

taxCodeId

The identifier of a tax code

lineItemsAsObjects

Enter line items as an array of objects

Inputs

itemId

The identifier of an item

name

Name of the item. This value must be unique.

trackQtyOnHand

True if there is quantity on hand to be tracked. Once this value is true, it cannot be updated to false. Applicable for items of type `Inventory`. Not applicable for `Service` or `NonInventory` item types.

qtyOnHand

Current quantity of the `Inventory` items available for sale. Not used for `Service` or `NonInventory` type items. Required for `Inventory` type items.

incomeAccountRefValue

Reference to the posting account, that is, the account that records the proceeds from the sale of this item. Must be an account with account type of `Sales of Product Income`. Query the Account name list resource to determine the appropriate Account object for this reference. Use `Account.Id` from that object for `IncomeAccountRef.value`. See specifications for the IncomeAccountRef parameters in the [Create an item page](https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/item#create-an-item).

type

Classification that specifies the use of this item. See the description at the top of the [Item entity page](https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/item) for details about supported item types. See specifications for the type parameter in the [Create an item page](https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/item#create-an-item).

assetAccountRefValue

Required for Inventory item types. Reference to the Inventory Asset account that tracks the current value of the inventory. If the same account is used for all inventory items, the current balance of this account will represent the current total value of the inventory. Must be an account with account type of `Other Current Asset`. Query the Account name list resource to determine the appropriate Account object for this reference. Use `Account.Id` from that object for `AssetAccountRef.value`.

invStartDate

Date of opening balance for the inventory transaction. Required when creating an `Item.Type=Inventory`. Required for `Inventory` item types.

expenseAccountRefValue

Reference to the expense account used to pay the vendor for this item. Must be an account with account type of `Cost of Goods Sold`. Query the Account name list resource to determine the appropriate Account object for this reference. Use `Account.Id` from that object for `ExpenseAccountRef.value`. See specifications for the ExpenseAccountRef parameters in the [Create an item page](https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/item#create-an-item).

sku

The stock keeping unit (SKU) for this Item. This is a company-defined identifier for an item or product used in tracking inventory.

salesTaxIncluded

True if the sales tax is included in the item amount, and therefore is not calculated for the transaction.

salesTaxCodeRefValue

ID of the referenced sales tax code for the Sales item. Applicable to Service and Sales item types only. Query the TaxCode name list resource to determine the appropriate TaxCode object for this reference. Use `TaxCode.Id` from that object for `SalesTaxCodeRef.value`.

purchaseTaxIncluded

True if the purchase tax is included in the item amount, and therefore is not calculated for the transaction.

description

Description of the item.

abatementRate

Sales tax abatement rate for India locales.

reverseChargeRate

Sales tax reverse charge rate for India locales.

subItem

If true, this is a sub item. If false or null, this is a top-level item. Creating inventory hierarchies with traditional inventory items is being phased out in lieu of using categories and sub categories.

taxable

If true, transactions for this item are taxable. Applicable to US companies, only.

UqcDisplayText

Text to be displayed on customer

reorderPoint

The minimum quantity of a particular inventory item that you need to restock at any given time. The ReorderPoint value cannot be set to null for sparse updates(sparse=true). It can be set to null only for full updates.

purchaseDesc

Purchase description for the item.

prefVendorRefValue

Pref vendor ref value

active

If true, the object is currently enabled for use by QuickBooks.

UqcId

ID of Standard Unit of Measure (UQC:Unique Quantity Code) of the item according to GST rule.

purchaseTaxCodeRefValue

The ID for the referenced purchase tax code object as found in the Id field of the object payload. \n\nReference to the purchase tax code for the item. Applicable to Service, Other Charge, and Product (Non-Inventory) item types. Query the TaxCode name list resource to determine the appropriate TaxCode object for this reference. Use `TaxCode.Id` from that object for `PurchaseTaxCodeRef.value`.

serviceType

Sales tax service type for India locales.

purchaseCost

Amount paid when buying or ordering the item, as expressed in the home currency.

unitPrice

Corresponds to the Price/Rate column on the QuickBooks Online UI to specify either unit price, a discount, or a tax rate for item. If used for unit price, the monetary value of the service or product, as expressed in the home currency. If used for a discount or tax rate, express the percentage as a fraction. For example, specify `0.4` for 40% tax

taxClassificationRefValue

The ID for the referenced Tax classification object as found in the Id field of the object payload.\n\nTax classification segregates different items into different classifications and the tax classification is one of the key parameters to determine appropriate tax on transactions involving items. Tax classifications are sourced by either tax governing authorities as in India/Malaysia or externally like Exactor.

parentRefValue

The ID for the referenced parent item object as found in the Id field of the object payload. \n\nThe immediate parent of the sub item in the hierarchical Category:Sub-category list. If SubItem is true, then ParenRef is required. Query the Item name list resource to determine the appropriate object for this reference. Use `Item.Id` from that object for `ParentRef.value`.

Inputs

invoiceId

ID of the invoice to get details of