About the QuickBooks Online Plus category

anon99371720 · September 21, 2022, 11:11am

Put topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.

Extra information

System documentation: QuickBooks Online Plus API Reference

Connector package documentation

1. Setting up HTTP Client QuickBooks Online Plus

1.1 Steps

In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client and select “QuickBooks Online Plus HTTP Client” as the HTTP Client.
Fill in the Base URI, Client ID, Client Secret, and Scopes (Optional).
(For more information, see QuickBooks Online Plus Reference)
Click on “Grant access to QuickBooks Online Plus” to get the Key.
You can optionally enable logging of request to get the log of the authentication.
Save the HTTP Client for use.

2. Subscribing to Entities from QuickBooks Online Plus

2.1 Steps

Go to Connections → Incoming and create a new incoming configuration and select “QuickBooks Online Plus Subscriber” as the subscriber.
Select the entity you want to subscribe to from QuickBooks Online Plus.
Add any request parameters needed to subscribe to the entity.
You can optionally add a transformer to transform the request parameters into something you will request from QuickBooks Online Plus.
You can also optionally enable pagination to allow Alumio fetches paginated entities.
Select the QuickBooks Online Plus HTTP Client to use.

2.2 General Concept

We follow QuickBooks Online Plus documentation on building this connector, so you can easily use the connector based on QuickBooks Online Plus API Reference.

Entity

The entity you want to subscribe to QuickBooks Online Plus. Please refer to the entities from QuickBooks Online Plus API Reference page.

Request Parameters

These are the parameters you can provide to get the needed entity based on the QuickBooks Online Plus API Reference.

Please look at the example below on how to fill path field when subscribing “Read an Account” entity.

Based on the documentation, we can see that the end point require “accountId” as a path. That is why we set the “accountId” inside the path key in the Request Parameters.
We can ignore the realmID because we set them in the HTTP Client.

Path is the path parameter of the url. For example the {channelId}.
Query is defined set of parameters attached to the end of a url.
Example: www.url.com?type=true&start=0

Alumio will then make a request to QuickBooks Online Plus with the URL /v3/company/123/account/33

HTTP Client

The HTTP Client configuration you will use to access QuickBooks Online Plus.

3. Publishing Entity to QuickBooks Online Plus

3.1 Steps

Go to Connections → Outgoing, create a new outgoing configuration and select “QuickBooks Online Plus Publisher” as the publisher.
Select the QuickBooks Online Plus entity you want the data to be published to.
You can optionally add any path data to the request on the key path.
You can optionally add any query data to the request on the key query.
You can optionally add any payload data to the request on the key payload.
Select the HTTP Client to use.

3.2 General Concept

Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer.

Entity

We support publishing to most QuickBooks Online Plus endpoints.
Please refer to QuickBooks Online Plus API Reference page.

For example, we want to update a customer. Please select “Create or Update Customer” as the entity of the publisher.

Based on the documentation, we need to add a Body Request. So we put the body inside the payload key in the Data.

Alumio will send an API request to QuickBooks Online Plus with URL /v3/company/123/customer

Path is the path parameter of the url. For example the {id}.
Query is defined set of parameters attached to the end of a url.
Example: www.url.com?type=true&start=0
Payload is the data contained within a request.