Skip to main content
POST
Create a new connection

Authorizations

Authorization
string
header
required

Use your app's API_KEY as the username, and leave the password blank

Body

application/json
name
string

Optional name for the connection - if you leave this blank, the company name returned by QuickBooks will be used once the first request is processed. A blank name (empty or only whitespace) is stored as null, and surrounding whitespace is trimmed. A simulated connection left blank takes its simulated company's name (Simulated Company) straight away.

redirect_url
string<uri>

The URL to redirect the user to after they complete (or cancel) the QuickBooks setup process. This URL should be able to handle the query parameters:

  • ?state=connected if they completed the process,
  • ?state=cancelled if they cancelled it or
  • ?state=expired if they visit the onboarding link after it has expired
Example:

"https://myapp.com/quickbooks-setup-callback"

type
enum<string>
default:standard

How QuickBooks is reached. 'simulated' creates a fake QuickBooks answered by QuBe Sync: connected immediately, no Web Connector, meant for development and tests (see the Quickstart). Simulated connections are in beta: they don't match real QuickBooks in every case yet.

Available options:
standard,
realtime,
simulated

Response

Connection created successfully

data
object