Quickbooks component

Quickbooks

QuickBooks is a software to manage sales and expenses, and keep track of daily transactions.

General information

API version / SDK version

By default minor API version 26 is used, but it’s also possible to specify a more suitable minor API version in the credentials field Minor API version in case you really need it.

Environment variables

Please Note: From the platform version 20.51 we deprecated the component LOG_LEVEL environment variable. Now you can control logging level per each step of the flow.

Technical Notes

The technical notes page gives some technical details about AWS-S3 component like changelog and completeness matrix.

Credentials

Quickbooks service uses OAuth 2.0 authorization. Information about how to retrieve OAuth keys you can find here.

The keys could be found here.

If you create an app that needs a Callback URL for authentication purposes then the URL structure should be the following:

https://{YOUR_TENANT_ADDRESS}/callback/oauth2

Actual Callback URL can be found here.

Credentials

  • Company ID - Set the id of the company you want to access.
  • Application Client Id - OAuth client id (client key).
  • Application Client Secret - OAuth client secret.
  • Switching from production to sandbox environment - If True - sandbox environment will be used, if False - production one.
  • Minor API version - This field represents current API minor version. For default, it’s 26.

Warning: To maintain a smooth experience, we recommend reusing stored credentials where possible. Duplicating secrets across OAuth clients can result in errors and complications.

Triggers

Polling Trigger

Allows to get entries by chosen type. On first request, trigger will provide all existing objects by current type. On the next iterations, trigger will provide ONLY objects which were changed since a previous request. This trigger supports all type of business entities and response pagination. To set response size you should set/change ‘Batch Size for request pagination’ field in trigger settings.

Polling Trigger

List of Expected Config fields

  • Polling Object - dropdown with a list of objects available for polling
  • Batch Size for request pagination - The maximum number of entities that can be returned is 1000. If the result size is not specified, the default number is 1000. If a query returns a big amount of entities, it is recommended to fetch the entities in chunks.

Actions

Insert Object

Allows to add a new entity to your company. To Insert entity you must provide mandatory fields and fields which you want to update. This action is available ONLY for entities which can’t be updated with API. This action contains dynamic metadata.

Upsert Object

Allows to add a new object or update one of the existing objects in your company. To add a new object you should provide business required fields in the request body. To update entity you should provide primary key and fields which you want to update. This action contains dynamic metadata.

Delete Object

Allows to remove existing entity in your division. To remove contact you need to provide a primary key in the request body. This action contains dynamic metadata.

General Update & Upsert Actions

To prevent problems with concurrent access QuickBooks API entities have SyncToken field. This field is required for update API request. If you provide wrong SyncToken your request will be rejected with 400 code.

Current Limitations

For now, API XSD description doesn’t have any information about required fields, so be careful while creating insert, update or upsert requests.

Entities metadata structure was created from v3_minor_version_26 XSD version. Be careful, metadata was created once from the XSD, and now is stored in the component schemas/io.

The QuickBooks API has some limitations for request number:

  • Sandbox servers: Throttled at 100 requests per minute, per individual app.
  • Production servers: Throttled to 500 requests per minute, per realm ID.

Here is more information about the request limitations.

Known limitations

  1. For now, API XSD description doesn’t have any information about required fields, so be careful while creating insert, update or upsert requests. Entities metadata structure was created from ` v3_minor_version_26 ` XSD version. Be careful, metadata was created once from the XSD, and now is storing in the component.
  2. The QuickBooks API has some limitations for request number:
    • Sandbox servers: Throttled at 100 requests per minute, per individual app.
    • Production servers: Throttled to 500 requests per minute, per realm ID. Here is more information about request limitations.

  3. To prevent problems with concurrent access QuickBooks API entities have SyncToken field. This field is required for update API request. If you provide wrong SyncToken your request will be rejected with 400 code.

  4. Metadata Most field of Quick Books entities are optionally required - they are NOT marked in EIO web so be careful and check the QB docs before building a request.

Additional info