Get started with the API Explorer

The API Explorer is where you’ll find references for all QuickBooks Online Accounting API entities. Each API reference contains relevant fields, operations, attributes, and associated values. It’s also an interactive tool. If you sign in with your developer account, you can use the sample requests to call specific APIs.

Learn how APIs are organized in the API explorer

Each API has a reference with has several sections:

A description of the API entity that summarizes how it relates to QuickBooks.
A sample API object with all possible fields and attributes.
A section for each applicable operation (create, query, read, update, etc).

The Sample Entity sections includes all possible fields and values for the API entity. Each operation section has sample code modules you can use for reference.

All the data you need is contained in the reference, including any notes, call-outs, and other points to consider.

Tip: Most accounting and business workflows, such as invoicing, involve multiple API entities that interact with each other in particular ways. Here’s how to use specific entities to build your app around workflows.

Call any API entity

When you sign up for a developer account, you automatically get a sandbox company you can use for testing. You can use the sample requests in API Explorer references to make calls and send sample data to your sandbox company.

Let’s send a request to the CompanyInfo entity:

Sign in to your developer account.
Open another browser tab and then open a sandbox company. Keep the tab open.
In the first tab, go to the API Explorer.
Select one of your sandbox companies from the dropdown menu at the top.
Find and select CompanyInfo from the left navigation pane.
In the SAMPLE OBJECT pane on the right, review the complete list of fields and attributes.

Use the sample code in the reference to do the operation:

Find the operation you want to explore.
In the Request URL section to the right, review the header parameters.
In the Request body section, review the sample request code. For some operations, you will instead see a Sample Query or Enter ID box.
Edit fields and values in the request as needed. Tip: The fields and values need to correspond with actual objects in your sandbox company.
When you’re ready to send the request, select Try it.
In the Returns section, review the server response.

If you queried an entity, you’ll see the payload in the response. If you perform an update, the change will be reflected in your open sandbox company.

Tip: You can follow these general steps for any entity in the API Explorer. Try calling the Invoice entity to create a new invoice object, send it, and see it in your sandbox company.