Items

Accounts

Bill Payments

Bills

Classes

Company Info

Credit Card Payments

Credit Memos

If true, this entity is currently enabled for use by QuickBooks.

Specifies the telephone number in free form.

Specifies the open balance amount or the amount unpaid by the customer. For the create operation, this represents the opening balance for the customer. When returned in response to the query request it represents the current open balance (unpaid amount) for that customer.

Cumulative open balance amount for the Customer (or Job) and all its sub-jobs. Cannot be written to QuickBooks.

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.

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.

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

An identifying name for the object being referenced by value and is derived from the field that holds the common name of that object. This varies by context and specific type of object referenced. For example, references to a Customer object use Customer.DisplayName to populate this field. Optionally returned in responses, implementation dependent.

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.

Reference to the customer type assigned to a customer. This field is only returned if the customer is assigned a customer type.

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.

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.

Fully qualified name of the object. The fully qualified name prepends the topmost parent, followed by each sub element separated by colons. Takes the form of Customer:Job:Sub-job. System generated. Limited to 5 levels.

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

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 'GST registration type'. Possible values are listed below: GST_REG_REG, GST_REG_COMP, GST_UNREG, CONSUMER, OVERSEAS, SEZ, DEEMED

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.

Unique identifier for this object. Sort order is ASC by default.

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.

Specifies the level of the hierarchy in which the entity is located. Zero specifies the top level of the hierarchy; anything above will be level with respect to the parent. Constraints:up to 5 levels

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.

The date format follows the XML Schema standard.

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

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.

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.

Resale number or some additional info about the customer.

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.

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

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

Postal code. For example, zip code for USA and Canada

The Source type of the transactions created by QuickBooks Commerce. Valid values include: QBCommerce

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

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.

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.

If true, transactions for this customer are taxable.

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

Uniform Resource Identifier for the web site.

Customers

Departments

Deposits

Employees

Estimates

Invoices

Journal Entries

Journal Report

Payments

Purchase Orders

Purchases

Refund Receipts

Sales Receipts

Tax Agencies

Tax Codes

Tax Payments

Tax Rates

Payment must be received by this day of the month. Used only if DueDays is not specified. Required if DueDays not present

Discount applies if paid before this day of month. Required if DueDays not present

Discount applies if paid within this number of days. Used only when DueDays is specified.

Discount percentage available against an amount if paid within the days specified by DiscountDays.

Number of days from delivery of goods or services until the payment is due. Required if DayOfMonthDue not present

Payment due next month if issued that many days before the DayOfMonthDue. Required if DueDays not present

User recognizable name for the term. For example, Net 30.

Type of the Sales Term. Valid values: STANDARD--Used if DueDays is not null. DATE_DRIVEN--Used if DueDays is null.

Terms

Transfers

Vendor Credits

Vendors

Quickbooks

Get Connection Info

Account-Create

Account-ReadById

Get all customer records using generic 'Query' endpoint.
Method - POST

Account-ReadAll

Create an attachable object
Conent-Type:application/json
Method - POST

Attachable-Create

Retrieve an attachable object by Id
Accept:application/json
Method - GET

Attachable-ReadById

Uploading and linking new attachments

https://developer.intuit.com/docs/0100_quickbooks_online/0200_dev_guides/accounting/attachments#Uploading_and_linking_new_attachments

If the attachment is not in the Attachment list already, it's possible to upload it and link it to the object in one multipart operation.

Operation:      POST https://quickbooks.api.intuit.com/companyID/upload
Content type: multipart/form-data

Request body

The following sample code shows the multipart request body for uploading a file and its supporting Attachable metatdata object, with the result of it being both added to the Attachment list and added to the object.

The Attachable object accompanying this request supplies metadata and object information to which the attachment is linked.
Each part of the multipart request is separated by a boundary.  In the sample below, the string  --YOjcLaTlykb6OxfYJx4O07j1MweeMFem is used. You can use any random and unique string.
The file to be uploaded and its Attachable object are paired together via the name parameter in the part header for each one.
The name parameter for the file part is of the form file_content_nn, where nn is a unique index number among the set of files being uploaded.
The name parameter for the Attachable object is of the form file_metadata_nn, where nn corresponds to the file index number used with the content .
The file or files are stored in the Attachment list with the name specified by the filename parameter.
If the data supplied with the Attachable object cannot be validated, an error is returned and the file is not uploaded.

Upload-Attachments

Multiple operations using batch query
Content-Type:application/json
Method - POST

Batch

Create a bill
Content-Type:application/json
Method - POST

Bill-Create

Retrieve a bill by Id
Accept:application/json
Method - GET

Bill-GetById

Create a BillPayment against a pre-created bill
Content-Type:application/json
Method - POST

BillPayment-Create

BillPayment-ReadById

Retrive changed Bill and invoice objects since Aug10,2016
Method - GET

CDC-Read

Class-Create

Class-ReadById

CompanyInfo-ReadById

CreditMemo-Create

CreditMemo-ReadById

Customer-Create

Customer-ReadById

Department-Create

Department-ReadById

Deposit-Create

Read a deposit object by Id
Method : POST

Deposit-ReadById

Create an employee object
Method : POST



Employee-Create

Retrive an employee object by ID
Method : GET



Employee-ReadById

Estimate-Create

Read an Estimate object by Id
Method : POST


Estimate-ReadById

ExchangeRate - GetDetails

Invoice-Create

Read an invoice object by Id
Method : POST


Invoice-ReadById

Item-Create

Item-ReadById

Create an journalentry object
Method : POST


JournalEntry-Create

Read an journalentry object by Id
Method : POST


JournalEntry-ReadById

Payment-Create

Read a payment object by Id
Method : GET


Payment-ReadByID

PaymentMethod-Create

PaymentMethod-ReadById

Read the preference object
Method : POST


Preference-Read

Update the preference object endpoint
Method : POST


Preference-Update

Purchase-Create

Read a puchase object by Id
Method : POST


Purchase-ReadById

Create a puchase-order object
Method : POST


PurchaseOrder-Create

Read a puchase-order object
Method : POST


PurchaseOrder-ReadById

Create a refund-receipt object
Method : POST


RefundReceipt-Create

Read a refund-receipt object
Method : GET


RefundReceipt-ReadById

Report - Account list detail
Method : GET

The information below provides a reference on how to access the account list detail report from the QuickBooks Online Report Service.



Report-AccountList

Report - AgedPayable aging detail
Method : GET

The information below provides a reference on how to access the AP Aging summary report from the QuickBooks Online Report Service.





Report-AgedPayableDetail

Report - AgedPayable aging summary
Method : GET

The information below provides a reference on how to access the AP Aging summary report from the QuickBooks Online Report Service.






Report-AgedPayables

Report - AgedReceivableDetail aging detail
Method : GET

The information below provides a reference on how to access the AR Aging Detail report from the QuickBooks Online Report Service.






Report-AgedReceivableDetail

Report - AgedReceivable aging summary
Method : GET

The information below provides a reference on how to access the AR Aging Summary report from the QuickBooks Online Report Service.







Report-AgedReceivables

Report - BalanceSheet
Method : GET

The information below provides a reference on how to query the Balance Sheet report from the QuickBooks Online Report Service.








Report-BalanceSheet

Report - CashFlow
Method : GET

The information below provides a reference on how to access the cash flow report from the QuickBooks Online Report Service.








Report-CashFlow

Report-CashSales

Report - CustomerBalance
Method : GET









Report-CustomerBalance

Report - CustomerBalance Detail
Method : GET

The information below provides a reference on how to access the Customer Balance Detail report from the QuickBooks Online Report Service.











Report-CustomerBalanceDetail

Report - Customer Income
Method : GET












Report-CustomerIncome

Report - Customer Sales
Method : GET












Report-CustomerSales

Report - Department Sales
Method : GET












Report-DepartmentSales

Report - General Ledger
Method : GET

Docs - https://developer.intuit.com/docs/api/accounting/general%20ledger










Report-GeneralLedger

Report - Inventory Valuation Summary
Method : GET

Docs - https://developer.intuit.com/docs/api/accounting/inventory%20valuation










Report-InventoryValuationSummary

Report - Item Sales
Method : GET

Docs - https://developer.intuit.com/docs/api/accounting/sales%20by%20product










Report-ItemSales

Report - Profit and Loss
Method : GET

Docs - https://developer.intuit.com/docs/api/accounting/profit%20and%20loss










Report-ProfitAndLoss

Report - Profit and Loss Detail
Method : GET

Docs - https://developer.intuit.com/docs/api/accounting/profit%20and%20loss%20detail










Report-ProfitAndLossDetail

Report - Trial Balance
Method : GET

Docs - https://developer.intuit.com/docs/api/accounting/trial%20balance









Report-TrialBalance

Report - Trial List
Method : GET

Docs - https://developer.intuit.com/docs/api/accounting/transaction%20list









Report-TransactionList

Report - Vendor Balance
Method : GET

Docs - https://developer.intuit.com/docs/api/accounting/vendor%20balance








Report-VendorBalance

Report - Vendor Balance Detail
Method : GET

Docs - https://developer.intuit.com/docs/api/accounting/vendor%20balance%20detail







Report-VendorBalanceDetail

Report - Vendor Expense
Method : GET

Docs - https://developer.intuit.com/docs/api/accounting/expenses%20by%20vendor







Report-VendorExpense

Create an salesreceipt object
Method : POST


SalesReceipt-Create

SalesReceipt-ReadByID

Create a tax-agency object
Method : POST

Sample response payload

{
  "SalesReceipt": {
    "domain": "QBO",
    "status": "Deleted",
    "Id": "181"
  },
  "time": "2016-09-02T02:17:24.353-07:00"
}

Quickbooks API Integration Profile

How to work with Items in Quickbooks API

Operations on Items Collection

Build every single integration your customers need with AI

Field Name	API Key	Type
Id	Id	string
Fully Qualified Name	FullyQualifiedName	string
Domain	domain	string
Sync Token	SyncToken	string
Sparse	sparse	boolean