Get started

Get started

Set up your environment to make your first API call.

qbo/docs/workflow-related-26.svg
This guide describes how to make your first API call with QuickBooks Online app. If you want to integrate with QuickBooks Desktop, click here.
  1. Create an Intuit Developer account

Sign up for a new Intuit Developer account or sign in with any current Intuit product account such as QuickBooks, TurboTax, Mint, or ProConnect.

View Screenshot

qbo/docs/get-started-1.png
Note: When you create an Intuit Developer account, we create a QuickBooks test company called a sandbox company. View your sandbox company here.
You can start exploring QuickBooks Online APIs right away through the API Explorer
  1. Create an app
Creating an app generates your development keys. Use the app for yourself, your clients, or make it available to all QuickBooks users by listing it on the QuickBooks app store.
  • Select My apps and then Create an app.

View Screenshot

qbo/docs/get-started-3.png
  • Select the Keys tab to locate your Client ID and Client Secret.

View Screenshot

qbo/docs/get-started-2.png
You need your Client ID and Client Secret in the next step to generate an OAuth 2.0 access token.
  1. Get an OAuth 2.0 access token
Your app needs an OAuth 2.0 Access Token to access QuickBooks Online data. The OAuth 2.0 playground is the easiest way to get your access token.
If you’d like to learn about OAuth 2.0 in detail, see Authentication.
  1. Make the first API call
By now, you have your Client ID, Client Secret, and OAuth access token. Next, you can try making an API call. In the snippet below:
  • Replace YOUR_ACCESS_TOKEN with the OAuth access token generated in the previous step.
  • Replace YOUR_SANDBOX_COMPANY_ID with your sandbox-company Company ID.
GET CompanyInfo

1
2
3
4
5
6
curl -X GET 'https://sandbox-quickbooks.api.intuit.com/
v3/company/REPLACE_WITH_SANDBOX_COMPANY_ID/
companyinfo/REPLACE_WITH_SANDBOX_COMPANY_ID/?minorversion=12'
-H 'accept: application/json'
-H 'authorization: Bearer REPLACE_WITH_ACCESS_TOKEN'
-H 'content-type: application/json'

View Sample Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
{
 "CompanyInfo": {
   "CompanyName": "SandboxCompany_US_1",
   "LegalName": "SandboxCompany_US_1",
   "CompanyAddr": {
     "Id": "1","Line1":"123 Sierra Way","City":"San Pablo","CountrySubDivisionCode":"CA","PostalCode":"87999",
     "Lat": "36.6788345","Long":"-5.4464622"
   },
   "CustomerCommunicationAddr": {
     "Id": "1",
     "Line1":"123 Sierra Way","City":"San Pablo","CountrySubDivisionCode":"CA","PostalCode":"87999","Lat":"36.6788345","Long":"-5.4464622"},"LegalAddr":{"Id":"1",
     "Line1": "123SierraWay",
     "City": "SanPablo",
     "CountrySubDivisionCode": "CA",
     "PostalCode": "87999","Lat":"36.6788345",
     "Long": "-5.4464622"},"PrimaryPhone":{},"CompanyStartDate":"2018-03-02","FiscalYearStartMonth":"January","Country":"US","Email":{"Address":"noreply@quickbooks.com"},"WebAddr":{},"SupportedLanguages":"en","NameValue":[{"Name":"NeoEnabled","Value":"true"},{"Name":"IsQbdtMigrated","Value":"false"},{"Name":"CompanyType","Value":"Other"},{"Name":"SubscriptionStatus","Value":"TRIAL"},{"Name":"OfferingSku","Value":"QuickBooks Online Plus"},{"Name":"PayrollFeature","Value":"false"},{"Name":"AccountantFeature","Value":"false"},{"Name":"QBOIndustryType","Value":"Landscaping Services"},{"Name":"ItemCategoriesFeature","Value":"true"},{"Name":"AssignedTime","Value":"2018-03-05T19:40:40-08:00"
   }
 ],
 "domain": "QBO",
 "sparse": false,
 "Id": "1",
 "SyncToken": "8",
 "MetaData": {
   "CreateTime": "2018-03-02T01: 08: 21-08: 00","LastUpdatedTime":"2018-04-27T00:34:31-07:00"
 }
},
"time": "2018-05-04T14: 36: 43.747-07: 00"}
What’s next